KiCad PCB EDA Suite
color_swatch.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) 2017 KiCad Developers, see AUTHORS.txt for contributors.
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, you may find one here:
18  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19  * or you may search the http://www.gnu.org website for the version 2 license,
20  * or you may write to the Free Software Foundation, Inc.,
21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22  */
23 
24 #ifndef COLOR_SWATCH__H_
25 #define COLOR_SWATCH__H_
26 
27 #include <wx/wx.h>
28 
29 #include <common.h>
30 
31 #include <gal/color4d.h>
32 
33 
38 class COLOR_SWATCH: public wxPanel
39 {
40 public:
41 
49  COLOR_SWATCH( wxWindow* aParent, KIGFX::COLOR4D aColor, int aID, KIGFX::COLOR4D aBackground,
50  const KIGFX::COLOR4D aDefault, bool aForDialog );
51 
55  COLOR_SWATCH( wxWindow *aParent, wxWindowID aId, const wxPoint &aPos = wxDefaultPosition,
56  const wxSize &aSize = wxDefaultSize, long aStyle = 0 );
57 
61  void SetSwatchColor( KIGFX::COLOR4D aColor, bool sendEvent );
62 
66  void SetSwatchBackground( KIGFX::COLOR4D aBackground );
67 
72 
78  void GetNewSwatchColor();
79 
80  static wxBitmap MakeBitmap( KIGFX::COLOR4D aColor, KIGFX::COLOR4D aBackground, wxSize aSize );
81 
82 private:
83  void setupEvents();
84 
88  void rePostEvent( wxEvent& aEvt );
89 
92 
95 
98 
100  wxStaticBitmap* m_swatch;
101 
102  wxSize m_size;
103 };
104 
105 
109 wxDECLARE_EVENT(COLOR_SWATCH_CHANGED, wxCommandEvent);
110 
111 #endif // COLOR_SWATCH__H_
KIGFX::COLOR4D GetSwatchColor() const
void SetSwatchColor(KIGFX::COLOR4D aColor, bool sendEvent)
Set the current swatch color directly.
wxDECLARE_EVENT(COLOR_SWATCH_CHANGED, wxCommandEvent)
Event signalling a swatch has changed color.
void setupEvents()
COLOR_SWATCH(wxWindow *aParent, KIGFX::COLOR4D aColor, int aID, KIGFX::COLOR4D aBackground, const KIGFX::COLOR4D aDefault, bool aForDialog)
Construct a COLOR_SWATCH.
void SetSwatchBackground(KIGFX::COLOR4D aBackground)
Set the swatch background color.
KIGFX::COLOR4D m_default
The default color for the swatch
Definition: color_swatch.h:97
void rePostEvent(wxEvent &aEvt)
Pass unwanted events on to listeners of this object.
KIGFX::COLOR4D m_background
The background colour to show the swatch over
Definition: color_swatch.h:94
static wxBitmap MakeBitmap(KIGFX::COLOR4D aColor, KIGFX::COLOR4D aBackground, wxSize aSize)
Make a simple color swatch bitmap.
wxStaticBitmap * m_swatch
Handle of the actual swatch shown
Definition: color_swatch.h:100
Class representing a simple color swatch, of the kind used to set layer colors.
Definition: color_swatch.h:38
The common library.
void GetNewSwatchColor()
Prompt for a new colour, using the colour picker dialog.
KIGFX::COLOR4D m_color
The current colour of the swatch
Definition: color_swatch.h:91
COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:40