#include <panel_pcbnew_color_settings.h>

Inheritance diagram for PANEL_PCBNEW_COLOR_SETTINGS:

Public Member Functions
	PANEL_PCBNEW_COLOR_SETTINGS (wxWindow aParent, BOARD aBoard)

	~PANEL_PCBNEW_COLOR_SETTINGS () override

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

EDA_UNITS	GetUserUnits () const

void	SetUserUnits (EDA_UNITS aUnits)

virtual void	GetUnitPair (EDA_UNITS &aPrimaryUnit, EDA_UNITS &aSecondaryUnits)

const EDA_IU_SCALE &	GetIuScale () const

virtual ORIGIN_TRANSFORMS &	GetOriginTransforms ()

wxString	StringFromValue (double aValue, bool aAddUnitLabel=false, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) const
	Converts aValue in internal units into a united string. More...

wxString	StringFromValue (const EDA_ANGLE &aValue, bool aAddUnitLabel=false) const

wxString	MessageTextFromValue (double aValue, bool aAddUnitLabel=true, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) const
	A lower-precision version of StringFromValue(). More...

wxString	MessageTextFromValue (const EDA_ANGLE &aValue, bool aAddUnitLabel=true) const

wxString	MessageTextFromMinOptMax (const MINOPTMAX< int > &aValue) const

int	ValueFromString (const wxString &aTextValue, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) const
	Converts aTextValue in aUnits to internal units used by the frame. More...

EDA_ANGLE	AngleValueFromString (const wxString &aTextValue) const

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

void	createSwatches () 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...

wxString	GetSettingsDropdownName (COLOR_SETTINGS *aSettings)
	Retrieves the drop down name to be displayed for a color setting. More...

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

Private Member Functions
void	createPreviewItems ()

void	updatePreview ()

void	zoomFitPreview ()

Private Attributes
FOOTPRINT_PREVIEW_PANEL *	m_preview

PAGE_INFO *	m_page

TITLE_BLOCK *	m_titleBlock

BOARD *	m_board

const EDA_IU_SCALE &	m_iuScale

EDA_UNITS	m_userUnits

Detailed Description

Definition at line 32 of file panel_pcbnew_color_settings.h.

Member Enumeration Documentation

◆ COLOR_CONTEXT_ID

enum PANEL_PCBNEW_COLOR_SETTINGS::COLOR_CONTEXT_ID

protected

Enumerator
ID_COPY
ID_PASTE
ID_REVERT

Definition at line 52 of file panel_pcbnew_color_settings.h.

Constructor & Destructor Documentation

◆ PANEL_PCBNEW_COLOR_SETTINGS()

PANEL_PCBNEW_COLOR_SETTINGS::PANEL_PCBNEW_COLOR_SETTINGS	(	wxWindow *	aParent,
		BOARD *	aBoard
	)

Definition at line 677 of file panel_pcbnew_color_settings.cpp.

References PANEL_COLOR_SETTINGS::createThemeList(), g_excludedLayers, GAL_LAYER_ID_BITMASK_END, GAL_LAYER_ID_START, SETTINGS_MANAGER::GetAppSettings(), SETTINGS_MANAGER::GetColorSettings(), LAYER_CONFLICTS_SHADOW, LAYER_LOCKED_ITEM_SHADOW, LAYER_PAGE_LIMITS, LAYER_PCB_BACKGROUND, PANEL_COLOR_SETTINGS::m_backgroundLayer, PANEL_COLOR_SETTINGS::m_colorNamespace, APP_SETTINGS_BASE::m_ColorTheme, PANEL_COLOR_SETTINGS::m_currentSettings, PANEL_COLOR_SETTINGS_BASE::m_optOverrideColors, PANEL_COLOR_SETTINGS::m_validLayers, and Pgm().

◆ ~PANEL_PCBNEW_COLOR_SETTINGS()

PANEL_PCBNEW_COLOR_SETTINGS::~PANEL_PCBNEW_COLOR_SETTINGS ( )

override

Definition at line 720 of file panel_pcbnew_color_settings.cpp.

References PANEL_COLOR_SETTINGS::m_currentSettings, m_page, and m_titleBlock.

Member Function Documentation

◆ AngleValueFromString()

EDA_ANGLE UNITS_PROVIDER::AngleValueFromString ( const wxString & aTextValue ) const

inlineinherited

Definition at line 138 of file units_provider.h.

References DEGREES_T, EDA_UNIT_UTILS::UI::DoubleValueFromString(), and UNITS_PROVIDER::GetIuScale().

Referenced by FP_TEXT_GRID_TABLE::SetValue().

◆ createPreviewItems()

void PANEL_PCBNEW_COLOR_SETTINGS::createPreviewItems ( )

private

◆ createSwatch()

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

protectedinherited

◆ createSwatches()

void PANEL_PCBNEW_COLOR_SETTINGS::createSwatches ( )

overrideprotectedvirtual

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

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

◆ GetIuScale()

const EDA_IU_SCALE & UNITS_PROVIDER::GetIuScale ( ) const

inlineinherited

Definition at line 57 of file units_provider.h.

References UNITS_PROVIDER::m_iuScale.

Referenced by UNITS_PROVIDER::AngleValueFromString(), GRID_MENU::BuildChoiceList(), PGPROPERTY_DISTANCE::DistanceToString(), RC_ITEM::GetJsonViolation(), UNITS_PROVIDER::MessageTextFromMinOptMax(), UNITS_PROVIDER::MessageTextFromValue(), UNIT_BINDER::onUnitsChanged(), PANEL_GRID_SETTINGS::RebuildGridSizes(), COMMON_TOOLS::Reset(), UNITS_PROVIDER::StringFromValue(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), GRID::UserUnitsMessageText(), and UNITS_PROVIDER::ValueFromString().

◆ GetOriginTransforms()

virtual ORIGIN_TRANSFORMS & UNITS_PROVIDER::GetOriginTransforms ( )

inlinevirtualinherited

Reimplemented in EDA_BASE_FRAME, and PCB_BASE_FRAME.

Definition at line 60 of file units_provider.h.

◆ GetResetTooltip()

virtual wxString PANEL_COLOR_SETTINGS::GetResetTooltip ( ) const

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.

References _.

◆ GetSettingsDropdownName()

wxString PANEL_COLOR_SETTINGS::GetSettingsDropdownName ( COLOR_SETTINGS * aSettings )

protectedinherited

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

Definition at line 383 of file panel_color_settings.cpp.

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

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

◆ GetUnitPair()

virtual void UNITS_PROVIDER::GetUnitPair	(	EDA_UNITS &	aPrimaryUnit,
		EDA_UNITS &	aSecondaryUnits
	)

inlinevirtualinherited

Reimplemented in EDA_DRAW_FRAME.

Definition at line 46 of file units_provider.h.

References UNITS_PROVIDER::GetUserUnits(), and EDA_UNIT_UTILS::IsImperialUnit().

Referenced by PANEL_GRID_SETTINGS::RebuildGridSizes().

◆ GetUserUnits()

EDA_UNITS UNITS_PROVIDER::GetUserUnits ( ) const

inlineinherited

Definition at line 43 of file units_provider.h.

References UNITS_PROVIDER::m_userUnits.

Referenced by DIALOG_BOOK_REPORTER::AddHTMLPage(), PANEL_SYMBOL_CHOOSER::constructRightPanel(), PG_UNIT_EDITOR::CreateControls(), PCB::IFACE::CreateKiWindow(), DIALOG_SHIM::DIALOG_SHIM(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), PL_EDITOR_FRAME::DisplayGridMsg(), EDA_DRAW_FRAME::DisplayUnitsMsg(), PGPROPERTY_DISTANCE::DistanceToString(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawSpecificationStackup(), EVT_GRID_CMD_CELL_CHANGED(), FOOTPRINT_PREVIEW_PANEL::FOOTPRINT_PREVIEW_PANEL(), FP_TEXT_GRID_TABLE::FP_TEXT_GRID_TABLE(), RC_ITEM::GetJsonViolation(), GERBER_DRAW_ITEM::GetMsgPanelInfo(), UNITS_PROVIDER::GetUnitPair(), EDA_DRAW_FRAME::GetUnitPair(), WX_GRID::GetUnitValue(), GetUserUnits(), UNIT_BINDER::init(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), UNITS_PROVIDER::MessageTextFromMinOptMax(), UNITS_PROVIDER::MessageTextFromValue(), PANEL_SETUP_BOARD_STACKUP::onAdjustDielectricThickness(), WX_GRID::onCellEditorHidden(), PANEL_SETUP_BOARD_STACKUP::onExportToClipboard(), DIALOG_NET_INSPECTOR::onReport(), DIALOG_ERC::OnSaveReport(), PANEL_PREVIEW_3D_MODEL::onUnitsChanged(), PANEL_SETUP_NETCLASSES::onUnitsChanged(), UNIT_BINDER::onUnitsChanged(), DIALOG_TRACK_VIA_PROPERTIES::onUnitsChanged(), DIALOG_GENERATORS::onUnitsChanged(), DIALOG_NET_INSPECTOR::onUnitsChanged(), PANEL_FOOTPRINT_CHOOSER::PANEL_FOOTPRINT_CHOOSER(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), PANEL_SETUP_NETCLASSES::PANEL_SETUP_NETCLASSES(), PG_UNIT_EDITOR::PG_UNIT_EDITOR(), PIN_TABLE_DATA_MODEL::PIN_TABLE_DATA_MODEL(), POSITION_RELATIVE_TOOL::PositionRelative(), DRC_TOOL::RunTests(), EDA_DRAW_FRAME::SaveSettings(), PCB_BASE_FRAME::SetBoard(), WX_GRID::SetUnitsProvider(), PIN_TABLE_DATA_MODEL::SetValue(), FP_TEXT_GRID_TABLE::SetValue(), GERBVIEW_INSPECTION_TOOL::ShowDCodes(), UNITS_PROVIDER::StringFromValue(), COMMON_TOOLS::ToggleUnits(), EDA_DRAW_FRAME::ToggleUserUnits(), PCB_BASE_FRAME::unitsChangeRefresh(), EDITOR_CONDITIONS::unitsFunc(), GERBVIEW_FRAME::updateDCodeSelectBox(), PG_UNIT_EDITOR::UpdateFrame(), PL_EDITOR_FRAME::UpdateStatusBar(), DRC_TOOL::userUnits(), GRID::UserUnitsMessageText(), and UNITS_PROVIDER::ValueFromString().

◆ MessageTextFromMinOptMax()

wxString UNITS_PROVIDER::MessageTextFromMinOptMax ( const MINOPTMAX< int > & aValue ) const

inlineinherited

Definition at line 115 of file units_provider.h.

References UNITS_PROVIDER::GetIuScale(), UNITS_PROVIDER::GetUserUnits(), and EDA_UNIT_UTILS::UI::MessageTextFromMinOptMax().

Referenced by PCB_TUNING_PATTERN::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfo(), and PCB_CONTROL::UpdateMessagePanel().

◆ MessageTextFromValue() [1/2]

wxString UNITS_PROVIDER::MessageTextFromValue	(	const EDA_ANGLE &	aValue,
		bool	aAddUnitLabel = `true`
	)		const

inlineinherited

Definition at line 108 of file units_provider.h.

References EDA_ANGLE::AsDegrees(), EDA_UNIT_UTILS::UI::MessageTextFromValue(), and unityScale.

◆ MessageTextFromValue() [2/2]

wxString UNITS_PROVIDER::MessageTextFromValue	(	double	aValue,
		bool	aAddUnitLabel = `true`,
		EDA_DATA_TYPE	aType = `EDA_DATA_TYPE::DISTANCE`
	)		const

inlineinherited

A lower-precision version of StringFromValue().

Should ONLY be used for status text and messages. Not suitable for dialogs, files, etc. where the loss of precision matters.

Definition at line 101 of file units_provider.h.

References UNITS_PROVIDER::GetIuScale(), UNITS_PROVIDER::GetUserUnits(), and EDA_UNIT_UTILS::UI::MessageTextFromValue().

◆ OnBtnOpenThemeFolderClicked()

void PANEL_COLOR_SETTINGS::OnBtnOpenThemeFolderClicked ( wxCommandEvent & event )

overrideprotectedvirtualinherited

Reimplemented from PANEL_COLOR_SETTINGS_BASE.

Definition at line 60 of file panel_color_settings.cpp.

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

◆ onColorChanged()

void PANEL_PCBNEW_COLOR_SETTINGS::onColorChanged ( )

overrideprotectedvirtual

Event fired when the user changes any color.

Reimplemented from PANEL_COLOR_SETTINGS.

Definition at line 821 of file panel_pcbnew_color_settings.cpp.

References updatePreview().

◆ OnColorChanged()

void PANEL_COLOR_SETTINGS::OnColorChanged ( wxCommandEvent & aEvent )

protectedinherited

Definition at line 328 of file panel_color_settings.cpp.

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

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

◆ onNewThemeSelected()

void PANEL_PCBNEW_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 779 of file panel_pcbnew_color_settings.cpp.

References updatePreview().

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

void PANEL_PCBNEW_COLOR_SETTINGS::OnSize ( wxSizeEvent & aEvent )

overrideprotectedvirtual

Reimplemented from PANEL_COLOR_SETTINGS_BASE.

Definition at line 876 of file panel_pcbnew_color_settings.cpp.

References zoomFitPreview().

◆ OnThemeChanged()

void PANEL_COLOR_SETTINGS::OnThemeChanged ( wxCommandEvent & aEvent )

overrideprotectedvirtualinherited

Reimplemented from PANEL_COLOR_SETTINGS_BASE.

Definition at line 113 of file panel_color_settings.cpp.

◆ ResetPanel()

void PANEL_PCBNEW_COLOR_SETTINGS::ResetPanel ( )

overridevirtual

Reset the contents of this panel.

Reimplemented from PANEL_COLOR_SETTINGS.

Definition at line 827 of file panel_pcbnew_color_settings.cpp.

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

◆ saveCurrentTheme()

bool PANEL_COLOR_SETTINGS::saveCurrentTheme ( bool aValidate )

protectedvirtualinherited

Reimplemented in PANEL_EESCHEMA_COLOR_SETTINGS.

Definition at line 361 of file panel_color_settings.cpp.

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

◆ SetUserUnits()

void UNITS_PROVIDER::SetUserUnits ( EDA_UNITS aUnits )

inlineinherited

Definition at line 44 of file units_provider.h.

References UNITS_PROVIDER::m_userUnits.

Referenced by EDA_BASE_FRAME::ChangeUserUnits(), PCB::IFACE::CreateKiWindow(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_DIM_ALIGNED::GetMsgPanelInfo(), EDA_DRAW_FRAME::LoadSettings(), DRC_TEST_PROVIDER::RunTests(), DRC_ENGINE::RunTests(), and EDA_DRAW_FRAME::ToggleUserUnits().

◆ Show()

bool PANEL_COLOR_SETTINGS::Show ( bool show )

overrideinherited

Definition at line 85 of file panel_color_settings.cpp.

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

References _, KIUI::AddMenuItem(), 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, and PANEL_COLOR_SETTINGS::m_currentSettings.

Referenced by PANEL_COLOR_SETTINGS::createSwatch().

◆ StringFromValue() [1/2]

wxString UNITS_PROVIDER::StringFromValue	(	const EDA_ANGLE &	aValue,
		bool	aAddUnitLabel = `false`
	)		const

inlineinherited

Definition at line 88 of file units_provider.h.

References EDA_ANGLE::AsDegrees(), EDA_UNIT_UTILS::UI::StringFromValue(), and unityScale.

◆ StringFromValue() [2/2]

wxString UNITS_PROVIDER::StringFromValue	(	double	aValue,
		bool	aAddUnitLabel = `false`,
		EDA_DATA_TYPE	aType = `EDA_DATA_TYPE::DISTANCE`
	)		const

inlineinherited

Converts aValue in internal units into a united string.

For readability, trailing 0s are removed if the mantissa has 3 or more digits. This function should be used to display values in dialogs because a value entered in mm (for instance 2.0 mm) could need up to 8 digits mantissa if displayed in inch to avoid truncation or rounding made just by the printf function.

Parameters

aValue	= value in internal units
aAddUnitLabel	= true to add symbol unit to the string value
aType	is the type of this value, and controls the way the value is converted to a string, and the suitable unit

Returns: A wxString object containing value and optionally the symbol unit (like 2.000 mm)

Definition at line 81 of file units_provider.h.

References UNITS_PROVIDER::GetIuScale(), UNITS_PROVIDER::GetUserUnits(), and EDA_UNIT_UTILS::UI::StringFromValue().

Referenced by DIALOG_PLOT::applyPlotSettings(), PANEL_SETUP_BOARD_STACKUP::computeBoardThickness(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DRAWING_TOOL::DrawSpecificationStackup(), VALIDATION_ERROR_TOO_LARGE< T >::Format(), VALIDATION_ERROR_TOO_SMALL< T >::Format(), DRC_TEST_PROVIDER::formatMsg(), PIN_TABLE_DATA_MODEL::GetValue(), FP_TEXT_GRID_TABLE::GetValue(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectDRCError(), PANEL_SETUP_BOARD_STACKUP::lazyBuildRowUI(), PANEL_SETUP_BOARD_STACKUP::onAdjustDielectricThickness(), WX_GRID::onCellEditorHidden(), DIALOG_TRACK_VIA_PROPERTIES::onUnitsChanged(), reportMax(), reportMin(), reportOpt(), PANEL_SETUP_BOARD_STACKUP::setDefaultLayerWidths(), WX_GRID::SetUnitValue(), PANEL_SETUP_BOARD_STACKUP::synchronizeWithBoard(), PANEL_SETUP_CONSTRAINTS::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES::Validate(), and DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::Validate().

◆ TransferDataFromWindow()

bool PANEL_PCBNEW_COLOR_SETTINGS::TransferDataFromWindow ( )

overrideprotected

Definition at line 728 of file panel_pcbnew_color_settings.cpp.

References SETTINGS_MANAGER::GetAppSettings(), JSON_SETTINGS::GetFilename(), APP_SETTINGS_BASE::m_ColorTheme, PANEL_COLOR_SETTINGS::m_currentSettings, and Pgm().

◆ TransferDataToWindow()

bool PANEL_PCBNEW_COLOR_SETTINGS::TransferDataToWindow ( )

overrideprotected

Definition at line 738 of file panel_pcbnew_color_settings.cpp.

References zoomFitPreview().

◆ updateColor()

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

protectedinherited

Definition at line 338 of file panel_color_settings.cpp.

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

◆ updatePreview()

void PANEL_PCBNEW_COLOR_SETTINGS::updatePreview ( )

private

Definition at line 834 of file panel_pcbnew_color_settings.cpp.

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

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

◆ updateSwatches()

void PANEL_COLOR_SETTINGS::updateSwatches ( )

protectedinherited

Definition at line 187 of file panel_color_settings.cpp.

References PANEL_COLOR_SETTINGS::createSwatches(), 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

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 PANEL_COLOR_SETTINGS::saveCurrentTheme().

◆ ValueFromString()

int UNITS_PROVIDER::ValueFromString	(	const wxString &	aTextValue,
		EDA_DATA_TYPE	aType = `EDA_DATA_TYPE::DISTANCE`
	)		const

inlineinherited

Converts aTextValue in aUnits to internal units used by the frame.

Warning: This utilizes the current locale and will break if decimal formats differ

Parameters

aType	is the type of this value, and controls the way the string is converted to a value
aTextValue	A reference to a wxString object containing the string to convert.