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-2021 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>
30#include <layer_ids.h>
31
32using KIGFX::COLOR4D;
33
38{
39public:
41
43 {
44 }
45
46 bool SetLayersHotkeys( bool value );
47
48 // Fill the layer bitmap aLayerbmp with the layer color
49 static void DrawColorSwatch( wxBitmap& aLayerbmp, const COLOR4D& aBackground,
50 const COLOR4D& aColor );
51
52protected:
53 // Return a color index from the layer id
54 virtual COLOR4D getLayerColor( int aLayer ) const = 0;
55
56 // Return the name of the layer id
57 virtual wxString getLayerName( int aLayer ) const = 0;
58
59 // Return true if the layer id is enabled (i.e. is it should be displayed)
60 virtual bool isLayerEnabled( int aLayer ) const = 0;
61
63};
64
65
66/*
67 * Display a layer list in a wxBitmapComboBox.
68 */
69class LAYER_BOX_SELECTOR : public wxBitmapComboBox, public LAYER_SELECTOR
70{
71public:
72 LAYER_BOX_SELECTOR( wxWindow* parent, wxWindowID id, const wxPoint& pos = wxDefaultPosition,
73 const wxSize& size = wxDefaultSize, int n = 0,
74 const wxString choices[] = nullptr );
75
76 LAYER_BOX_SELECTOR( wxWindow* parent, wxWindowID id, const wxPoint& pos, const wxSize& size,
77 const wxArrayString& choices );
78
79 ~LAYER_BOX_SELECTOR() override;
80
81 int GetLayerSelection() const;
82
83 int SetLayerSelection( int layer );
84
85 // Reload the Layers
86 // Virtual pure function because GerbView uses its own functions in a derived class
87 virtual void Resync() = 0;
88
89 // Reload the Layers bitmaps colors
90 void ResyncBitmapOnly();
91
92private:
93 void onKeyDown( wxKeyEvent& aEvent );
94};
95
96#endif // LAYER_BOX_SELECTOR_H
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:104
void onKeyDown(wxKeyEvent &aEvent)
LAYER_BOX_SELECTOR(wxWindow *parent, wxWindowID id, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, int n=0, const wxString choices[]=nullptr)
int SetLayerSelection(int layer)
virtual void Resync()=0
Base class to build a layer list.
virtual COLOR4D getLayerColor(int aLayer) const =0
static void DrawColorSwatch(wxBitmap &aLayerbmp, const COLOR4D &aBackground, const COLOR4D &aColor)
virtual bool isLayerEnabled(int aLayer) const =0
bool SetLayersHotkeys(bool value)
virtual ~LAYER_SELECTOR()
virtual wxString getLayerName(int aLayer) const =0