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-2021 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/bitmap.h>
28 #include <wx/gdicmn.h>
29 #include <wx/panel.h>
30 #include <wx/statbmp.h>
31 #include <wx/window.h>
32 
33 #include <functional>
34 
35 #include <gal/color4d.h>
37 
39 {
44 };
45 
46 
47 const static wxSize SWATCH_SIZE_SMALL_DU( 8, 6 );
48 const static wxSize SWATCH_SIZE_MEDIUM_DU( 24, 10 );
49 const static wxSize SWATCH_SIZE_LARGE_DU( 24, 16 );
50 const static wxSize CHECKERBOARD_SIZE_DU( 3, 3 );
51 
52 
56 class COLOR_SWATCH: public wxPanel
57 {
58 public:
59 
67  COLOR_SWATCH( wxWindow* aParent, const KIGFX::COLOR4D& aColor, int aID,
68  const KIGFX::COLOR4D& aBackground, const KIGFX::COLOR4D& aDefault,
69  SWATCH_SIZE aSwatchType );
70 
74  COLOR_SWATCH( wxWindow *aParent, wxWindowID aId, const wxPoint &aPos = wxDefaultPosition,
75  const wxSize &aSize = wxDefaultSize, long aStyle = 0 );
76 
80  void SetSwatchColor( const KIGFX::COLOR4D& aColor, bool aSendEvent );
81 
85  void SetDefaultColor( const KIGFX::COLOR4D& aColor );
86 
90  void SetSwatchBackground( const KIGFX::COLOR4D& aBackground );
91 
95  void SetUserColors( CUSTOM_COLORS_LIST* aUserColors ) { m_userColors = aUserColors; }
96 
101 
106  void SetWindowID( wxWindowID aId )
107  {
108  SetId( aId );
109  m_swatch->SetId( aId );
110  }
111 
117  void GetNewSwatchColor();
118 
119  void SetReadOnly( bool aReadOnly = true ) { m_readOnly = aReadOnly; }
120  bool IsReadOnly() const { return m_readOnly; }
121 
122  void SetSupportsOpacity( bool aSupportsOpacity ) { m_supportsOpacity = aSupportsOpacity; }
123 
125  void SetReadOnlyCallback( std::function<void()> aCallback ) { m_readOnlyCallback = aCallback; }
126 
127  static wxBitmap MakeBitmap( const KIGFX::COLOR4D& aColor, const KIGFX::COLOR4D& aBackground,
128  const wxSize& aSize, const wxSize& aCheckerboardSize,
129  const KIGFX::COLOR4D& aCheckerboardBackground );
130 
131 private:
132  void setupEvents();
133 
137  void rePostEvent( wxEvent& aEvent );
138 
143 
144  wxStaticBitmap* m_swatch;
145 
146  wxSize m_size;
149 
152  std::function<void()> m_readOnlyCallback;
153 
156 };
157 
158 
162 wxDECLARE_EVENT(COLOR_SWATCH_CHANGED, wxCommandEvent);
163 
164 #endif // COLOR_SWATCH__H_
void SetSwatchColor(const KIGFX::COLOR4D &aColor, bool aSendEvent)
Set the current swatch color directly.
KIGFX::COLOR4D GetSwatchColor() const
wxDECLARE_EVENT(COLOR_SWATCH_CHANGED, wxCommandEvent)
Event signaling a swatch has changed color.
void setupEvents()
static wxBitmap MakeBitmap(const KIGFX::COLOR4D &aColor, const KIGFX::COLOR4D &aBackground, const wxSize &aSize, const wxSize &aCheckerboardSize, const KIGFX::COLOR4D &aCheckerboardBackground)
static const wxSize SWATCH_SIZE_LARGE_DU(24, 16)
void SetReadOnly(bool aReadOnly=true)
Definition: color_swatch.h:119
std::vector< CUSTOM_COLOR_ITEM > CUSTOM_COLORS_LIST
COLOR_SWATCH(wxWindow *aParent, const KIGFX::COLOR4D &aColor, int aID, const KIGFX::COLOR4D &aBackground, const KIGFX::COLOR4D &aDefault, SWATCH_SIZE aSwatchType)
Construct a COLOR_SWATCH.
void SetReadOnlyCallback(std::function< void()> aCallback)
Registers a handler for when the user tries to interact with a read-only swatch.
Definition: color_swatch.h:125
bool m_supportsOpacity
If opacity is not supported the color chooser dialog will be displayed without it.
Definition: color_swatch.h:155
bool IsReadOnly() const
Definition: color_swatch.h:120
KIGFX::COLOR4D m_default
Definition: color_swatch.h:141
void SetSupportsOpacity(bool aSupportsOpacity)
Definition: color_swatch.h:122
wxSize m_checkerboardSize
Definition: color_swatch.h:147
KIGFX::COLOR4D m_background
Definition: color_swatch.h:140
static const wxSize SWATCH_SIZE_MEDIUM_DU(24, 10)
std::function< void()> m_readOnlyCallback
Definition: color_swatch.h:152
void SetDefaultColor(const KIGFX::COLOR4D &aColor)
Sets the color that will be chosen with the "Reset to Default" button in the chooser.
CUSTOM_COLORS_LIST * m_userColors
Definition: color_swatch.h:142
wxStaticBitmap * m_swatch
Definition: color_swatch.h:144
void SetWindowID(wxWindowID aId)
Updates the window ID of this control and its children.
Definition: color_swatch.h:106
KIGFX::COLOR4D m_checkerboardBg
Definition: color_swatch.h:148
bool m_readOnly
A read-only swatch won't show the color chooser dialog but otherwise works normally.
Definition: color_swatch.h:151
void rePostEvent(wxEvent &aEvent)
Pass unwanted events on to listeners of this object.
static const wxSize CHECKERBOARD_SIZE_DU(3, 3)
A simple color swatch of the kind used to set layer colors.
Definition: color_swatch.h:56
static const wxSize SWATCH_SIZE_SMALL_DU(8, 6)
void GetNewSwatchColor()
Prompt for a new colour, using the colour picker dialog.
KIGFX::COLOR4D m_color
Definition: color_swatch.h:139
void SetUserColors(CUSTOM_COLORS_LIST *aUserColors)
Fetch a reference to the user colors list.
Definition: color_swatch.h:95
SWATCH_SIZE
Definition: color_swatch.h:38
void SetSwatchBackground(const KIGFX::COLOR4D &aBackground)
Set the swatch background color.
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:103