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-2023 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>
22#include <launch_ext.h>
23#include <layer_ids.h>
24#include <menus_helpers.h>
26#include <pgm_base.h>
30#include <validators.h>
32#include <widgets/wx_panel.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 m_panel1->SetBorders( false, false, true, false );
58}
59
60
62{
64 LaunchExternal( dir );
65}
66
67
69{
71 return;
72
73 for( const std::pair<const int, COLOR_SWATCH*>& pair : m_swatches )
74 {
75 int layer = pair.first;
76 COLOR_SWATCH* button = pair.second;
77
78 COLOR4D defaultColor = m_currentSettings->GetDefaultColor( layer );
79
80 m_currentSettings->SetColor( layer, defaultColor );
81 button->SetSwatchColor( defaultColor, false );
82 }
83}
84
85
87{
88 if( show )
89 {
90 // In case changes have been made to the current theme in another panel:
91 int idx = m_cbTheme->GetSelection();
92 COLOR_SETTINGS* settings = static_cast<COLOR_SETTINGS*>( m_cbTheme->GetClientData( idx ) );
93
94 if( settings )
95 *m_currentSettings = *settings;
96
99 }
100
101 return PANEL_COLOR_SETTINGS_BASE::Show( show );
102}
103
104
105void PANEL_COLOR_SETTINGS::OnLeftDownTheme( wxMouseEvent& event )
106{
107 // Lazy rebuild of theme menu to catch any colour theme changes made in other panels
109
110 event.Skip();
111}
112
113
114void PANEL_COLOR_SETTINGS::OnThemeChanged( wxCommandEvent& event )
115{
116 int idx = m_cbTheme->GetSelection();
117
118 if( idx == static_cast<int>( m_cbTheme->GetCount() ) - 2 )
119 {
120 // separator; re-select active theme
121 m_cbTheme->SetStringSelection( m_currentSettings->GetName() );
122 return;
123 }
124
125 if( idx == (int)m_cbTheme->GetCount() - 1 )
126 {
127 // New Theme...
128
129 if( !saveCurrentTheme( false ) )
130 return;
131
132 FOOTPRINT_NAME_VALIDATOR themeNameValidator;
133 wxTextEntryDialog dlg( this, _( "New theme name:" ), _( "Add Color Theme" ) );
134 dlg.SetTextValidator( themeNameValidator );
135
136 if( dlg.ShowModal() != wxID_OK )
137 return;
138
139 wxString themeName = dlg.GetValue();
140 wxFileName fn( themeName + wxT( ".json" ) );
142
143 if( fn.Exists() )
144 {
145 wxMessageBox( _( "Theme already exists!" ) );
146 return;
147 }
148
149 SETTINGS_MANAGER& settingsMgr = Pgm().GetSettingsManager();
150 COLOR_SETTINGS* newSettings = settingsMgr.AddNewColorSettings( themeName );
151 newSettings->SetName( themeName );
152 newSettings->SetReadOnly( false );
153
154 for( int layer : m_validLayers )
155 newSettings->SetColor( layer, m_currentSettings->GetColor( layer ) );
156
157 newSettings->SaveToFile( settingsMgr.GetPathForSettingsFile( newSettings ) );
158
159 idx = m_cbTheme->Insert( themeName, idx - 1, static_cast<void*>( newSettings ) );
160 m_cbTheme->SetSelection( idx );
161
162 m_optOverrideColors->SetValue( newSettings->GetOverrideSchItemColors() );
163
164 *m_currentSettings = *newSettings;
167 }
168 else
169 {
170 COLOR_SETTINGS* selected = static_cast<COLOR_SETTINGS*>( m_cbTheme->GetClientData( idx ) );
171
172 if( selected->GetFilename() != m_currentSettings->GetFilename() )
173 {
174 if( !saveCurrentTheme( false ) )
175 return;
176
177 m_optOverrideColors->SetValue( selected->GetOverrideSchItemColors() );
178
179 *m_currentSettings = *selected;
182 }
183 }
184}
185
186
188{
189 if( m_swatches.empty() )
190 {
192 }
193 else
194 {
195 bool isReadOnly = m_currentSettings->IsReadOnly();
197
198 for( std::pair<int, COLOR_SWATCH*> pair : m_swatches )
199 {
200 pair.second->SetSwatchBackground( background );
201 pair.second->SetSwatchColor( m_currentSettings->GetColor( pair.first ), false );
202 pair.second->SetReadOnly( isReadOnly );
203 }
204 }
205}
206
207
208void PANEL_COLOR_SETTINGS::createThemeList( const wxString& aCurrent )
209{
210 int width = 0;
211 int height = 0;
212
213 m_cbTheme->GetTextExtent( _( "New Theme..." ), &width, &height );
214 int minwidth = width;
215
216 m_cbTheme->Clear();
217
218 for( COLOR_SETTINGS* settings : Pgm().GetSettingsManager().GetColorSettingsList() )
219 {
220 wxString name = settings->GetName();
221
222 if( settings->IsReadOnly() )
223 name += wxS( " " ) + _( "(read-only)" );
224
225 int pos = m_cbTheme->Append( name, static_cast<void*>( settings ) );
226
227 if( settings->GetFilename() == aCurrent )
228 m_cbTheme->SetSelection( pos );
229
230 m_cbTheme->GetTextExtent( name, &width, &height );
231 minwidth = std::max( minwidth, width );
232 }
233
234 m_cbTheme->Append( wxT( "---" ) );
235 m_cbTheme->Append( _( "New Theme..." ) );
236
237 m_cbTheme->SetMinSize( wxSize( minwidth + 50, -1 ) );
238}
239
240
241void PANEL_COLOR_SETTINGS::createSwatch( int aLayer, const wxString& aName )
242{
243 wxStaticText* label = new wxStaticText( m_colorsListWindow, wxID_ANY, aName );
244
245 // The previously selected theme can be deleted and cannot be selected.
246 // so select the default theme (first theme of the list)
247 if( m_cbTheme->GetSelection() < 0 )
248 {
249 m_cbTheme->SetSelection( 0 );
251 }
252
253 void* clientData = m_cbTheme->GetClientData( m_cbTheme->GetSelection() );
254 COLOR_SETTINGS* selected = static_cast<COLOR_SETTINGS*>( clientData );
255
256 int id = FIRST_BUTTON_ID + aLayer;
257 COLOR4D defaultColor = selected->GetDefaultColor( aLayer );
260
261 COLOR_SWATCH* swatch = new COLOR_SWATCH( m_colorsListWindow, color, id, backgroundColor,
262 defaultColor, SWATCH_MEDIUM );
263 swatch->SetForegroundColour( wxSystemSettings::GetColour( wxSYS_COLOUR_WINDOW ) );
264
265 m_colorsGridSizer->Add( label, 0, wxALIGN_CENTER_VERTICAL | wxALIGN_LEFT | wxLEFT, 5 );
266 m_colorsGridSizer->Add( swatch, 0, wxALIGN_CENTER_VERTICAL | wxALL, 3 );
267
268 m_labels[aLayer] = label;
269 m_swatches[aLayer] = swatch;
270
271 swatch->Bind( wxEVT_RIGHT_DOWN,
272 [&, aLayer]( wxMouseEvent& aEvent )
273 {
274 ShowColorContextMenu( aEvent, aLayer );
275 } );
276
277 swatch->Bind( COLOR_SWATCH_CHANGED, &PANEL_COLOR_SETTINGS::OnColorChanged, this );
278}
279
280
281void PANEL_COLOR_SETTINGS::ShowColorContextMenu( wxMouseEvent& aEvent, int aLayer )
282{
283 auto selected =
284 static_cast<COLOR_SETTINGS*>( m_cbTheme->GetClientData( m_cbTheme->GetSelection() ) );
285
286 COLOR4D current = m_currentSettings->GetColor( aLayer );
287 COLOR4D saved = selected->GetColor( aLayer );
288 bool readOnly = m_currentSettings->IsReadOnly();
289
290 wxMenu menu;
291
292 AddMenuItem( &menu, ID_COPY, _( "Copy color" ), KiBitmap( BITMAPS::copy ) );
293
294 if( !readOnly && m_copied != COLOR4D::UNSPECIFIED )
295 AddMenuItem( &menu, ID_PASTE, _( "Paste color" ), KiBitmap( BITMAPS::paste ) );
296
297 if( !readOnly && current != saved )
298 AddMenuItem( &menu, ID_REVERT, _( "Revert to saved color" ), KiBitmap( BITMAPS::undo ) );
299
300 menu.Bind( wxEVT_COMMAND_MENU_SELECTED,
301 [&]( wxCommandEvent& aCmd )
302 {
303 switch( aCmd.GetId() )
304 {
305 case ID_COPY:
306 m_copied = current;
307 break;
308
309 case ID_PASTE:
310 updateColor( aLayer, m_copied );
311 break;
312
313 case ID_REVERT:
314 updateColor( aLayer, saved );
315 break;
316
317 default:
318 aCmd.Skip();
319 }
320 } );
321
322 PopupMenu( &menu );
323}
324
325
326void PANEL_COLOR_SETTINGS::OnColorChanged( wxCommandEvent& aEvent )
327{
328 COLOR_SWATCH* swatch = static_cast<COLOR_SWATCH*>( aEvent.GetEventObject() );
329 COLOR4D newColor = swatch->GetSwatchColor();
330 int layer = static_cast<SCH_LAYER_ID>( swatch->GetId() - FIRST_BUTTON_ID );
331
332 updateColor( layer, newColor );
333}
334
335
336void PANEL_COLOR_SETTINGS::updateColor( int aLayer, const KIGFX::COLOR4D& aColor )
337{
339 m_currentSettings->SetColor( aLayer, aColor );
340
341 // Colors must be persisted when edited because multiple PANEL_COLOR_SETTINGS could be
342 // referring to the same theme.
343 saveCurrentTheme( false );
344
345 m_swatches[aLayer]->SetSwatchColor( aColor, false );
346
347 if( m_currentSettings && aLayer == m_backgroundLayer )
348 {
350
351 for( std::pair<int, COLOR_SWATCH*> pair : m_swatches )
352 pair.second->SetSwatchBackground( background );
353 }
354
356}
357
358
360{
362 return true;
363
364 if( aValidate && !validateSave() )
365 return false;
366
367 SETTINGS_MANAGER& settingsMgr = Pgm().GetSettingsManager();
368 COLOR_SETTINGS* selected = settingsMgr.GetColorSettings( m_currentSettings->GetFilename() );
369
370 selected->SetOverrideSchItemColors( m_optOverrideColors->GetValue() );
371
372 for( int layer : m_validLayers )
373 selected->SetColor( layer, m_currentSettings->GetColor( layer ) );
374
375 settingsMgr.SaveColorSettings( selected, m_colorNamespace );
376
377 return true;
378}
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:265
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.
void SetBorders(bool aLeft, bool aRight, bool aTop, bool aBottom)
Definition: wx_panel.h:38
@ 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.