#include <panel_color_settings.h>

Inheritance diagram for PANEL_COLOR_SETTINGS:

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

Public Member Functions
	PANEL_COLOR_SETTINGS (wxWindow *aParent)

	~PANEL_COLOR_SETTINGS ()=default

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 Member Functions
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_SETTINGS *	m_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

Detailed Description

Definition at line 32 of file panel_color_settings.h.

Member Enumeration Documentation

◆ COLOR_CONTEXT_ID

enum PANEL_COLOR_SETTINGS::COLOR_CONTEXT_ID

Enumerator
ID_COPY
ID_PASTE
ID_REVERT

Definition at line 39 of file panel_color_settings.h.

     {
         ID_COPY = wxID_HIGHEST + 1,
         ID_PASTE,
         ID_REVERT
     };

Constructor & Destructor Documentation

◆ PANEL_COLOR_SETTINGS()

PANEL_COLOR_SETTINGS::PANEL_COLOR_SETTINGS ( wxWindow * aParent )

Definition at line 39 of file panel_color_settings.cpp.

                                                               :
         PANEL_COLOR_SETTINGS_BASE( aParent ),
         m_currentSettings( nullptr ),
         m_swatches(),
         m_copied( COLOR4D::UNSPECIFIED ),
         m_validLayers(),
         m_backgroundLayer( LAYER_PCB_BACKGROUND ),
         m_colorNamespace()
 {
 #ifdef __APPLE__
     m_btnOpenFolder->SetLabel( _( "Reveal Themes in Finder" ) );
 
     // Simple border is too dark on OSX
     m_colorsListWindow->SetWindowStyle( wxBORDER_SUNKEN|wxVSCROLL );
 #endif
 }

References _, PANEL_COLOR_SETTINGS_BASE::m_btnOpenFolder, PANEL_COLOR_SETTINGS_BASE::m_colorsListWindow, and UNSPECIFIED.

◆ ~PANEL_COLOR_SETTINGS()

PANEL_COLOR_SETTINGS::~PANEL_COLOR_SETTINGS ( )

default

Member Function Documentation

◆ createSwatch()

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

protected

Definition at line 230 of file panel_color_settings.cpp.

 {
     wxStaticText* label = new wxStaticText( m_colorsListWindow, wxID_ANY, aName );
 
     // The previously selected theme can be deleted and cannot be selected.
     // so select the default theme (first theme of the list)
     if( m_cbTheme->GetSelection() < 0 )
     {
         m_cbTheme->SetSelection( 0 );
         onNewThemeSelected();
     }
 
     void*           clientData = m_cbTheme->GetClientData( m_cbTheme->GetSelection() );
     COLOR_SETTINGS* selected = static_cast<COLOR_SETTINGS*>( clientData );
 
     int             id = FIRST_BUTTON_ID + aLayer;
     COLOR4D         defaultColor    = selected->GetDefaultColor( aLayer );
     COLOR4D         color           = m_currentSettings->GetColor( aLayer );
     COLOR4D         backgroundColor = m_currentSettings->GetColor( m_backgroundLayer );
 
     COLOR_SWATCH* swatch = new COLOR_SWATCH( m_colorsListWindow, color, id, backgroundColor,
                                              defaultColor, SWATCH_MEDIUM );
     swatch->SetForegroundColour( wxSystemSettings::GetColour( wxSYS_COLOUR_WINDOW ) );
 
     m_colorsGridSizer->Add( label, 0, wxALIGN_CENTER_VERTICAL | wxALIGN_LEFT | wxLEFT, 5 );
     m_colorsGridSizer->Add( swatch, 0, wxALIGN_CENTER_VERTICAL | wxALL, 3 );
 
     m_labels[aLayer]   = label;
     m_swatches[aLayer] = swatch;
 
     swatch->Bind( wxEVT_RIGHT_DOWN,
                   [&, aLayer]( wxMouseEvent& aEvent )
                   {
                       ShowColorContextMenu( aEvent, aLayer );
                   } );
 
     swatch->Bind( COLOR_SWATCH_CHANGED, &PANEL_COLOR_SETTINGS::OnColorChanged, this );
 }

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

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

◆ createThemeList()

void PANEL_COLOR_SETTINGS::createThemeList ( const wxString & aCurrent )

protected

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

Parameters

aCurrent is the filename of the current color theme (no extension)

Definition at line 197 of file panel_color_settings.cpp.

 {
     int width    = 0;
     int height   = 0;
 
     m_cbTheme->GetTextExtent( _( "New Theme..." ), &width, &height );
     int minwidth = width;
 
     m_cbTheme->Clear();
 
     for( COLOR_SETTINGS* settings : Pgm().GetSettingsManager().GetColorSettingsList() )
     {
         wxString name = settings->GetName();
 
         if( settings->IsReadOnly() )
             name += wxS( " " ) + _( "(read-only)" );
 
         int pos = m_cbTheme->Append( name, static_cast<void*>( settings ) );
 
         if( settings->GetFilename() == aCurrent )
             m_cbTheme->SetSelection( pos );
 
         m_cbTheme->GetTextExtent( name, &width, &height );
         minwidth = std::max( minwidth, width );
     }
 
     m_cbTheme->Append( wxT( "---" ) );
     m_cbTheme->Append( _( "New Theme..." ) );
 
     m_cbTheme->SetMinSize( wxSize( minwidth + 50, -1 ) );
 }

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

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

◆ GetResetTooltip()

virtual wxString PANEL_COLOR_SETTINGS::GetResetTooltip ( )

inlineoverridevirtual

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.

     {
         return _( "Reset all colors in this theme to the KiCad defaults" );
     }

References _.

◆ OnBtnOpenThemeFolderClicked()

void PANEL_COLOR_SETTINGS::OnBtnOpenThemeFolderClicked ( wxCommandEvent & event )

overrideprotectedvirtual

Reimplemented from PANEL_COLOR_SETTINGS_BASE.

Definition at line 57 of file panel_color_settings.cpp.

 {
     wxString dir( SETTINGS_MANAGER::GetColorSettingsPath() );
     LaunchExternal( dir );
 }

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

◆ OnColorChanged()

void PANEL_COLOR_SETTINGS::OnColorChanged ( wxCommandEvent & aEvent )

protected

Definition at line 315 of file panel_color_settings.cpp.

 {
     COLOR_SWATCH* swatch = static_cast<COLOR_SWATCH*>( aEvent.GetEventObject() );
     COLOR4D       newColor = swatch->GetSwatchColor();
     LAYER_NUM     layer = static_cast<SCH_LAYER_ID>( swatch->GetId() - FIRST_BUTTON_ID );
 
     updateColor( layer, newColor );
 }

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

Referenced by createSwatch().

◆ onColorChanged()

virtual void PANEL_COLOR_SETTINGS::onColorChanged ( )

inlineprotectedvirtual

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 updateColor().

◆ OnLeftDownTheme()

void PANEL_COLOR_SETTINGS::OnLeftDownTheme ( wxMouseEvent & event )

overrideprotectedvirtual

Reimplemented from PANEL_COLOR_SETTINGS_BASE.

Definition at line 101 of file panel_color_settings.cpp.

 {
     // Lazy rebuild of theme menu to catch any colour theme changes made in other panels
     createThemeList( m_currentSettings->GetFilename() );
 
     event.Skip();
 }

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

◆ onNewThemeSelected()

virtual void PANEL_COLOR_SETTINGS::onNewThemeSelected ( )

inlineprotectedvirtual

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 createSwatch(), OnThemeChanged(), and Show().

◆ OnOverrideItemColorsClicked()

virtual void PANEL_COLOR_SETTINGS_BASE::OnOverrideItemColorsClicked ( wxCommandEvent & event )

inlineprotectedvirtualinherited

Reimplemented in PANEL_EESCHEMA_COLOR_SETTINGS.

Definition at line 54 of file panel_color_settings_base.h.

54 { event.Skip(); }

Referenced by PANEL_COLOR_SETTINGS_BASE::PANEL_COLOR_SETTINGS_BASE(), and PANEL_COLOR_SETTINGS_BASE::~PANEL_COLOR_SETTINGS_BASE().

◆ OnSize()

virtual void PANEL_COLOR_SETTINGS_BASE::OnSize ( wxSizeEvent & event )

inlineprotectedvirtualinherited

Reimplemented in PANEL_EESCHEMA_COLOR_SETTINGS, and PANEL_PCBNEW_COLOR_SETTINGS.

Definition at line 51 of file panel_color_settings_base.h.

51 { event.Skip(); }

Referenced by PANEL_COLOR_SETTINGS_BASE::PANEL_COLOR_SETTINGS_BASE(), and PANEL_COLOR_SETTINGS_BASE::~PANEL_COLOR_SETTINGS_BASE().

◆ OnThemeChanged()

void PANEL_COLOR_SETTINGS::OnThemeChanged ( wxCommandEvent & aEvent )

overrideprotectedvirtual

Reimplemented from PANEL_COLOR_SETTINGS_BASE.

Definition at line 110 of file panel_color_settings.cpp.

 {
     int idx = m_cbTheme->GetSelection();
 
     if( idx == static_cast<int>( m_cbTheme->GetCount() ) - 2 )
     {
         // separator; re-select active theme
         m_cbTheme->SetStringSelection( m_currentSettings->GetName() );
         return;
     }
 
     if( idx == (int)m_cbTheme->GetCount() - 1 )
     {
         // New Theme...
 
         if( !saveCurrentTheme( false ) )
             return;
 
         FOOTPRINT_NAME_VALIDATOR themeNameValidator;
         wxTextEntryDialog dlg( this, _( "New theme name:" ), _( "Add Color Theme" ) );
         dlg.SetTextValidator( themeNameValidator );
 
         if( dlg.ShowModal() != wxID_OK )
             return;
 
         wxString themeName = dlg.GetValue();
         wxFileName fn( themeName + wxT( ".json" ) );
         fn.SetPath( SETTINGS_MANAGER::GetColorSettingsPath() );
 
         if( fn.Exists() )
         {
             wxMessageBox( _( "Theme already exists!" ) );
             return;
         }
 
         SETTINGS_MANAGER& settingsMgr = Pgm().GetSettingsManager();
         COLOR_SETTINGS*   newSettings = settingsMgr.AddNewColorSettings( themeName );
         newSettings->SetName( themeName );
         newSettings->SetReadOnly( false );
 
         for( auto layer : m_validLayers )
             newSettings->SetColor( layer, m_currentSettings->GetColor( layer ) );
 
         newSettings->SaveToFile( settingsMgr.GetPathForSettingsFile( newSettings ) );
 
         idx = m_cbTheme->Insert( themeName, idx - 1, static_cast<void*>( newSettings ) );
         m_cbTheme->SetSelection( idx );
 
         m_optOverrideColors->SetValue( newSettings->GetOverrideSchItemColors() );
 
         *m_currentSettings = *newSettings;
         updateSwatches();
         onNewThemeSelected();
     }
     else
     {
         COLOR_SETTINGS* selected = static_cast<COLOR_SETTINGS*>( m_cbTheme->GetClientData( idx ) );
 
         if( selected->GetFilename() != m_currentSettings->GetFilename() )
         {
             if( !saveCurrentTheme( false ) )
                 return;
 
             m_optOverrideColors->SetValue( selected->GetOverrideSchItemColors() );
 
             *m_currentSettings = *selected;
             onNewThemeSelected();
             updateSwatches();
         }
     }
 }

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, m_currentSettings, PANEL_COLOR_SETTINGS_BASE::m_optOverrideColors, m_validLayers, onNewThemeSelected(), Pgm(), saveCurrentTheme(), JSON_SETTINGS::SaveToFile(), COLOR_SETTINGS::SetColor(), COLOR_SETTINGS::SetName(), JSON_SETTINGS::SetReadOnly(), and updateSwatches().

◆ ResetPanel()

void PANEL_COLOR_SETTINGS::ResetPanel ( )

overridevirtual

Reset the contents of this panel.

Implements RESETTABLE_PANEL.

Reimplemented in PANEL_EESCHEMA_COLOR_SETTINGS, and PANEL_PCBNEW_COLOR_SETTINGS.

Definition at line 64 of file panel_color_settings.cpp.

 {
     if( !m_currentSettings || m_currentSettings->IsReadOnly() )
         return;
 
     for( const std::pair<const int, COLOR_SWATCH*>& pair : m_swatches )
     {
         int           layer  = pair.first;
         COLOR_SWATCH* button = pair.second;
 
         COLOR4D defaultColor = m_currentSettings->GetDefaultColor( layer );
 
         m_currentSettings->SetColor( layer, defaultColor );
         button->SetSwatchColor( defaultColor, false );
     }
 }

References COLOR_SETTINGS::GetDefaultColor(), JSON_SETTINGS::IsReadOnly(), m_currentSettings, 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 )

protectedvirtual

Reimplemented in PANEL_EESCHEMA_COLOR_SETTINGS.

Definition at line 348 of file panel_color_settings.cpp.

 {
     if( m_currentSettings->IsReadOnly() )
         return true;
 
     if( aValidate && !validateSave() )
         return false;
 
     SETTINGS_MANAGER& settingsMgr = Pgm().GetSettingsManager();
     COLOR_SETTINGS* selected = settingsMgr.GetColorSettings( m_currentSettings->GetFilename() );
 
     selected->SetOverrideSchItemColors( m_optOverrideColors->GetValue() );
 
     for( auto layer : m_validLayers )
         selected->SetColor( layer, m_currentSettings->GetColor( layer ) );
 
     settingsMgr.SaveColorSettings( selected, m_colorNamespace );
 
     return true;
 }

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

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

◆ Show()

bool PANEL_COLOR_SETTINGS::Show ( bool show )

override

Definition at line 82 of file panel_color_settings.cpp.

 {
     if( show )
     {
         // In case changes have been made to the current theme in another panel:
         int idx = m_cbTheme->GetSelection();
         COLOR_SETTINGS* settings = static_cast<COLOR_SETTINGS*>( m_cbTheme->GetClientData( idx ) );
 
         if( settings )
             *m_currentSettings = *settings;
 
         onNewThemeSelected();
         updateSwatches();
     }
 
     return PANEL_COLOR_SETTINGS_BASE::Show( show );
 }

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

◆ ShowColorContextMenu()

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

protected

Definition at line 270 of file panel_color_settings.cpp.

 {
     auto selected =
             static_cast<COLOR_SETTINGS*>( m_cbTheme->GetClientData( m_cbTheme->GetSelection() ) );
 
     COLOR4D current  = m_currentSettings->GetColor( aLayer );
     COLOR4D saved    = selected->GetColor( aLayer );
     bool    readOnly = m_currentSettings->IsReadOnly();
 
     wxMenu menu;
 
     AddMenuItem( &menu, ID_COPY, _( "Copy color" ), KiBitmap( BITMAPS::copy ) );
 
     if( !readOnly && m_copied != COLOR4D::UNSPECIFIED )
         AddMenuItem( &menu, ID_PASTE, _( "Paste color" ), KiBitmap( BITMAPS::paste ) );
 
     if( !readOnly && current != saved )
         AddMenuItem( &menu, ID_REVERT, _( "Revert to saved color" ), KiBitmap( BITMAPS::undo ) );
 
     menu.Bind( wxEVT_COMMAND_MENU_SELECTED,
             [&]( wxCommandEvent& aCmd )
             {
                 switch( aCmd.GetId() )
                 {
                 case ID_COPY:
                     m_copied = current;
                     break;
 
                 case ID_PASTE:
                     updateColor( aLayer, m_copied );
                     break;
 
                 case ID_REVERT:
                     updateColor( aLayer, saved );
                     break;
 
                 default:
                     aCmd.Skip();
                 }
             } );
 
     PopupMenu( &menu );
 }

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

Referenced by createSwatch().

◆ updateColor()

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

protected

Definition at line 325 of file panel_color_settings.cpp.

 {
     if( m_currentSettings )
         m_currentSettings->SetColor( aLayer, aColor );
 
     // Colors must be persisted when edited because multiple PANEL_COLOR_SETTINGS could be
     // referring to the same theme.
     saveCurrentTheme( false );
 
     m_swatches[aLayer]->SetSwatchColor( aColor, false );
 
     if( m_currentSettings && aLayer == m_backgroundLayer )
     {
         COLOR4D background = m_currentSettings->GetColor( m_backgroundLayer );
 
         for( std::pair<int, COLOR_SWATCH*> pair : m_swatches )
             pair.second->SetSwatchBackground( background );
     }
 
     onColorChanged();
 }

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

Referenced by OnColorChanged(), and ShowColorContextMenu().

◆ updateSwatches()

void PANEL_COLOR_SETTINGS::updateSwatches ( )

protected

Definition at line 183 of file panel_color_settings.cpp.

 {
     bool    isReadOnly = m_currentSettings->IsReadOnly();
     COLOR4D background = m_currentSettings->GetColor( m_backgroundLayer );
 
     for( std::pair<int, COLOR_SWATCH*> pair : m_swatches )
     {
         pair.second->SetSwatchBackground( background );
         pair.second->SetSwatchColor( m_currentSettings->GetColor( pair.first ), false );
         pair.second->SetReadOnly( isReadOnly );
     }
 }