#include <dialog_configure_paths.h>

Inheritance diagram for DIALOG_CONFIGURE_PATHS:

Public Types
enum	HOLDER_TYPE { DIALOG , FRAME , PANEL }

Public Member Functions
	DIALOG_CONFIGURE_PATHS (wxWindow *aParent)

	~DIALOG_CONFIGURE_PATHS () override

bool	TransferDataToWindow () override

bool	TransferDataFromWindow () override

void	SetInitialFocus (wxWindow *aWindow)
	Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.

int	ShowModal () override

int	ShowQuasiModal ()

void	EndQuasiModal (int retCode)

bool	IsQuasiModal () const

void	PrepareForModalSubDialog ()

void	CleanupAfterModalSubDialog ()

bool	Show (bool show) override

bool	Enable (bool enable) override

void	OnPaint (wxPaintEvent &event)

void	OnModify ()

void	ClearModify ()

void	SetPosition (const wxPoint &aNewPosition)
	Force the position of the dialog to a new position.

EDA_UNITS	GetUserUnits () const

void	SelectAllInTextCtrls (wxWindowList &children)

void	SetupStandardButtons (std::map< int, wxString > aLabels={})

HOLDER_TYPE	GetType () const

KIWAY &	Kiway () const
	Return a reference to the KIWAY that this object has an opportunity to participate in.

bool	HasKiway () const
	Safety check before asking for the Kiway reference.

PROJECT &	Prj () const
	Return a reference to the PROJECT associated with this KIWAY.

void	SetKiway (wxWindow aDest, KIWAY aKiway)
	It is only used for debugging, since "this" is not a wxWindow*.

Static Public Member Functions
static bool	IsCtrl (int aChar, const wxKeyEvent &e)

static bool	IsShiftCtrl (int aChar, const wxKeyEvent &e)

Protected Member Functions
void	OnUpdateUI (wxUpdateUIEvent &event) override

void	OnGridCellChanging (wxGridEvent &event)

void	OnAddEnvVar (wxCommandEvent &event) override

void	OnRemoveEnvVar (wxCommandEvent &event) override

void	OnHelp (wxCommandEvent &event) override

void	AppendEnvVar (const wxString &aName, const wxString &aPath, bool isExternal)

void	AppendSearchPath (const wxString &aName, const wxString &aPath, const wxString &aDesc)

void	finishDialogSettings ()
	In all dialogs, we must call the same functions to fix minimal dlg size, the default position and perhaps some others to fix a few issues depending on Windows Managers this helper function does these calls.

void	setSizeInDU (int x, int y)
	Set the dialog to the given dimensions in "dialog units".

int	horizPixelsFromDU (int x) const
	Convert an integer number of dialog units to pixels, horizontally.

int	vertPixelsFromDU (int y) const
	Convert an integer number of dialog units to pixels, vertically.

void	resetSize ()
	Clear the existing dialog size and position.

virtual void	OnCharHook (wxKeyEvent &aEvt)

virtual void	TearDownQuasiModal ()
	Override this method to perform dialog tear down actions not suitable for object dtor.

Protected Attributes
WX_GRID *	m_EnvVars

STD_BITMAP_BUTTON *	m_btnAddEnvVar

STD_BITMAP_BUTTON *	m_btnDeleteEnvVar

wxStdDialogButtonSizer *	m_sdbSizer

wxButton *	m_sdbSizerOK

wxButton *	m_sdbSizerCancel

wxButton *	m_sdbSizerHelp

EDA_UNITS	m_units

std::string	m_hash_key

bool	m_useCalculatedSize

bool	m_firstPaintEvent

wxWindow *	m_initialFocusTarget

bool	m_isClosing

wxGUIEventLoop *	m_qmodal_loop

bool	m_qmodal_showing

WINDOW_DISABLER *	m_qmodal_parent_disabler

EDA_BASE_FRAME *	m_parentFrame

std::vector< wxWindow * >	m_tabOrder

wxSize	m_initialSize

std::map< wxWindow *, wxString >	m_beforeEditValues

Private Member Functions
void	OnCloseWindow (wxCloseEvent &aEvent)
	Properly handle the wxCloseEvent when in the quasimodal mode when not calling EndQuasiModal which is possible with any dialog derived from DIALOG_SHIM.

void	OnButton (wxCommandEvent &aEvent)
	Properly handle the default button events when in the quasimodal mode when not calling EndQuasiModal which is possible with any dialog derived from DIALOG_SHIM.

void	onChildSetFocus (wxFocusEvent &aEvent)

	DECLARE_EVENT_TABLE ()

Private Attributes
wxString	m_errorMsg

wxGrid *	m_errorGrid

int	m_errorRow

int	m_errorCol

wxString	m_curdir

wxTextValidator	m_aliasValidator

std::unique_ptr< WX_GRID_AUTOSIZER >	m_gridAutosizer

HTML_WINDOW *	m_helpBox

int	m_heightBeforeHelp

KIWAY *	m_kiway

HOLDER_TYPE	m_type

Detailed Description

Definition at line 40 of file dialog_configure_paths.h.

Member Enumeration Documentation

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE

inherited

Enumerator
DIALOG
FRAME
PANEL

Definition at line 41 of file kiway_holder.h.

Constructor & Destructor Documentation

◆ DIALOG_CONFIGURE_PATHS()

DIALOG_CONFIGURE_PATHS::DIALOG_CONFIGURE_PATHS ( wxWindow * aParent )

Definition at line 63 of file dialog_configure_paths.cpp.

References WX_GRID::ClearRows(), KiBitmapBundle(), DIALOG_CONFIGURE_PATHS_BASE::m_btnAddEnvVar, DIALOG_CONFIGURE_PATHS_BASE::m_btnDeleteEnvVar, m_curdir, DIALOG_CONFIGURE_PATHS_BASE::m_EnvVars, m_gridAutosizer, m_heightBeforeHelp, OnAddEnvVar(), OnGridCellChanging(), STD_BITMAP_BUTTON::SetBitmap(), DIALOG_SHIM::SetInitialFocus(), DIALOG_SHIM::SetupStandardButtons(), TV_FLAG_COL, TV_NAME_COL, and TV_VALUE_COL.

◆ ~DIALOG_CONFIGURE_PATHS()

DIALOG_CONFIGURE_PATHS::~DIALOG_CONFIGURE_PATHS ( )

override

Definition at line 113 of file dialog_configure_paths.cpp.

References DIALOG_CONFIGURE_PATHS_BASE::m_EnvVars, and OnGridCellChanging().

Member Function Documentation

◆ AppendEnvVar()

void DIALOG_CONFIGURE_PATHS::AppendEnvVar	(	const wxString &	aName,
		const wxString &	aPath,
		bool	isExternal
	)

protected

Definition at line 144 of file dialog_configure_paths.cpp.

References ENV_VAR::IsEnvVarImmutable(), DIALOG_CONFIGURE_PATHS_BASE::m_EnvVars, TV_FLAG_COL, TV_NAME_COL, and TV_VALUE_COL.

Referenced by OnAddEnvVar(), and TransferDataToWindow().

◆ AppendSearchPath()

void DIALOG_CONFIGURE_PATHS::AppendSearchPath	(	const wxString &	aName,
		const wxString &	aPath,
		const wxString &	aDesc
	)

protected

◆ CleanupAfterModalSubDialog()

void DIALOG_SHIM::CleanupAfterModalSubDialog ( )

inherited

Definition at line 541 of file dialog_shim.cpp.

References DIALOG_SHIM::m_qmodal_parent_disabler, and WINDOW_DISABLER::ResumeAfterTrueModal().

Referenced by TEXT_BUTTON_URL::OnButtonClick(), and TEXT_BUTTON_FILE_BROWSER::OnButtonClick().

◆ ClearModify()

void DIALOG_SHIM::ClearModify ( )

inherited

Definition at line 448 of file dialog_shim.cpp.

Referenced by DIALOG_SYMBOL_FIELDS_TABLE::OnSaveAndContinue().

◆ DECLARE_EVENT_TABLE()

DIALOG_SHIM::DECLARE_EVENT_TABLE ( )

privateinherited

◆ Enable()

bool DIALOG_SHIM::Enable ( bool enable )

overrideinherited

Definition at line 340 of file dialog_shim.cpp.

◆ EndQuasiModal()

void DIALOG_SHIM::EndQuasiModal ( int retCode )

inherited

Definition at line 548 of file dialog_shim.cpp.

References DIALOG_SHIM::IsQuasiModal(), DIALOG_SHIM::m_qmodal_loop, DIALOG_SHIM::m_qmodal_parent_disabler, DIALOG_SHIM::Show(), and DIALOG_SHIM::TearDownQuasiModal().

Referenced by EDA_3D_CONTROLLER::Main(), DIALOG_EXPORT_NETLIST::OnAddGenerator(), DIALOG_SHIM::OnButton(), DIALOG_EDIT_SYMBOLS_LIBID::onCancel(), DIALOG_LIB_SYMBOL_PROPERTIES::OnCancelButtonClick(), DIALOG_SYMBOL_PROPERTIES::OnCancelButtonClick(), DIALOG_LIB_EDIT_PIN_TABLE::OnClose(), DIALOG_SHIM::OnCloseWindow(), DIALOG_EXPORT_NETLIST::OnDelGenerator(), DIALOG_SYMBOL_PROPERTIES::OnEditLibrarySymbol(), DIALOG_SYMBOL_PROPERTIES::OnEditSymbol(), DIALOG_SYMBOL_PROPERTIES::OnExchangeSymbol(), PCB_ONE_LAYER_SELECTOR::OnLeftGridCellClick(), PCB_ONE_LAYER_SELECTOR::OnRightGridCellClick(), DIALOG_SYMBOL_PROPERTIES::OnUpdateSymbol(), DIALOG_PUSH_PAD_PROPERTIES::PadPropertiesAccept(), and DIALOG_SHIM::~DIALOG_SHIM().

◆ finishDialogSettings()

void DIALOG_SHIM::finishDialogSettings ( )

protectedinherited

In all dialogs, we must call the same functions to fix minimal dlg size, the default position and perhaps some others to fix a few issues depending on Windows Managers this helper function does these calls.

finishDialogSettings must be called from derived classes after all widgets have been initialized, and therefore their size fixed. If TransferDataToWindow() is used to initialize widgets, at the end of TransferDataToWindow, or better yet, at end of a wxInitDialogEvent handler.

Definition at line 165 of file dialog_shim.cpp.

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( ) const

inlineinherited

Definition at line 48 of file kiway_holder.h.

Referenced by DIALOG_SHIM::DIALOG_SHIM(), EDA_3D_CONTROLLER::Main(), and PANEL_PREVIEW_3D_MODEL::onModify().

◆ GetUserUnits()

EDA_UNITS DIALOG_SHIM::GetUserUnits ( ) const

inlineinherited

Definition at line 102 of file dialog_shim.h.

Referenced by DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), DIALOG_SHIM::DIALOG_SHIM(), DIALOG_DRC::OnSaveReport(), POSITION_RELATIVE_TOOL::PositionRelative(), DIALOG_POSITION_RELATIVE::updateAnchorInfo(), DIALOG_MOVE_EXACT::updateDialogControls(), DIALOG_POSITION_RELATIVE::updateDialogControls(), and DIALOG_SET_OFFSET::updateDialogControls().

◆ HasKiway()

bool KIWAY_HOLDER::HasKiway ( ) const

inlineinherited

Safety check before asking for the Kiway reference.

Returns: true if kiway is non-null

Definition at line 65 of file kiway_holder.h.

Referenced by DIALOG_SHIM::~DIALOG_SHIM().

◆ horizPixelsFromDU()

int DIALOG_SHIM::horizPixelsFromDU ( int x ) const

protectedinherited

Convert an integer number of dialog units to pixels, horizontally.

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 183 of file dialog_shim.cpp.

Referenced by DIALOG_SYMBOL_FIELDS_TABLE::DIALOG_SYMBOL_FIELDS_TABLE().

◆ IsCtrl()

static bool DIALOG_SHIM::IsCtrl	(	int	aChar,
		const wxKeyEvent &	e
	)

inlinestaticinherited

Definition at line 111 of file dialog_shim.h.

◆ IsQuasiModal()

bool DIALOG_SHIM::IsQuasiModal ( ) const

inlineinherited

Definition at line 77 of file dialog_shim.h.

Referenced by DIALOG_SHIM::EndQuasiModal(), EDA_3D_CONTROLLER::Main(), DIALOG_EXPORT_NETLIST::OnAddGenerator(), DIALOG_SHIM::OnButton(), DIALOG_EDIT_SYMBOLS_LIBID::onCancel(), DIALOG_BOOK_REPORTER::OnClose(), DIALOG_LIB_EDIT_PIN_TABLE::OnClose(), DIALOG_ERC::OnCloseErcDialog(), DIALOG_SHIM::OnCloseWindow(), DIALOG_EXPORT_NETLIST::OnDelGenerator(), PCB_ONE_LAYER_SELECTOR::OnLeftGridCellClick(), PCB_ONE_LAYER_SELECTOR::OnRightGridCellClick(), DIALOG_PUSH_PAD_PROPERTIES::PadPropertiesAccept(), and DIALOG_SHIM::~DIALOG_SHIM().

◆ IsShiftCtrl()

static bool DIALOG_SHIM::IsShiftCtrl	(	int	aChar,
		const wxKeyEvent &	e
	)

inlinestaticinherited

Definition at line 117 of file dialog_shim.h.

◆ Kiway()

KIWAY & KIWAY_HOLDER::Kiway ( ) const

inlineinherited

Return a reference to the KIWAY that this object has an opportunity to participate in.

A KIWAY_HOLDER is not necessarily a KIWAY_PLAYER.

Definition at line 55 of file kiway_holder.h.

Referenced by PROJECT_TREE_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), IMPORT_PROJ_HELPER::addLocalLibraries(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), CVPCB_MAINFRAME::BuildLibrariesList(), KICAD_MANAGER_FRAME::CloseProject(), COMMON_CONTROL::ConfigurePaths(), BOARD_INSPECTION_TOOL::constructDiffPanel(), PANEL_SYMBOL_CHOOSER::constructRightPanel(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), KIWAY_PLAYER::Destroy(), DIALOG_LIST_HOTKEYS::DIALOG_LIST_HOTKEYS(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), IMPORT_PROJ_HELPER::doImport(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), FIELDS_GRID_TRICKS::doPopupSelection(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), PANEL_JOBSET::EnsurePcbSchFramesOpen(), SIMULATOR_CONTROL::ExportPlotToSchematic(), BACK_ANNOTATE::FetchNetlistFromPCB(), PANEL_SYMBOL_CHOOSER::FinishSetup(), EDA_DRAW_FRAME::IsScriptingConsoleVisible(), KIWAY_PLAYER::language_change(), KICAD_MANAGER_FRAME::language_change(), DIALOG_CHANGE_SYMBOLS::launchMatchIdSymbolBrowser(), DIALOG_CHANGE_SYMBOLS::launchNewIdSymbolBrowser(), PGM_SINGLE_TOP::MacOpenFile(), PLUGIN_CONTENT_MANAGER::MarkInstalled(), DESIGN_BLOCK_CONTROL::notifyOtherFrames(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), PCB_CALCULATOR_FRAME::OnExit(), SIMULATOR_FRAME::onExit(), SAVE_AS_TRAVERSER::OnFile(), PANEL_DESTINATION::OnGenerate(), PANEL_JOBSET::OnGenerateAllDestinationsClick(), KIGFX::WX_VIEW_CONTROLS::onMotion(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), PANEL_COMPONENT_CLASS_CONDITION_FOOTPRINT::OnShowLibraryClick(), DIALOG_FIELD_PROPERTIES::OnTextValueSelectButtonClick(), PANEL_JOBSET::OpenJobOptionsForListItem(), PANEL_FOOTPRINT_CHOOSER::PANEL_FOOTPRINT_CHOOSER(), PCB_DESIGN_BLOCK_PREVIEW_WIDGET::PCB_DESIGN_BLOCK_PREVIEW_WIDGET(), KIWAY_HOLDER::Prj(), SIMULATOR_CONTROL::Probe(), SCH_EDIT_TOOL::Properties(), BACK_ANNOTATE::PushNewLinksToPCB(), SCH_EDITOR_CONTROL::rescueProject(), SCH_INSPECTION_TOOL::RunSimulation(), CVPCB_MAINFRAME::SaveFootprintAssociation(), EDA_DRAW_FRAME::ScriptingConsoleEnableDisable(), CVPCB_MAINFRAME::SendComponentSelectionToSch(), BOARD_EDITOR_CONTROL::ShowEeschema(), CVPCB_CONTROL::ShowFootprintViewer(), showFrame(), COMMON_CONTROL::ShowLibraryTable(), COMMON_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPluginManager(), EDA_BASE_FRAME::ShowPreferences(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::ShowPreview(), FP_TREE_SYNCHRONIZING_ADAPTER::ShowPreview(), COMMON_CONTROL::ShowProjectManager(), SCH_EDITOR_CONTROL::SimProbe(), SCH_EDITOR_CONTROL::SimTune(), DIALOG_ERC::testErc(), DIALOG_FOOTPRINT_ASSOCIATIONS::TransferDataToWindow(), SIMULATOR_CONTROL::Tune(), KICAD_MANAGER_FRAME::UnarchiveFiles(), BOARD_EDITOR_CONTROL::UpdateSchematicFromPCB(), DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint(), and DIALOG_SHIM::~DIALOG_SHIM().

◆ OnAddEnvVar()

void DIALOG_CONFIGURE_PATHS::OnAddEnvVar ( wxCommandEvent & event )

overrideprotectedvirtual

Reimplemented from DIALOG_CONFIGURE_PATHS_BASE.

Definition at line 317 of file dialog_configure_paths.cpp.

References AppendEnvVar(), WX_GRID::CommitPendingChanges(), DIALOG_CONFIGURE_PATHS_BASE::m_EnvVars, and TV_NAME_COL.

Referenced by DIALOG_CONFIGURE_PATHS().

◆ OnButton()

void DIALOG_SHIM::OnButton ( wxCommandEvent & aEvent )

privateinherited

Properly handle the default button events when in the quasimodal mode when not calling EndQuasiModal which is possible with any dialog derived from DIALOG_SHIM.

Definition at line 597 of file dialog_shim.cpp.

References DIALOG_SHIM::EndQuasiModal(), ignore_unused(), and DIALOG_SHIM::IsQuasiModal().

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

◆ OnCharHook()

void DIALOG_SHIM::OnCharHook ( wxKeyEvent & aEvt )

protectedvirtualinherited

Reimplemented in HK_PROMPT_DIALOG, and HTML_MESSAGE_BOX.

Definition at line 651 of file dialog_shim.cpp.

References delta, DIALOG_SHIM::m_beforeEditValues, DIALOG_SHIM::m_parentFrame, DIALOG_SHIM::m_tabOrder, and EDA_BASE_FRAME::ToggleUserUnits().

Referenced by DIALOG_TABLECELL_PROPERTIES::DIALOG_TABLECELL_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TEXTBOX_PROPERTIES::DIALOG_TEXTBOX_PROPERTIES(), and DIALOG_TEXTBOX_PROPERTIES::~DIALOG_TEXTBOX_PROPERTIES().

◆ onChildSetFocus()

void DIALOG_SHIM::onChildSetFocus ( wxFocusEvent & aEvent )

privateinherited

Definition at line 635 of file dialog_shim.cpp.

References DIALOG_SHIM::m_beforeEditValues, and DIALOG_SHIM::m_isClosing.

Referenced by DIALOG_SHIM::SelectAllInTextCtrls(), and DIALOG_SHIM::~DIALOG_SHIM().

◆ OnCloseWindow()

void DIALOG_SHIM::OnCloseWindow ( wxCloseEvent & aEvent )

privateinherited

Properly handle the wxCloseEvent when in the quasimodal mode when not calling EndQuasiModal which is possible with any dialog derived from DIALOG_SHIM.

Definition at line 581 of file dialog_shim.cpp.

References APP_MONITOR::AddNavigationBreadcrumb(), DIALOG_SHIM::EndQuasiModal(), and DIALOG_SHIM::IsQuasiModal().

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

◆ OnGridCellChanging()

void DIALOG_CONFIGURE_PATHS::OnGridCellChanging ( wxGridEvent & event )

protected

◆ OnHelp()

void DIALOG_CONFIGURE_PATHS::OnHelp ( wxCommandEvent & event )

overrideprotectedvirtual

Reimplemented from DIALOG_CONFIGURE_PATHS_BASE.

Definition at line 377 of file dialog_configure_paths.cpp.

References _, ENV_VAR::GetPredefinedEnvVars(), ENV_VAR::LookUpEnvVarHelp(), m_heightBeforeHelp, m_helpBox, and HTML_WINDOW::SetPage().

◆ OnModify()

void DIALOG_SHIM::OnModify ( )

inherited

Definition at line 441 of file dialog_shim.cpp.

◆ OnPaint()

void DIALOG_SHIM::OnPaint ( wxPaintEvent & event )

inherited

Definition at line 421 of file dialog_shim.cpp.

References KIPLATFORM::UI::FixupCancelButtonCmdKeyCollision(), KIPLATFORM::UI::ForceFocus(), DIALOG_SHIM::m_firstPaintEvent, DIALOG_SHIM::m_initialFocusTarget, and DIALOG_SHIM::SelectAllInTextCtrls().

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

◆ OnRemoveEnvVar()

void DIALOG_CONFIGURE_PATHS::OnRemoveEnvVar ( wxCommandEvent & event )

overrideprotectedvirtual

Reimplemented from DIALOG_CONFIGURE_PATHS_BASE.

Definition at line 332 of file dialog_configure_paths.cpp.

References WX_GRID::CommitPendingChanges(), ENV_VAR::IsEnvVarImmutable(), DIALOG_CONFIGURE_PATHS_BASE::m_EnvVars, and TV_NAME_COL.

◆ OnUpdateUI()

void DIALOG_CONFIGURE_PATHS::OnUpdateUI ( wxUpdateUIEvent & event )

overrideprotectedvirtual

Reimplemented from DIALOG_CONFIGURE_PATHS_BASE.

Definition at line 354 of file dialog_configure_paths.cpp.

References DisplayErrorMessage(), grid, m_errorCol, m_errorGrid, m_errorMsg, and m_errorRow.

◆ PrepareForModalSubDialog()

void DIALOG_SHIM::PrepareForModalSubDialog ( )

inherited

Definition at line 534 of file dialog_shim.cpp.

References DIALOG_SHIM::m_qmodal_parent_disabler, and WINDOW_DISABLER::SuspendForTrueModal().

Referenced by TEXT_BUTTON_URL::OnButtonClick(), and TEXT_BUTTON_FILE_BROWSER::OnButtonClick().

◆ Prj()

PROJECT & KIWAY_HOLDER::Prj ( ) const

inherited

Return a reference to the PROJECT associated with this KIWAY.

Definition at line 36 of file kiway_holder.cpp.

References KIWAY_HOLDER::Kiway(), and KIWAY::Prj().

◆ resetSize()

void DIALOG_SHIM::resetSize ( )

protectedinherited

Clear the existing dialog size and position.

This will cause the dialog size to be clear so the next time the dialog is shown the sizers will layout the dialog accordingly. This useful when there are dialog windows that size changes due to layout dependency hidden controls.

Definition at line 315 of file dialog_shim.cpp.

References class_map, and DIALOG_SHIM::m_hash_key.

Referenced by DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES(), and DIALOG_PAD_PROPERTIES::updatePadSizeControls().

◆ SelectAllInTextCtrls()

void DIALOG_SHIM::SelectAllInTextCtrls ( wxWindowList & children )

inherited

Definition at line 350 of file dialog_shim.cpp.

References ignore_unused(), DIALOG_SHIM::m_beforeEditValues, minSize, DIALOG_SHIM::onChildSetFocus(), and DIALOG_SHIM::SelectAllInTextCtrls().

Referenced by DIALOG_SHIM::OnPaint(), and DIALOG_SHIM::SelectAllInTextCtrls().

◆ SetInitialFocus()

void DIALOG_SHIM::SetInitialFocus ( wxWindow * aWindow )

inlineinherited

Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.

Definition at line 66 of file dialog_shim.h.

◆ SetKiway()

void KIWAY_HOLDER::SetKiway	(	wxWindow *	aDest,
		KIWAY *	aKiway
	)

inherited

It is only used for debugging, since "this" is not a wxWindow*.

"this" is a KIWAY_HOLDER mix-in.

Parameters

aDest	is the recipient of aKiway pointer.
aKiway	is often from a parent window or from KIFACE::CreateKiWindow().

Definition at line 43 of file kiway_holder.cpp.

References ignore_unused(), KIWAY_HOLDER::m_kiway, and name.

Referenced by PCB::IFACE::CreateKiWindow(), InvokePcbLibTableEditor(), and InvokeSchEditSymbolLibTable().

◆ SetPosition()

void DIALOG_SHIM::SetPosition ( const wxPoint & aNewPosition )

inherited

Force the position of the dialog to a new position.

Parameters

aNewPosition is the new forced position

Definition at line 204 of file dialog_shim.cpp.

References class_map, and DIALOG_SHIM::m_hash_key.

Referenced by PCB_BASE_FRAME::SelectOneLayer().

◆ setSizeInDU()

void DIALOG_SHIM::setSizeInDU	(	int	x,
		int	y
	)

protectedinherited

Set the dialog to the given dimensions in "dialog units".

These are units equivalent to 4* the average character width and 8* the average character height, allowing a dialog to be sized in a way that scales it with the system font.

Definition at line 176 of file dialog_shim.cpp.

Referenced by HTML_MESSAGE_BOX::HTML_MESSAGE_BOX(), and HTML_MESSAGE_BOX::SetDialogSizeInDU().

◆ SetupStandardButtons()

void DIALOG_SHIM::SetupStandardButtons ( std::map< int, wxString > aLabels = {} )

inherited

Definition at line 837 of file dialog_shim.cpp.

References recursiveDescent().

◆ Show()

bool DIALOG_SHIM::Show ( bool show )

overrideinherited

Definition at line 233 of file dialog_shim.cpp.

References class_map, DIALOG_SHIM::m_hash_key, DIALOG_SHIM::m_initialSize, and DIALOG_SHIM::m_useCalculatedSize.

Referenced by FOOTPRINT_EDITOR_CONTROL::CheckFootprint(), ARRAY_TOOL::CreateArray(), FOOTPRINT_EDITOR_CONTROL::CrossProbe(), SCH_INSPECTION_TOOL::CrossProbe(), BOARD_INSPECTION_TOOL::DiffFootprint(), SCH_INSPECTION_TOOL::DiffSymbol(), SCH_EDITOR_CONTROL::EditSymbolFields(), DIALOG_SHIM::EndQuasiModal(), SCH_EDITOR_CONTROL::GenerateBOM(), GROUP_TOOL::GroupProperties(), HOTKEY_CYCLE_POPUP::HOTKEY_CYCLE_POPUP(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), BOARD_INSPECTION_TOOL::InspectDRCError(), SCH_INSPECTION_TOOL::NextMarker(), DRC_TOOL::NextMarker(), SCH_EDIT_FRAME::OnAnnotate(), DIALOG_DRC::OnDRCItemDClick(), DIALOG_ERC::OnERCItemDClick(), DIALOG_CLEANUP_GRAPHICS::OnLeftDClickItem(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnLeftDClickItem(), DIALOG_FOOTPRINT_CHECKER::OnLeftDClickItem(), SCH_GROUP_TOOL::PickNewMember(), PCB_GROUP_TOOL::PickNewMember(), HOTKEY_CYCLE_POPUP::Popup(), POSITION_RELATIVE_TOOL::PositionRelative(), SCH_INSPECTION_TOOL::PrevMarker(), DRC_TOOL::PrevMarker(), CVPCB_MAINFRAME::readNetListAndFpFiles(), DIALOG_PAD_PROPERTIES::Show(), EDA_VIEW_SWITCHER::Show(), EDA_LIST_DIALOG::Show(), DIALOG_FIND::Show(), SCH_INSPECTION_TOOL::ShowBusSyntaxHelp(), DRC_TOOL::ShowDRCDialog(), SCH_INSPECTION_TOOL::ShowERCDialog(), SCH_EDIT_FRAME::ShowFindReplaceDialog(), GENERATOR_TOOL::ShowGeneratorsManager(), HTML_MESSAGE_BOX::ShowModeless(), DIALOG_SHIM::ShowQuasiModal(), DIALOG_CREATE_ARRAY::UpdatePickedItem(), DIALOG_POSITION_RELATIVE::UpdatePickedItem(), DIALOG_CREATE_ARRAY::UpdatePickedPoint(), and DIALOG_POSITION_RELATIVE::UpdatePickedPoint().

◆ ShowModal()

int DIALOG_SHIM::ShowModal ( )

overrideinherited

Definition at line 454 of file dialog_shim.cpp.

References KIPLATFORM::UI::ReparentModal().

Referenced by SYMBOL_TREE_MODEL_ADAPTER::AddLibraries(), PANEL_SETUP_LAYERS::addUserDefinedLayer(), MULTICHANNEL_TOOL::AutogenerateRuleAreas(), GRID_CELL_COLOR_SELECTOR::BeginEdit(), SCH_INSPECTION_TOOL::CheckSymbol(), FOOTPRINT_EDITOR_CONTROL::CleanupGraphics(), GLOBAL_EDIT_TOOL::CleanupGraphics(), GLOBAL_EDIT_TOOL::CleanupTracksAndVias(), COMMON_CONTROL::ConfigurePaths(), DIALOG_PLOT::CreateDrillFile(), SYMBOL_EDIT_FRAME::CreateNewSymbol(), MICROWAVE_TOOL::createPolygonShape(), CONVERT_TOOL::CreatePolys(), ROUTER_TOOL::CustomTrackWidthDialog(), FOOTPRINT_LIST::DisplayErrors(), PANEL_DESIGN_BLOCK_CHOOSER::displayErrors(), DisplayHotkeyList(), SIGNALS_GRID_TRICKS::doPopupSelection(), CURSORS_GRID_TRICKS::doPopupSelection(), MEASUREMENTS_GRID_TRICKS::doPopupSelection(), ROUTER_TOOL::DpDimensionsDialog(), SIMULATOR_FRAME::EditAnalysis(), DESIGN_BLOCK_PANE::EditDesignBlockProperties(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), SYMBOL_EDITOR_EDIT_TOOL::editShapeProperties(), SCH_EDIT_FRAME::EditSheetProperties(), FOOTPRINT_EDITOR_CONTROL::EditTextAndGraphics(), GLOBAL_EDIT_TOOL::EditTextAndGraphics(), SYMBOL_EDITOR_EDIT_TOOL::editTextBoxProperties(), SYMBOL_EDITOR_EDIT_TOOL::editTextProperties(), EESCHEMA_JOBS_HANDLER::EESCHEMA_JOBS_HANDLER(), VIA_SIZE_MENU::eventHandler(), BOARD_EDITOR_CONTROL::ExportGenCAD(), BOARD_EDITOR_CONTROL::ExportIDF(), BOARD_EDITOR_CONTROL::ExportSTEP(), GERBVIEW_CONTROL::ExportToPcbnew(), BOARD_EDITOR_CONTROL::ExportVRML(), EDIT_TOOL::FilletTracks(), PCB_SELECTION_TOOL::filterSelection(), BOARD_EDITOR_CONTROL::GenerateDrillFiles(), BOARD_EDITOR_CONTROL::GenerateODBPPFiles(), BOARD_EDITOR_CONTROL::GeneratePosFile(), BOARD_EDITOR_CONTROL::GenIPC2581File(), GetChamferParams(), GetDogboneParams(), GetFootprintFromBoardByReference(), COLOR_SWATCH::GetNewSwatchColor(), GetRadiusParams(), GetSequentialPadNumberingParams(), GLOBAL_EDIT_TOOL::GlobalDeletions(), SCH_EDIT_TOOL::GlobalEdit(), COMMON_TOOLS::GridOrigin(), SCH_EDIT_FRAME::importFile(), SCH_DRAWING_TOOLS::ImportGraphics(), SYMBOL_EDITOR_DRAWING_TOOLS::ImportGraphics(), SCH_EDITOR_CONTROL::IncrementAnnotations(), PCB_EDIT_FRAME::InstallNetlistFrame(), InvokeDialogNetList(), InvokeEditDesignBlockLibTable(), InvokePcbLibTableEditor(), InvokeRuleAreaEditor(), InvokeSchEditSymbolLibTable(), SYMBOL_VIEWER_FRAME::loadAllLibraries(), GERBVIEW_FRAME::LoadGerberJobFile(), SCH::IFACE::loadGlobalLibTable(), PCB::IFACE::loadGlobalLibTable(), GERBVIEW_FRAME::LoadListOfGerberAndDrillFiles(), GERBVIEW_FRAME::LoadZipArchiveFile(), SETTINGS_MANAGER::MigrateIfNeeded(), SCH_EDIT_FRAME::ModalAnnotate(), EDIT_TOOL::MoveExact(), PCB_POINT_EDITOR::movePoint(), SIMULATOR_CONTROL::NewAnalysisTab(), KICAD_MANAGER_CONTROL::NewFromRepository(), KICAD_MANAGER_CONTROL::NewFromTemplate(), PANEL_JOBSET::OnAddDestinationClick(), PANEL_SETUP_BOARD_STACKUP::onAddDielectricLayer(), DIALOG_LIB_SYMBOL_PROPERTIES::OnAddFootprintFilter(), DIALOG_EXPORT_NETLIST::OnAddGenerator(), PANEL_GRID_SETTINGS::OnAddGrid(), PCB_NET_INSPECTOR_PANEL::onAddGroup(), PANEL_JOBSET::OnAddJobClick(), PCB_NET_INSPECTOR_PANEL::onAddNet(), PANEL_REGULATOR::OnAddRegulator(), DIALOG_SCHEMATIC_SETUP::onAuxiliaryAction(), DIALOG_BOARD_SETUP::onAuxiliaryAction(), DIALOG_SYMBOL_FIELDS_TABLE::onBomFmtPresetChanged(), DIALOG_SYMBOL_FIELDS_TABLE::onBomPresetChanged(), PANEL_SETUP_BOARD_STACKUP::onColorSelected(), DIALOG_DRC::OnDRCItemRClick(), DIALOG_LIB_SYMBOL_PROPERTIES::OnEditFootprintFilter(), PANEL_GRID_SETTINGS::onEditGrid(), PANEL_REGULATOR::OnEditRegulator(), DIALOG_LIB_SYMBOL_PROPERTIES::OnEditSpiceModel(), DIALOG_SYMBOL_PROPERTIES::OnEditSpiceModel(), DIALOG_ERC::OnERCItemRClick(), DIALOG_EXPORT_STEP::onExportButton(), PROJECT_TREE_PANE::onGitCommit(), PROJECT_TREE_PANE::onGitInitializeProject(), PROJECT_TREE_PANE::onGitSwitchBranch(), LIB_TREE::onHeaderContextMenu(), PROPERTIES_FRAME::onHelp(), PANEL_DESTINATION::OnLastStatusClick(), APPEARANCE_CONTROLS_3D::onLayerPresetChanged(), APPEARANCE_CONTROLS::onLayerPresetChanged(), DIALOG_PCM::OnManageRepositoriesClicked(), PANEL_SETUP_BOARD_STACKUP::onMaterialChange(), PANEL_FP_LIB_TABLE::onMigrateLibraries(), PANEL_DESTINATION::OnProperties(), PANEL_SETUP_BOARD_STACKUP::onRemoveDielectricLayer(), PCB_NET_INSPECTOR_PANEL::onRenameSelectedNet(), PANEL_SYM_LIB_TABLE::onReset(), PANEL_FP_LIB_TABLE::onReset(), PANEL_PCBNEW_ACTION_PLUGINS::OnShowErrorsButtonClick(), DIALOG_FOOTPRINT_WIZARD_LIST::onShowTrace(), APPEARANCE_CONTROLS_3D::onViewportChanged(), APPEARANCE_CONTROLS::onViewportChanged(), PANEL_JOBSET::OpenJobOptionsForListItem(), PCB_EDIT_FRAME::OpenProjectFiles(), DESIGN_BLOCK_GRID_TRICKS::optionsEditor(), SYMBOL_GRID_TRICKS::optionsEditor(), FP_GRID_TRICKS::optionsEditor(), DIALOG_PAD_PROPERTIES::padValuesOK(), BOARD_EDITOR_CONTROL::PageSettings(), SCH_EDITOR_CONTROL::PageSetup(), PL_EDITOR_CONTROL::PageSetup(), SCH_EDITOR_CONTROL::Paste(), PCB_CONTROL::Paste(), PCBNEW_JOBS_HANDLER::PCBNEW_JOBS_HANDLER(), SCH_BASE_FRAME::PickSymbolFromLibrary(), SYMBOL_EDITOR_EDIT_TOOL::PinTable(), DRAWING_TOOL::PlaceImportedGraphics(), DRAWING_TOOL::PlaceTuningPattern(), SCH_EDITOR_CONTROL::Plot(), POSITION_RELATIVE_TOOL::PositionRelativeInteractively(), SYMBOL_LIBRARY_MANAGER::Preload(), SCH_EDITOR_CONTROL::Print(), GERBVIEW_CONTROL::Print(), PCB_CONTROL::Print(), HK_PROMPT_DIALOG::PromptForKey(), SCH_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), PAD_TOOL::pushPadSettings(), GERBVIEW_FRAME::Read_EXCELLON_File(), GERBVIEW_FRAME::Read_GERBER_File(), CVPCB_MAINFRAME::readNetListAndFpFiles(), GLOBAL_EDIT_TOOL::RemoveUnusedPads(), MULTICHANNEL_TOOL::repeatLayout(), DIALOG_IMPORT_CHOOSE_PROJECT::RunModal(), DIALOG_MAP_LAYERS::RunModal(), PCB_EDIT_FRAME::SaveBoardAsDesignBlock(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), SCH_EDIT_FRAME::SaveSelectionAsDesignBlock(), PCB_EDIT_FRAME::SaveSelectionAsDesignBlock(), SCH_EDIT_FRAME::SaveSheetAsDesignBlock(), SCH_EDIT_FRAME::SaveSheetToDesignBlock(), SYMBOL_EDIT_FRAME::saveSymbolCopyAs(), PROJECT_SCH::SchLibs(), ROUTER_TOOL::SelectCopperLayerPair(), FOOTPRINT_EDIT_FRAME::SelectFootprintFromBoard(), FOOTPRINT_WIZARD_FRAME::SelectFootprintWizard(), PCB_BASE_FRAME::SelectLibrary(), SCH_BASE_FRAME::SelectLibraryFromList(), PCB_BASE_FRAME::SelectOneLayer(), GERBVIEW_FRAME::SelectPCBLayer(), GERBVIEW_FRAME::SetLayerDrawPrms(), ROUTER_TOOL::SettingsDialog(), BOARD_INSPECTION_TOOL::ShowBoardStatistics(), PL_EDITOR_FRAME::ShowDesignInspector(), DRC_TOOL::ShowDRCDialog(), CVPCB_CONTROL::ShowEquFileTable(), BOARD_INSPECTION_TOOL::ShowFootprintLinks(), DIALOG_LOCKED_ITEMS_QUERY::ShowModal(), SIMULATOR_CONTROL::ShowNetlist(), KICAD_MANAGER_CONTROL::ShowPluginManager(), EDA_BASE_FRAME::ShowPreferences(), PCB_TUNING_PATTERN::ShowPropertiesDialog(), BOARD_REANNOTATE_TOOL::ShowReannotateDialog(), PCB_BASE_EDIT_FRAME::ShowReferenceImagePropertiesDialog(), SYMBOL_LIB_TABLE_ROW::ShowSettingsDialog(), PCB_EDIT_FRAME::ShowTargetOptionsDialog(), SCH_DRAWING_TOOLS::SingleClickPlace(), GLOBAL_EDIT_TOOL::SwapLayers(), DIALOG_IMPORT_GFX_SCH::TransferDataFromWindow(), DIALOG_IMPORT_GRAPHICS::TransferDataFromWindow(), EDA_3D_VIEWER_FRAME::TryBefore(), PCB_BASE_EDIT_FRAME::TryBefore(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), SCH_EDITOR_CONTROL::UpdateFromPCB(), BOARD_EDITOR_CONTROL::UpdatePCBFromSchematic(), SYMBOL_EDITOR_EDIT_TOOL::UpdateSymbolFields(), DIALOG_SHAPE_PROPERTIES::Validate(), and PANEL_PREVIEW_3D_MODEL::View3DSettings().

◆ ShowQuasiModal()

int DIALOG_SHIM::ShowQuasiModal ( )

inherited

Definition at line 489 of file dialog_shim.cpp.

References DIALOG_SHIM::m_qmodal_loop, DIALOG_SHIM::m_qmodal_parent_disabler, DIALOG_SHIM::m_qmodal_showing, KIPLATFORM::UI::ReparentModal(), and DIALOG_SHIM::Show().

Referenced by PANEL_FP_PROPERTIES_3D_MODEL::Cfg3DPath(), DIALOG_SELECT_3DMODEL::Cfg3DPaths(), SCH_EDIT_TOOL::ChangeSymbols(), MICROWAVE_TOOL::createFootprint(), PCB::IFACE::CreateKiWindow(), MICROWAVE_TOOL::createMicrowaveInductor(), SCH_DRAWING_TOOLS::createNewLabel(), SCH_DRAWING_TOOLS::createNewText(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), SCH_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawTable(), DRAWING_TOOL::DrawTable(), SYMBOL_EDITOR_EDIT_TOOL::editFieldProperties(), SCH_EDIT_TOOL::editFieldText(), FOOTPRINT_EDIT_FRAME::editFootprintProperties(), SYMBOL_EDITOR_EDIT_TOOL::editSymbolProperties(), SCH_EDIT_TABLE_TOOL::EditTable(), PCB_EDIT_TABLE_TOOL::EditTable(), GLOBAL_EDIT_TOOL::EditTeardrops(), GLOBAL_EDIT_TOOL::EditTracksAndVias(), SIMULATOR_CONTROL::EditUserDefinedSignals(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), BOARD_EDITOR_CONTROL::GenerateGerbers(), InvokeCopperZonesEditor(), InvokeDialogCreateBOM(), InvokeDialogEditSymbolsLibId(), InvokeDialogRescueEach(), InvokeNonCopperZonesEditor(), PANEL_FP_PROPERTIES_3D_MODEL::OnAdd3DModel(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), PCB_EDIT_FRAME::OnEditItemRequest(), PANEL_JOBSET::OpenJobOptionsForListItem(), SCH_EDIT_FRAME::OpenProjectFiles(), DRAWING_TOOL::PlaceText(), BOARD_EDITOR_CONTROL::Plot(), SCH_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), SCH_EDITOR_CONTROL::RemapSymbols(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), PCB_EDIT_FRAME::ShowExchangeFootprintsDialog(), PCB_EDIT_FRAME::ShowFootprintPropertiesDialog(), PCB_BASE_EDIT_FRAME::ShowGraphicItemPropertiesDialog(), PCB_BASE_FRAME::ShowPadPropertiesDialog(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), PCB_BASE_EDIT_FRAME::ShowTextBoxPropertiesDialog(), PCB_BASE_EDIT_FRAME::ShowTextPropertiesDialog(), and GLOBAL_EDIT_TOOL::ZonesManager().

◆ TearDownQuasiModal()

virtual void DIALOG_SHIM::TearDownQuasiModal ( )

inlineprotectedvirtualinherited

Override this method to perform dialog tear down actions not suitable for object dtor.

Warning: This only gets called for dialogs that are shown in the quasimodal mode. If you need to perform tear down actions in modal or modeless dialogs, create a close window event handler.

Definition at line 173 of file dialog_shim.h.

Referenced by DIALOG_SHIM::EndQuasiModal().