#include <panel_eeschema_color_settings.h>

Inheritance diagram for PANEL_EESCHEMA_COLOR_SETTINGS:

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

Public Member Functions
	PANEL_EESCHEMA_COLOR_SETTINGS (SCH_BASE_FRAME aFrame, wxWindow aParent)

	~PANEL_EESCHEMA_COLOR_SETTINGS () override

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
bool	TransferDataFromWindow () override

bool	TransferDataToWindow () override

void	OnOverrideItemColorsClicked (wxCommandEvent &aEvent) override

void	OnSize (wxSizeEvent &aEvent) override

void	onNewThemeSelected () override
	Event fired when a new theme is selected that can be overridden in children. More...

void	onColorChanged () override
	Event fired when the user changes any color. More...

bool	validateSave (bool aQuiet=false) override
	Performs a pre-save validation of the current color theme. More...

bool	saveCurrentTheme (bool aValidate) 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)

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

Private Member Functions
void	createPreviewItems ()

void	createSwatches ()

void	updatePreview ()

void	zoomFitPreview ()

Private Attributes
SCH_BASE_FRAME *	m_frame

SCH_PREVIEW_PANEL *	m_preview

PAGE_INFO *	m_page

TITLE_BLOCK *	m_titleBlock

DS_PROXY_VIEW_ITEM *	m_drawingSheet

std::vector< EDA_ITEM * >	m_previewItems

KIGFX::GAL_DISPLAY_OPTIONS	m_galDisplayOptions

Detailed Description

Definition at line 39 of file panel_eeschema_color_settings.h.

Member Enumeration Documentation

◆ COLOR_CONTEXT_ID

enum PANEL_COLOR_SETTINGS::COLOR_CONTEXT_ID

inherited

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_EESCHEMA_COLOR_SETTINGS()

PANEL_EESCHEMA_COLOR_SETTINGS::PANEL_EESCHEMA_COLOR_SETTINGS	(	SCH_BASE_FRAME *	aFrame,
		wxWindow *	aParent
	)

Definition at line 50 of file panel_eeschema_color_settings.cpp.

                                                                                   :
         PANEL_COLOR_SETTINGS( aParent ),
         m_frame( aFrame ),
         m_preview( nullptr ),
         m_page( nullptr ),
         m_titleBlock( nullptr ),
         m_drawingSheet( nullptr ),
         m_previewItems()
 {
     m_colorNamespace = "schematic";
 
     SETTINGS_MANAGER&  mgr = Pgm().GetSettingsManager();
 
     mgr.ReloadColorSettings();
 
     COMMON_SETTINGS*   common_settings = Pgm().GetCommonSettings();
     EESCHEMA_SETTINGS* app_settings = mgr.GetAppSettings<EESCHEMA_SETTINGS>();
     COLOR_SETTINGS*    current = mgr.GetColorSettings( app_settings->m_ColorTheme );
 
     // Saved theme doesn't exist?  Reset to default
     if( current->GetFilename() != app_settings->m_ColorTheme )
         app_settings->m_ColorTheme = current->GetFilename();
 
     createThemeList( app_settings->m_ColorTheme );
 
     m_optOverrideColors->SetValue( current->GetOverrideSchItemColors() );
 
     m_currentSettings = new COLOR_SETTINGS( *current );
 
     for( int id = SCH_LAYER_ID_START; id < SCH_LAYER_ID_END; id++ )
         m_validLayers.push_back( id );
 
     m_backgroundLayer = LAYER_SCHEMATIC_BACKGROUND;
 
     createSwatches();
 
     m_galDisplayOptions.ReadConfig( *common_settings, app_settings->m_Window, this );
     m_galDisplayOptions.m_forceDisplayCursor = false;
 
     auto type = static_cast<EDA_DRAW_PANEL_GAL::GAL_TYPE>( app_settings->m_Graphics.canvas_type );
 
     m_preview = new SCH_PREVIEW_PANEL( this, wxID_ANY, wxDefaultPosition, wxSize( -1, -1 ),
                                        m_galDisplayOptions, type );
     m_preview->SetStealsFocus( false );
     m_preview->ShowScrollbars( wxSHOW_SB_NEVER, wxSHOW_SB_NEVER );
     m_preview->GetGAL()->SetAxesEnabled( false );
 
     m_colorsMainSizer->Add( 10, 0, 0, wxEXPAND, 5 );
     m_colorsMainSizer->Add( m_preview, 1, wxALL | wxEXPAND, 5 );
     m_colorsMainSizer->Add( 10, 0, 0, wxEXPAND, 5 );
 
     createPreviewItems();
     updatePreview();
     zoomFitPreview();
 }

References APP_SETTINGS_BASE::GRAPHICS::canvas_type, createPreviewItems(), createSwatches(), PANEL_COLOR_SETTINGS::createThemeList(), SETTINGS_MANAGER::GetAppSettings(), SETTINGS_MANAGER::GetColorSettings(), EDA_DRAW_PANEL_GAL::GetGAL(), LAYER_SCHEMATIC_BACKGROUND, 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, KIGFX::GAL_DISPLAY_OPTIONS::m_forceDisplayCursor, m_galDisplayOptions, APP_SETTINGS_BASE::m_Graphics, PANEL_COLOR_SETTINGS_BASE::m_optOverrideColors, m_preview, PANEL_COLOR_SETTINGS::m_validLayers, APP_SETTINGS_BASE::m_Window, Pgm(), KIGFX::GAL_DISPLAY_OPTIONS::ReadConfig(), SETTINGS_MANAGER::ReloadColorSettings(), SCH_LAYER_ID_END, SCH_LAYER_ID_START, KIGFX::GAL::SetAxesEnabled(), EDA_DRAW_PANEL_GAL::SetStealsFocus(), updatePreview(), and zoomFitPreview().

◆ ~PANEL_EESCHEMA_COLOR_SETTINGS()

PANEL_EESCHEMA_COLOR_SETTINGS::~PANEL_EESCHEMA_COLOR_SETTINGS ( )

override

Definition at line 108 of file panel_eeschema_color_settings.cpp.

 {
     delete m_page;
     delete m_titleBlock;
     delete m_drawingSheet;
     delete m_currentSettings;
 
     for( EDA_ITEM* item : m_previewItems )
         delete item;
 }

References PANEL_COLOR_SETTINGS::m_currentSettings, m_drawingSheet, m_page, m_previewItems, and m_titleBlock.

Member Function Documentation

◆ createPreviewItems()

void PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems ( )

private

Definition at line 237 of file panel_eeschema_color_settings.cpp.

 {
     KIGFX::VIEW* view = m_preview->GetView();
 
     m_page       = new PAGE_INFO( PAGE_INFO::Custom );
     m_titleBlock = new TITLE_BLOCK;
     m_titleBlock->SetTitle( _( "Color Preview" ) );
     m_titleBlock->SetDate( wxDateTime::Now().FormatDate() );
 
     m_page->SetHeightMils( 5000 );
     m_page->SetWidthMils( 6000 );
 
     m_drawingSheet = new DS_PROXY_VIEW_ITEM((int) IU_PER_MILS, m_page, nullptr, m_titleBlock );
     m_drawingSheet->SetColorLayer( LAYER_SCHEMATIC_DRAWINGSHEET );
     view->Add( m_drawingSheet );
 
     // NOTE: It would be nice to parse a schematic file here.
     // This is created from the color_settings.sch file in demos folder
 
     auto addItem = [&]( EDA_ITEM* aItem )
                    {
                        view->Add( aItem );
                        m_previewItems.push_back( aItem );
                    };
 
     std::vector<std::pair<SCH_LAYER_ID, std::pair<wxPoint, wxPoint>>> lines = {
                 { LAYER_WIRE,  { { 1950, 1500 }, { 2325, 1500 } } },
                 { LAYER_WIRE,  { { 1950, 2600 }, { 2350, 2600 } } },
                 { LAYER_WIRE,  { { 2150, 1700 }, { 2325, 1700 } } },
                 { LAYER_WIRE,  { { 2150, 2000 }, { 2150, 1700 } } },
                 { LAYER_WIRE,  { { 2925, 1600 }, { 3075, 1600 } } },
                 { LAYER_WIRE,  { { 3075, 1600 }, { 3075, 2000 } } },
                 { LAYER_WIRE,  { { 3075, 1600 }, { 3250, 1600 } } },
                 { LAYER_WIRE,  { { 3075, 2000 }, { 2150, 2000 } } },
                 { LAYER_BUS,   { { 1750, 1400 }, { 1850, 1400 } } },
                 { LAYER_BUS,   { { 1850, 2500 }, { 1850, 1400 } } },
                 { LAYER_NOTES, { { 2350, 2125 }, { 2350, 2300 } } },
                 { LAYER_NOTES, { { 2350, 2125 }, { 2950, 2125 } } },
                 { LAYER_NOTES, { { 2950, 2125 }, { 2950, 2300 } } },
                 { LAYER_NOTES, { { 2950, 2300 }, { 2350, 2300 } } }
             };
 
     for( const auto& line : lines )
     {
         SCH_LINE* wire = new SCH_LINE;
         wire->SetLayer( line.first );
         wire->SetStartPoint( wxPoint( Mils2iu( line.second.first.x ),
                                       Mils2iu( line.second.first.y ) ) );
         wire->SetEndPoint( wxPoint( Mils2iu( line.second.second.x ),
                                     Mils2iu( line.second.second.y ) ) );
         addItem( wire );
     }
 
 #define MILS_POINT( x, y ) wxPoint( Mils2iu( x ), Mils2iu( y ) )
 
     SCH_NO_CONNECT* nc = new SCH_NO_CONNECT;
     nc->SetPosition( MILS_POINT( 2525, 1300 ) );
     addItem( nc );
 
     SCH_BUS_WIRE_ENTRY* e1 = new SCH_BUS_WIRE_ENTRY_PREVIEW_ITEM;
     e1->SetPosition( MILS_POINT( 1850, 1400 ) );
     addItem( e1 );
 
     SCH_BUS_WIRE_ENTRY* e2 = new SCH_BUS_WIRE_ENTRY_PREVIEW_ITEM;
     e2->SetPosition( MILS_POINT( 1850, 2500 ) );
     addItem( e2 );
 
     SCH_TEXT* t1 = new SCH_TEXT( MILS_POINT( 2850, 2250 ), wxT( "PLAIN TEXT" ) );
     t1->SetLabelSpinStyle( LABEL_SPIN_STYLE::SPIN::LEFT );
     addItem( t1 );
 
     SCH_LABEL* t2 = new SCH_LABEL( MILS_POINT( 1975, 1500 ), wxT( "LABEL_{0}" ) );
     t2->SetLabelSpinStyle( LABEL_SPIN_STYLE::SPIN::RIGHT );
     t2->SetIsDangling( false );
     addItem( t2 );
 
     SCH_LABEL* t3 = new SCH_LABEL( MILS_POINT( 1975, 2600 ), wxT( "LABEL_{1}" ) );
     t3->SetLabelSpinStyle( LABEL_SPIN_STYLE::SPIN::RIGHT );
     t3->SetIsDangling( false );
     addItem( t3 );
 
     SCH_GLOBALLABEL* t4 = new SCH_GLOBALLABEL( MILS_POINT( 1750, 1400 ), wxT( "GLOBAL[3..0]" ) );
     t4->SetLabelSpinStyle( LABEL_SPIN_STYLE::SPIN::LEFT );
     t4->SetIsDangling( false );
     addItem( t4 );
 
     SCH_HIERLABEL* t5 = new SCH_HIERLABEL( MILS_POINT( 3250, 1600 ), wxT( "HIER_LABEL" ) );
     t5->SetLabelSpinStyle( LABEL_SPIN_STYLE::SPIN::RIGHT );
     t5->SetIsDangling( false );
     addItem( t5 );
 
     SCH_JUNCTION* j = new SCH_JUNCTION( MILS_POINT( 3075, 1600 ) );
     addItem( j );
 
     t2->SetSelected();
 
     {
         LIB_SYMBOL* symbol = new LIB_SYMBOL( wxEmptyString );
         wxPoint p( 2625, -1600 );
 
         LIB_FIELD& ref = symbol->GetReferenceField();
 
         ref.SetText( wxT( "U1" ) );
         ref.SetPosition( MILS_POINT( p.x + 30, p.y + 260 ) );
         ref.SetHorizJustify( GR_TEXT_HJUSTIFY_LEFT );
 
         LIB_FIELD& value = symbol->GetValueField();
 
         value.SetText( wxT( "OPA604" ) );
         value.SetPosition( MILS_POINT( p.x + 30, p.y + 180 ) );
         value.SetHorizJustify( GR_TEXT_HJUSTIFY_LEFT );
 
         symbol->SetShowPinNames( true );
         symbol->SetShowPinNumbers( true );
         symbol->SetPinNameOffset( 0 );
 
         LIB_POLYLINE* comp_body = new LIB_POLYLINE( symbol );
 
         comp_body->SetUnit( 0 );
         comp_body->SetConvert( 0 );
         comp_body->SetWidth( Mils2iu( 10 ) );
         comp_body->SetFillMode( FILL_TYPE::FILLED_WITH_BG_BODYCOLOR );
         comp_body->AddPoint( MILS_POINT( p.x - 200, p.y + 200 ) );
         comp_body->AddPoint( MILS_POINT( p.x + 200, p.y ) );
         comp_body->AddPoint( MILS_POINT( p.x - 200, p.y - 200 ) );
         comp_body->AddPoint( MILS_POINT( p.x - 200, p.y + 200 ) );
 
         addItem( comp_body );
 
         LIB_PIN* pin = new LIB_PIN( symbol );
 
         pin->SetPosition( MILS_POINT( p.x - 200, p.y + 100 ) );
         pin->SetLength( Mils2iu( 100 ) );
         pin->SetOrientation( PIN_LEFT );
         pin->SetType( ELECTRICAL_PINTYPE::PT_INPUT );
         pin->SetNumber( wxT( "1" ) );
         pin->SetName( wxT( "-" ) );
 
         symbol->AddDrawItem( pin );
 
         pin = new LIB_PIN( symbol );
 
         pin->SetPosition( MILS_POINT( p.x - 200, p.y - 100 ) );
         pin->SetLength( Mils2iu( 100 ) );
         pin->SetOrientation( PIN_LEFT );
         pin->SetType( ELECTRICAL_PINTYPE::PT_INPUT );
         pin->SetNumber( wxT( "2" ) );
         pin->SetName( wxT( "+" ) );
 
         symbol->AddDrawItem( pin );
 
         pin = new LIB_PIN( symbol );
 
         pin->SetPosition( MILS_POINT( p.x + 200, p.y ) );
         pin->SetLength( Mils2iu( 100 ) );
         pin->SetOrientation( PIN_RIGHT );
         pin->SetType( ELECTRICAL_PINTYPE::PT_OUTPUT );
         pin->SetNumber( wxT( "3" ) );
         pin->SetName( wxT( "OUT" ) );
 
         symbol->AddDrawItem( pin );
 
         addItem( symbol );
     }
 
     SCH_SHEET* s = new SCH_SHEET( nullptr, MILS_POINT( 4000, 1300 ) );
     s->SetSize( wxSize( Mils2iu( 800 ), Mils2iu( 1300 ) ) );
     s->GetFields().at( SHEETNAME ).SetText( wxT( "SHEET" ) );
     s->GetFields().at( SHEETFILENAME ).SetText( _( "/path/to/sheet" ) );
     s->AutoplaceFields( nullptr, false );
     addItem( s );
 
     SCH_SHEET_PIN* sp = new SCH_SHEET_PIN( s, MILS_POINT( 4500, 1500 ), wxT( "SHEET PIN" ) );
     addItem( sp );
 
     zoomFitPreview();
 }

References _, KIGFX::VIEW::Add(), LIB_SYMBOL::AddDrawItem(), LIB_POLYLINE::AddPoint(), SCH_SHEET::AutoplaceFields(), PAGE_INFO::Custom, FILLED_WITH_BG_BODYCOLOR, SCH_SHEET::GetFields(), LIB_SYMBOL::GetReferenceField(), LIB_SYMBOL::GetValueField(), EDA_DRAW_PANEL_GAL::GetView(), GR_TEXT_HJUSTIFY_LEFT, IU_PER_MILS, LAYER_BUS, LAYER_NOTES, LAYER_SCHEMATIC_DRAWINGSHEET, LAYER_WIRE, m_drawingSheet, m_page, m_preview, m_previewItems, m_titleBlock, MILS_POINT, pin, PIN_LEFT, PIN_RIGHT, PT_INPUT, PT_OUTPUT, DS_PROXY_VIEW_ITEM::SetColorLayer(), LIB_ITEM::SetConvert(), TITLE_BLOCK::SetDate(), SCH_LINE::SetEndPoint(), LIB_ITEM::SetFillMode(), PAGE_INFO::SetHeightMils(), EDA_TEXT::SetHorizJustify(), SCH_TEXT::SetIsDangling(), SCH_TEXT::SetLabelSpinStyle(), SCH_GLOBALLABEL::SetLabelSpinStyle(), SCH_HIERLABEL::SetLabelSpinStyle(), SCH_ITEM::SetLayer(), LIB_SYMBOL::SetPinNameOffset(), SCH_BUS_ENTRY_BASE::SetPosition(), SCH_NO_CONNECT::SetPosition(), LIB_ITEM::SetPosition(), EDA_ITEM::SetSelected(), LIB_SYMBOL::SetShowPinNames(), LIB_SYMBOL::SetShowPinNumbers(), SCH_SHEET::SetSize(), SCH_LINE::SetStartPoint(), EDA_TEXT::SetText(), TITLE_BLOCK::SetTitle(), LIB_ITEM::SetUnit(), LIB_POLYLINE::SetWidth(), PAGE_INFO::SetWidthMils(), SHEETFILENAME, SHEETNAME, and zoomFitPreview().

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS().

◆ createSwatch()

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

protectedinherited

Definition at line 232 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 );
 }

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

◆ createSwatches()

void PANEL_EESCHEMA_COLOR_SETTINGS::createSwatches ( )

private

Definition at line 189 of file panel_eeschema_color_settings.cpp.

 {
     std::vector<SCH_LAYER_ID> layers;
 
     for( SCH_LAYER_ID i = SCH_LAYER_ID_START; i < SCH_LAYER_ID_END; ++i )
         layers.push_back( i );
 
     std::sort( layers.begin(), layers.end(),
                []( SCH_LAYER_ID a, SCH_LAYER_ID b )
                {
                    return LayerName( a ) < LayerName( b );
                } );
 
     for( int layer : layers )
     {
         wxString name = LayerName( layer );
 
         if( layer == LAYER_SCHEMATIC_GRID_AXES )
             name += wxS( " " ) + _( "(symbol editor only)" );
 
         createSwatch( layer, name );
     }
 
     // Give a minimal width to m_colorsListWindow, in order to always having
     // a full row shown
     int min_width = m_colorsGridSizer->GetMinSize().x;
     const int margin = 20;  // A margin around the sizer
     m_colorsListWindow->SetMinSize( wxSize( min_width + margin, -1 ) );
 }

References _, PANEL_COLOR_SETTINGS::createSwatch(), LAYER_SCHEMATIC_GRID_AXES, LayerName(), PANEL_COLOR_SETTINGS_BASE::m_colorsGridSizer, PANEL_COLOR_SETTINGS_BASE::m_colorsListWindow, name, SCH_LAYER_ID_END, and SCH_LAYER_ID_START.

Referenced by PANEL_EESCHEMA_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

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

Definition at line 199 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 PANEL_COLOR_SETTINGS::OnLeftDownTheme(), 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 ( )

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.

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

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.

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

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

◆ onColorChanged()

void PANEL_EESCHEMA_COLOR_SETTINGS::onColorChanged ( )

overrideprotectedvirtual

Event fired when the user changes any color.

Reimplemented from PANEL_COLOR_SETTINGS.

Definition at line 416 of file panel_eeschema_color_settings.cpp.

 {
     updatePreview();
 }

References updatePreview().

◆ OnColorChanged()

void PANEL_COLOR_SETTINGS::OnColorChanged ( wxCommandEvent & aEvent )

protectedinherited

Definition at line 317 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 PANEL_COLOR_SETTINGS::updateColor().

Referenced by PANEL_COLOR_SETTINGS::createSwatch().

◆ 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.

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

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

◆ onNewThemeSelected()

void PANEL_EESCHEMA_COLOR_SETTINGS::onNewThemeSelected ( )

overrideprotectedvirtual

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

Reimplemented from PANEL_COLOR_SETTINGS.

Definition at line 220 of file panel_eeschema_color_settings.cpp.

 {
     updatePreview();
 }

References updatePreview().

◆ OnOverrideItemColorsClicked()

void PANEL_EESCHEMA_COLOR_SETTINGS::OnOverrideItemColorsClicked ( wxCommandEvent & aEvent )

overrideprotectedvirtual

Reimplemented from PANEL_COLOR_SETTINGS_BASE.

Definition at line 470 of file panel_eeschema_color_settings.cpp.

 {
     m_currentSettings->SetOverrideSchItemColors( m_optOverrideColors->GetValue() );
 
     // If the theme is not overriding individual item colors then don't show them so that
     // the user doesn't get seduced into thinking they'll have some effect.
     m_labels[ LAYER_SHEET ]->Show( m_currentSettings->GetOverrideSchItemColors() );
     m_swatches[ LAYER_SHEET ]->Show( m_currentSettings->GetOverrideSchItemColors() );
 
     m_labels[ LAYER_SHEET_BACKGROUND ]->Show( m_currentSettings->GetOverrideSchItemColors() );
     m_swatches[ LAYER_SHEET_BACKGROUND ]->Show( m_currentSettings->GetOverrideSchItemColors() );
 
     m_colorsGridSizer->Layout();
     m_colorsListWindow->Layout();
 }

References COLOR_SETTINGS::GetOverrideSchItemColors(), LAYER_SHEET, LAYER_SHEET_BACKGROUND, 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_BASE::m_optOverrideColors, PANEL_COLOR_SETTINGS::m_swatches, and COLOR_SETTINGS::SetOverrideSchItemColors().

◆ OnSize()

void PANEL_EESCHEMA_COLOR_SETTINGS::OnSize ( wxSizeEvent & aEvent )

overrideprotectedvirtual

Reimplemented from PANEL_COLOR_SETTINGS_BASE.

Definition at line 463 of file panel_eeschema_color_settings.cpp.

 {
     zoomFitPreview();
     aEvent.Skip();
 }

References zoomFitPreview().

◆ 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.

 {
     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, 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_EESCHEMA_COLOR_SETTINGS::ResetPanel ( )

overridevirtual

Reset the contents of this panel.

Reimplemented from PANEL_COLOR_SETTINGS.

Definition at line 422 of file panel_eeschema_color_settings.cpp.

 {
     PANEL_COLOR_SETTINGS::ResetPanel();
     updatePreview();
 }

References PANEL_COLOR_SETTINGS::ResetPanel(), and updatePreview().

◆ saveCurrentTheme()

bool PANEL_EESCHEMA_COLOR_SETTINGS::saveCurrentTheme ( bool aValidate )

overrideprotectedvirtual

Reimplemented from PANEL_COLOR_SETTINGS.

Definition at line 168 of file panel_eeschema_color_settings.cpp.

 {
     for( auto layer : m_validLayers )
     {
         COLOR4D color = m_currentSettings->GetColor( layer );
 
         // Do not allow non-background layers to be completely white.
         // This ensures the BW printing recognizes that the colors should be printed black.
         if( color == COLOR4D::WHITE && layer != LAYER_SCHEMATIC_BACKGROUND
                 && layer != LAYER_SHEET_BACKGROUND )
         {
             color.Darken( 0.01 );
         }
 
         m_currentSettings->SetColor( layer, color );
     }
 
     return PANEL_COLOR_SETTINGS::saveCurrentTheme( aValidate );
 }

References color, COLOR_SETTINGS::GetColor(), LAYER_SCHEMATIC_BACKGROUND, LAYER_SHEET_BACKGROUND, PANEL_COLOR_SETTINGS::m_currentSettings, PANEL_COLOR_SETTINGS::m_validLayers, PANEL_COLOR_SETTINGS::saveCurrentTheme(), COLOR_SETTINGS::SetColor(), and WHITE.

Referenced by TransferDataFromWindow().

◆ Show()

bool PANEL_COLOR_SETTINGS::Show ( bool show )

overrideinherited

Definition at line 84 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, 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.

 {
     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(), 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_EESCHEMA_COLOR_SETTINGS::TransferDataFromWindow ( )

overrideprotected

Definition at line 120 of file panel_eeschema_color_settings.cpp.

 {
     m_currentSettings->SetOverrideSchItemColors( m_optOverrideColors->GetValue() );
 
     if( !saveCurrentTheme( true ) )
         return false;
 
     m_frame->GetCanvas()->GetView()->GetPainter()->GetSettings()->LoadColors( m_currentSettings );
 
     SETTINGS_MANAGER& settingsMgr = Pgm().GetSettingsManager();
     EESCHEMA_SETTINGS* app_settings = settingsMgr.GetAppSettings<EESCHEMA_SETTINGS>();
     app_settings->m_ColorTheme = m_currentSettings->GetFilename();
 
     return true;
 }

References SETTINGS_MANAGER::GetAppSettings(), SCH_BASE_FRAME::GetCanvas(), JSON_SETTINGS::GetFilename(), KIGFX::VIEW::GetPainter(), KIGFX::PAINTER::GetSettings(), SCH_DRAW_PANEL::GetView(), KIGFX::RENDER_SETTINGS::LoadColors(), APP_SETTINGS_BASE::m_ColorTheme, PANEL_COLOR_SETTINGS::m_currentSettings, m_frame, PANEL_COLOR_SETTINGS_BASE::m_optOverrideColors, Pgm(), saveCurrentTheme(), and COLOR_SETTINGS::SetOverrideSchItemColors().

◆ TransferDataToWindow()

bool PANEL_EESCHEMA_COLOR_SETTINGS::TransferDataToWindow ( )

overrideprotected

Definition at line 137 of file panel_eeschema_color_settings.cpp.

 {
     zoomFitPreview();
     return true;
 }

References zoomFitPreview().

◆ updateColor()

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

protectedinherited

Definition at line 327 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(), 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().

◆ updatePreview()

void PANEL_EESCHEMA_COLOR_SETTINGS::updatePreview ( )

private

Definition at line 429 of file panel_eeschema_color_settings.cpp.

 {
     if( !m_preview )
         return;
 
     KIGFX::VIEW* view = m_preview->GetView();
     auto settings = static_cast<KIGFX::SCH_RENDER_SETTINGS*>( view->GetPainter()->GetSettings() );
     settings->LoadColors( m_currentSettings );
 
     m_preview->GetGAL()->SetClearColor( settings->GetBackgroundColor() );
 
     view->UpdateAllItems( KIGFX::COLOR );
     auto rect = m_preview->GetScreenRect();
     m_preview->Refresh( true, &rect );
 }

References KIGFX::COLOR, EDA_DRAW_PANEL_GAL::GetGAL(), KIGFX::VIEW::GetPainter(), KIGFX::PAINTER::GetSettings(), EDA_DRAW_PANEL_GAL::GetView(), PANEL_COLOR_SETTINGS::m_currentSettings, m_preview, SCH_PREVIEW_PANEL::Refresh(), KIGFX::GAL::SetClearColor(), and KIGFX::VIEW::UpdateAllItems().

Referenced by onColorChanged(), onNewThemeSelected(), PANEL_EESCHEMA_COLOR_SETTINGS(), and ResetPanel().

◆ updateSwatches()

void PANEL_COLOR_SETTINGS::updateSwatches ( )

protectedinherited

Definition at line 185 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 );
     }
 }

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

bool PANEL_EESCHEMA_COLOR_SETTINGS::validateSave ( bool aQuiet = false )

overrideprotectedvirtual

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

Parameters

aQuiet will suppress any warning output (prompt dialogs)

Returns: true if save is allowed

Reimplemented from PANEL_COLOR_SETTINGS.

Definition at line 144 of file panel_eeschema_color_settings.cpp.

 {
     COLOR4D bgcolor = m_currentSettings->GetColor( LAYER_SCHEMATIC_BACKGROUND );
 
     for( SCH_LAYER_ID layer = SCH_LAYER_ID_START; layer < SCH_LAYER_ID_END; ++layer )
     {
         if( bgcolor == m_currentSettings->GetColor( layer )
             && layer != LAYER_SCHEMATIC_BACKGROUND && layer != LAYER_SHEET_BACKGROUND )
         {
             wxString msg = _( "Some items have the same color as the background\n"
                               "and they will not be seen on the screen.  Are you\n"
                               "sure you want to use these colors?" );
 
             if( wxMessageBox( msg, _( "Warning" ), wxYES_NO | wxICON_QUESTION, this ) == wxNO )
                 return false;
 
             break;
         }
     }
 
     return true;
 }

References _, COLOR_SETTINGS::GetColor(), LAYER_SCHEMATIC_BACKGROUND, LAYER_SHEET_BACKGROUND, PANEL_COLOR_SETTINGS::m_currentSettings, SCH_LAYER_ID_END, and SCH_LAYER_ID_START.

◆ zoomFitPreview()

void PANEL_EESCHEMA_COLOR_SETTINGS::zoomFitPreview ( )

private

Definition at line 446 of file panel_eeschema_color_settings.cpp.

 {
     KIGFX::VIEW* view = m_preview->GetView();
 
     view->SetScale( 1.0 );
     VECTOR2D screenSize = view->ToWorld( m_preview->GetClientSize(), false );
 
     VECTOR2I psize( m_page->GetWidthIU(), m_page->GetHeightIU() );
     double scale = view->GetScale() / std::max( fabs( psize.x / screenSize.x ),
                                                 fabs( psize.y / screenSize.y ) );
 
     view->SetScale( scale * m_galDisplayOptions.m_scaleFactor * 0.8 /* margin */ );
     view->SetCenter( m_drawingSheet->ViewBBox().Centre() );
     m_preview->ForceRefresh();
 }