#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 () const override
	Get the tooltip the reset button should display when showing this panel. More...

bool	Show (bool show) override

wxString	GetHelpTextAtPoint (const wxPoint &aPt, wxHelpEvent::Origin aOrigin) const override
	Overridden to supply the reset button tooltip when queried with { -INT_MAX, INT_MAX }. More...

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)

virtual void	createSwatches ()=0

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

wxString	GetSettingsDropdownName (COLOR_SETTINGS *aSettings)
	Retrieves the drop down name to be displayed for a color setting. 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

WX_PANEL *	m_panel1

wxBoxSizer *	m_colorsMainSizer

wxScrolledWindow *	m_colorsListWindow

wxFlexGridSizer *	m_colorsGridSizer

wxBoxSizer *	m_previewPanelSizer

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.

Constructor & Destructor Documentation

◆ PANEL_COLOR_SETTINGS()

PANEL_COLOR_SETTINGS::PANEL_COLOR_SETTINGS ( wxWindow * aParent )

Definition at line 41 of file panel_color_settings.cpp.

References _, PANEL_COLOR_SETTINGS_BASE::m_btnOpenFolder, PANEL_COLOR_SETTINGS_BASE::m_colorsListWindow, PANEL_COLOR_SETTINGS_BASE::m_panel1, and WX_PANEL::SetBorders().

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

◆ createSwatches()

virtual void PANEL_COLOR_SETTINGS::createSwatches ( )

protectedpure virtual

Implemented in PANEL_EESCHEMA_COLOR_SETTINGS, PANEL_GERBVIEW_COLOR_SETTINGS, PANEL_FP_EDITOR_COLOR_SETTINGS, and PANEL_PCBNEW_COLOR_SETTINGS.

Referenced by updateSwatches().

◆ 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 209 of file panel_color_settings.cpp.

References _, GetSettingsDropdownName(), 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(), PANEL_GERBVIEW_COLOR_SETTINGS::PANEL_GERBVIEW_COLOR_SETTINGS(), and PANEL_PCBNEW_COLOR_SETTINGS::PANEL_PCBNEW_COLOR_SETTINGS().

◆ GetHelpTextAtPoint()

wxString RESETTABLE_PANEL::GetHelpTextAtPoint	(	const wxPoint &	aPt,
		wxHelpEvent::Origin	aOrigin
	)		const

inlineoverrideinherited

Overridden to supply the reset button tooltip when queried with { -INT_MAX, INT_MAX }.

Definition at line 72 of file resettable_panel.h.

References RESETTABLE_PANEL::GetResetTooltip().

◆ GetResetTooltip()

virtual wxString PANEL_COLOR_SETTINGS::GetResetTooltip ( ) const

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.

References _.

◆ GetSettingsDropdownName()

wxString PANEL_COLOR_SETTINGS::GetSettingsDropdownName ( COLOR_SETTINGS * aSettings )

protected

Retrieves the drop down name to be displayed for a color setting.

Definition at line 384 of file panel_color_settings.cpp.

References _, COLOR_SETTINGS::GetName(), JSON_SETTINGS::IsReadOnly(), and name.

Referenced by createThemeList(), and OnThemeChanged().

◆ OnBtnOpenThemeFolderClicked()

void PANEL_COLOR_SETTINGS::OnBtnOpenThemeFolderClicked ( wxCommandEvent & event )

overrideprotectedvirtual

Reimplemented from PANEL_COLOR_SETTINGS_BASE.

Definition at line 61 of file panel_color_settings.cpp.

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

◆ 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 98 of file panel_color_settings.h.

Referenced by updateColor().

◆ OnColorChanged()

void PANEL_COLOR_SETTINGS::OnColorChanged ( wxCommandEvent & aEvent )

protected

Definition at line 329 of file panel_color_settings.cpp.

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

Referenced by createSwatch().

◆ OnLeftDownTheme()

void PANEL_COLOR_SETTINGS::OnLeftDownTheme ( wxMouseEvent & event )

overrideprotectedvirtual

Reimplemented from PANEL_COLOR_SETTINGS_BASE.

Definition at line 105 of file panel_color_settings.cpp.

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 93 of file panel_color_settings.h.

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 56 of file panel_color_settings_base.h.

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 53 of file panel_color_settings_base.h.

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

◆ 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 68 of file panel_color_settings.cpp.

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

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

◆ saveCurrentTheme()

bool PANEL_COLOR_SETTINGS::saveCurrentTheme ( bool aValidate )

protectedvirtual

Reimplemented in PANEL_EESCHEMA_COLOR_SETTINGS.

Definition at line 362 of file panel_color_settings.cpp.

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 86 of file panel_color_settings.cpp.

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 282 of file panel_color_settings.cpp.

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

Referenced by createSwatch().

◆ updateColor()

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

protected

Definition at line 339 of file panel_color_settings.cpp.

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

Referenced by OnColorChanged().

◆ updateSwatches()

void PANEL_COLOR_SETTINGS::updateSwatches ( )

protected

Definition at line 188 of file panel_color_settings.cpp.

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

Referenced by OnThemeChanged(), and Show().

◆ validateSave()

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

inlineprotectedvirtual

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 in PANEL_EESCHEMA_COLOR_SETTINGS.

Definition at line 85 of file panel_color_settings.h.

Referenced by saveCurrentTheme().

Member Data Documentation

◆ m_backgroundLayer

int PANEL_COLOR_SETTINGS::m_backgroundLayer

protected

Definition at line 121 of file panel_color_settings.h.

Referenced by createSwatch(), PANEL_EESCHEMA_COLOR_SETTINGS::PANEL_EESCHEMA_COLOR_SETTINGS(), PANEL_FP_EDITOR_COLOR_SETTINGS::PANEL_FP_EDITOR_COLOR_SETTINGS(), PANEL_GERBVIEW_COLOR_SETTINGS::PANEL_GERBVIEW_COLOR_SETTINGS(), PANEL_PCBNEW_COLOR_SETTINGS::PANEL_PCBNEW_COLOR_SETTINGS(), updateColor(), and updateSwatches().

◆ m_btnOpenFolder

wxButton* PANEL_COLOR_SETTINGS_BASE::m_btnOpenFolder

protectedinherited

Definition at line 45 of file panel_color_settings_base.h.

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

◆ m_cbTheme

wxChoice* PANEL_COLOR_SETTINGS_BASE::m_cbTheme

protectedinherited

Definition at line 44 of file panel_color_settings_base.h.

Referenced by createSwatch(), createThemeList(), OnThemeChanged(), PANEL_COLOR_SETTINGS_BASE::PANEL_COLOR_SETTINGS_BASE(), Show(), ShowColorContextMenu(), and PANEL_COLOR_SETTINGS_BASE::~PANEL_COLOR_SETTINGS_BASE().

◆ m_colorNamespace

std::string PANEL_COLOR_SETTINGS::m_colorNamespace

protected

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 128 of file panel_color_settings.h.

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

◆ m_colorsGridSizer

wxFlexGridSizer* PANEL_COLOR_SETTINGS_BASE::m_colorsGridSizer

protectedinherited

Definition at line 49 of file panel_color_settings_base.h.

Referenced by createSwatch(), PANEL_EESCHEMA_COLOR_SETTINGS::createSwatches(), PANEL_COLOR_SETTINGS_BASE::PANEL_COLOR_SETTINGS_BASE(), and PANEL_EESCHEMA_COLOR_SETTINGS::updateAllowedSwatches().

◆ m_colorsListWindow

wxScrolledWindow* PANEL_COLOR_SETTINGS_BASE::m_colorsListWindow

protectedinherited

Definition at line 48 of file panel_color_settings_base.h.

Referenced by createSwatch(), PANEL_EESCHEMA_COLOR_SETTINGS::createSwatches(), PANEL_COLOR_SETTINGS(), PANEL_COLOR_SETTINGS_BASE::PANEL_COLOR_SETTINGS_BASE(), and PANEL_EESCHEMA_COLOR_SETTINGS::updateAllowedSwatches().

◆ m_colorsMainSizer

wxBoxSizer* PANEL_COLOR_SETTINGS_BASE::m_colorsMainSizer

protectedinherited

Definition at line 47 of file panel_color_settings_base.h.

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

◆ m_copied

KIGFX::COLOR4D PANEL_COLOR_SETTINGS::m_copied

protected

Definition at line 110 of file panel_color_settings.h.

Referenced by ShowColorContextMenu().

◆ m_currentSettings

COLOR_SETTINGS* PANEL_COLOR_SETTINGS::m_currentSettings

protected

Definition at line 105 of file panel_color_settings.h.

◆ m_labels

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

protected

Definition at line 107 of file panel_color_settings.h.

Referenced by createSwatch(), and PANEL_EESCHEMA_COLOR_SETTINGS::updateAllowedSwatches().

◆ m_mainSizer

wxBoxSizer* PANEL_COLOR_SETTINGS_BASE::m_mainSizer

protectedinherited

Definition at line 42 of file panel_color_settings_base.h.

Referenced by PANEL_COLOR_SETTINGS_BASE::PANEL_COLOR_SETTINGS_BASE().

◆ m_optOverrideColors

wxCheckBox* PANEL_COLOR_SETTINGS_BASE::m_optOverrideColors

inherited

Definition at line 61 of file panel_color_settings_base.h.

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::OnOverrideItemColorsClicked(), OnThemeChanged(), PANEL_COLOR_SETTINGS_BASE::PANEL_COLOR_SETTINGS_BASE(), PANEL_EESCHEMA_COLOR_SETTINGS::PANEL_EESCHEMA_COLOR_SETTINGS(), PANEL_FP_EDITOR_COLOR_SETTINGS::PANEL_FP_EDITOR_COLOR_SETTINGS(), PANEL_GERBVIEW_COLOR_SETTINGS::PANEL_GERBVIEW_COLOR_SETTINGS(), PANEL_PCBNEW_COLOR_SETTINGS::PANEL_PCBNEW_COLOR_SETTINGS(), saveCurrentTheme(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), PANEL_EESCHEMA_COLOR_SETTINGS::TransferDataFromWindow(), and PANEL_COLOR_SETTINGS_BASE::~PANEL_COLOR_SETTINGS_BASE().

◆ m_panel1

WX_PANEL* PANEL_COLOR_SETTINGS_BASE::m_panel1

protectedinherited

Definition at line 46 of file panel_color_settings_base.h.

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

◆ m_previewPanelSizer

wxBoxSizer* PANEL_COLOR_SETTINGS_BASE::m_previewPanelSizer

protectedinherited

Definition at line 50 of file panel_color_settings_base.h.

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

◆ m_staticText9

wxStaticText* PANEL_COLOR_SETTINGS_BASE::m_staticText9

protectedinherited

Definition at line 43 of file panel_color_settings_base.h.

Referenced by PANEL_COLOR_SETTINGS_BASE::PANEL_COLOR_SETTINGS_BASE().

◆ m_swatches

std::map<int, COLOR_SWATCH*> PANEL_COLOR_SETTINGS::m_swatches

protected

Definition at line 108 of file panel_color_settings.h.

Referenced by createSwatch(), ResetPanel(), PANEL_EESCHEMA_COLOR_SETTINGS::updateAllowedSwatches(), updateColor(), and updateSwatches().

◆ m_validLayers

std::vector<int> PANEL_COLOR_SETTINGS::m_validLayers

protected

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 120 of file panel_color_settings.h.

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

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

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ COLOR_CONTEXT_ID

Constructor & Destructor Documentation

◆ PANEL_COLOR_SETTINGS()

◆ ~PANEL_COLOR_SETTINGS()

Member Function Documentation

◆ createSwatch()

◆ createSwatches()

◆ createThemeList()

◆ GetHelpTextAtPoint()

◆ GetResetTooltip()

◆ GetSettingsDropdownName()

◆ OnBtnOpenThemeFolderClicked()

◆ onColorChanged()

◆ OnColorChanged()

◆ OnLeftDownTheme()

◆ onNewThemeSelected()

◆ OnOverrideItemColorsClicked()

◆ OnSize()

◆ OnThemeChanged()

◆ ResetPanel()

◆ saveCurrentTheme()

◆ Show()

◆ ShowColorContextMenu()

◆ updateColor()

◆ updateSwatches()

◆ validateSave()

Member Data Documentation

◆ m_backgroundLayer

◆ m_btnOpenFolder

◆ m_cbTheme

◆ m_colorNamespace

◆ m_colorsGridSizer

◆ m_colorsListWindow

◆ m_colorsMainSizer

◆ m_copied

◆ m_currentSettings

◆ m_labels

◆ m_mainSizer

◆ m_optOverrideColors

◆ m_panel1

◆ m_previewPanelSizer

◆ m_staticText9

◆ m_swatches

◆ m_validLayers