Dialog to globally edit the LIB_ID of groups if symbols having the same initial LIB_ID. More...

Inheritance diagram for DIALOG_EDIT_SYMBOLS_LIBID:

Public Types
enum	HOLDER_TYPE { DIALOG , FRAME , PANEL }

Public Member Functions
	DIALOG_EDIT_SYMBOLS_LIBID (SCH_EDIT_FRAME *aParent)

	~DIALOG_EDIT_SYMBOLS_LIBID () override

SCH_EDIT_FRAME *	GetParent ()

bool	IsSchematicModified ()

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

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

wxButton *	m_buttonOrphanItems

wxCheckBox *	m_checkBoxUpdateFields

wxStdDialogButtonSizer *	m_sdbSizer

wxButton *	m_sdbSizerOK

wxButton *	m_sdbSizerCancel

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

WDO_ENABLE_DISABLE *	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	initDlg ()

void	AddRowToGrid (bool aMarkRow, const wxString &aReferences, const wxString &aStrLibId)
	Add a new row (new entry) in m_grid.

bool	validateLibIds ()
	returns true if all new lib id are valid

bool	setLibIdByBrowser (int aRow)
	Run the lib browser and set the selected LIB_ID for aRow.

void	onCellBrowseLib (wxGridEvent &event) override

void	onCancel (wxCommandEvent &event) override

void	onClickOrphansButton (wxCommandEvent &event) override

bool	TransferDataFromWindow () override

void	AdjustGridColumns ()

void	OnSizeGrid (wxSizeEvent &event) override

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
bool	m_isModified

std::vector< int >	m_OrphansRowIndexes

std::vector< SYMBOL_CANDIDATE >	m_symbols

GRIDCELL_AUTOWRAP_STRINGRENDERER *	m_autoWrapRenderer

KIWAY *	m_kiway

HOLDER_TYPE	m_type

Detailed Description

Dialog to globally edit the LIB_ID of groups if symbols having the same initial LIB_ID.

This is useful when you want to:

move a symbol from a symbol library to another symbol library.
change the nickname of a library.
globally replace the symbol used by a group of symbols by another symbol.

Definition at line 285 of file dialog_edit_symbols_libid.cpp.

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

DIALOG_EDIT_SYMBOLS_LIBID::DIALOG_EDIT_SYMBOLS_LIBID ( SCH_EDIT_FRAME * aParent )

Definition at line 352 of file dialog_edit_symbols_libid.cpp.

References DIALOG_SHIM::finishDialogSettings(), initDlg(), m_autoWrapRenderer, and DIALOG_EDIT_SYMBOLS_LIBID_BASE::m_grid.

◆ ~DIALOG_EDIT_SYMBOLS_LIBID()

DIALOG_EDIT_SYMBOLS_LIBID::~DIALOG_EDIT_SYMBOLS_LIBID ( )

override

Definition at line 365 of file dialog_edit_symbols_libid.cpp.

References m_autoWrapRenderer, and DIALOG_EDIT_SYMBOLS_LIBID_BASE::m_grid.

Member Function Documentation

◆ AddRowToGrid()

void DIALOG_EDIT_SYMBOLS_LIBID::AddRowToGrid	(	bool	aMarkRow,
		const wxString &	aReferences,
		const wxString &	aStrLibId
	)

private

Add a new row (new entry) in m_grid.

Parameters

aMarkRow	set to true to use bold/italic font in column COL_CURR_LIBID.
aReferences	is the value of cell( aRowId, COL_REFS).
aStrLibId	is the value of cell( aRowId, COL_CURR_LIBID).

Definition at line 475 of file dialog_edit_symbols_libid.cpp.

References GRIDCELL_AUTOWRAP_STRINGRENDERER::Clone(), COL_CURR_LIBID, COL_NEW_LIBID, COL_REFS, GRIDCELL_AUTOWRAP_STRINGRENDERER::GetHeight(), m_autoWrapRenderer, DIALOG_EDIT_SYMBOLS_LIBID_BASE::m_grid, m_OrphansRowIndexes, and UnescapeString().

Referenced by initDlg().

◆ AdjustGridColumns()

void DIALOG_EDIT_SYMBOLS_LIBID::AdjustGridColumns ( )

private

Definition at line 791 of file dialog_edit_symbols_libid.cpp.

References COL_CURR_LIBID, COL_NEW_LIBID, COL_REFS, KIUI::GetTextSize(), KIPLATFORM::UI::GetUnobscuredSize(), and DIALOG_EDIT_SYMBOLS_LIBID_BASE::m_grid.

Referenced by OnSizeGrid().

◆ ClearModify()

void DIALOG_SHIM::ClearModify ( )

inherited

Definition at line 468 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 361 of file dialog_shim.cpp.

◆ EndQuasiModal()

void DIALOG_SHIM::EndQuasiModal ( int retCode )

inherited

Definition at line 562 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 DIALOG_FOOTPRINT_CHOOSER::DIALOG_FOOTPRINT_CHOOSER(), EDA_3D_CONTROLLER::Main(), DIALOG_EXPORT_NETLIST::OnAddGenerator(), DIALOG_SHIM::OnButton(), 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 186 of file dialog_shim.cpp.

◆ GetParent()

SCH_EDIT_FRAME * DIALOG_EDIT_SYMBOLS_LIBID::GetParent ( )

Definition at line 469 of file dialog_edit_symbols_libid.cpp.

Referenced by initDlg(), setLibIdByBrowser(), and TransferDataFromWindow().

◆ 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 130 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 204 of file dialog_shim.cpp.

Referenced by DIALOG_SYMBOL_FIELDS_TABLE::DIALOG_SYMBOL_FIELDS_TABLE().

◆ initDlg()

void DIALOG_EDIT_SYMBOLS_LIBID::initDlg ( )

private

◆ IsCtrl()

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

inlinestaticinherited

Definition at line 139 of file dialog_shim.h.

◆ IsQuasiModal()

bool DIALOG_SHIM::IsQuasiModal ( ) const

inlineinherited

Definition at line 113 of file dialog_shim.h.

Referenced by DIALOG_SHIM::EndQuasiModal(), EDA_3D_CONTROLLER::Main(), DIALOG_EXPORT_NETLIST::OnAddGenerator(), DIALOG_SHIM::OnButton(), 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().

◆ IsSchematicModified()

bool DIALOG_EDIT_SYMBOLS_LIBID::IsSchematicModified ( )

inline

Definition at line 293 of file dialog_edit_symbols_libid.cpp.

References m_isModified.

Referenced by InvokeDialogEditSymbolsLibId().

◆ IsShiftCtrl()

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

inlinestaticinherited

Definition at line 145 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(), 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_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), FIELDS_GRID_TRICKS::doPopupSelection(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), PANEL_JOBS::EnsurePcbSchFramesOpen(), SIMULATOR_CONTROL::ExportPlotToSchematic(), BACK_ANNOTATE::FetchNetlistFromPCB(), PANEL_SYMBOL_CHOOSER::FinishSetup(), IMPORT_PROJ_HELPER::ImportIndividualFile(), 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(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), PCB_CALCULATOR_FRAME::OnExit(), SIMULATOR_FRAME::onExit(), SAVE_AS_TRAVERSER::OnFile(), KIGFX::WX_VIEW_CONTROLS::onMotion(), PANEL_JOB_OUTPUT::OnOutputRunClick(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), PANEL_JOBS::OnRunAllJobsClick(), DIALOG_FIELD_PROPERTIES::OnTextValueSelectButtonClick(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), PANEL_JOBS::openJobOptionsForListItem(), PANEL_FOOTPRINT_CHOOSER::PANEL_FOOTPRINT_CHOOSER(), PCB_FIELDS_GRID_TABLE::PCB_FIELDS_GRID_TABLE(), KIWAY_HOLDER::Prj(), SIMULATOR_CONTROL::Probe(), SCH_EDIT_TOOL::Properties(), BACK_ANNOTATE::PushNewLinksToPCB(), SCH_EDITOR_CONTROL::rescueProject(), EE_INSPECTION_TOOL::RunSimulation(), CVPCB_MAINFRAME::SaveFootprintAssociation(), EDA_DRAW_FRAME::ScriptingConsoleEnableDisable(), CVPCB_MAINFRAME::SendComponentSelectionToSch(), 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(), BOARD_EDITOR_CONTROL::UpdateSchematicFromPCB(), DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint(), and DIALOG_SHIM::~DIALOG_SHIM().

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

◆ onCancel()

void DIALOG_EDIT_SYMBOLS_LIBID::onCancel ( wxCommandEvent & event )

inlineoverrideprivatevirtual

Reimplemented from DIALOG_EDIT_SYMBOLS_LIBID_BASE.

Definition at line 324 of file dialog_edit_symbols_libid.cpp.

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

◆ onCellBrowseLib()

void DIALOG_EDIT_SYMBOLS_LIBID::onCellBrowseLib ( wxGridEvent & event )

overrideprivatevirtual

Reimplemented from DIALOG_EDIT_SYMBOLS_LIBID_BASE.

Definition at line 566 of file dialog_edit_symbols_libid.cpp.

References DIALOG_EDIT_SYMBOLS_LIBID_BASE::m_grid, and setLibIdByBrowser().

◆ OnCharHook()

void DIALOG_SHIM::OnCharHook ( wxKeyEvent & aEvt )

protectedvirtualinherited

Reimplemented in HK_PROMPT_DIALOG, and HTML_MESSAGE_BOX.

Definition at line 664 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_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 648 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().

◆ onClickOrphansButton()

void DIALOG_EDIT_SYMBOLS_LIBID::onClickOrphansButton ( wxCommandEvent & event )

overrideprivatevirtual

Reimplemented from DIALOG_EDIT_SYMBOLS_LIBID_BASE.

Definition at line 576 of file dialog_edit_symbols_libid.cpp.

References _, COL_CURR_LIBID, COL_NEW_LIBID, SYMBOL_LIB_TABLE::EnumerateSymbolLib(), getLibIdValue(), LIB_ID::GetLibItemName(), LIB_TABLE::GetLogicalLibs(), DIALOG_EDIT_SYMBOLS_LIBID_BASE::m_grid, m_OrphansRowIndexes, LIB_ID::Parse(), KIWAY_HOLDER::Prj(), PROJECT_SCH::SchSymbolLibTable(), and UnescapeString().

◆ 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 597 of file dialog_shim.cpp.

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

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

◆ OnModify()

void DIALOG_SHIM::OnModify ( )

inherited

Definition at line 461 of file dialog_shim.cpp.

◆ OnPaint()

void DIALOG_SHIM::OnPaint ( wxPaintEvent & event )

inherited

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

◆ OnSizeGrid()

void DIALOG_EDIT_SYMBOLS_LIBID::OnSizeGrid ( wxSizeEvent & event )

overrideprivatevirtual

Reimplemented from DIALOG_EDIT_SYMBOLS_LIBID_BASE.

Definition at line 826 of file dialog_edit_symbols_libid.cpp.

References AdjustGridColumns(), COL_REFS, GRIDCELL_AUTOWRAP_STRINGRENDERER::GetHeight(), m_autoWrapRenderer, and DIALOG_EDIT_SYMBOLS_LIBID_BASE::m_grid.

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

Referenced by SYMBOL_TREE_MODEL_ADAPTER::AddLibraries(), DESIGN_BLOCK_TREE_MODEL_ADAPTER::AddLibraries(), FP_TREE_MODEL_ADAPTER::AddLibraries(), SYMBOL_LIBRARY_MANAGER::addLibrary(), DIALOG_PLOT::applyPlotSettings(), AskSaveBoardFileName(), DIALOG_SYMBOL_REMAP::backupProject(), DIALOG_FOOTPRINT_CHOOSER::build3DCanvas(), CVPCB_MAINFRAME::buildEquivalenceList(), CVPCB_MAINFRAME::BuildLibrariesList(), PCB_BASE_FRAME::canCloseWindow(), SIMULATOR_FRAME::canCloseWindow(), PANEL_SETUP_NETCLASSES::checkReload(), KICAD_MANAGER_FRAME::CloseProject(), PCB_BASE_FRAME::CreateNewFootprint(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_ASSIGN_NETCLASS::DIALOG_ASSIGN_NETCLASS(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOARD_STATISTICS::DIALOG_BOARD_STATISTICS(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXPORT_SVG::DIALOG_EXPORT_SVG(), DIALOG_GEN_FOOTPRINT_POSITION::DIALOG_GEN_FOOTPRINT_POSITION(), DIALOG_IBIS_PARSER_REPORTER::DIALOG_IBIS_PARSER_REPORTER(), DIALOG_IMPORT_NETLIST::DIALOG_IMPORT_NETLIST(), DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_PLOT::DIALOG_PLOT(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), DIALOG_UPDATE_FROM_PCB::DIALOG_UPDATE_FROM_PCB(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), EE_INSPECTION_TOOL::DiffSymbol(), PL_DRAW_PANEL_GAL::DisplayDrawingSheet(), FOOTPRINT_PREVIEW_PANEL::DisplayFootprint(), CVPCB_MAINFRAME::DisplayStatus(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), FIELDS_GRID_TRICKS::doPopupSelection(), KICAD_MANAGER_CONTROL::Execute(), BOARD_EDITOR_CONTROL::ExportNetlist(), SYMBOL_EDITOR_CONTROL::ExportSymbolAsSVG(), SCH_EDITOR_CONTROL::ExportSymbolsToLibrary(), SYMBOL_EDITOR_CONTROL::ExportView(), BACK_ANNOTATE::FetchNetlistFromPCB(), PANEL_SYMBOL_CHOOSER::FinishSetup(), FIELDS_GRID_TABLE::GetAttr(), DIALOG_TABLE_PROPERTIES::getContextualTextVars(), DIALOG_TEXT_PROPERTIES::getContextualTextVars(), SIMULATOR_CONTROL::getDefaultFilename(), SIMULATOR_CONTROL::getDefaultPath(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), SCH_BASE_FRAME::GetLibSymbol(), DIALOG_PLOT_SCHEMATIC::getOutputPath(), KICAD_MANAGER_FRAME::GetProjectFileName(), SCH_NAVIGATE_TOOL::HypertextCommand(), SCH_EDITOR_CONTROL::ImportFPAssignments(), PANEL_SETUP_RULES::ImportSettingsFrom(), SCH_DRAWING_TOOLS::ImportSheet(), DIALOG_EXPORT_2581::Init(), DIALOG_PLOT::init_Dialog(), DIALOG_EXPORT_SVG::initDialog(), DIALOG_GEN_FOOTPRINT_POSITION::initDialog(), FIELDS_GRID_TABLE::initGrid(), SIMULATOR_FRAME_UI::InitWorkbook(), EDA_DRAW_FRAME::LibraryFileBrowser(), PCB_BASE_FRAME::loadFootprint(), CVPCB_MAINFRAME::LoadFootprintFiles(), KICAD_MANAGER_FRAME::LoadProject(), EDA_3D_VIEWER_FRAME::LoadSettings(), SIMULATOR_FRAME::LoadSettings(), SIMULATOR_FRAME::LoadSimulator(), EDA_BASE_FRAME::LoadWindowState(), SIMULATOR_FRAME_UI::LoadWorkbook(), EDA_3D_VIEWER_FRAME::NewDisplay(), PANEL_FP_PROPERTIES_3D_MODEL::On3DModelCellChanged(), PANEL_FP_PROPERTIES_3D_MODEL::OnAdd3DModel(), DIALOG_BOARD_SETUP::onAuxiliaryAction(), DIALOG_EXPORT_STEP::onBrowseClicked(), DIALOG_EXPORT_2581::onBrowseClicked(), DIALOG_EXPORT_ODBPP::onBrowseClicked(), KICAD_MANAGER_FRAME::OnBrowseInFileExplorer(), DIALOG_IMPORT_NETLIST::onBrowseNetlistFiles(), TEXT_BUTTON_URL::OnButtonClick(), TEXT_BUTTON_FILE_BROWSER::OnButtonClick(), onClickOrphansButton(), DIALOG_SYMBOL_FIELDS_TABLE::OnExport(), DIALOG_EXPORT_STEP::onExportButton(), PCB_BASE_FRAME::OnFpChangeDebounceTimer(), DIALOG_GEN_FOOTPRINT_POSITION::OnGenerate(), DIALOG_GENDRILL::OnGenReportFile(), KICAD_MANAGER_FRAME::OnIdle(), DIALOG_CONFIG_EQUFILES::OnOkClick(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), DIALOG_PLOT::onOpenOutputDirectory(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_EXPORT_SVG::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_SYMBOL_FIELDS_TABLE::OnOutputFileBrowseClicked(), DIALOG_SCHEMATIC_SETUP::onPageChanged(), DIALOG_BOARD_SETUP::onPageChanged(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_ERC::OnSaveReport(), DIALOG_DRC::OnSaveReport(), PROPERTIES_FRAME::onScintillaCharAdded(), DIALOG_SHEET_PROPERTIES::onSheetFilenameChanged(), SCH_BASE_FRAME::OnSymChange(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), DIALOG_PAGES_SETTINGS::OnWksFileSelection(), FOOTPRINT_EDITOR_CONTROL::OpenDirectory(), FOOTPRINT_EDITOR_CONTROL::OpenWithTextEditor(), PANEL_DESIGN_BLOCK_CHOOSER::PANEL_DESIGN_BLOCK_CHOOSER(), PANEL_FOOTPRINT_CHOOSER::PANEL_FOOTPRINT_CHOOSER(), PANEL_FP_PROPERTIES_3D_MODEL::PANEL_FP_PROPERTIES_3D_MODEL(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), PANEL_SETUP_NETCLASSES::PANEL_SETUP_NETCLASSES(), PANEL_SYMBOL_CHOOSER::PANEL_SYMBOL_CHOOSER(), SCH_EDITOR_CONTROL::Paste(), FOOTPRINT_EDITOR_CONTROL::PasteFootprint(), LIBRARY_EDITOR_CONTROL::PinLibrary(), SCH_DESIGN_BLOCK_CONTROL::PinLibrary(), LIB_TREE_MODEL_ADAPTER::PinLibrary(), SCH_DRAWING_TOOLS::PlaceSymbol(), PANEL_SYMBOL_CHOOSER::populateFootprintSelector(), EDA_DRAW_FRAME::PrintDrawingSheet(), KICAD_MANAGER_FRAME::PrintPrjInfo(), SCH_EDITOR_CONTROL::prunePastedSymbolInstances(), CVPCB_MAINFRAME::readNetListAndFpFiles(), APPEARANCE_CONTROLS::rebuildNets(), PANEL_DESIGN_BLOCK_CHOOSER::RefreshLibs(), PANEL_FP_PROPERTIES_3D_MODEL::ReloadModelsFromFootprint(), EDA_3D_VIEWER_FRAME::ReloadRequest(), SIMULATOR_FRAME::ReloadSimulator(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), FOOTPRINT_EDITOR_CONTROL::RenameFootprint(), SCH_EDITOR_CONTROL::RescueLegacyProject(), SCH_EDITOR_CONTROL::RescueSymbolLibTableProject(), SAVE_AS_DIALOG::SAVE_AS_DIALOG(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), DIALOG_BOARD_STATISTICS::saveReportClicked(), EDA_BASE_FRAME::SaveSettings(), SIMULATOR_FRAME::SaveSettings(), SCH_BASE_FRAME::saveSymbolLibTables(), SIMULATOR_CONTROL::SaveWorkbook(), SIMULATOR_FRAME_UI::SaveWorkbook(), PCB_BASE_FRAME::SelectLibrary(), SCH_BASE_FRAME::SelectLibraryFromList(), SCH_BASE_FRAME::SelectSymLibTable(), PCB_BASE_FRAME::setFPWatcher(), GERBVIEW_FRAME::SetPageSettings(), SCH_BASE_FRAME::setSymWatcher(), DIALOG_SYMBOL_FIELDS_TABLE::SetupColumnProperties(), EE_INSPECTION_TOOL::ShowDatasheet(), FOOTPRINT_EDITOR_CONTROL::ShowDatasheet(), PANEL_SYMBOL_CHOOSER::showFootprintFor(), COMMON_CONTROL::ShowHelp(), APPEARANCE_CONTROLS::showNetclass(), SCH_EDITOR_CONTROL::SimProbe(), SYMBOL_LIBRARY_MANAGER::symTable(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync(), FP_TREE_SYNCHRONIZING_ADAPTER::Sync(), EDA_3D_VIEWER_FRAME::takeScreenshot(), DIALOG_ERC::testErc(), TransferDataFromWindow(), DIALOG_EXPORT_NETLIST::TransferDataFromWindow(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), DIALOG_ASSIGN_NETCLASS::TransferDataFromWindow(), DIALOG_EXPORT_2581::TransferDataFromWindow(), PANEL_SETUP_RULES::TransferDataFromWindow(), PANEL_SETUP_NETCLASSES::TransferDataToWindow(), PANEL_SETUP_RULES::TransferDataToWindow(), FOOTPRINT_EDITOR_CONTROL::tryToSaveFootprintInLibrary(), LIBRARY_EDITOR_CONTROL::UnpinLibrary(), SCH_DESIGN_BLOCK_CONTROL::UnpinLibrary(), LIB_TREE_MODEL_ADAPTER::UnpinLibrary(), DIALOG_PAGES_SETTINGS::UpdateDrawingSheetExample(), SCH_EDITOR_CONTROL::updatePastedSymbol(), SIMULATOR_FRAME::UpdateTitle(), SIMULATOR_FRAME_UI::UpdateTunerValue(), PANEL_FP_PROPERTIES_3D_MODEL::validateModelExists(), DIALOG_EXPORT_SVG::~DIALOG_EXPORT_SVG(), DIALOG_FOOTPRINT_PROPERTIES::~DIALOG_FOOTPRINT_PROPERTIES(), EDA_3D_VIEWER_FRAME::~EDA_3D_VIEWER_FRAME(), and PANEL_FP_PROPERTIES_3D_MODEL::~PANEL_FP_PROPERTIES_3D_MODEL().

◆ 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 336 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 371 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 102 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().

◆ setLibIdByBrowser()

bool DIALOG_EDIT_SYMBOLS_LIBID::setLibIdByBrowser ( int aRow )

private

Run the lib browser and set the selected LIB_ID for aRow.

Parameters

aRow	is the row to edit.

Returns: false if the command was aborted.

Definition at line 671 of file dialog_edit_symbols_libid.cpp.

References _, COL_CURR_LIBID, COL_NEW_LIBID, LIB_ID::empty(), LIB_ID::Format(), getLibIdValue(), GetParent(), LIB_ID::IsValid(), PICKED_SYMBOL::LibId, DIALOG_EDIT_SYMBOLS_LIBID_BASE::m_grid, LIB_ID::Parse(), SCH_BASE_FRAME::PickSymbolFromLibrary(), UnescapeString(), and UTF8::wx_str().

Referenced by onCellBrowseLib().

◆ 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 225 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 197 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 809 of file dialog_shim.cpp.

References recursiveDescent().

◆ Show()

bool DIALOG_SHIM::Show ( bool show )

overrideinherited

Definition at line 254 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(), EE_INSPECTION_TOOL::CrossProbe(), BOARD_INSPECTION_TOOL::DiffFootprint(), EE_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(), EE_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(), GROUP_TOOL::PickNewMember(), HOTKEY_CYCLE_POPUP::Popup(), POSITION_RELATIVE_TOOL::PositionRelative(), EE_INSPECTION_TOOL::PrevMarker(), DRC_TOOL::PrevMarker(), CVPCB_MAINFRAME::readNetListAndFpFiles(), DIALOG_PAD_PROPERTIES::Show(), EDA_VIEW_SWITCHER::Show(), EDA_LIST_DIALOG::Show(), DIALOG_FIND::Show(), EE_INSPECTION_TOOL::ShowBusSyntaxHelp(), DRC_TOOL::ShowDRCDialog(), EE_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 474 of file dialog_shim.cpp.

References KIPLATFORM::UI::ReparentModal().

◆ ShowQuasiModal()

int DIALOG_SHIM::ShowQuasiModal ( )

inherited

Definition at line 509 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::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(), 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(), InvokeCopperZonesEditor(), InvokeDialogCreateBOM(), InvokeDialogEditSymbolsLibId(), InvokeDialogRescueEach(), InvokeNonCopperZonesEditor(), PANEL_FP_PROPERTIES_3D_MODEL::OnAdd3DModel(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), PCB_EDIT_FRAME::OnEditItemRequest(), SCH_EDIT_FRAME::OpenProjectFiles(), DRAWING_TOOL::PlaceText(), SCH_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), SCH_EDITOR_CONTROL::RemapSymbols(), PCB_BASE_FRAME::SelectFootprintFromLibrary(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), PCB_EDIT_FRAME::ShowExchangeFootprintsDialog(), PCB_BASE_EDIT_FRAME::ShowGraphicItemPropertiesDialog(), PCB_BASE_FRAME::ShowPadPropertiesDialog(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), PCB_BASE_EDIT_FRAME::ShowTextBoxPropertiesDialog(), PCB_BASE_EDIT_FRAME::ShowTextPropertiesDialog(), PCB_EDIT_FRAME::ToPlotter(), 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.

Reimplemented in DIALOG_FOOTPRINT_CHOOSER.

Definition at line 201 of file dialog_shim.h.

Referenced by DIALOG_SHIM::EndQuasiModal().