KiCad PCB EDA Suite
class_layer_box_selector.h
Go to the documentation of this file.
1 /*
2  * This program source code file is part of KiCad, a free EDA CAD application.
3  *
4  * Copyright (C) 2011-2014 Jean-Pierre Charras, jp.charras at wanadoo.fr
5  * Copyright (C) 1992-2014 KiCad Developers, see CHANGELOG.TXT for contributors.
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, you may find one here:
19  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20  * or you may search the http://www.gnu.org website for the version 2 license,
21  * or you may write to the Free Software Foundation, Inc.,
22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23  */
24 
25 #ifndef CLASS_LAYER_BOX_SELECTOR_H
26 #define CLASS_LAYER_BOX_SELECTOR_H 1
27 
28 #include <wx/bmpcbox.h>
29 #include <gal/color4d.h>
31 
32 struct EDA_HOTKEY_CONFIG;
33 using KIGFX::COLOR4D;
34 
35 /* Basic class to build a layer list.
36  * this is an basic abstract class to build a layer list selector.
37  * To display this list, you should therefore derive this class
38  */
40 {
41 protected:
43 
44 public:
45  // Hotkey Info
47 
48 public:
50 
51  // Returns a color index from the layer id
52  // Virtual function because GerbView uses its own functions in a derived class
53  virtual COLOR4D GetLayerColor( LAYER_NUM aLayer ) const = 0;
54 
55  // Returns the name of the layer id
56  // Virtual pure function because GerbView uses its own functions in a derived class
57  virtual wxString GetLayerName( LAYER_NUM aLayer ) const = 0;
58 
59  // Returns true if the layer id is enabled (i.e. is it should be displayed)
60  // Virtual function pure because GerbView uses its own functions in a derived class
61  virtual bool IsLayerEnabled( LAYER_NUM aLayer ) const = 0;
62 
63  bool SetLayersOrdered( bool value );
64  bool SetLayersHotkeys( bool value );
65 
66 protected:
67  // Fills the layer bitmap aLayerbmp with the layer color
68  void SetBitmapLayer( wxBitmap& aLayerbmp, LAYER_NUM aLayer );
69 };
70 
71 
72 /* class to display a layer list in a wxBitmapComboBox.
73  */
74 class LAYER_BOX_SELECTOR : public wxBitmapComboBox, public LAYER_SELECTOR
75 {
76 public:
77  // Hotkey Info
79 
80 public:
81  LAYER_BOX_SELECTOR( wxWindow* parent, wxWindowID id,
82  const wxPoint& pos = wxDefaultPosition,
83  const wxSize& size = wxDefaultSize,
84  int n = 0, const wxString choices[] = NULL );
85 
86  LAYER_BOX_SELECTOR( wxWindow* parent, wxWindowID id,
87  const wxPoint& pos, const wxSize& size,
88  const wxArrayString& choices );
89 
90  // Get Current Item #
91  int GetChoice();
92 
93  // Get Current Layer
95 
96  // Set Layer #
97  int SetLayerSelection( LAYER_NUM layer );
98 
99  // Reload the Layers
100  // Virtual pure function because GerbView uses its own functions in a derived class
101  virtual void Resync() = 0;
102 
103  // Reload the Layers bitmaps colors
104  void ResyncBitmapOnly();
105 };
106 
107 #endif // CLASS_LAYER_BOX_SELECTOR_H
virtual COLOR4D GetLayerColor(LAYER_NUM aLayer) const =0
bool SetLayersOrdered(bool value)
Structure EDA_HOTKEY_CONFIG contains the information required to save hot key information to a config...
Definition: hotkeys_basic.h:87
struct EDA_HOTKEY_CONFIG * m_hotkeys
LAYER_BOX_SELECTOR(wxWindow *parent, wxWindowID id, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, int n=0, const wxString choices[]=NULL)
void SetBitmapLayer(wxBitmap &aLayerbmp, LAYER_NUM aLayer)
int SetLayerSelection(LAYER_NUM layer)
struct EDA_HOTKEY_CONFIG * m_hotkeys
bool SetLayersHotkeys(bool value)
int LAYER_NUM
Type LAYER_NUM can be replaced with int and removed.
virtual void Resync()=0
virtual bool IsLayerEnabled(LAYER_NUM aLayer) const =0
Board layer functions and definitions.
LAYER_NUM GetLayerSelection() const
virtual wxString GetLayerName(LAYER_NUM aLayer) const =0
Class COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39