KiCad PCB EDA Suite
PANEL_FP_EDITOR_COLOR_SETTINGS Class Reference

#include <panel_fp_editor_color_settings.h>

Inheritance diagram for PANEL_FP_EDITOR_COLOR_SETTINGS:
PANEL_COLOR_SETTINGS PANEL_COLOR_SETTINGS_BASE RESETTABLE_PANEL

Public Member Functions

 PANEL_FP_EDITOR_COLOR_SETTINGS (FOOTPRINT_EDIT_FRAME *aFrame, wxWindow *aParent)
 
 ~PANEL_FP_EDITOR_COLOR_SETTINGS () override
 
virtual void ResetPanel () override
 Reset the contents of this panel. More...
 
virtual wxString GetResetTooltip () override
 Get the tooltip the reset button should display when showing this panel. More...
 
bool Show (bool show) override
 

Public Attributes

wxCheckBox * m_optOverrideColors
 

Protected Types

enum  COLOR_CONTEXT_ID { ID_COPY = wxID_HIGHEST + 1, ID_PASTE, ID_REVERT }
 

Protected Member Functions

bool TransferDataFromWindow () override
 
bool TransferDataToWindow () override
 
void OnBtnOpenThemeFolderClicked (wxCommandEvent &event) override
 
void OnLeftDownTheme (wxMouseEvent &event) override
 
void OnThemeChanged (wxCommandEvent &aEvent) override
 
void ShowColorContextMenu (wxMouseEvent &aEvent, int aLayer)
 
void OnColorChanged (wxCommandEvent &aEvent)
 
void updateSwatches ()
 
void createThemeList (const wxString &aCurrent)
 Builds the theme listbox and sets the selection to the current theme. More...
 
void createSwatch (int aLayer, const wxString &aName)
 
void updateColor (int aLayer, const KIGFX::COLOR4D &aColor)
 
virtual bool saveCurrentTheme (bool aValidate)
 
virtual bool validateSave (bool aQuiet=false)
 Performs a pre-save validation of the current color theme. More...
 
virtual void onNewThemeSelected ()
 Event fired when a new theme is selected that can be overridden in children. More...
 
virtual void onColorChanged ()
 Event fired when the user changes any color. More...
 
virtual void OnSize (wxSizeEvent &event)
 
virtual void OnOverrideItemColorsClicked (wxCommandEvent &event)
 

Protected Attributes

COLOR_SETTINGSm_currentSettings
 
std::map< int, wxStaticText * > m_labels
 
std::map< int, COLOR_SWATCH * > m_swatches
 
KIGFX::COLOR4D m_copied
 
std::vector< int > m_validLayers
 A list of layer IDs that are valid for the current color settings dialog. More...
 
int m_backgroundLayer
 
std::string m_colorNamespace
 A namespace that will be passed to SETTINGS_MANAGER::SaveColorSettings. More...
 
wxBoxSizer * m_mainSizer
 
wxStaticText * m_staticText9
 
wxChoice * m_cbTheme
 
wxButton * m_btnOpenFolder
 
wxStaticLine * m_staticline2
 
wxBoxSizer * m_colorsMainSizer
 
wxScrolledWindow * m_colorsListWindow
 
wxFlexGridSizer * m_colorsGridSizer
 

Private Member Functions

void createSwatches ()
 

Private Attributes

FOOTPRINT_EDIT_FRAMEm_frame
 
PAGE_INFOm_page
 
TITLE_BLOCKm_titleBlock
 

Detailed Description

Definition at line 35 of file panel_fp_editor_color_settings.h.

Member Enumeration Documentation

◆ COLOR_CONTEXT_ID

Constructor & Destructor Documentation

◆ PANEL_FP_EDITOR_COLOR_SETTINGS()

PANEL_FP_EDITOR_COLOR_SETTINGS::PANEL_FP_EDITOR_COLOR_SETTINGS ( FOOTPRINT_EDIT_FRAME aFrame,
wxWindow *  aParent 
)

Definition at line 32 of file panel_fp_editor_color_settings.cpp.

34  : PANEL_COLOR_SETTINGS( aParent ),
35  m_frame( aFrame ),
36  m_page( nullptr ),
37  m_titleBlock( nullptr )
38 {
39  // Currently this only applies to eeschema
40  m_optOverrideColors->Hide();
41 
42  m_colorNamespace = "board";
43 
45 
47  COLOR_SETTINGS* current = mgr->GetColorSettings( settings->m_ColorTheme );
48 
49  // Store the current settings before reloading below
50  current->Store();
51  mgr->SaveColorSettings( current, "board" );
52 
53  m_optOverrideColors->SetValue( current->GetOverrideSchItemColors() );
54 
55  m_currentSettings = new COLOR_SETTINGS( *current );
56 
57  mgr->ReloadColorSettings();
58  createThemeList( settings->m_ColorTheme );
59 
60  m_validLayers.push_back( F_Cu );
61  m_validLayers.push_back( In1_Cu ); // "Internal Layers"
62  m_validLayers.push_back( B_Cu );
63 
64  for( int id = GAL_LAYER_ID_START; id < GAL_LAYER_ID_END; id++ )
65  {
66  if( id == LAYER_VIAS
67  || id == LAYER_VIA_HOLES
68  || id == LAYER_VIA_HOLEWALLS
69  || id == LAYER_PAD_PLATEDHOLES
70  || id == LAYER_PAD_HOLEWALLS )
71  {
72  continue;
73  }
74 
75  m_validLayers.push_back( id );
76  }
77 
79 
80  m_colorsMainSizer->Insert( 0, 10, 0, 0, wxEXPAND, 5 );
81 
83 }
virtual bool Store()
Stores the current parameters into the JSON document represented by this object Note: this doesn't do...
SETTINGS_MANAGER * GetSettingsManager() const
to draw via holes (pad holes do not use this layer)
Definition: layer_ids.h:211
std::string m_colorNamespace
A namespace that will be passed to SETTINGS_MANAGER::SaveColorSettings.
Meta control for all vias opacity/visibility.
Definition: layer_ids.h:189
void createThemeList(const wxString &aCurrent)
Builds the theme listbox and sets the selection to the current theme.
COLOR_SETTINGS * m_currentSettings
T * GetAppSettings(bool aLoadNow=true)
Returns a handle to the a given settings by type If the settings have already been loaded,...
PANEL_COLOR_SETTINGS(wxWindow *aParent)
std::vector< int > m_validLayers
A list of layer IDs that are valid for the current color settings dialog.
COLOR_SETTINGS * GetColorSettings(const wxString &aName="user")
Retrieves a color settings object that applications can read colors from.
void ReloadColorSettings()
Re-scans the color themes directory, reloading any changes it finds.
Definition: layer_ids.h:71
void SaveColorSettings(COLOR_SETTINGS *aSettings, const std::string &aNamespace="")
Safely saves a COLOR_SETTINGS to disk, preserving any changes outside the given namespace.
PCB background color.
Definition: layer_ids.h:216
Color settings are a bit different than most of the settings objects in that there can be more than o...
to draw pad holes (plated)
Definition: layer_ids.h:210
wxString m_ColorTheme
Active color theme name.
Definition: app_settings.h:184

References B_Cu, createSwatches(), PANEL_COLOR_SETTINGS::createThemeList(), F_Cu, GAL_LAYER_ID_END, GAL_LAYER_ID_START, SETTINGS_MANAGER::GetAppSettings(), SETTINGS_MANAGER::GetColorSettings(), EDA_BASE_FRAME::GetSettingsManager(), In1_Cu, LAYER_PAD_HOLEWALLS, LAYER_PAD_PLATEDHOLES, LAYER_PCB_BACKGROUND, LAYER_VIA_HOLES, LAYER_VIA_HOLEWALLS, LAYER_VIAS, PANEL_COLOR_SETTINGS::m_backgroundLayer, PANEL_COLOR_SETTINGS::m_colorNamespace, PANEL_COLOR_SETTINGS_BASE::m_colorsMainSizer, APP_SETTINGS_BASE::m_ColorTheme, PANEL_COLOR_SETTINGS::m_currentSettings, m_frame, PANEL_COLOR_SETTINGS_BASE::m_optOverrideColors, PANEL_COLOR_SETTINGS::m_validLayers, SETTINGS_MANAGER::ReloadColorSettings(), SETTINGS_MANAGER::SaveColorSettings(), and JSON_SETTINGS::Store().

◆ ~PANEL_FP_EDITOR_COLOR_SETTINGS()

PANEL_FP_EDITOR_COLOR_SETTINGS::~PANEL_FP_EDITOR_COLOR_SETTINGS ( )
override

Member Function Documentation

◆ createSwatch()

void PANEL_COLOR_SETTINGS::createSwatch ( int  aLayer,
const wxString &  aName 
)
protectedinherited

Definition at line 232 of file panel_color_settings.cpp.

233 {
234  wxStaticText* label = new wxStaticText( m_colorsListWindow, wxID_ANY, aName );
235 
236  // The previously selected theme can be deleted and cannot be selected.
237  // so select the default theme (first theme of the list)
238  if( m_cbTheme->GetSelection() < 0 )
239  {
240  m_cbTheme->SetSelection( 0 );
242  }
243 
244  void* clientData = m_cbTheme->GetClientData( m_cbTheme->GetSelection() );
245  COLOR_SETTINGS* selected = static_cast<COLOR_SETTINGS*>( clientData );
246 
247  int id = FIRST_BUTTON_ID + aLayer;
248  COLOR4D defaultColor = selected->GetDefaultColor( aLayer );
250  COLOR4D backgroundColor = m_currentSettings->GetColor( m_backgroundLayer );
251 
252  COLOR_SWATCH* swatch = new COLOR_SWATCH( m_colorsListWindow, color, id, backgroundColor,
253  defaultColor, SWATCH_MEDIUM );
254  swatch->SetForegroundColour( wxSystemSettings::GetColour( wxSYS_COLOUR_WINDOW ) );
255 
256  m_colorsGridSizer->Add( label, 0, wxALIGN_CENTER_VERTICAL | wxALIGN_LEFT | wxLEFT, 5 );
257  m_colorsGridSizer->Add( swatch, 0, wxALIGN_CENTER_VERTICAL | wxALL, 3 );
258 
259  m_labels[aLayer] = label;
260  m_swatches[aLayer] = swatch;
261 
262  swatch->Bind( wxEVT_RIGHT_DOWN,
263  [&, aLayer]( wxMouseEvent& aEvent )
264  {
265  ShowColorContextMenu( aEvent, aLayer );
266  } );
267 
268  swatch->Bind( COLOR_SWATCH_CHANGED, &PANEL_COLOR_SETTINGS::OnColorChanged, this );
269 }
int color
Definition: DXF_plotter.cpp:57
std::map< int, wxStaticText * > m_labels
virtual void onNewThemeSelected()
Event fired when a new theme is selected that can be overridden in children.
std::map< int, COLOR_SWATCH * > m_swatches
void ShowColorContextMenu(wxMouseEvent &aEvent, int aLayer)
COLOR_SETTINGS * m_currentSettings
COLOR4D GetDefaultColor(int aLayer)
constexpr int FIRST_BUTTON_ID
COLOR4D GetColor(int aLayer) const
A simple color swatch of the kind used to set layer colors.
Definition: color_swatch.h:56
Color settings are a bit different than most of the settings objects in that there can be more than o...
void OnColorChanged(wxCommandEvent &aEvent)
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:103

References color, FIRST_BUTTON_ID, COLOR_SETTINGS::GetColor(), COLOR_SETTINGS::GetDefaultColor(), PANEL_COLOR_SETTINGS::m_backgroundLayer, PANEL_COLOR_SETTINGS_BASE::m_cbTheme, PANEL_COLOR_SETTINGS_BASE::m_colorsGridSizer, PANEL_COLOR_SETTINGS_BASE::m_colorsListWindow, PANEL_COLOR_SETTINGS::m_currentSettings, PANEL_COLOR_SETTINGS::m_labels, PANEL_COLOR_SETTINGS::m_swatches, PANEL_COLOR_SETTINGS::OnColorChanged(), PANEL_COLOR_SETTINGS::onNewThemeSelected(), PANEL_COLOR_SETTINGS::ShowColorContextMenu(), and SWATCH_MEDIUM.

Referenced by createSwatches(), PANEL_PCBNEW_COLOR_SETTINGS::createSwatches(), and PANEL_EESCHEMA_COLOR_SETTINGS::createSwatches().

◆ createSwatches()

void PANEL_FP_EDITOR_COLOR_SETTINGS::createSwatches ( )
private

Definition at line 110 of file panel_fp_editor_color_settings.cpp.

111 {
112  std::vector<GAL_LAYER_ID> galLayers;
113 
114  // Sort the gal layers by name
115  for( int i : m_validLayers )
116  {
117  if( i >= GAL_LAYER_ID_START && m_currentSettings->GetColor( i ) != COLOR4D::UNSPECIFIED )
118  galLayers.push_back( (GAL_LAYER_ID) i );
119  }
120 
121  std::sort( galLayers.begin(), galLayers.end(),
122  []( int a, int b )
123  {
124  return LayerName( a ) < LayerName( b );
125  } );
126 
127  BOARD* board = m_frame->GetBoard();
128 
129  createSwatch( F_Cu, board ? board->GetLayerName( F_Cu ) : LayerName( F_Cu ) );
130  createSwatch( In1_Cu, _( "Internal Layers" ) );
131  createSwatch( B_Cu, board ? board->GetLayerName( B_Cu ) : LayerName( B_Cu ) );
132 
133  for( GAL_LAYER_ID layer : galLayers )
134  createSwatch( layer, LayerName( layer ) );
135 }
GAL_LAYER_ID
GAL layers are "virtual" layers, i.e.
Definition: layer_ids.h:185
COLOR_SETTINGS * m_currentSettings
#define _(s)
wxString LayerName(int aLayer)
Returns the default display name for a given layer.
Definition: layer_id.cpp:27
std::vector< int > m_validLayers
A list of layer IDs that are valid for the current color settings dialog.
COLOR4D GetColor(int aLayer) const
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:190
Definition: layer_ids.h:71
BOARD * GetBoard() const
void createSwatch(int aLayer, const wxString &aName)

References _, B_Cu, PANEL_COLOR_SETTINGS::createSwatch(), F_Cu, GAL_LAYER_ID_START, PCB_BASE_FRAME::GetBoard(), COLOR_SETTINGS::GetColor(), In1_Cu, LayerName(), PANEL_COLOR_SETTINGS::m_currentSettings, m_frame, and PANEL_COLOR_SETTINGS::m_validLayers.

Referenced by PANEL_FP_EDITOR_COLOR_SETTINGS().

◆ createThemeList()

void PANEL_COLOR_SETTINGS::createThemeList ( const wxString &  aCurrent)
protectedinherited

Builds the theme listbox and sets the selection to the current theme.

Parameters
aCurrentis the filename of the current color theme (no extension)

Definition at line 199 of file panel_color_settings.cpp.

200 {
201  int width = 0;
202  int height = 0;
203 
204  m_cbTheme->GetTextExtent( _( "New Theme..." ), &width, &height );
205  int minwidth = width;
206 
207  m_cbTheme->Clear();
208 
209  for( COLOR_SETTINGS* settings : Pgm().GetSettingsManager().GetColorSettingsList() )
210  {
211  wxString name = settings->GetName();
212 
213  if( settings->IsReadOnly() )
214  name += wxS( " " ) + _( "(read-only)" );
215 
216  int pos = m_cbTheme->Append( name, static_cast<void*>( settings ) );
217 
218  if( settings->GetFilename() == aCurrent )
219  m_cbTheme->SetSelection( pos );
220 
221  m_cbTheme->GetTextExtent( name, &width, &height );
222  minwidth = std::max( minwidth, width );
223  }
224 
225  m_cbTheme->Append( wxT( "---" ) );
226  m_cbTheme->Append( _( "New Theme..." ) );
227 
228  m_cbTheme->SetMinSize( wxSize( minwidth + 50, -1 ) );
229 }
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
#define _(s)
SETTINGS_MANAGER * GetSettingsManager()
const char * name
Definition: DXF_plotter.cpp:56
Color settings are a bit different than most of the settings objects in that there can be more than o...

References _, GetSettingsManager(), PANEL_COLOR_SETTINGS_BASE::m_cbTheme, name, and Pgm().

Referenced by PANEL_COLOR_SETTINGS::OnLeftDownTheme(), PANEL_EESCHEMA_COLOR_SETTINGS::PANEL_EESCHEMA_COLOR_SETTINGS(), PANEL_FP_EDITOR_COLOR_SETTINGS(), and PANEL_PCBNEW_COLOR_SETTINGS::PANEL_PCBNEW_COLOR_SETTINGS().

◆ GetResetTooltip()

virtual wxString PANEL_COLOR_SETTINGS::GetResetTooltip ( )
inlineoverridevirtualinherited

Get the tooltip the reset button should display when showing this panel.

Returns
the tooltip

Reimplemented from RESETTABLE_PANEL.

Definition at line 48 of file panel_color_settings.h.

49  {
50  return _( "Reset all colors in this theme to the KiCad defaults" );
51  }
#define _(s)

References _.

◆ OnBtnOpenThemeFolderClicked()

void PANEL_COLOR_SETTINGS::OnBtnOpenThemeFolderClicked ( wxCommandEvent &  event)
overrideprotectedvirtualinherited

Reimplemented from PANEL_COLOR_SETTINGS_BASE.

Definition at line 59 of file panel_color_settings.cpp.

60 {
62  LaunchExternal( dir );
63 }
static wxString GetColorSettingsPath()
Returns the path where color scheme files are stored; creating it if missing (normally .
void LaunchExternal(const wxString &aPath)
Launches the given file or folder in the host OS.
Definition: launch_ext.cpp:25

References SETTINGS_MANAGER::GetColorSettingsPath(), and LaunchExternal().

◆ OnColorChanged()

void PANEL_COLOR_SETTINGS::OnColorChanged ( wxCommandEvent &  aEvent)
protectedinherited

Definition at line 317 of file panel_color_settings.cpp.

318 {
319  COLOR_SWATCH* swatch = static_cast<COLOR_SWATCH*>( aEvent.GetEventObject() );
320  COLOR4D newColor = swatch->GetSwatchColor();
321  LAYER_NUM layer = static_cast<SCH_LAYER_ID>( swatch->GetId() - FIRST_BUTTON_ID );
322 
323  updateColor( layer, newColor );
324 }
KIGFX::COLOR4D GetSwatchColor() const
int LAYER_NUM
This can be replaced with int and removed.
Definition: layer_ids.h:41
void updateColor(int aLayer, const KIGFX::COLOR4D &aColor)
constexpr int FIRST_BUTTON_ID
A simple color swatch of the kind used to set layer colors.
Definition: color_swatch.h:56
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:103

References FIRST_BUTTON_ID, COLOR_SWATCH::GetSwatchColor(), and PANEL_COLOR_SETTINGS::updateColor().

Referenced by PANEL_COLOR_SETTINGS::createSwatch().

◆ onColorChanged()

virtual void PANEL_COLOR_SETTINGS::onColorChanged ( )
inlineprotectedvirtualinherited

Event fired when the user changes any color.

Reimplemented in PANEL_EESCHEMA_COLOR_SETTINGS, and PANEL_PCBNEW_COLOR_SETTINGS.

Definition at line 97 of file panel_color_settings.h.

97 {}

Referenced by PANEL_COLOR_SETTINGS::updateColor().

◆ OnLeftDownTheme()

void PANEL_COLOR_SETTINGS::OnLeftDownTheme ( wxMouseEvent &  event)
overrideprotectedvirtualinherited

Reimplemented from PANEL_COLOR_SETTINGS_BASE.

Definition at line 103 of file panel_color_settings.cpp.

104 {
105  // Lazy rebuild of theme menu to catch any colour theme changes made in other panels
107 
108  event.Skip();
109 }
wxString GetFilename() const
Definition: json_settings.h:72
void createThemeList(const wxString &aCurrent)
Builds the theme listbox and sets the selection to the current theme.
COLOR_SETTINGS * m_currentSettings

References PANEL_COLOR_SETTINGS::createThemeList(), JSON_SETTINGS::GetFilename(), and PANEL_COLOR_SETTINGS::m_currentSettings.

◆ onNewThemeSelected()

virtual void PANEL_COLOR_SETTINGS::onNewThemeSelected ( )
inlineprotectedvirtualinherited

Event fired when a new theme is selected that can be overridden in children.

Reimplemented in PANEL_EESCHEMA_COLOR_SETTINGS, and PANEL_PCBNEW_COLOR_SETTINGS.

Definition at line 92 of file panel_color_settings.h.

92 {}

Referenced by PANEL_COLOR_SETTINGS::createSwatch(), PANEL_COLOR_SETTINGS::OnThemeChanged(), and PANEL_COLOR_SETTINGS::Show().

◆ OnOverrideItemColorsClicked()

virtual void PANEL_COLOR_SETTINGS_BASE::OnOverrideItemColorsClicked ( wxCommandEvent &  event)
inlineprotectedvirtualinherited

◆ OnSize()

virtual void PANEL_COLOR_SETTINGS_BASE::OnSize ( wxSizeEvent &  event)
inlineprotectedvirtualinherited

◆ OnThemeChanged()

void PANEL_COLOR_SETTINGS::OnThemeChanged ( wxCommandEvent &  aEvent)
overrideprotectedvirtualinherited

Reimplemented from PANEL_COLOR_SETTINGS_BASE.

Definition at line 112 of file panel_color_settings.cpp.

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( auto 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;
163  updateSwatches();
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;
179  updateSwatches();
180  }
181  }
182 }
virtual bool saveCurrentTheme(bool aValidate)
void SetReadOnly(bool aReadOnly)
Definition: json_settings.h:83
wxString GetFilename() const
Definition: json_settings.h:72
virtual void onNewThemeSelected()
Event fired when a new theme is selected that can be overridden in children.
void SetColor(int aLayer, const COLOR4D &aColor)
const wxString & GetName() const
COLOR_SETTINGS * AddNewColorSettings(const wxString &aFilename)
Registers a new color settings object with the given filename.
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
This class provides a custom wxValidator object for limiting the allowable characters when defining f...
Definition: validators.h:63
virtual bool SaveToFile(const wxString &aDirectory="", bool aForce=false)
COLOR_SETTINGS * m_currentSettings
#define _(s)
void SetName(const wxString &aName)
std::vector< int > m_validLayers
A list of layer IDs that are valid for the current color settings dialog.
static wxString GetColorSettingsPath()
Returns the path where color scheme files are stored; creating it if missing (normally .
COLOR4D GetColor(int aLayer) const
Color settings are a bit different than most of the settings objects in that there can be more than o...
bool GetOverrideSchItemColors() const
wxString GetPathForSettingsFile(JSON_SETTINGS *aSettings)
Returns the path a given settings file should be loaded from / stored to.

References _, SETTINGS_MANAGER::AddNewColorSettings(), COLOR_SETTINGS::GetColor(), SETTINGS_MANAGER::GetColorSettingsPath(), JSON_SETTINGS::GetFilename(), COLOR_SETTINGS::GetName(), COLOR_SETTINGS::GetOverrideSchItemColors(), SETTINGS_MANAGER::GetPathForSettingsFile(), PANEL_COLOR_SETTINGS_BASE::m_cbTheme, PANEL_COLOR_SETTINGS::m_currentSettings, PANEL_COLOR_SETTINGS_BASE::m_optOverrideColors, PANEL_COLOR_SETTINGS::m_validLayers, PANEL_COLOR_SETTINGS::onNewThemeSelected(), Pgm(), PANEL_COLOR_SETTINGS::saveCurrentTheme(), JSON_SETTINGS::SaveToFile(), COLOR_SETTINGS::SetColor(), COLOR_SETTINGS::SetName(), JSON_SETTINGS::SetReadOnly(), and PANEL_COLOR_SETTINGS::updateSwatches().

◆ ResetPanel()

void PANEL_COLOR_SETTINGS::ResetPanel ( )
overridevirtualinherited

Reset the contents of this panel.

Implements RESETTABLE_PANEL.

Reimplemented in PANEL_EESCHEMA_COLOR_SETTINGS, and PANEL_PCBNEW_COLOR_SETTINGS.

Definition at line 66 of file panel_color_settings.cpp.

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 }
void SetSwatchColor(const KIGFX::COLOR4D &aColor, bool aSendEvent)
Set the current swatch color directly.
void SetColor(int aLayer, const COLOR4D &aColor)
std::map< int, COLOR_SWATCH * > m_swatches
COLOR_SETTINGS * m_currentSettings
COLOR4D GetDefaultColor(int aLayer)
A simple color swatch of the kind used to set layer colors.
Definition: color_swatch.h:56
bool IsReadOnly() const
Definition: json_settings.h:82
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:103

References COLOR_SETTINGS::GetDefaultColor(), JSON_SETTINGS::IsReadOnly(), PANEL_COLOR_SETTINGS::m_currentSettings, PANEL_COLOR_SETTINGS::m_swatches, COLOR_SETTINGS::SetColor(), and COLOR_SWATCH::SetSwatchColor().

Referenced by PANEL_PCBNEW_COLOR_SETTINGS::ResetPanel(), and PANEL_EESCHEMA_COLOR_SETTINGS::ResetPanel().

◆ saveCurrentTheme()

bool PANEL_COLOR_SETTINGS::saveCurrentTheme ( bool  aValidate)
protectedvirtualinherited

Reimplemented in PANEL_EESCHEMA_COLOR_SETTINGS.

Definition at line 350 of file panel_color_settings.cpp.

351 {
353  return true;
354 
355  if( aValidate && !validateSave() )
356  return false;
357 
358  SETTINGS_MANAGER& settingsMgr = Pgm().GetSettingsManager();
359  COLOR_SETTINGS* selected = settingsMgr.GetColorSettings( m_currentSettings->GetFilename() );
360 
361  selected->SetOverrideSchItemColors( m_optOverrideColors->GetValue() );
362 
363  for( auto layer : m_validLayers )
364  selected->SetColor( layer, m_currentSettings->GetColor( layer ) );
365 
366  settingsMgr.SaveColorSettings( selected, m_colorNamespace );
367 
368  return true;
369 }
wxString GetFilename() const
Definition: json_settings.h:72
void SetColor(int aLayer, const COLOR4D &aColor)
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
std::string m_colorNamespace
A namespace that will be passed to SETTINGS_MANAGER::SaveColorSettings.
COLOR_SETTINGS * m_currentSettings
void SetOverrideSchItemColors(bool aFlag)
std::vector< int > m_validLayers
A list of layer IDs that are valid for the current color settings dialog.
COLOR_SETTINGS * GetColorSettings(const wxString &aName="user")
Retrieves a color settings object that applications can read colors from.
COLOR4D GetColor(int aLayer) const
void SaveColorSettings(COLOR_SETTINGS *aSettings, const std::string &aNamespace="")
Safely saves a COLOR_SETTINGS to disk, preserving any changes outside the given namespace.
bool IsReadOnly() const
Definition: json_settings.h:82
Color settings are a bit different than most of the settings objects in that there can be more than o...
virtual bool validateSave(bool aQuiet=false)
Performs a pre-save validation of the current color theme.

References COLOR_SETTINGS::GetColor(), SETTINGS_MANAGER::GetColorSettings(), JSON_SETTINGS::GetFilename(), JSON_SETTINGS::IsReadOnly(), PANEL_COLOR_SETTINGS::m_colorNamespace, PANEL_COLOR_SETTINGS::m_currentSettings, PANEL_COLOR_SETTINGS_BASE::m_optOverrideColors, PANEL_COLOR_SETTINGS::m_validLayers, Pgm(), SETTINGS_MANAGER::SaveColorSettings(), COLOR_SETTINGS::SetColor(), COLOR_SETTINGS::SetOverrideSchItemColors(), and PANEL_COLOR_SETTINGS::validateSave().

Referenced by PANEL_COLOR_SETTINGS::OnThemeChanged(), PANEL_EESCHEMA_COLOR_SETTINGS::saveCurrentTheme(), and PANEL_COLOR_SETTINGS::updateColor().

◆ Show()

bool PANEL_COLOR_SETTINGS::Show ( bool  show)
overrideinherited

Definition at line 84 of file panel_color_settings.cpp.

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 }
virtual void onNewThemeSelected()
Event fired when a new theme is selected that can be overridden in children.
COLOR_SETTINGS * m_currentSettings
Color settings are a bit different than most of the settings objects in that there can be more than o...

References PANEL_COLOR_SETTINGS_BASE::m_cbTheme, PANEL_COLOR_SETTINGS::m_currentSettings, PANEL_COLOR_SETTINGS::onNewThemeSelected(), and PANEL_COLOR_SETTINGS::updateSwatches().

◆ ShowColorContextMenu()

void PANEL_COLOR_SETTINGS::ShowColorContextMenu ( wxMouseEvent &  aEvent,
int  aLayer 
)
protectedinherited

Definition at line 272 of file panel_color_settings.cpp.

273 {
274  auto selected =
275  static_cast<COLOR_SETTINGS*>( m_cbTheme->GetClientData( m_cbTheme->GetSelection() ) );
276 
277  COLOR4D current = m_currentSettings->GetColor( aLayer );
278  COLOR4D saved = selected->GetColor( aLayer );
279  bool readOnly = m_currentSettings->IsReadOnly();
280 
281  wxMenu menu;
282 
283  AddMenuItem( &menu, ID_COPY, _( "Copy color" ), KiBitmap( BITMAPS::copy ) );
284 
285  if( !readOnly && m_copied != COLOR4D::UNSPECIFIED )
286  AddMenuItem( &menu, ID_PASTE, _( "Paste color" ), KiBitmap( BITMAPS::paste ) );
287 
288  if( !readOnly && current != saved )
289  AddMenuItem( &menu, ID_REVERT, _( "Revert to saved color" ), KiBitmap( BITMAPS::undo ) );
290 
291  menu.Bind( wxEVT_COMMAND_MENU_SELECTED,
292  [&]( wxCommandEvent& aCmd )
293  {
294  switch( aCmd.GetId() )
295  {
296  case ID_COPY:
297  m_copied = current;
298  break;
299 
300  case ID_PASTE:
301  updateColor( aLayer, m_copied );
302  break;
303 
304  case ID_REVERT:
305  updateColor( aLayer, saved );
306  break;
307 
308  default:
309  aCmd.Skip();
310  }
311  } );
312 
313  PopupMenu( &menu );
314 }
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
void updateColor(int aLayer, const KIGFX::COLOR4D &aColor)
COLOR_SETTINGS * m_currentSettings
#define _(s)
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
COLOR4D GetColor(int aLayer) const
bool IsReadOnly() const
Definition: json_settings.h:82
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:103

References _, AddMenuItem(), copy, COLOR_SETTINGS::GetColor(), PANEL_COLOR_SETTINGS::ID_COPY, PANEL_COLOR_SETTINGS::ID_PASTE, PANEL_COLOR_SETTINGS::ID_REVERT, JSON_SETTINGS::IsReadOnly(), KiBitmap(), PANEL_COLOR_SETTINGS_BASE::m_cbTheme, PANEL_COLOR_SETTINGS::m_copied, PANEL_COLOR_SETTINGS::m_currentSettings, paste, undo, and PANEL_COLOR_SETTINGS::updateColor().

Referenced by PANEL_COLOR_SETTINGS::createSwatch().

◆ TransferDataFromWindow()

bool PANEL_FP_EDITOR_COLOR_SETTINGS::TransferDataFromWindow ( )
overrideprotected

Definition at line 94 of file panel_fp_editor_color_settings.cpp.

95 {
99 
100  return true;
101 }
SETTINGS_MANAGER * GetSettingsManager() const
wxString GetFilename() const
Definition: json_settings.h:72
COLOR_SETTINGS * m_currentSettings
T * GetAppSettings(bool aLoadNow=true)
Returns a handle to the a given settings by type If the settings have already been loaded,...
wxString m_ColorTheme
Active color theme name.
Definition: app_settings.h:184

References SETTINGS_MANAGER::GetAppSettings(), JSON_SETTINGS::GetFilename(), EDA_BASE_FRAME::GetSettingsManager(), APP_SETTINGS_BASE::m_ColorTheme, PANEL_COLOR_SETTINGS::m_currentSettings, and m_frame.

◆ TransferDataToWindow()

bool PANEL_FP_EDITOR_COLOR_SETTINGS::TransferDataToWindow ( )
overrideprotected

Definition at line 104 of file panel_fp_editor_color_settings.cpp.

105 {
106  return true;
107 }

◆ updateColor()

void PANEL_COLOR_SETTINGS::updateColor ( int  aLayer,
const KIGFX::COLOR4D aColor 
)
protectedinherited

Definition at line 327 of file panel_color_settings.cpp.

328 {
329  if( m_currentSettings )
330  m_currentSettings->SetColor( aLayer, aColor );
331 
332  // Colors must be persisted when edited because multiple PANEL_COLOR_SETTINGS could be
333  // referring to the same theme.
334  saveCurrentTheme( false );
335 
336  m_swatches[aLayer]->SetSwatchColor( aColor, false );
337 
338  if( m_currentSettings && aLayer == m_backgroundLayer )
339  {
341 
342  for( std::pair<int, COLOR_SWATCH*> pair : m_swatches )
343  pair.second->SetSwatchBackground( background );
344  }
345 
346  onColorChanged();
347 }
virtual bool saveCurrentTheme(bool aValidate)
void SetColor(int aLayer, const COLOR4D &aColor)
std::map< int, COLOR_SWATCH * > m_swatches
COLOR_SETTINGS * m_currentSettings
virtual void onColorChanged()
Event fired when the user changes any color.
COLOR4D GetColor(int aLayer) const
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:103

References COLOR_SETTINGS::GetColor(), PANEL_COLOR_SETTINGS::m_backgroundLayer, PANEL_COLOR_SETTINGS::m_currentSettings, PANEL_COLOR_SETTINGS::m_swatches, PANEL_COLOR_SETTINGS::onColorChanged(), PANEL_COLOR_SETTINGS::saveCurrentTheme(), and COLOR_SETTINGS::SetColor().

Referenced by PANEL_COLOR_SETTINGS::OnColorChanged(), and PANEL_COLOR_SETTINGS::ShowColorContextMenu().

◆ updateSwatches()

void PANEL_COLOR_SETTINGS::updateSwatches ( )
protectedinherited

Definition at line 185 of file panel_color_settings.cpp.

186 {
187  bool isReadOnly = m_currentSettings->IsReadOnly();
189 
190  for( std::pair<int, COLOR_SWATCH*> pair : m_swatches )
191  {
192  pair.second->SetSwatchBackground( background );
193  pair.second->SetSwatchColor( m_currentSettings->GetColor( pair.first ), false );
194  pair.second->SetReadOnly( isReadOnly );
195  }
196 }
std::map< int, COLOR_SWATCH * > m_swatches
COLOR_SETTINGS * m_currentSettings
COLOR4D GetColor(int aLayer) const
bool IsReadOnly() const
Definition: json_settings.h:82
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:103

References COLOR_SETTINGS::GetColor(), JSON_SETTINGS::IsReadOnly(), PANEL_COLOR_SETTINGS::m_backgroundLayer, PANEL_COLOR_SETTINGS::m_currentSettings, and PANEL_COLOR_SETTINGS::m_swatches.

Referenced by PANEL_COLOR_SETTINGS::OnThemeChanged(), and PANEL_COLOR_SETTINGS::Show().

◆ validateSave()

virtual bool PANEL_COLOR_SETTINGS::validateSave ( bool  aQuiet = false)
inlineprotectedvirtualinherited

Performs a pre-save validation of the current color theme.

Parameters
aQuietwill suppress any warning output (prompt dialogs)
Returns
true if save is allowed

Reimplemented in PANEL_EESCHEMA_COLOR_SETTINGS.

Definition at line 84 of file panel_color_settings.h.

85  {
86  return true;
87  }

Referenced by PANEL_COLOR_SETTINGS::saveCurrentTheme().

Member Data Documentation

◆ m_backgroundLayer

◆ m_btnOpenFolder

wxButton* PANEL_COLOR_SETTINGS_BASE::m_btnOpenFolder
protectedinherited

◆ m_cbTheme

◆ m_colorNamespace

std::string PANEL_COLOR_SETTINGS::m_colorNamespace
protectedinherited

A namespace that will be passed to SETTINGS_MANAGER::SaveColorSettings.

This should be set to the appropriate namespace in the application-specific constructor

Definition at line 122 of file panel_color_settings.h.

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::PANEL_EESCHEMA_COLOR_SETTINGS(), PANEL_FP_EDITOR_COLOR_SETTINGS(), PANEL_PCBNEW_COLOR_SETTINGS::PANEL_PCBNEW_COLOR_SETTINGS(), and PANEL_COLOR_SETTINGS::saveCurrentTheme().

◆ m_colorsGridSizer

◆ m_colorsListWindow

◆ m_colorsMainSizer

◆ m_copied

KIGFX::COLOR4D PANEL_COLOR_SETTINGS::m_copied
protectedinherited

Definition at line 104 of file panel_color_settings.h.

Referenced by PANEL_COLOR_SETTINGS::ShowColorContextMenu().

◆ m_currentSettings

◆ m_frame

FOOTPRINT_EDIT_FRAME* PANEL_FP_EDITOR_COLOR_SETTINGS::m_frame
private

◆ m_labels

std::map<int, wxStaticText*> PANEL_COLOR_SETTINGS::m_labels
protectedinherited

◆ m_mainSizer

wxBoxSizer* PANEL_COLOR_SETTINGS_BASE::m_mainSizer
protectedinherited

◆ m_optOverrideColors

◆ m_page

PAGE_INFO* PANEL_FP_EDITOR_COLOR_SETTINGS::m_page
private

Definition at line 56 of file panel_fp_editor_color_settings.h.

Referenced by ~PANEL_FP_EDITOR_COLOR_SETTINGS().

◆ m_staticline2

wxStaticLine* PANEL_COLOR_SETTINGS_BASE::m_staticline2
protectedinherited

◆ m_staticText9

wxStaticText* PANEL_COLOR_SETTINGS_BASE::m_staticText9
protectedinherited

◆ m_swatches

◆ m_titleBlock

TITLE_BLOCK* PANEL_FP_EDITOR_COLOR_SETTINGS::m_titleBlock
private

Definition at line 57 of file panel_fp_editor_color_settings.h.

Referenced by ~PANEL_FP_EDITOR_COLOR_SETTINGS().

◆ m_validLayers

std::vector<int> PANEL_COLOR_SETTINGS::m_validLayers
protectedinherited

A list of layer IDs that are valid for the current color settings dialog.

Valid colors will be shown for editing and are the set of colors that actions like resetting to defaults will apply to.

This list must be filled in the application-specific color settings panel constructors.

Definition at line 114 of file panel_color_settings.h.

Referenced by createSwatches(), PANEL_PCBNEW_COLOR_SETTINGS::createSwatches(), PANEL_COLOR_SETTINGS::OnThemeChanged(), PANEL_EESCHEMA_COLOR_SETTINGS::PANEL_EESCHEMA_COLOR_SETTINGS(), PANEL_FP_EDITOR_COLOR_SETTINGS(), PANEL_PCBNEW_COLOR_SETTINGS::PANEL_PCBNEW_COLOR_SETTINGS(), PANEL_EESCHEMA_COLOR_SETTINGS::saveCurrentTheme(), and PANEL_COLOR_SETTINGS::saveCurrentTheme().


The documentation for this class was generated from the following files: