KiCad PCB EDA Suite
panel_color_settings.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) 2020 Jon Evans <[email protected]>
5 * Copyright (C) 2020 KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * This program is free software: you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the
9 * Free Software Foundation, either version 3 of the License, or (at your
10 * option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License along
18 * with this program. If not, see <http://www.gnu.org/licenses/>.
19 */
20
21#include <bitmaps.h>
23#include <launch_ext.h>
24#include <layer_ids.h>
25#include <menus_helpers.h>
27#include <pgm_base.h>
31#include <validators.h>
33
34#include <wx/msgdlg.h>
35#include <wx/textdlg.h>
36
37// Button ID starting point
38constexpr int FIRST_BUTTON_ID = 1800;
39
40
43 m_currentSettings( nullptr ),
44 m_swatches(),
45 m_copied( COLOR4D::UNSPECIFIED ),
46 m_validLayers(),
47 m_backgroundLayer( LAYER_PCB_BACKGROUND ),
48 m_colorNamespace()
49{
50#ifdef __APPLE__
51 m_btnOpenFolder->SetLabel( _( "Reveal Themes in Finder" ) );
52
53 // Simple border is too dark on OSX
54 m_colorsListWindow->SetWindowStyle( wxBORDER_SUNKEN|wxVSCROLL );
55#endif
56}
57
58
60{
62 LaunchExternal( dir );
63}
64
65
67{
69 return;
70
71 for( const std::pair<const int, COLOR_SWATCH*>& pair : m_swatches )
72 {
73 int layer = pair.first;
74 COLOR_SWATCH* button = pair.second;
75
76 COLOR4D defaultColor = m_currentSettings->GetDefaultColor( layer );
77
78 m_currentSettings->SetColor( layer, defaultColor );
79 button->SetSwatchColor( defaultColor, false );
80 }
81}
82
83
85{
86 if( show )
87 {
88 // In case changes have been made to the current theme in another panel:
89 int idx = m_cbTheme->GetSelection();
90 COLOR_SETTINGS* settings = static_cast<COLOR_SETTINGS*>( m_cbTheme->GetClientData( idx ) );
91
92 if( settings )
93 *m_currentSettings = *settings;
94
97 }
98
99 return PANEL_COLOR_SETTINGS_BASE::Show( show );
100}
101
102
103void PANEL_COLOR_SETTINGS::OnLeftDownTheme( wxMouseEvent& event )
104{
105 // Lazy rebuild of theme menu to catch any colour theme changes made in other panels
107
108 event.Skip();
109}
110
111
112void PANEL_COLOR_SETTINGS::OnThemeChanged( wxCommandEvent& event )
113{
114 int idx = m_cbTheme->GetSelection();
115
116 if( idx == static_cast<int>( m_cbTheme->GetCount() ) - 2 )
117 {
118 // separator; re-select active theme
119 m_cbTheme->SetStringSelection( m_currentSettings->GetName() );
120 return;
121 }
122
123 if( idx == (int)m_cbTheme->GetCount() - 1 )
124 {
125 // New Theme...
126
127 if( !saveCurrentTheme( false ) )
128 return;
129
130 FOOTPRINT_NAME_VALIDATOR themeNameValidator;
131 wxTextEntryDialog dlg( this, _( "New theme name:" ), _( "Add Color Theme" ) );
132 dlg.SetTextValidator( themeNameValidator );
133
134 if( dlg.ShowModal() != wxID_OK )
135 return;
136
137 wxString themeName = dlg.GetValue();
138 wxFileName fn( themeName + wxT( ".json" ) );
140
141 if( fn.Exists() )
142 {
143 wxMessageBox( _( "Theme already exists!" ) );
144 return;
145 }
146
147 SETTINGS_MANAGER& settingsMgr = Pgm().GetSettingsManager();
148 COLOR_SETTINGS* newSettings = settingsMgr.AddNewColorSettings( themeName );
149 newSettings->SetName( themeName );
150 newSettings->SetReadOnly( false );
151
152 for( int layer : m_validLayers )
153 newSettings->SetColor( layer, m_currentSettings->GetColor( layer ) );
154
155 newSettings->SaveToFile( settingsMgr.GetPathForSettingsFile( newSettings ) );
156
157 idx = m_cbTheme->Insert( themeName, idx - 1, static_cast<void*>( newSettings ) );
158 m_cbTheme->SetSelection( idx );
159
160 m_optOverrideColors->SetValue( newSettings->GetOverrideSchItemColors() );
161
162 *m_currentSettings = *newSettings;
165 }
166 else
167 {
168 COLOR_SETTINGS* selected = static_cast<COLOR_SETTINGS*>( m_cbTheme->GetClientData( idx ) );
169
170 if( selected->GetFilename() != m_currentSettings->GetFilename() )
171 {
172 if( !saveCurrentTheme( false ) )
173 return;
174
175 m_optOverrideColors->SetValue( selected->GetOverrideSchItemColors() );
176
177 *m_currentSettings = *selected;
180 }
181 }
182}
183
184
186{
187 if( m_swatches.empty() )
188 {
190 }
191 else
192 {
193 bool isReadOnly = m_currentSettings->IsReadOnly();
195
196 for( std::pair<int, COLOR_SWATCH*> pair : m_swatches )
197 {
198 pair.second->SetSwatchBackground( background );
199 pair.second->SetSwatchColor( m_currentSettings->GetColor( pair.first ), false );
200 pair.second->SetReadOnly( isReadOnly );
201 }
202 }
203}
204
205
206void PANEL_COLOR_SETTINGS::createThemeList( const wxString& aCurrent )
207{
208 int width = 0;
209 int height = 0;
210
211 m_cbTheme->GetTextExtent( _( "New Theme..." ), &width, &height );
212 int minwidth = width;
213
214 m_cbTheme->Clear();
215
216 for( COLOR_SETTINGS* settings : Pgm().GetSettingsManager().GetColorSettingsList() )
217 {
218 wxString name = settings->GetName();
219
220 if( settings->IsReadOnly() )
221 name += wxS( " " ) + _( "(read-only)" );
222
223 int pos = m_cbTheme->Append( name, static_cast<void*>( settings ) );
224
225 if( settings->GetFilename() == aCurrent )
226 m_cbTheme->SetSelection( pos );
227
228 m_cbTheme->GetTextExtent( name, &width, &height );
229 minwidth = std::max( minwidth, width );
230 }
231
232 m_cbTheme->Append( wxT( "---" ) );
233 m_cbTheme->Append( _( "New Theme..." ) );
234
235 m_cbTheme->SetMinSize( wxSize( minwidth + 50, -1 ) );
236}
237
238
239void PANEL_COLOR_SETTINGS::createSwatch( int aLayer, const wxString& aName )
240{
241 wxStaticText* label = new wxStaticText( m_colorsListWindow, wxID_ANY, aName );
242
243 // The previously selected theme can be deleted and cannot be selected.
244 // so select the default theme (first theme of the list)
245 if( m_cbTheme->GetSelection() < 0 )
246 {
247 m_cbTheme->SetSelection( 0 );
249 }
250
251 void* clientData = m_cbTheme->GetClientData( m_cbTheme->GetSelection() );
252 COLOR_SETTINGS* selected = static_cast<COLOR_SETTINGS*>( clientData );
253
254 int id = FIRST_BUTTON_ID + aLayer;
255 COLOR4D defaultColor = selected->GetDefaultColor( aLayer );
258
259 COLOR_SWATCH* swatch = new COLOR_SWATCH( m_colorsListWindow, color, id, backgroundColor,
260 defaultColor, SWATCH_MEDIUM );
261 swatch->SetForegroundColour( wxSystemSettings::GetColour( wxSYS_COLOUR_WINDOW ) );
262
263 m_colorsGridSizer->Add( label, 0, wxALIGN_CENTER_VERTICAL | wxALIGN_LEFT | wxLEFT, 5 );
264 m_colorsGridSizer->Add( swatch, 0, wxALIGN_CENTER_VERTICAL | wxALL, 3 );
265
266 m_labels[aLayer] = label;
267 m_swatches[aLayer] = swatch;
268
269 swatch->Bind( wxEVT_RIGHT_DOWN,
270 [&, aLayer]( wxMouseEvent& aEvent )
271 {
272 ShowColorContextMenu( aEvent, aLayer );
273 } );
274
275 swatch->Bind( COLOR_SWATCH_CHANGED, &PANEL_COLOR_SETTINGS::OnColorChanged, this );
276}
277
278
279void PANEL_COLOR_SETTINGS::ShowColorContextMenu( wxMouseEvent& aEvent, int aLayer )
280{
281 auto selected =
282 static_cast<COLOR_SETTINGS*>( m_cbTheme->GetClientData( m_cbTheme->GetSelection() ) );
283
284 COLOR4D current = m_currentSettings->GetColor( aLayer );
285 COLOR4D saved = selected->GetColor( aLayer );
286 bool readOnly = m_currentSettings->IsReadOnly();
287
288 wxMenu menu;
289
290 AddMenuItem( &menu, ID_COPY, _( "Copy color" ), KiBitmap( BITMAPS::copy ) );
291
292 if( !readOnly && m_copied != COLOR4D::UNSPECIFIED )
293 AddMenuItem( &menu, ID_PASTE, _( "Paste color" ), KiBitmap( BITMAPS::paste ) );
294
295 if( !readOnly && current != saved )
296 AddMenuItem( &menu, ID_REVERT, _( "Revert to saved color" ), KiBitmap( BITMAPS::undo ) );
297
298 menu.Bind( wxEVT_COMMAND_MENU_SELECTED,
299 [&]( wxCommandEvent& aCmd )
300 {
301 switch( aCmd.GetId() )
302 {
303 case ID_COPY:
304 m_copied = current;
305 break;
306
307 case ID_PASTE:
308 updateColor( aLayer, m_copied );
309 break;
310
311 case ID_REVERT:
312 updateColor( aLayer, saved );
313 break;
314
315 default:
316 aCmd.Skip();
317 }
318 } );
319
320 PopupMenu( &menu );
321}
322
323
324void PANEL_COLOR_SETTINGS::OnColorChanged( wxCommandEvent& aEvent )
325{
326 COLOR_SWATCH* swatch = static_cast<COLOR_SWATCH*>( aEvent.GetEventObject() );
327 COLOR4D newColor = swatch->GetSwatchColor();
328 int layer = static_cast<SCH_LAYER_ID>( swatch->GetId() - FIRST_BUTTON_ID );
329
330 updateColor( layer, newColor );
331}
332
333
334void PANEL_COLOR_SETTINGS::updateColor( int aLayer, const KIGFX::COLOR4D& aColor )
335{
337 m_currentSettings->SetColor( aLayer, aColor );
338
339 // Colors must be persisted when edited because multiple PANEL_COLOR_SETTINGS could be
340 // referring to the same theme.
341 saveCurrentTheme( false );
342
343 m_swatches[aLayer]->SetSwatchColor( aColor, false );
344
345 if( m_currentSettings && aLayer == m_backgroundLayer )
346 {
348
349 for( std::pair<int, COLOR_SWATCH*> pair : m_swatches )
350 pair.second->SetSwatchBackground( background );
351 }
352
354}
355
356
358{
360 return true;
361
362 if( aValidate && !validateSave() )
363 return false;
364
365 SETTINGS_MANAGER& settingsMgr = Pgm().GetSettingsManager();
366 COLOR_SETTINGS* selected = settingsMgr.GetColorSettings( m_currentSettings->GetFilename() );
367
368 selected->SetOverrideSchItemColors( m_optOverrideColors->GetValue() );
369
370 for( int layer : m_validLayers )
371 selected->SetColor( layer, m_currentSettings->GetColor( layer ) );
372
373 settingsMgr.SaveColorSettings( selected, m_colorNamespace );
374
375 return true;
376}
int color
Definition: DXF_plotter.cpp:57
const char * name
Definition: DXF_plotter.cpp:56
wxBitmap KiBitmap(BITMAPS aBitmap, int aHeightTag)
Construct a wxBitmap from an image identifier Returns the image from the active theme if the image ha...
Definition: bitmap.cpp:105
wxMenuItem * AddMenuItem(wxMenu *aMenu, int aId, const wxString &aText, const wxBitmap &aImage, wxItemKind aType=wxITEM_NORMAL)
Create and insert a menu item with an icon into aMenu.
Definition: bitmap.cpp:257
Color settings are a bit different than most of the settings objects in that there can be more than o...
void SetName(const wxString &aName)
void SetColor(int aLayer, const COLOR4D &aColor)
bool GetOverrideSchItemColors() const
COLOR4D GetColor(int aLayer) const
COLOR4D GetDefaultColor(int aLayer)
void SetOverrideSchItemColors(bool aFlag)
const wxString & GetName() const
A simple color swatch of the kind used to set layer colors.
Definition: color_swatch.h:57
void SetSwatchColor(const KIGFX::COLOR4D &aColor, bool aSendEvent)
Set the current swatch color directly.
KIGFX::COLOR4D GetSwatchColor() const
This class provides a custom wxValidator object for limiting the allowable characters when defining f...
Definition: validators.h:64
bool IsReadOnly() const
Definition: json_settings.h:84
void SetReadOnly(bool aReadOnly)
Definition: json_settings.h:85
virtual bool SaveToFile(const wxString &aDirectory="", bool aForce=false)
wxString GetFilename() const
Definition: json_settings.h:73
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:104
Class PANEL_COLOR_SETTINGS_BASE.
void createThemeList(const wxString &aCurrent)
Builds the theme listbox and sets the selection to the current theme.
void createSwatch(int aLayer, const wxString &aName)
std::vector< int > m_validLayers
A list of layer IDs that are valid for the current color settings dialog.
void OnThemeChanged(wxCommandEvent &aEvent) override
virtual bool saveCurrentTheme(bool aValidate)
std::string m_colorNamespace
A namespace that will be passed to SETTINGS_MANAGER::SaveColorSettings.
virtual void ResetPanel() override
Reset the contents of this panel.
void OnBtnOpenThemeFolderClicked(wxCommandEvent &event) override
void OnColorChanged(wxCommandEvent &aEvent)
std::map< int, wxStaticText * > m_labels
virtual void onNewThemeSelected()
Event fired when a new theme is selected that can be overridden in children.
void updateColor(int aLayer, const KIGFX::COLOR4D &aColor)
COLOR_SETTINGS * m_currentSettings
PANEL_COLOR_SETTINGS(wxWindow *aParent)
void ShowColorContextMenu(wxMouseEvent &aEvent, int aLayer)
void OnLeftDownTheme(wxMouseEvent &event) override
bool Show(bool show) override
virtual void createSwatches()=0
virtual void onColorChanged()
Event fired when the user changes any color.
virtual bool validateSave(bool aQuiet=false)
Performs a pre-save validation of the current color theme.
std::map< int, COLOR_SWATCH * > m_swatches
wxString GetPathForSettingsFile(JSON_SETTINGS *aSettings)
Returns the path a given settings file should be loaded from / stored to.
COLOR_SETTINGS * GetColorSettings(const wxString &aName="user")
Retrieves a color settings object that applications can read colors from.
void SaveColorSettings(COLOR_SETTINGS *aSettings, const std::string &aNamespace="")
Safely saves a COLOR_SETTINGS to disk, preserving any changes outside the given namespace.
static wxString GetColorSettingsPath()
Returns the path where color scheme files are stored; creating it if missing (normally .
COLOR_SETTINGS * AddNewColorSettings(const wxString &aFilename)
Registers a new color settings object with the given filename.
@ SWATCH_MEDIUM
Definition: color_swatch.h:41
#define _(s)
bool LaunchExternal(const wxString &aPath)
Launches the given file or folder in the host OS.
Definition: launch_ext.cpp:25
@ LAYER_PCB_BACKGROUND
PCB background color.
Definition: layer_ids.h:220
SCH_LAYER_ID
Eeschema drawing layers.
Definition: layer_ids.h:341
Macros and inline functions to create menus items in menubars or popup menus.
constexpr int FIRST_BUTTON_ID
SETTINGS_MANAGER * GetSettingsManager()
see class PGM_BASE
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:111
Custom text control validator definitions.