KiCad PCB EDA Suite
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 AUTHORS.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 LAYER_BOX_SELECTOR_H
26 #define LAYER_BOX_SELECTOR_H
27 
28 #include <wx/bmpcbox.h>
29 #include <gal/color4d.h>
31 
32 using KIGFX::COLOR4D;
33 
34 /* Basic class to build a layer list.
35  * this is an basic abstract class to build a layer list selector.
36  * To display this list, you should therefore derive this class
37  */
39 {
40 protected:
42 
43 public:
45 
46  // Returns a color index from the layer id
47  // Virtual function because GerbView uses its own functions in a derived class
48  virtual COLOR4D GetLayerColor( LAYER_NUM aLayer ) const = 0;
49 
50  // Returns the name of the layer id
51  // Virtual pure function because GerbView uses its own functions in a derived class
52  virtual wxString GetLayerName( LAYER_NUM aLayer ) const = 0;
53 
54  // Returns true if the layer id is enabled (i.e. is it should be displayed)
55  // Virtual function pure because GerbView uses its own functions in a derived class
56  virtual bool IsLayerEnabled( LAYER_NUM aLayer ) const = 0;
57 
58  bool SetLayersHotkeys( bool value );
59 
60  // Fills the layer bitmap aLayerbmp with the layer color
61  static void DrawColorSwatch( wxBitmap& aLayerbmp, COLOR4D aBackground, COLOR4D aColor );
62 };
63 
64 
65 /* class to display a layer list in a wxBitmapComboBox.
66  */
67 class LAYER_BOX_SELECTOR : public wxBitmapComboBox, public LAYER_SELECTOR
68 {
69 public:
70  LAYER_BOX_SELECTOR( wxWindow* parent, wxWindowID id,
71  const wxPoint& pos = wxDefaultPosition,
72  const wxSize& size = wxDefaultSize,
73  int n = 0, const wxString choices[] = NULL );
74 
75  LAYER_BOX_SELECTOR( wxWindow* parent, wxWindowID id,
76  const wxPoint& pos, const wxSize& size,
77  const wxArrayString& choices );
78 
79  ~LAYER_BOX_SELECTOR() override;
80 
81  // Get Current Item #
82  int GetChoice();
83 
84  // Get Current Layer
86 
87  // Set Layer #
88  int SetLayerSelection( LAYER_NUM layer );
89 
90  // Reload the Layers
91  // Virtual pure function because GerbView uses its own functions in a derived class
92  virtual void Resync() = 0;
93 
94  // Reload the Layers bitmaps colors
95  void ResyncBitmapOnly();
96 
97 private:
98  void onKeyDown( wxKeyEvent& aEvent );
99 };
100 
101 #endif // LAYER_BOX_SELECTOR_H
virtual COLOR4D GetLayerColor(LAYER_NUM aLayer) const =0
LAYER_BOX_SELECTOR(wxWindow *parent, wxWindowID id, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, int n=0, const wxString choices[]=NULL)
LAYER_NUM GetLayerSelection() const
int SetLayerSelection(LAYER_NUM layer)
bool SetLayersHotkeys(bool value)
int LAYER_NUM
Type LAYER_NUM can be replaced with int and removed.
static void DrawColorSwatch(wxBitmap &aLayerbmp, COLOR4D aBackground, COLOR4D aColor)
virtual void Resync()=0
virtual bool IsLayerEnabled(LAYER_NUM aLayer) const =0
Board layer functions and definitions.
virtual wxString GetLayerName(LAYER_NUM aLayer) const =0
void onKeyDown(wxKeyEvent &aEvent)
Class COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39