KiCad PCB EDA Suite
color_swatch.cpp
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-2018 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 #include <widgets/color_swatch.h>
25 
26 #include "dialog_color_picker.h"
27 #include <memory>
28 
29 wxDEFINE_EVENT(COLOR_SWATCH_CHANGED, wxCommandEvent);
30 
31 using KIGFX::COLOR4D;
32 
33 
34 const static wxSize SWATCH_SIZE_DU( 8, 6 );
35 
36 // See selcolor.cpp:
37 extern COLOR4D DisplayColorFrame( wxWindow* aParent, COLOR4D aOldColor );
38 
39 
45 wxBitmap COLOR_SWATCH::MakeBitmap( COLOR4D aColor, COLOR4D aBackground, wxSize aSize )
46 {
47  wxBitmap bitmap( aSize );
48  wxBrush brush;
49  wxMemoryDC iconDC;
50 
51  iconDC.SelectObject( bitmap );
52 
53  brush.SetStyle( wxBRUSHSTYLE_SOLID );
54  brush.SetColour( aBackground.WithAlpha(1.0).ToColour() );
55  iconDC.SetBrush( brush );
56  iconDC.DrawRectangle( 0, 0, aSize.x, aSize.y );
57 
58  brush.SetColour( aColor.ToColour() );
59  iconDC.SetBrush( brush );
60  iconDC.DrawRectangle( 0, 0, aSize.x, aSize.y );
61 
62  return bitmap;
63 }
64 
65 
70 static std::unique_ptr<wxStaticBitmap> makeColorSwatch( wxWindow* aParent, COLOR4D aColor,
71  COLOR4D aBackground, int aID )
72 {
73  static wxSize size = aParent->ConvertDialogToPixels( SWATCH_SIZE_DU );
74 
75  wxBitmap bitmap = COLOR_SWATCH::MakeBitmap( aColor, aBackground, size );
76  auto ret = std::make_unique<wxStaticBitmap>( aParent, aID, bitmap );
77 
78  return ret;
79 }
80 
81 
82 COLOR_SWATCH::COLOR_SWATCH( wxWindow* aParent, COLOR4D aColor, int aID, COLOR4D aBackground ):
83  wxPanel( aParent, aID ),
84  m_color( aColor ),
85  m_background( aBackground )
86 {
87  auto sizer = new wxBoxSizer( wxHORIZONTAL );
88  SetSizer( sizer );
89 
90  auto swatch = makeColorSwatch( this, m_color, m_background, aID );
91  m_swatch = swatch.release(); // hold a handle
92 
93  sizer->Add( m_swatch, 0, 0 );
94 
95  // forward click to any other listeners, since we don't want them
96  m_swatch->Bind( wxEVT_LEFT_DOWN, &COLOR_SWATCH::rePostEvent, this );
97  m_swatch->Bind( wxEVT_RIGHT_DOWN, &COLOR_SWATCH::rePostEvent, this );
98 
99  // bind the events that trigger the dialog
100  m_swatch->Bind( wxEVT_LEFT_DCLICK, [this] ( wxMouseEvent& aEvt ) {
102  } );
103 
104  m_swatch->Bind( wxEVT_MIDDLE_DOWN, [this] ( wxMouseEvent& aEvt ) {
106  } );
107 }
108 
109 
110 void COLOR_SWATCH::rePostEvent( wxEvent& aEvt )
111 {
112  wxPostEvent( this, aEvt );
113 }
114 
115 
116 static void sendSwatchChangeEvent( COLOR_SWATCH& aSender )
117 {
118  wxCommandEvent changeEvt( COLOR_SWATCH_CHANGED );
119 
120  // use this class as the object (alternative might be to
121  // set a custom event class but that's more work)
122  changeEvt.SetEventObject( &aSender );
123 
124  wxPostEvent( &aSender, changeEvt );
125 }
126 
127 
128 void COLOR_SWATCH::SetSwatchColor( COLOR4D aColor, bool sendEvent )
129 {
130  m_color = aColor;
131 
132  wxBitmap bm = MakeBitmap( m_color, m_background, ConvertDialogToPixels( SWATCH_SIZE_DU ) );
133  m_swatch->SetBitmap( bm );
134 
135  if( sendEvent )
136  {
137  sendSwatchChangeEvent( *this );
138  }
139 }
140 
141 
143 {
144  m_background = aBackground;
145  wxBitmap bm = MakeBitmap( m_color, m_background, ConvertDialogToPixels( SWATCH_SIZE_DU ) );
146  m_swatch->SetBitmap( bm );
147 }
148 
149 
151 {
152  return m_color;
153 }
154 
155 
157 {
158  COLOR4D newColor = COLOR4D::UNSPECIFIED;
159 
160  DIALOG_COLOR_PICKER dialog( ::wxGetTopLevelParent( this ), m_color, true );
161 
162  if( dialog.ShowModal() == wxID_OK )
163  newColor = dialog.GetColor();
164 
165  if( newColor != COLOR4D::UNSPECIFIED )
166  {
167  m_color = newColor;
168 
169  wxBitmap bm = MakeBitmap( newColor, m_background, ConvertDialogToPixels( SWATCH_SIZE_DU ) );
170  m_swatch->SetBitmap( bm );
171 
172  sendSwatchChangeEvent( *this );
173  }
174 }
COLOR4D DisplayColorFrame(wxWindow *aParent, COLOR4D aOldColor)
KIGFX::COLOR4D GetSwatchColor() const
void SetSwatchColor(KIGFX::COLOR4D aColor, bool sendEvent)
Set the current swatch color directly.
COLOR4D WithAlpha(double aAlpha) const
Function WithAlpha Returns a colour with the same colour, but the given alpha.
Definition: color4d.h:247
void SetSwatchBackground(KIGFX::COLOR4D aBackground)
Set the swatch background color.
static const wxSize SWATCH_SIZE_DU(8, 6)
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:86
static wxBitmap MakeBitmap(KIGFX::COLOR4D aColor, KIGFX::COLOR4D aBackground, wxSize aSize)
Make a simple color swatch bitmap.
COLOR_SWATCH(wxWindow *aParent, KIGFX::COLOR4D aColor, int aID, KIGFX::COLOR4D aBackground)
Construct a COLOR_SWATCH.
wxStaticBitmap * m_swatch
Handle of the actual swatch shown
Definition: color_swatch.h:89
static std::unique_ptr< wxStaticBitmap > makeColorSwatch(wxWindow *aParent, COLOR4D aColor, COLOR4D aBackground, int aID)
Function makeColorButton creates a wxStaticBitmap and assigns it a solid color and a control ID.
wxDEFINE_EVENT(COLOR_SWATCH_CHANGED, wxCommandEvent)
static void sendSwatchChangeEvent(COLOR_SWATCH &aSender)
KIGFX::COLOR4D GetColor()
Class representing a simple color swatch, of the kind used to set layer colors.
Definition: color_swatch.h:38
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:83
Class COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39