File-compare dialog (Phase 7). More...

#include <dialog_kicad_diff.h>

Inheritance diagram for DIALOG_KICAD_DIFF:

Public Types
using	SHEET_SWITCHER = std::function<void( WIDGET_DIFF_CANVAS&, const KIID_PATH& )>

using	REVISION_HANDLER = std::function<void( int aIndex )>

using	CHANGE_SELECTED_FN = std::function<void( const KIID_PATH& )>

using	UP_HANDLER = std::function<void()>

enum	HOLDER_TYPE { DIALOG , FRAME , PANEL }

Public Member Functions
	DIALOG_KICAD_DIFF (wxWindow *aParent, const wxString &aReferencePath, const wxString &aComparisonPath, const KICAD_DIFF::DOCUMENT_DIFF &aDiff, KICAD_DIFF::DOCUMENT_GEOMETRY aReferenceGeometry={}, KICAD_DIFF::DOCUMENT_GEOMETRY aComparisonGeometry={}, SHEET_SWITCHER aSheetSwitcher={}, KIID_PATH aInitialSheet={})

	~DIALOG_KICAD_DIFF () override=default

void	SwitchCanvasToSheet (const KIID_PATH &aSheetPath)

const KIID_PATH &	CurrentCanvasSheet () const

WIDGET_DIFF_CANVAS *	DiffCanvas () const

void	Reload (const wxString &aReferencePath, const wxString &aComparisonPath, KICAD_DIFF::DOCUMENT_DIFF aDiff, KICAD_DIFF::DOCUMENT_GEOMETRY aReferenceGeometry, KICAD_DIFF::DOCUMENT_GEOMETRY aComparisonGeometry, SHEET_SWITCHER aSheetSwitcher, KIID_PATH aInitialSheet)
	Swap in a fresh diff with new schematics.

void	SetRevisionChooser (const std::vector< wxString > &aLabels, int aSelected, REVISION_HANDLER aOnChange)
	Add a revision dropdown (with prev/next) at the top.

void	SetChangeSelectedHandler (CHANGE_SELECTED_FN aFn)

void	SetUpHandler (UP_HANDLER aHandler)

void	EnableUp (bool aEnable)

void	m_splitterOnIdle (wxIdleEvent &)

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={})

void	LoadControlState ()
	Load persisted control values from the current project's local settings.

void	ReloadSashPositions ()
	While we did this in LoadControlState(), we need to re-apply if after setting the dialog size.

void	SaveControlState ()
	Save control values and geometry to the current project's local settings.

void	OptOut (wxWindow *aWindow)
	Opt out of control state saving.

void	ExcludeFromControlUndoRedo (wxWindow *aWindow)
	Opt a control out of the dialog's generic Ctrl+Z/Ctrl+Y undo/redo.

void	RegisterUnitBinder (UNIT_BINDER aUnitBinder, wxWindow aWindow)
	Register a UNIT_BINDER so that it can handle units in control-state save/restore.

void	UnregisterUnitBinder (UNIT_BINDER *aUnitBinder)
	Remove a UNIT_BINDER from the control-state save/restore map.

void	EndDialogShim (int aReturnCode)
	A mode agnostic way to close a dialog.

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)

Public Attributes
wxStdDialogButtonSizer *	m_sdbSizer

wxButton *	m_sdbSizerOK

Protected Member Functions
void	OnClose (wxCloseEvent &aEvent) override

void	OnTreeSelectionChanged (wxTreeEvent &aEvent) override

void	OnTreeItemMenu (wxTreeEvent &aEvent)

void	OnOK (wxCommandEvent &aEvent) override

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	clampToWorkArea ()
	Constrain the dialog's minimum size, size and position to the work area of the display it occupies, so a dialog whose content or restored geometry is larger than the monitor still fits, its bottom controls stay reachable, and it never lands off-screen.

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.

void	resetUndoRedoForNewContent (wxWindowList &aChildren)
	Reset undo/redo tracking after dynamically replacing child panels.

void	unregisterUnitBinders (wxWindow *aWindow)
	Remove UNIT_BINDER registrations for a window and all its descendants.

Protected Attributes
wxStaticText *	m_labelReference

wxStaticText *	m_pathReference

wxStaticText *	m_labelComparison

wxStaticText *	m_pathComparison

wxStaticLine *	m_separator

wxSplitterWindow *	m_splitter

wxPanel *	m_panelTree

wxTreeCtrl *	m_treeChanges

wxPanel *	m_panelDetail

wxStaticText *	m_labelSummary

wxListCtrl *	m_listProperties

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

bool	m_userPositioned

bool	m_userResized

std::map< wxWindow *, wxString >	m_beforeEditValues

std::map< wxWindow , UNIT_BINDER >	m_unitBinders

std::vector< UNDO_STEP >	m_undoStack

std::vector< UNDO_STEP >	m_redoStack

std::map< wxWindow *, wxVariant >	m_currentValues

std::set< wxWindow * >	m_controlsWithPendingChanges

std::set< wxWindow * >	m_noControlUndoRedo

bool	m_handlingUndoRedo

bool	m_childReleased

Private Member Functions
void	buildTree ()
	Populate the tree from m_diff. Groups by CHANGE_KIND.

void	showChange (const KICAD_DIFF::ITEM_CHANGE *aChange)
	Populate the property list for the change associated with the selected tree node, or clear the list if no change is selected (e.g.

bool	selectChangeById (const KIID_PATH &aChangeId)
	Select the tree row whose change has the given KIID_PATH.

void	applyHiddenToTree ()
	Grey out tree rows whose change is in m_hiddenChanges, restore the rest.

std::vector< KIID_PATH >	changeRowIds (const KICAD_DIFF::ITEM_CHANGE &aChange) const
	Change ids a tree row stands for.

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	OnActivate (wxActivateEvent &aEvent)

void	forceInitialFocus ()
	Focus the requested initial target if it is visible, otherwise focus the dialog itself so keyboard events (especially ESC) are always delivered.

void	OnSize (wxSizeEvent &aEvent)

void	OnMove (wxMoveEvent &aEvent)

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)

void	onInitDialog (wxInitDialogEvent &aEvent)

void	focusParentCanvas (bool aDeferUntilFrameActive=false)
	Set focus back to the parent frame's tool canvas if available, otherwise to the parent window.

std::string	generateKey (const wxWindow *aWin) const

void	registerUndoRedoHandlers (wxWindowList &aChildren)

void	recordControlChange (wxWindow *aCtrl)
	Tell the undo mechanism to snapshot the current value of a control and record it as an undo step when the value changes.

void	flushPendingControlChanges ()
	Apply outstanding control changes to the undo stack, and clear the pending list.

void	onCommandEvent (wxCommandEvent &aEvent)

void	onSpinEvent (wxSpinEvent &aEvent)

void	onSpinDoubleEvent (wxSpinDoubleEvent &aEvent)

void	onStyledTextChanged (wxStyledTextEvent &aEvent)

void	onGridCellChanged (wxGridEvent &aEvent)

void	onPropertyGridChanged (wxPropertyGridEvent &aEvent)

void	onDataViewListChanged (wxDataViewEvent &aEvent)

void	doUndo ()

void	doRedo ()

wxVariant	getControlValue (wxWindow *aCtrl)

void	setControlValue (wxWindow *aCtrl, const wxVariant &aValue)

	DECLARE_EVENT_TABLE ()

Private Attributes
KICAD_DIFF::DOCUMENT_DIFF	m_diff

std::set< KIID_PATH >	m_hiddenChanges
	Changes the user has muted via the tree's right-click menu.

REVISION_HANDLER	m_revisionHandler

wxChoice *	m_revisionChoice = nullptr

UP_HANDLER	m_upHandler

wxButton *	m_btnUp = nullptr

wxBoxSizer *	m_filterSizer = nullptr

std::map< wxUIntPtr, const KICAD_DIFF::ITEM_CHANGE * >	m_changeByTreeId
	Maps tree item IDs to the underlying change record so selection can find the data without walking the diff again.

wxString	m_searchFilter
	Lowercased free-text filter applied to typeName / refdes.

WIDGET_DIFF_CANVAS *	m_canvas = nullptr
	GAL-backed canvas showing the DIFF_SCENE shape rectangles.

bool	m_suppressCenter = false
	True while a canvas click is propagating into the tree, so the tree- selection handler skips re-centering on a shape that is already under the cursor.

SHEET_SWITCHER	m_sheetSwitcher

KIID_PATH	m_currentCanvasSheet

CHANGE_SELECTED_FN	m_changeSelectedFn

KIWAY *	m_kiway

HOLDER_TYPE	m_type

Detailed Description

File-compare dialog (Phase 7).

Shows a DOCUMENT_DIFF as a hierarchical tree of changes on the left and the property delta list for the selected change on the right. The change geometry renders on a GAL-backed WIDGET_DIFF_CANVAS that cross-probes with the tree through OnTreeSelectionChanged and the canvas's pick handler.

The dialog is constructed with a pre-computed DOCUMENT_DIFF; the caller is responsible for running the appropriate differ.

Definition at line 51 of file dialog_kicad_diff.h.

Member Typedef Documentation

◆ CHANGE_SELECTED_FN

using DIALOG_KICAD_DIFF::CHANGE_SELECTED_FN = std::function<void( const KIID_PATH& )>

Definition at line 80 of file dialog_kicad_diff.h.

◆ REVISION_HANDLER

using DIALOG_KICAD_DIFF::REVISION_HANDLER = std::function<void( int aIndex )>

Definition at line 73 of file dialog_kicad_diff.h.

◆ SHEET_SWITCHER

using DIALOG_KICAD_DIFF::SHEET_SWITCHER = std::function<void( WIDGET_DIFF_CANVAS&, const KIID_PATH& )>

Definition at line 54 of file dialog_kicad_diff.h.

◆ UP_HANDLER

using DIALOG_KICAD_DIFF::UP_HANDLER = std::function<void()>

Definition at line 84 of file dialog_kicad_diff.h.

Member Enumeration Documentation

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE

inherited

Enumerator
DIALOG
FRAME
PANEL

Definition at line 40 of file kiway_holder.h.

Constructor & Destructor Documentation

◆ DIALOG_KICAD_DIFF()

DIALOG_KICAD_DIFF::DIALOG_KICAD_DIFF	(	wxWindow *	aParent,
		const wxString &	aReferencePath,
		const wxString &	aComparisonPath,
		const KICAD_DIFF::DOCUMENT_DIFF &	aDiff,
		KICAD_DIFF::DOCUMENT_GEOMETRY	aReferenceGeometry = {},
		KICAD_DIFF::DOCUMENT_GEOMETRY	aComparisonGeometry = {},
		SHEET_SWITCHER	aSheetSwitcher = {},
		KIID_PATH	aInitialSheet = {} )

Definition at line 48 of file dialog_kicad_diff.cpp.

◆ ~DIALOG_KICAD_DIFF()

DIALOG_KICAD_DIFF::~DIALOG_KICAD_DIFF ( )

overridedefault

Member Function Documentation

◆ applyHiddenToTree()

void DIALOG_KICAD_DIFF::applyHiddenToTree ( )

private

Grey out tree rows whose change is in m_hiddenChanges, restore the rest.

Definition at line 410 of file dialog_kicad_diff.cpp.

References m_changeByTreeId, m_hiddenChanges, DIALOG_KICAD_DIFF_BASE::m_treeChanges, and normal.

Referenced by buildTree(), and OnTreeItemMenu().

◆ buildTree()

void DIALOG_KICAD_DIFF::buildTree ( )

private

Populate the tree from m_diff. Groups by CHANGE_KIND.

Definition at line 277 of file dialog_kicad_diff.cpp.

References applyHiddenToTree(), KICAD_DIFF::BuildChangeTreeGroups(), KICAD_DIFF::CATEGORY_COUNT, KICAD_DIFF::CHANGE_TREE_ENTRY::change, group, KICAD_DIFF::CHANGE_TREE_ENTRY::itemLabel, m_canvas, m_changeByTreeId, m_diff, m_searchFilter, DIALOG_KICAD_DIFF_BASE::m_treeChanges, selectChangeById(), and showChange().

Referenced by DIALOG_KICAD_DIFF(), and Reload().

◆ changeRowIds()

std::vector< KIID_PATH > DIALOG_KICAD_DIFF::changeRowIds ( const KICAD_DIFF::ITEM_CHANGE & aChange ) const

private

Change ids a tree row stands for.

A routing net row collapses every segment of the net, so hiding it must hide them all.

Definition at line 384 of file dialog_kicad_diff.cpp.

References KICAD_DIFF::ITEM_CHANGE::id, KICAD_DIFF::IsRoutingNetChange(), KICAD_DIFF::ITEM_CHANGE::kind, m_diff, and KICAD_DIFF::ITEM_CHANGE::refdes.

Referenced by OnTreeItemMenu().

◆ clampToWorkArea()

void DIALOG_SHIM::clampToWorkArea ( )

protectedinherited

Constrain the dialog's minimum size, size and position to the work area of the display it occupies, so a dialog whose content or restored geometry is larger than the monitor still fits, its bottom controls stay reachable, and it never lands off-screen.

Geometry restored from a different monitor, or inflated by the per-monitor DPI rescale that fires when the dialog moves to the saved monitor, can otherwise leave the dialog off-screen or larger than the display with no way to shrink it. Only shrinks; never grows.

Definition at line 385 of file dialog_shim.cpp.

References ClampRectToDisplay(), and minSize.

Referenced by Show(), EDA_VIEW_SWITCHER::Show(), and HOTKEY_CYCLE_POPUP::Show().

◆ CleanupAfterModalSubDialog()

void DIALOG_SHIM::CleanupAfterModalSubDialog ( )

inherited

Definition at line 1829 of file dialog_shim.cpp.

References m_qmodal_parent_disabler.

◆ ClearModify()

void DIALOG_SHIM::ClearModify ( )

inherited

Definition at line 1735 of file dialog_shim.cpp.

Referenced by DIALOG_FOOTPRINT_FIELDS_TABLE::OnSaveAndContinue(), DIALOG_LIB_FIELDS_TABLE::OnSaveAndContinue(), DIALOG_LIB_FOOTPRINT_FIELDS_TABLE::OnSaveAndContinue(), DIALOG_SYMBOL_FIELDS_TABLE::OnSaveAndContinue(), DIALOG_LIB_FIELDS_TABLE::TransferDataFromWindow(), and DIALOG_LIB_FOOTPRINT_FIELDS_TABLE::TransferDataFromWindow().

◆ CurrentCanvasSheet()

const KIID_PATH & DIALOG_KICAD_DIFF::CurrentCanvasSheet ( ) const

inline

Definition at line 64 of file dialog_kicad_diff.h.

References m_currentCanvasSheet.

◆ DECLARE_EVENT_TABLE()

DIALOG_SHIM::DECLARE_EVENT_TABLE ( )

privateinherited

◆ DiffCanvas()

WIDGET_DIFF_CANVAS * DIALOG_KICAD_DIFF::DiffCanvas ( ) const

inline

Definition at line 65 of file dialog_kicad_diff.h.

References m_canvas.

Referenced by SCH_INSPECTION_TOOL::showSchematicComparison().

◆ doRedo()

void DIALOG_SHIM::doRedo ( )

privateinherited

Definition at line 1653 of file dialog_shim.cpp.

References DIALOG_SHIM::UNDO_STEP::after, DIALOG_SHIM::UNDO_STEP::ctrl, flushPendingControlChanges(), m_currentValues, m_handlingUndoRedo, m_redoStack, m_undoStack, and setControlValue().

Referenced by OnCharHook().

◆ doUndo()

void DIALOG_SHIM::doUndo ( )

privateinherited

Definition at line 1636 of file dialog_shim.cpp.

References DIALOG_SHIM::UNDO_STEP::before, DIALOG_SHIM::UNDO_STEP::ctrl, flushPendingControlChanges(), m_currentValues, m_handlingUndoRedo, m_redoStack, m_undoStack, and setControlValue().

Referenced by OnCharHook().

◆ Enable()

bool DIALOG_SHIM::Enable ( bool enable )

overrideinherited

Definition at line 665 of file dialog_shim.cpp.

Referenced by DIALOG_CREATE_ARRAY::UpdatePickedItem(), and DIALOG_CREATE_ARRAY::UpdatePickedPoint().

◆ EnableUp()

void DIALOG_KICAD_DIFF::EnableUp ( bool aEnable )

Definition at line 512 of file dialog_kicad_diff.cpp.

References m_btnUp.

Referenced by SCH_INSPECTION_TOOL::showSchematicComparison().

◆ EndDialogShim()

void DIALOG_SHIM::EndDialogShim ( int aReturnCode )

inherited

A mode agnostic way to close a dialog.

This replaces the protected method wxDialog::EndDialog() which unfortunately was not made virtual and knows nothing of our custom QuasiModal behavior.

Warning: Do not call EndModal or EndQuasimodal directly. This is a bug because it's not known in advance how the dialog was opened and cannot be guaranteed not to change in the future.

Parameters

aReturnCode is the return code from ending Modal and QuasiModal dialogs.

Definition at line 2188 of file dialog_shim.cpp.

References EndQuasiModal(), and IsQuasiModal().

Referenced by DIALOG_DATABASE_LIB_SETTINGS::confirmClose(), EDA_3D_CONTROLLER::Main(), DIALOG_EXPORT_NETLIST::OnAddGenerator(), DIALOG_EDIT_SYMBOLS_LIBID::onCancel(), DIALOG_LIB_SYMBOL_PROPERTIES::OnCancelButtonClick(), DIALOG_SYMBOL_PROPERTIES::OnCancelButtonClick(), PCB_ONE_LAYER_SELECTOR::onCharHook(), DIALOG_SYMBOL_PROPERTIES::OnClearVariantSymbol(), DIALOG_LIB_EDIT_PIN_TABLE::OnClose(), DIALOG_DATABASE_LIB_SETTINGS::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(), and DIALOG_PUSH_PAD_PROPERTIES::PadPropertiesAccept().

◆ EndQuasiModal()

void DIALOG_SHIM::EndQuasiModal ( int retCode )

inherited

Definition at line 1836 of file dialog_shim.cpp.

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

Referenced by EndDialogShim(), OnButton(), OnCloseWindow(), and ~DIALOG_SHIM().

◆ ExcludeFromControlUndoRedo()

void DIALOG_SHIM::ExcludeFromControlUndoRedo ( wxWindow * aWindow )

inherited

Opt a control out of the dialog's generic Ctrl+Z/Ctrl+Y undo/redo.

The generic handler snapshots a control's value and restores it by position. That is wrong for grids whose rows can be regrouped, sorted, or reordered while the dialog is open (and which manage their own undo), so such controls must opt out.

Definition at line 1131 of file dialog_shim.cpp.

References m_noControlUndoRedo.

Referenced by DIALOG_FOOTPRINT_FIELDS_TABLE::DIALOG_FOOTPRINT_FIELDS_TABLE(), DIALOG_LIB_FIELDS_TABLE::DIALOG_LIB_FIELDS_TABLE(), DIALOG_LIB_FOOTPRINT_FIELDS_TABLE::DIALOG_LIB_FOOTPRINT_FIELDS_TABLE(), and DIALOG_SYMBOL_FIELDS_TABLE::DIALOG_SYMBOL_FIELDS_TABLE().

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

◆ flushPendingControlChanges()

void DIALOG_SHIM::flushPendingControlChanges ( )

privateinherited

Apply outstanding control changes to the undo stack, and clear the pending list.

Runs at the end of the current event handler.

Definition at line 1338 of file dialog_shim.cpp.

References getControlValue(), m_controlsWithPendingChanges, m_currentValues, m_redoStack, and m_undoStack.

Referenced by doRedo(), doUndo(), and recordControlChange().

◆ focusParentCanvas()

void DIALOG_SHIM::focusParentCanvas ( bool aDeferUntilFrameActive = false )

privateinherited

Set focus back to the parent frame's tool canvas if available, otherwise to the parent window.

Prevents focus from landing on auxiliary panels like the properties panel when the mouse happens to hover over them at dialog close time.

Parameters

aDeferUntilFrameActive also re-asserts the focus from an idle callback, needed only for the GTK quasi-modal teardown race where the dialog is still the active top-level window when this is called.

Definition at line 454 of file dialog_shim.cpp.

References TOOLS_HOLDER::GetToolCanvas(), KIPLATFORM::UI::IsWindowActive(), and m_parentFrame.

Referenced by Show(), and ShowQuasiModal().

◆ forceInitialFocus()

void DIALOG_SHIM::forceInitialFocus ( )

privateinherited

Focus the requested initial target if it is visible, otherwise focus the dialog itself so keyboard events (especially ESC) are always delivered.

Definition at line 1688 of file dialog_shim.cpp.

References KIPLATFORM::UI::ForceFocus(), and m_initialFocusTarget.

Referenced by OnActivate(), and OnPaint().

◆ generateKey()

std::string DIALOG_SHIM::generateKey ( const wxWindow * aWin ) const

privateinherited

Definition at line 672 of file dialog_shim.cpp.

References index, and makeKey().

Referenced by LoadControlState(), ReloadSashPositions(), and SaveControlState().

◆ getControlValue()

wxVariant DIALOG_SHIM::getControlValue ( wxWindow * aCtrl )

privateinherited

Definition at line 1422 of file dialog_shim.cpp.

References grid, and table.

Referenced by flushPendingControlChanges(), and registerUndoRedoHandlers().

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( ) const

inlineinherited

Definition at line 47 of file kiway_holder.h.

References m_type.

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.

References m_units.

Referenced by DIALOG_FP_EDIT_PAD_TABLE::DIALOG_FP_EDIT_PAD_TABLE(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), DIALOG_DRC::OnSaveReport(), DIALOG_KICAD_DIFF::showChange(), DIALOG_MICROVIA_STACK::TransferDataFromWindow(), DIALOG_POSITION_RELATIVE::updateAnchorInfo(), DIALOG_MOVE_EXACT::updateDialogControls(), DIALOG_OFFSET_ITEM::updateDialogControls(), and DIALOG_POSITION_RELATIVE::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 64 of file kiway_holder.h.

References m_kiway.

Referenced by KIGIT::ClearSyncWarnings(), DIALOG_SHIM::DIALOG_SHIM(), and 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 428 of file dialog_shim.cpp.

◆ 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 105 of file dialog_shim.h.

References m_qmodal_showing.

Referenced by EndDialogShim(), EndQuasiModal(), OnButton(), DIALOG_EDIT_SYMBOLS_LIBID::onCancel(), DIALOG_BOOK_REPORTER::OnClose(), DIALOG_ERC::OnCloseErcDialog(), OnCloseWindow(), and ~DIALOG_SHIM().

◆ 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 54 of file kiway_holder.h.

References m_kiway.

◆ LoadControlState()

void DIALOG_SHIM::LoadControlState ( )

inherited

Load persisted control values from the current project's local settings.

Controls may opt out by setting the boolean window property "persist" to false. Dialog geometry is stored under the special key "__geometry".

Definition at line 851 of file dialog_shim.cpp.

References UNIT_BINDER::ChangeValue(), COMMON_SETTINGS::CsInternals(), generateKey(), PGM_BASE::GetCommonSettings(), getDialogKeyFromTitle(), grid, index, isCompoundDateTimePicker(), COMMON_SETTINGS_INTERNALS::m_dialogControlValues, m_hash_key, m_unitBinders, Pgm(), UNIT_BINDER::RestoreFormula(), UNIT_BINDER::RestoreValue(), PROPERTY_HOLDER::SafeCast(), and text.

Referenced by onInitDialog().

◆ m_splitterOnIdle()

void DIALOG_KICAD_DIFF_BASE::m_splitterOnIdle ( wxIdleEvent & )

inlineinherited

Definition at line 65 of file dialog_kicad_diff_base.h.

References m_splitter, and m_splitterOnIdle().

Referenced by DIALOG_KICAD_DIFF_BASE(), and m_splitterOnIdle().

◆ OnActivate()

void DIALOG_SHIM::OnActivate ( wxActivateEvent & aEvent )

privateinherited

Definition at line 1703 of file dialog_shim.cpp.

References DIALOG_SHIM(), forceInitialFocus(), KIPLATFORM::UI::IsWindowActive(), and m_firstPaintEvent.

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

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

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

◆ OnCharHook()

void DIALOG_SHIM::OnCharHook ( wxKeyEvent & aEvt )

protectedvirtualinherited

◆ onChildSetFocus()

void DIALOG_SHIM::onChildSetFocus ( wxFocusEvent & aEvent )

privateinherited

Definition at line 1941 of file dialog_shim.cpp.

References m_beforeEditValues, and m_isClosing.

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

◆ OnClose()

void DIALOG_KICAD_DIFF::OnClose ( wxCloseEvent & aEvent )

overrideprotectedvirtual

Reimplemented from DIALOG_KICAD_DIFF_BASE.

Definition at line 243 of file dialog_kicad_diff.cpp.

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

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

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

◆ onCommandEvent()

void DIALOG_SHIM::onCommandEvent ( wxCommandEvent & aEvent )

privateinherited

Definition at line 1362 of file dialog_shim.cpp.

References m_handlingUndoRedo, and recordControlChange().

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

◆ onDataViewListChanged()

void DIALOG_SHIM::onDataViewListChanged ( wxDataViewEvent & aEvent )

privateinherited

Definition at line 1414 of file dialog_shim.cpp.

References m_handlingUndoRedo, and recordControlChange().

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

◆ onGridCellChanged()

void DIALOG_SHIM::onGridCellChanged ( wxGridEvent & aEvent )

privateinherited

Definition at line 1398 of file dialog_shim.cpp.

References m_handlingUndoRedo, and recordControlChange().

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

◆ onInitDialog()

void DIALOG_SHIM::onInitDialog ( wxInitDialogEvent & aEvent )

privateinherited

Definition at line 343 of file dialog_shim.cpp.

References LoadControlState().

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

◆ OnModify()

void DIALOG_SHIM::OnModify ( )

inherited

Definition at line 1728 of file dialog_shim.cpp.

◆ OnMove()

void DIALOG_SHIM::OnMove ( wxMoveEvent & aEvent )

privateinherited

Definition at line 633 of file dialog_shim.cpp.

References m_childReleased, m_userPositioned, KIPLATFORM::UI::ReleaseChildWindow(), and KIPLATFORM::UI::ReparentModal().

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

◆ OnOK()

void DIALOG_KICAD_DIFF::OnOK ( wxCommandEvent & aEvent )

overrideprotectedvirtual

Reimplemented from DIALOG_KICAD_DIFF_BASE.

Definition at line 249 of file dialog_kicad_diff.cpp.

◆ OnPaint()

void DIALOG_SHIM::OnPaint ( wxPaintEvent & event )

inherited

Definition at line 1670 of file dialog_shim.cpp.

References KIPLATFORM::UI::FixupCancelButtonCmdKeyCollision(), forceInitialFocus(), m_firstPaintEvent, registerUndoRedoHandlers(), and SelectAllInTextCtrls().

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

◆ onPropertyGridChanged()

void DIALOG_SHIM::onPropertyGridChanged ( wxPropertyGridEvent & aEvent )

privateinherited

Definition at line 1406 of file dialog_shim.cpp.

References m_handlingUndoRedo, and recordControlChange().

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

◆ OnSize()

void DIALOG_SHIM::OnSize ( wxSizeEvent & aEvent )

privateinherited

Definition at line 626 of file dialog_shim.cpp.

References m_userResized.

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

◆ onSpinDoubleEvent()

void DIALOG_SHIM::onSpinDoubleEvent ( wxSpinDoubleEvent & aEvent )

privateinherited

Definition at line 1380 of file dialog_shim.cpp.

References m_handlingUndoRedo, and recordControlChange().

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

◆ onSpinEvent()

void DIALOG_SHIM::onSpinEvent ( wxSpinEvent & aEvent )

privateinherited

Definition at line 1371 of file dialog_shim.cpp.

References m_handlingUndoRedo, and recordControlChange().

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

◆ onStyledTextChanged()

void DIALOG_SHIM::onStyledTextChanged ( wxStyledTextEvent & aEvent )

privateinherited

Definition at line 1389 of file dialog_shim.cpp.

References m_handlingUndoRedo, and recordControlChange().

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

◆ OnTreeItemMenu()

void DIALOG_KICAD_DIFF::OnTreeItemMenu ( wxTreeEvent & aEvent )

protected

Definition at line 334 of file dialog_kicad_diff.cpp.

References _, applyHiddenToTree(), changeRowIds(), m_canvas, m_changeByTreeId, m_hiddenChanges, and DIALOG_KICAD_DIFF_BASE::m_treeChanges.

Referenced by DIALOG_KICAD_DIFF().

◆ OnTreeSelectionChanged()

void DIALOG_KICAD_DIFF::OnTreeSelectionChanged ( wxTreeEvent & aEvent )

overrideprotectedvirtual

Reimplemented from DIALOG_KICAD_DIFF_BASE.

Definition at line 255 of file dialog_kicad_diff.cpp.

References m_changeByTreeId, and showChange().

◆ OptOut()

void DIALOG_SHIM::OptOut ( wxWindow * aWindow )

inherited

Opt out of control state saving.

Parameters

aWindow can be either a specific control, or the whole dialog

Definition at line 1103 of file dialog_shim.cpp.

References COMMON_SETTINGS::CsInternals(), PGM_BASE::GetCommonSettings(), getDialogKeyFromTitle(), COMMON_SETTINGS_INTERNALS::m_dialogControlValues, m_hash_key, Pgm(), and PROPERTY_HOLDER::SetProperty().

Referenced by DIALOG_CONVERT_IMAGE_TO_OUTLINES::DIALOG_CONVERT_IMAGE_TO_OUTLINES(), DIALOG_EXPORT_3D_IMAGE::DIALOG_EXPORT_3D_IMAGE(), DIALOG_EXPORT_STEP::DIALOG_EXPORT_STEP(), DIALOG_FIELDS_TABLE::DIALOG_FIELDS_TABLE(), DIALOG_FIND::DIALOG_FIND(), DIALOG_FOOTPRINT_FIELDS_TABLE::DIALOG_FOOTPRINT_FIELDS_TABLE(), DIALOG_FOOTPRINT_WIZARD_LIST::DIALOG_FOOTPRINT_WIZARD_LIST(), DIALOG_GIT_CREDENTIALS::DIALOG_GIT_CREDENTIALS(), DIALOG_GIT_IDENTITY::DIALOG_GIT_IDENTITY(), DIALOG_GIT_NEW_TAG::DIALOG_GIT_NEW_TAG(), DIALOG_GIT_REMOTE::DIALOG_GIT_REMOTE(), DIALOG_GIT_REPOSITORY::DIALOG_GIT_REPOSITORY(), DIALOG_GLOBAL_DELETION::DIALOG_GLOBAL_DELETION(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), DIALOG_JOBSET_RUN_LOG::DIALOG_JOBSET_RUN_LOG(), DIALOG_KICAD_DIFF::DIALOG_KICAD_DIFF(), DIALOG_KICAD_MERGE_3WAY::DIALOG_KICAD_MERGE_3WAY(), DIALOG_LIB_EDIT_PIN_TABLE::DIALOG_LIB_EDIT_PIN_TABLE(), DIALOG_LIB_FIELDS_TABLE::DIALOG_LIB_FIELDS_TABLE(), DIALOG_LIB_FOOTPRINT_FIELDS_TABLE::DIALOG_LIB_FOOTPRINT_FIELDS_TABLE(), DIALOG_MIGRATE_BUSES::DIALOG_MIGRATE_BUSES(), DIALOG_SCH_FIND::DIALOG_SCH_FIND(), DIALOG_SIM_FORMAT_VALUE::DIALOG_SIM_FORMAT_VALUE(), DIALOG_SYMBOL_FIELDS_TABLE::DIALOG_SYMBOL_FIELDS_TABLE(), EDA_LIST_DIALOG::EDA_LIST_DIALOG(), EDA_LIST_DIALOG::EDA_LIST_DIALOG(), EDA_LIST_DIALOG::initDialog(), GIT_ADVANCED_DIALOG::optOutOfTextPersistence(), SAVE_AS_DIALOG::SAVE_AS_DIALOG(), DIALOG_EXPORT_IDF3::setupDialog(), WX_PT_ENTRY_DIALOG::WX_PT_ENTRY_DIALOG(), and WX_TEXT_ENTRY_DIALOG::WX_TEXT_ENTRY_DIALOG().

◆ PrepareForModalSubDialog()

void DIALOG_SHIM::PrepareForModalSubDialog ( )

inherited

Definition at line 1822 of file dialog_shim.cpp.

References m_qmodal_parent_disabler.

◆ Prj()

PROJECT & KIWAY_HOLDER::Prj ( ) const

inherited

Return a reference to the PROJECT associated with this KIWAY.

Definition at line 32 of file kiway_holder.cpp.

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

◆ recordControlChange()

void DIALOG_SHIM::recordControlChange ( wxWindow * aCtrl )

privateinherited

Tell the undo mechanism to snapshot the current value of a control and record it as an undo step when the value changes.

If you call this from an event handler that generates multiple change events, they will be coalesced into a single undo step.

Definition at line 1318 of file dialog_shim.cpp.

References flushPendingControlChanges(), and m_controlsWithPendingChanges.

Referenced by onCommandEvent(), onDataViewListChanged(), onGridCellChanged(), onPropertyGridChanged(), onSpinDoubleEvent(), onSpinEvent(), and onStyledTextChanged().

◆ registerUndoRedoHandlers()

void DIALOG_SHIM::registerUndoRedoHandlers ( wxWindowList & aChildren )

privateinherited

Definition at line 1232 of file dialog_shim.cpp.

References getControlValue(), grid, isCompoundDateTimePicker(), m_currentValues, m_noControlUndoRedo, onCommandEvent(), onDataViewListChanged(), onGridCellChanged(), onPropertyGridChanged(), onSpinDoubleEvent(), onSpinEvent(), onStyledTextChanged(), and registerUndoRedoHandlers().

Referenced by OnPaint(), registerUndoRedoHandlers(), and resetUndoRedoForNewContent().

◆ RegisterUnitBinder()

void DIALOG_SHIM::RegisterUnitBinder	(	UNIT_BINDER *	aUnitBinder,
		wxWindow *	aWindow )

inherited

Register a UNIT_BINDER so that it can handle units in control-state save/restore.

Parameters

aUnitBinder
aWindow	the control window

Definition at line 1137 of file dialog_shim.cpp.

References m_unitBinders.

◆ Reload()

void DIALOG_KICAD_DIFF::Reload	(	const wxString &	aReferencePath,
		const wxString &	aComparisonPath,
		KICAD_DIFF::DOCUMENT_DIFF	aDiff,
		KICAD_DIFF::DOCUMENT_GEOMETRY	aReferenceGeometry,
		KICAD_DIFF::DOCUMENT_GEOMETRY	aComparisonGeometry,
		SHEET_SWITCHER	aSheetSwitcher,
		KIID_PATH	aInitialSheet )

Swap in a fresh diff with new schematics.

Rebuilds tree and scene, clears selection and properties.

Definition at line 519 of file dialog_kicad_diff.cpp.

References _, KICAD_DIFF::BuildScene(), buildTree(), KICAD_DIFF::DIFF_SCENE::comparisonGeometry, KICAD_DIFF::ExpandBBoxToGeometry(), m_canvas, m_currentCanvasSheet, m_diff, DIALOG_KICAD_DIFF_BASE::m_labelSummary, DIALOG_KICAD_DIFF_BASE::m_pathComparison, DIALOG_KICAD_DIFF_BASE::m_pathReference, m_sheetSwitcher, KICAD_DIFF::DIFF_SCENE::referenceGeometry, and showChange().

◆ ReloadSashPositions()

void DIALOG_SHIM::ReloadSashPositions ( )

inherited

While we did this in LoadControlState(), we need to re-apply if after setting the dialog size.

Well, sometimes we need to re-apply it.

Definition at line 1046 of file dialog_shim.cpp.

References COMMON_SETTINGS::CsInternals(), generateKey(), PGM_BASE::GetCommonSettings(), getDialogKeyFromTitle(), COMMON_SETTINGS_INTERNALS::m_dialogControlValues, m_hash_key, Pgm(), and PROPERTY_HOLDER::SafeCast().

Referenced by Show().

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

References getDialogKeyFromTitle(), m_hash_key, and Pgm().

Referenced by DIALOG_PAD_PROPERTIES::updatePadSizeControls().

◆ resetUndoRedoForNewContent()

void DIALOG_SHIM::resetUndoRedoForNewContent ( wxWindowList & aChildren )

protectedinherited

Reset undo/redo tracking after dynamically replacing child panels.

Clears the undo/redo stacks and current value baselines, then registers undo/redo event handlers on the new children.

Parameters

aChildren The child window list of the newly created panel.

Definition at line 1868 of file dialog_shim.cpp.

References m_controlsWithPendingChanges, m_currentValues, m_redoStack, m_undoStack, and registerUndoRedoHandlers().

Referenced by RULE_EDITOR_DIALOG_BASE::SetContentPanel().

◆ SaveControlState()

void DIALOG_SHIM::SaveControlState ( )

inherited

Save control values and geometry to the current project's local settings.

Definition at line 714 of file dialog_shim.cpp.

References COMMON_SETTINGS::CsInternals(), generateKey(), PGM_BASE::GetCommonSettings(), getDialogKeyFromTitle(), UNIT_BINDER::GetFormula(), UNIT_BINDER::GetValue(), grid, index, isCompoundDateTimePicker(), COMMON_SETTINGS_INTERNALS::m_dialogControlValues, m_hash_key, m_unitBinders, Pgm(), PROPERTY_HOLDER::SafeCast(), and UNIT_BINDER::UnitsInvariant().

Referenced by OnCloseWindow(), and Show().

◆ SelectAllInTextCtrls()

void DIALOG_SHIM::SelectAllInTextCtrls ( wxWindowList & children )

inherited

Definition at line 1158 of file dialog_shim.cpp.

References ignore_unused(), isCompoundDateTimePicker(), m_beforeEditValues, minSize, onChildSetFocus(), and SelectAllInTextCtrls().

Referenced by OnPaint(), and SelectAllInTextCtrls().

◆ selectChangeById()

bool DIALOG_KICAD_DIFF::selectChangeById ( const KIID_PATH & aChangeId )

private

Select the tree row whose change has the given KIID_PATH.

Wired to the canvas's pick handler so clicking a rectangle on the canvas scrolls/selects the matching change in the tree. Returns false when the id isn't present (typically because its category is filtered out).

Definition at line 689 of file dialog_kicad_diff.cpp.

References m_changeByTreeId, and DIALOG_KICAD_DIFF_BASE::m_treeChanges.

Referenced by buildTree(), and DIALOG_KICAD_DIFF().

◆ SetChangeSelectedHandler()

void DIALOG_KICAD_DIFF::SetChangeSelectedHandler ( CHANGE_SELECTED_FN aFn )

inline

Definition at line 82 of file dialog_kicad_diff.h.

References m_changeSelectedFn.

◆ setControlValue()

void DIALOG_SHIM::setControlValue	(	wxWindow *	aCtrl,
		const wxVariant &	aValue )

privateinherited

Definition at line 1519 of file dialog_shim.cpp.

References grid, and table.

Referenced by doRedo(), and doUndo().

◆ 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 94 of file dialog_shim.h.

References m_initialFocusTarget.

◆ 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 39 of file kiway_holder.cpp.

References ignore_unused(), m_kiway, and name.

Referenced by DIALOG_SHIM::DIALOG_SHIM(), 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 448 of file dialog_shim.cpp.

Referenced by PCB_BASE_FRAME::SelectOneLayer().

◆ SetRevisionChooser()

void DIALOG_KICAD_DIFF::SetRevisionChooser	(	const std::vector< wxString > &	aLabels,
		int	aSelected,
		REVISION_HANDLER	aOnChange )

Add a revision dropdown (with prev/next) at the top.

Fired on change with the chosen index. Only call this for local-history compares; without it no chooser is shown.

Definition at line 428 of file dialog_kicad_diff.cpp.

References _, m_revisionChoice, m_revisionHandler, and top().

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

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

◆ SetUpHandler()

void DIALOG_KICAD_DIFF::SetUpHandler ( UP_HANDLER aHandler )

Definition at line 489 of file dialog_kicad_diff.cpp.

References _, KiBitmapBundle(), m_btnUp, m_filterSizer, DIALOG_KICAD_DIFF_BASE::m_panelDetail, m_upHandler, and up.

Referenced by SCH_INSPECTION_TOOL::showSchematicComparison().

◆ SetupStandardButtons()

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

inherited

Definition at line 2182 of file dialog_shim.cpp.

References recursiveDescent().

◆ Show()

bool DIALOG_SHIM::Show ( bool show )

overrideinherited

Definition at line 494 of file dialog_shim.cpp.

References clampToWorkArea(), KIPLATFORM::UI::EnsureVisible(), focusParentCanvas(), getDialogKeyFromTitle(), m_hash_key, m_initialSize, m_useCalculatedSize, m_userPositioned, m_userResized, Pgm(), ReloadSashPositions(), SaveControlState(), and KIPLATFORM::UI::StabilizeWindowPosition().

Referenced by SCH_INSPECTION_TOOL::CrossProbe(), BOARD_INSPECTION_TOOL::DiffFootprint(), SCH_INSPECTION_TOOL::DiffSymbol(), BOARD_EDITOR_CONTROL::EditFootprintFields(), SCH_EDITOR_CONTROL::EditSymbolFields(), EndQuasiModal(), BOARD_EDITOR_CONTROL::GenerateBOM(), SCH_EDITOR_CONTROL::GenerateBOM(), BOARD_INSPECTION_TOOL::InspectConstraints(), BOARD_INSPECTION_TOOL::InspectDRCError(), SCH_INSPECTION_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(), DIALOG_SCH_FIND::onShowSearchPanel(), SCH_INSPECTION_TOOL::PrevMarker(), CVPCB_MAINFRAME::readNetListAndFpFiles(), BOARD_INSPECTION_TOOL::reportClearance(), DIALOG_FIND::Show(), DIALOG_FIND_BY_PROPERTIES::Show(), DIALOG_PAD_PROPERTIES::Show(), EDA_LIST_DIALOG::Show(), EDA_VIEW_SWITCHER::Show(), HOTKEY_CYCLE_POPUP::Show(), RULE_EDITOR_DIALOG_BASE::Show(), PCB_CONTROL::ShowDrillGroups(), SCH_INSPECTION_TOOL::ShowERCDialog(), GIT_ADVANCED_DIALOG::ShowForFrame(), HTML_MESSAGE_BOX::ShowModeless(), ShowQuasiModal(), DIALOG_POSITION_RELATIVE::UpdatePickedItem(), and DIALOG_POSITION_RELATIVE::UpdatePickedPoint().

◆ showChange()

void DIALOG_KICAD_DIFF::showChange ( const KICAD_DIFF::ITEM_CHANGE * aChange )

private

Populate the property list for the change associated with the selected tree node, or clear the list if no change is selected (e.g.

group node).

Definition at line 597 of file dialog_kicad_diff.cpp.

References _, KICAD_DIFF::ChangeKindLabel(), KICAD_DIFF::ITEM_CHANGE::children, KICAD_DIFF::DocKindFromDocType(), DIALOG_SHIM::GetUserUnits(), KICAD_DIFF::ITEM_CHANGE::id, KICAD_DIFF::IuScaleForDocKind(), KICAD_DIFF::ITEM_CHANGE::kind, m_canvas, m_changeSelectedFn, m_currentCanvasSheet, m_diff, DIALOG_KICAD_DIFF_BASE::m_labelSummary, DIALOG_KICAD_DIFF_BASE::m_listProperties, m_sheetSwitcher, m_suppressCenter, KICAD_DIFF::ITEM_CHANGE::properties, KICAD_DIFF::ITEM_CHANGE::refdes, and KICAD_DIFF::ITEM_CHANGE::typeName.

Referenced by buildTree(), DIALOG_KICAD_DIFF(), OnTreeSelectionChanged(), Reload(), and SwitchCanvasToSheet().

◆ ShowModal()

int DIALOG_SHIM::ShowModal ( )

overrideinherited

Definition at line 1741 of file dialog_shim.cpp.

References KIPLATFORM::UI::ReparentModal(), and KIPLATFORM::UI::StabilizeWindowPosition().

Referenced by PANEL_SETUP_LAYERS::addUserDefinedLayer(), PCB_CONTROL::ApplyDesignBlockLayout(), MULTICHANNEL_TOOL::AutogenerateRuleAreas(), GRID_CELL_COLOR_SELECTOR::BeginEdit(), SCH_INSPECTION_TOOL::CheckSymbol(), FOOTPRINT_EDITOR_CONTROL::CleanupGraphics(), GLOBAL_EDIT_TOOL::CleanupGraphics(), GLOBAL_EDIT_TOOL::CleanupTracksAndVias(), CONSTRAINT_EDIT_TOOL::commitConstraint(), ZONE_CREATE_HELPER::commitZone(), FOOTPRINT_EDITOR_CONTROL::CompareLibraryWithFile(), COMMON_CONTROL::ConfigurePaths(), DRAWING_TOOL::ConvertImageToOutlines(), SCH_EDIT_TOOL::ConvertImageToOutlines(), DIALOG_PLOT::CreateDrillFile(), CONVERT_TOOL::CreateLines(), SYMBOL_EDIT_FRAME::CreateNewSymbol(), MICROWAVE_TOOL::createPolygonShape(), CONVERT_TOOL::CreatePolys(), ROUTER_TOOL::CustomTrackWidthDialog(), DIALOG_SYMBOL_FIELDS_TABLE::DIALOG_SYMBOL_FIELDS_TABLE(), PANEL_DESIGN_BLOCK_CHOOSER::displayErrors(), DisplayHotkeyList(), LIB_FIELDS_EDITOR_GRID_TRICKS::doFieldsTablePopupSelection(), CURSORS_GRID_TRICKS::doPopupSelection(), MEASUREMENTS_GRID_TRICKS::doPopupSelection(), SIGNALS_GRID_TRICKS::doPopupSelection(), ROUTER_TOOL::DpDimensionsDialog(), DRAWING_TOOL::DrawBarcode(), SIMULATOR_FRAME::EditAnalysis(), EditConstraintValue(), DESIGN_BLOCK_PANE::EditDesignBlockProperties(), KIGIT::EditGitIdentity(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), PANEL_SETUP_VIA_STACKS::editPreset(), SCH_EDIT_TOOL::EditProperties(), 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(), KICAD_MANAGER_CONTROL::ExportForOlderVersion(), BOARD_EDITOR_CONTROL::ExportGenCAD(), BOARD_EDITOR_CONTROL::ExportIDF(), EDA_3D_CONTROLLER::ExportImage(), 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(), EDIT_TOOL::HealShapes(), SCH_EDIT_FRAME::importFile(), EE_GRAPHIC_TOOL::ImportGraphics(), SYMBOL_EDIT_FRAME::ImportSymbol(), SCH_EDITOR_CONTROL::IncrementAnnotations(), PCB_EDIT_FRAME::InstallNetlistFrame(), POSITION_RELATIVE_TOOL::InteractiveOffset(), InvokeCopperZonesEditor(), InvokeDialogNetList(), InvokeEditDesignBlockLibTable(), InvokeNonCopperZonesEditor(), InvokePcbLibTableEditor(), InvokeRuleAreaEditor(), InvokeSchEditSymbolLibTable(), PROJECT_SCH::LegacySchLibs(), GERBVIEW_FRAME::LoadGerberJobFile(), GERBVIEW_FRAME::LoadListOfGerberAndDrillFiles(), GERBVIEW_FRAME::LoadZipArchiveFile(), CONSTRAINT_EDIT_TOOL::ManageConstraints(), GLOBAL_EDIT_TOOL::Migrate3DModels(), SCH_EDIT_FRAME::ModalAnnotate(), EDIT_TOOL::MoveExact(), PCB_POINT_EDITOR::movePoint(), SIMULATOR_CONTROL::NewAnalysisTab(), PANEL_SYM_LIB_TABLE::newDatabaseLibraryHandler(), KICAD_MANAGER_CONTROL::NewFromRepository(), KICAD_MANAGER_CONTROL::NewProject(), PANEL_JOBSET::OnAddDestinationClick(), PANEL_SETUP_BOARD_STACKUP::onAddDielectricLayer(), PANEL_FOOTPRINT_FILTERS::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(), PANEL_GIT_REMOTES::onAddRemote(), DIALOG_BOARD_SETUP::onAuxiliaryAction(), DIALOG_SCHEMATIC_SETUP::onAuxiliaryAction(), PCB_EDIT_FRAME::OnBoardLoaded(), PANEL_FAB_EXPORT_CONTENT::onBomFieldsClick(), DIALOG_FIELDS_TABLE::onBomFmtPresetChanged(), DIALOG_FIELDS_TABLE::onBomPresetChanged(), PANEL_SETUP_BOARD_STACKUP::onColorSelected(), KICAD_MANAGER_FRAME::OnCompareProjectBranches(), PANEL_REMOTE_SYMBOL::onConfigure(), DIALOG_DRC::OnDRCItemRClick(), PANEL_FOOTPRINT_FILTERS::OnEditFootprintFilter(), PANEL_GRID_SETTINGS::onEditGrid(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), PCB_EDIT_FRAME::OnEditItemRequest(), PANEL_REGULATOR::OnEditRegulator(), PANEL_GIT_REMOTES::onEditRemote(), DIALOG_LIB_SYMBOL_PROPERTIES::OnEditSpiceModel(), DIALOG_SYMBOL_PROPERTIES::OnEditSpiceModel(), DIALOG_ERC::OnERCItemRClick(), DIALOG_EXPORT_STEP::onExportButton(), PROJECT_TREE_PANE::onGitInitializeProject(), PROJECT_TREE_PANE::onGitRemoteSettings(), PROJECT_TREE_PANE::onGitSwitchBranch(), LIB_TREE::onHeaderContextMenu(), PANEL_DESTINATION::OnLastStatusClick(), APPEARANCE_CONTROLS::onLayerPresetChanged(), APPEARANCE_CONTROLS_3D::onLayerPresetChanged(), PANEL_SCH_DATA_SOURCES::OnManageDataSources(), DIALOG_PCM::OnManageRepositoriesClicked(), PANEL_SETUP_BOARD_STACKUP::onMaterialChange(), PANEL_FP_LIB_TABLE::onMigrateLibraries(), PANEL_GIT_TAGS::onNewTag(), PANEL_DESTINATION::OnProperties(), PANEL_IMAGE_EDITOR::OnRemoveBackground(), PANEL_SETUP_BOARD_STACKUP::onRemoveDielectricLayer(), PCB_NET_INSPECTOR_PANEL::onRenameSelectedNet(), PANEL_PCBNEW_ACTION_PLUGINS::OnShowErrorsButtonClick(), DIALOG_VIA_STITCH_PROPERTIES::OnViaConfigureClicked(), APPEARANCE_CONTROLS::onViewportChanged(), APPEARANCE_CONTROLS_3D::onViewportChanged(), PCBNEW_JOBS_HANDLER::OpenDiffDialog(), PANEL_JOBSET::OpenJobOptionsForListItem(), DESIGN_BLOCK_GRID_TRICKS::optionsEditor(), FP_GRID_TRICKS::optionsEditor(), SYMBOL_GRID_TRICKS::optionsEditor(), CONVERT_TOOL::OutsetItems(), DIALOG_PAD_PROPERTIES::padValuesOK(), BOARD_EDITOR_CONTROL::PageSettings(), PL_EDITOR_CONTROL::PageSetup(), SCH_EDITOR_CONTROL::PageSetup(), PCB_CONTROL::Paste(), SCH_EDITOR_CONTROL::Paste(), PCBNEW_JOBS_HANDLER::PCBNEW_JOBS_HANDLER(), SCH_BASE_FRAME::PickSymbolFromLibrary(), SYMBOL_EDITOR_EDIT_TOOL::PinTable(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceImportedGraphics(), DRAWING_TOOL::PlaceMicroviaStack(), DRAWING_TOOL::PlaceTuningPattern(), SCH_EDITOR_CONTROL::Plot(), GERBVIEW_CONTROL::Print(), PCB_CONTROL::Print(), SCH_EDITOR_CONTROL::Print(), KIGIT::PromptForCredentials(), HK_PROMPT_DIALOG::PromptForKey(), SCH_EDIT_TOOL::Properties(), PAD_TOOL::pushPadSettings(), GERBVIEW_FRAME::Read_EXCELLON_File(), GERBVIEW_FRAME::Read_GERBER_File(), CVPCB_MAINFRAME::readNetListAndFpFiles(), GLOBAL_EDIT_TOOL::RemoveUnusedPads(), DIALOG_IMPORT_CHOOSE_PROJECT::RunModal(), DIALOG_MAP_LAYERS::RunModal(), PCBNEW_JOBS_HANDLER::runPcbMerge(), EESCHEMA_JOBS_HANDLER::runSchMerge(), PCB_EDIT_FRAME::SaveBoardAsDesignBlock(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), ROUTER_TOOL::saveRouterDebugLog(), PCB_EDIT_FRAME::SaveSelectionAsDesignBlock(), SCH_EDIT_FRAME::SaveSelectionAsDesignBlock(), SCH_EDIT_FRAME::SaveSheetAsDesignBlock(), SYMBOL_EDIT_FRAME::saveSymbolCopyAs(), ROUTER_TOOL::SelectCopperLayerPair(), FOOTPRINT_EDIT_FRAME::SelectFootprintFromBoard(), FOOTPRINT_WIZARD_FRAME::SelectFootprintWizard(), PCB_BASE_EDIT_FRAME::SelectLibrary(), SCH_BASE_FRAME::SelectLibrary(), PCB_BASE_FRAME::SelectOneLayer(), GERBVIEW_FRAME::SelectPCBLayer(), GERBVIEW_FRAME::SetLayerDrawPrms(), ROUTER_TOOL::SettingsDialog(), PCB_BASE_EDIT_FRAME::ShowBarcodePropertiesDialog(), BOARD_INSPECTION_TOOL::ShowBoardStatistics(), SCH_EDITOR_CONTROL::ShowCreateNetChain(), PL_EDITOR_FRAME::ShowDesignInspector(), DIFF_PHASE_SKEW_TOOL::ShowDiffPhaseSkew(), CVPCB_CONTROL::ShowEquFileTable(), BOARD_INSPECTION_TOOL::ShowFootprintLinks(), FOOTPRINT_EDITOR_CONTROL::ShowFootprintUsers(), PCB_BASE_EDIT_FRAME::ShowGridItemPropertiesDialog(), FOOTPRINT_EDITOR_CONTROL::ShowLibraryFieldsTable(), SYMBOL_EDITOR_CONTROL::ShowLibraryTable(), SIMULATOR_CONTROL::ShowNetlist(), KICAD_MANAGER_CONTROL::ShowPluginManager(), EDA_BASE_FRAME::ShowPreferences(), PCB_TUNING_PATTERN::ShowPropertiesDialog(), PCB_VIA_STACK::ShowPropertiesDialog(), PCB_VIA_STITCH::ShowPropertiesDialog(), BOARD_REANNOTATE_TOOL::ShowReannotateDialog(), PCB_BASE_EDIT_FRAME::ShowReferenceImagePropertiesDialog(), LOCAL_HISTORY::ShowRestoreDialog(), SCH_INSPECTION_TOOL::showSchematicComparison(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), MATCH_PROPERTIES_TOOL::showSettingsDialog(), PCB_EDIT_FRAME::ShowTargetOptionsDialog(), EDIT_TOOL::SimplifyPolygons(), SCH_DRAWING_TOOLS::SingleClickPlace(), GLOBAL_EDIT_TOOL::SwapLayers(), DIALOG_IMPORT_GFX::TransferDataFromWindow(), DIALOG_IMPORT_GRAPHICS::TransferDataFromWindow(), PANEL_SETUP_LAYERS::TransferDataFromWindow(), EDA_3D_VIEWER_FRAME::TryBefore(), PCB_BASE_EDIT_FRAME::TryBefore(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), SCH_EDIT_FRAME::UpdateDesignBlockFromSheet(), 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 1781 of file dialog_shim.cpp.

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

Referenced by PANEL_FP_PROPERTIES_3D_MODEL::Cfg3DPath(), SCH_EDIT_TOOL::ChangeSymbols(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), SCH_DRAWING_TOOLS::createNewLabel(), SCH_DRAWING_TOOLS::createNewText(), EE_GRAPHIC_TOOL::DrawShape(), DRAWING_TOOL::DrawTable(), SCH_DRAWING_TOOLS::DrawTable(), SYMBOL_EDITOR_EDIT_TOOL::editFieldProperties(), SCH_EDIT_TOOL::editFieldText(), FOOTPRINT_EDIT_FRAME::editFootprintProperties(), FOOTPRINT_EDITOR_CONTROL::editFootprintPropertiesFromLibrary(), SCH_EDIT_TOOL::EditProperties(), SYMBOL_EDITOR_EDIT_TOOL::EditSymbolPinMaps(), SYMBOL_EDITOR_EDIT_TOOL::editSymbolProperties(), SYMBOL_EDITOR_EDIT_TOOL::editSymbolPropertiesFromLibrary(), PCB_EDIT_TABLE_TOOL::EditTable(), SCH_EDIT_TABLE_TOOL::EditTable(), GLOBAL_EDIT_TOOL::EditTeardrops(), GLOBAL_EDIT_TOOL::EditTracksAndVias(), SIMULATOR_CONTROL::EditUserDefinedSignals(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), DRC_TOOL::FixDRCError(), SCH_EDIT_TOOL::FixERCError(), BOARD_EDITOR_CONTROL::GenerateGerbers(), InvokeDialogCreateBOM(), InvokeDialogEditSymbolsLibId(), InvokeDialogRescueEach(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), PCB_EDIT_FRAME::OnEditItemRequest(), SCH_PROPERTIES_PANEL::onEditPinMap(), PANEL_JOBSET::OpenJobOptionsForListItem(), SCH_EDIT_FRAME::OpenProjectFiles(), PAD_TOOL::PadTable(), DRAWING_TOOL::PlaceText(), BOARD_EDITOR_CONTROL::Plot(), EDIT_TOOL::Properties(), SCH_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(), PCB_BASE_EDIT_FRAME::ShowTextBoxPropertiesDialog(), PCB_BASE_EDIT_FRAME::ShowTextPropertiesDialog(), and GLOBAL_EDIT_TOOL::ZonesManager().

◆ SwitchCanvasToSheet()

void DIALOG_KICAD_DIFF::SwitchCanvasToSheet ( const KIID_PATH & aSheetPath )

Definition at line 579 of file dialog_kicad_diff.cpp.

References m_canvas, m_currentCanvasSheet, m_sheetSwitcher, DIALOG_KICAD_DIFF_BASE::m_treeChanges, and showChange().

◆ 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 278 of file dialog_shim.h.

Referenced by EndQuasiModal().

◆ UnregisterUnitBinder()

void DIALOG_SHIM::UnregisterUnitBinder ( UNIT_BINDER * aUnitBinder )

inherited

Remove a UNIT_BINDER from the control-state save/restore map.

Called from ~UNIT_BINDER so that a destroyed binder never leaves a dangling pointer behind for SaveControlState()/LoadControlState() to dereference when a later control reuses the freed window's address.

Parameters

aUnitBinder the binder being destroyed

Definition at line 1143 of file dialog_shim.cpp.

References m_unitBinders.

◆ unregisterUnitBinders()

void DIALOG_SHIM::unregisterUnitBinders ( wxWindow * aWindow )

protectedinherited

Remove UNIT_BINDER registrations for a window and all its descendants.

Call before destroying a panel whose children have registered unit binders.

Parameters

aWindow The root window whose subtree should be unregistered.

Definition at line 1878 of file dialog_shim.cpp.

References m_unitBinders, and unregisterUnitBinders().

Referenced by RULE_EDITOR_DIALOG_BASE::SetContentPanel(), and unregisterUnitBinders().

◆ vertPixelsFromDU()

int DIALOG_SHIM::vertPixelsFromDU ( int y ) const

protectedinherited

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

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 435 of file dialog_shim.cpp.

Member Data Documentation

◆ m_beforeEditValues

std::map<wxWindow*, wxString> DIALOG_SHIM::m_beforeEditValues

protectedinherited

Definition at line 401 of file dialog_shim.h.

Referenced by OnCharHook(), onChildSetFocus(), and SelectAllInTextCtrls().

◆ m_btnUp

wxButton* DIALOG_KICAD_DIFF::m_btnUp = nullptr

private

Definition at line 126 of file dialog_kicad_diff.h.

Referenced by EnableUp(), and SetUpHandler().

◆ m_canvas

WIDGET_DIFF_CANVAS* DIALOG_KICAD_DIFF::m_canvas = nullptr

private

GAL-backed canvas showing the DIFF_SCENE shape rectangles.

Pick callbacks cross-probe to the tree.

Definition at line 140 of file dialog_kicad_diff.h.

Referenced by buildTree(), DIALOG_KICAD_DIFF(), DiffCanvas(), OnTreeItemMenu(), Reload(), showChange(), and SwitchCanvasToSheet().

◆ m_changeByTreeId

std::map<wxUIntPtr, const KICAD_DIFF::ITEM_CHANGE*> DIALOG_KICAD_DIFF::m_changeByTreeId

private

Maps tree item IDs to the underlying change record so selection can find the data without walking the diff again.

Group nodes have no entry here (selecting a group clears the property list).

Definition at line 132 of file dialog_kicad_diff.h.

Referenced by applyHiddenToTree(), buildTree(), OnTreeItemMenu(), OnTreeSelectionChanged(), and selectChangeById().

◆ m_changeSelectedFn

CHANGE_SELECTED_FN DIALOG_KICAD_DIFF::m_changeSelectedFn

private

Definition at line 150 of file dialog_kicad_diff.h.

Referenced by SetChangeSelectedHandler(), and showChange().

◆ m_childReleased

bool DIALOG_SHIM::m_childReleased

protectedinherited

Definition at line 417 of file dialog_shim.h.

Referenced by DIALOG_SHIM(), and OnMove().

◆ m_controlsWithPendingChanges

std::set<wxWindow*> DIALOG_SHIM::m_controlsWithPendingChanges

protectedinherited

Definition at line 414 of file dialog_shim.h.

Referenced by flushPendingControlChanges(), recordControlChange(), and resetUndoRedoForNewContent().

◆ m_currentCanvasSheet

KIID_PATH DIALOG_KICAD_DIFF::m_currentCanvasSheet

private

Definition at line 148 of file dialog_kicad_diff.h.

Referenced by CurrentCanvasSheet(), DIALOG_KICAD_DIFF(), Reload(), showChange(), and SwitchCanvasToSheet().

◆ m_currentValues

std::map<wxWindow*, wxVariant> DIALOG_SHIM::m_currentValues

protectedinherited

Definition at line 413 of file dialog_shim.h.

Referenced by doRedo(), doUndo(), flushPendingControlChanges(), registerUndoRedoHandlers(), and resetUndoRedoForNewContent().

◆ m_diff

KICAD_DIFF::DOCUMENT_DIFF DIALOG_KICAD_DIFF::m_diff

private

Definition at line 117 of file dialog_kicad_diff.h.

Referenced by buildTree(), changeRowIds(), DIALOG_KICAD_DIFF(), Reload(), and showChange().

◆ m_filterSizer

wxBoxSizer* DIALOG_KICAD_DIFF::m_filterSizer = nullptr

private

Definition at line 127 of file dialog_kicad_diff.h.

Referenced by DIALOG_KICAD_DIFF(), and SetUpHandler().

◆ m_firstPaintEvent

bool DIALOG_SHIM::m_firstPaintEvent

protectedinherited

Definition at line 382 of file dialog_shim.h.

Referenced by DIALOG_SHIM(), OnActivate(), and OnPaint().

◆ m_handlingUndoRedo

bool DIALOG_SHIM::m_handlingUndoRedo

protectedinherited

Definition at line 416 of file dialog_shim.h.

Referenced by DIALOG_SHIM(), doRedo(), doUndo(), onCommandEvent(), onDataViewListChanged(), onGridCellChanged(), onPropertyGridChanged(), onSpinDoubleEvent(), onSpinEvent(), and onStyledTextChanged().

◆ m_hash_key

std::string DIALOG_SHIM::m_hash_key

protectedinherited

Definition at line 373 of file dialog_shim.h.

Referenced by CONVERT_SETTINGS_DIALOG::CONVERT_SETTINGS_DIALOG(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), DIALOG_CONVERT_IMAGE_TO_OUTLINES::DIALOG_CONVERT_IMAGE_TO_OUTLINES(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXPORT_2581::DIALOG_EXPORT_2581(), DIALOG_EXPORT_2581::DIALOG_EXPORT_2581(), DIALOG_EXPORT_NETLIST::DIALOG_EXPORT_NETLIST(), DIALOG_EXPORT_ODBPP::DIALOG_EXPORT_ODBPP(), DIALOG_EXPORT_ODBPP::DIALOG_EXPORT_ODBPP(), DIALOG_EXPORT_STEP::DIALOG_EXPORT_STEP(), DIALOG_FOOTPRINT_FIELDS_TABLE::DIALOG_FOOTPRINT_FIELDS_TABLE(), DIALOG_GEN_FOOTPRINT_POSITION::DIALOG_GEN_FOOTPRINT_POSITION(), DIALOG_GEN_FOOTPRINT_POSITION::DIALOG_GEN_FOOTPRINT_POSITION(), DIALOG_GENCAD_EXPORT_OPTIONS::DIALOG_GENCAD_EXPORT_OPTIONS(), DIALOG_GENDRILL::DIALOG_GENDRILL(), DIALOG_GENDRILL::DIALOG_GENDRILL(), DIALOG_GRID_ITEM_PROPERTIES::DIALOG_GRID_ITEM_PROPERTIES(), DIALOG_IMPORT_GFX::DIALOG_IMPORT_GFX(), DIALOG_IMPORT_GRAPHICS::DIALOG_IMPORT_GRAPHICS(), DIALOG_LABEL_PROPERTIES::DIALOG_LABEL_PROPERTIES(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_PLOT::DIALOG_PLOT(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_SHAPE_PROPERTIES::DIALOG_SHAPE_PROPERTIES(), DIALOG_SHAPE_PROPERTIES::DIALOG_SHAPE_PROPERTIES(), DIALOG_SYMBOL_FIELDS_TABLE::DIALOG_SYMBOL_FIELDS_TABLE(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), EDA_LIST_DIALOG::EDA_LIST_DIALOG(), EDA_REORDERABLE_LIST_DIALOG::EDA_REORDERABLE_LIST_DIALOG(), GIT_ADVANCED_DIALOG::GIT_ADVANCED_DIALOG(), LoadControlState(), OptOut(), PAGED_DIALOG::PAGED_DIALOG(), ReloadSashPositions(), resetSize(), SaveControlState(), DIALOG_EXPORT_IDF3::setupDialog(), Show(), WX_MULTI_ENTRY_DIALOG::WX_MULTI_ENTRY_DIALOG(), WX_PT_ENTRY_DIALOG::WX_PT_ENTRY_DIALOG(), WX_TEXT_ENTRY_DIALOG::WX_TEXT_ENTRY_DIALOG(), and WX_UNIT_ENTRY_DIALOG::WX_UNIT_ENTRY_DIALOG().

◆ m_hiddenChanges

std::set<KIID_PATH> DIALOG_KICAD_DIFF::m_hiddenChanges

private

Changes the user has muted via the tree's right-click menu.

Definition at line 120 of file dialog_kicad_diff.h.

Referenced by applyHiddenToTree(), and OnTreeItemMenu().

◆ m_initialFocusTarget

wxWindow* DIALOG_SHIM::m_initialFocusTarget

protectedinherited

Definition at line 383 of file dialog_shim.h.

Referenced by DIALOG_SHIM(), forceInitialFocus(), NETLIST_DIALOG_ADD_GENERATOR::NETLIST_DIALOG_ADD_GENERATOR(), and SetInitialFocus().

◆ m_initialSize

wxSize DIALOG_SHIM::m_initialSize

protectedinherited

Definition at line 396 of file dialog_shim.h.

Referenced by DIALOG_SHIM(), RULE_EDITOR_DIALOG_BASE::finishInitialization(), Show(), and DIALOG_DRC_RULE_EDITOR::TransferDataToWindow().

◆ m_isClosing

bool DIALOG_SHIM::m_isClosing

protectedinherited

Definition at line 384 of file dialog_shim.h.

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

◆ m_kiway

KIWAY* KIWAY_HOLDER::m_kiway

privateinherited

Definition at line 85 of file kiway_holder.h.

Referenced by HasKiway(), Kiway(), KIWAY_HOLDER(), and SetKiway().

◆ m_labelComparison

wxStaticText* DIALOG_KICAD_DIFF_BASE::m_labelComparison

protectedinherited

Definition at line 41 of file dialog_kicad_diff_base.h.

Referenced by DIALOG_KICAD_DIFF_BASE().

◆ m_labelReference

wxStaticText* DIALOG_KICAD_DIFF_BASE::m_labelReference

protectedinherited

Definition at line 39 of file dialog_kicad_diff_base.h.

Referenced by DIALOG_KICAD_DIFF_BASE().

◆ m_labelSummary

wxStaticText* DIALOG_KICAD_DIFF_BASE::m_labelSummary

protectedinherited

Definition at line 48 of file dialog_kicad_diff_base.h.

Referenced by DIALOG_KICAD_DIFF::DIALOG_KICAD_DIFF(), DIALOG_KICAD_DIFF_BASE(), DIALOG_KICAD_DIFF::Reload(), and DIALOG_KICAD_DIFF::showChange().

◆ m_listProperties

wxListCtrl* DIALOG_KICAD_DIFF_BASE::m_listProperties

protectedinherited

Definition at line 49 of file dialog_kicad_diff_base.h.

Referenced by DIALOG_KICAD_DIFF::DIALOG_KICAD_DIFF(), DIALOG_KICAD_DIFF_BASE(), and DIALOG_KICAD_DIFF::showChange().

◆ m_noControlUndoRedo

std::set<wxWindow*> DIALOG_SHIM::m_noControlUndoRedo

protectedinherited

Definition at line 415 of file dialog_shim.h.

Referenced by ExcludeFromControlUndoRedo(), and registerUndoRedoHandlers().

◆ m_panelDetail

wxPanel* DIALOG_KICAD_DIFF_BASE::m_panelDetail

protectedinherited

Definition at line 47 of file dialog_kicad_diff_base.h.

Referenced by DIALOG_KICAD_DIFF::DIALOG_KICAD_DIFF(), DIALOG_KICAD_DIFF_BASE(), and DIALOG_KICAD_DIFF::SetUpHandler().

◆ m_panelTree

wxPanel* DIALOG_KICAD_DIFF_BASE::m_panelTree

protectedinherited

Definition at line 45 of file dialog_kicad_diff_base.h.

Referenced by DIALOG_KICAD_DIFF::DIALOG_KICAD_DIFF(), and DIALOG_KICAD_DIFF_BASE().

◆ m_parentFrame

EDA_BASE_FRAME* DIALOG_SHIM::m_parentFrame

protectedinherited

Definition at line 391 of file dialog_shim.h.

Referenced by DIALOG_MAP_LAYERS::DIALOG_MAP_LAYERS(), DIALOG_SHIM(), focusParentCanvas(), DIALOG_FIELDS_TABLE::onBomSettingsChanged(), OnCharHook(), DIALOG_LIB_SYMBOL_PROPERTIES::OnEditSpiceModel(), DIALOG_SYMBOL_PROPERTIES::OnEditSpiceModel(), DIALOG_FIELDS_TABLE::OnExport(), DIALOG_FIELDS_TABLE::OnOutputFileBrowseClicked(), DIALOG_PAGES_SETTINGS::OnWksFileSelection(), DIALOG_PAD_PROPERTIES::padValuesOK(), DIALOG_MAP_LAYERS::RunModal(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_ANNOTATE::TransferDataToWindow(), DIALOG_POSITION_RELATIVE::updateAnchorInfo(), and DIALOG_ANNOTATE::~DIALOG_ANNOTATE().

◆ m_pathComparison

wxStaticText* DIALOG_KICAD_DIFF_BASE::m_pathComparison

protectedinherited

Definition at line 42 of file dialog_kicad_diff_base.h.

Referenced by DIALOG_KICAD_DIFF::DIALOG_KICAD_DIFF(), DIALOG_KICAD_DIFF_BASE(), and DIALOG_KICAD_DIFF::Reload().

◆ m_pathReference

wxStaticText* DIALOG_KICAD_DIFF_BASE::m_pathReference

protectedinherited

Definition at line 40 of file dialog_kicad_diff_base.h.

Referenced by DIALOG_KICAD_DIFF::DIALOG_KICAD_DIFF(), DIALOG_KICAD_DIFF_BASE(), and DIALOG_KICAD_DIFF::Reload().

◆ m_qmodal_loop

wxGUIEventLoop* DIALOG_SHIM::m_qmodal_loop

protectedinherited

Definition at line 386 of file dialog_shim.h.

Referenced by DIALOG_SHIM(), EndQuasiModal(), and ShowQuasiModal().

◆ m_qmodal_parent_disabler

WINDOW_DISABLER* DIALOG_SHIM::m_qmodal_parent_disabler

protectedinherited

Definition at line 389 of file dialog_shim.h.

Referenced by CleanupAfterModalSubDialog(), DIALOG_SHIM(), EndQuasiModal(), PrepareForModalSubDialog(), ShowQuasiModal(), and ~DIALOG_SHIM().

◆ m_qmodal_showing

bool DIALOG_SHIM::m_qmodal_showing

protectedinherited

Definition at line 388 of file dialog_shim.h.

Referenced by DIALOG_SHIM(), IsQuasiModal(), and ShowQuasiModal().

◆ m_redoStack

std::vector<UNDO_STEP> DIALOG_SHIM::m_redoStack

protectedinherited

Definition at line 412 of file dialog_shim.h.

Referenced by doRedo(), doUndo(), flushPendingControlChanges(), and resetUndoRedoForNewContent().

◆ m_revisionChoice

wxChoice* DIALOG_KICAD_DIFF::m_revisionChoice = nullptr

private

Definition at line 123 of file dialog_kicad_diff.h.

Referenced by SetRevisionChooser().

◆ m_revisionHandler

REVISION_HANDLER DIALOG_KICAD_DIFF::m_revisionHandler

private

Definition at line 122 of file dialog_kicad_diff.h.

Referenced by SetRevisionChooser().

◆ m_sdbSizer

wxStdDialogButtonSizer* DIALOG_KICAD_DIFF_BASE::m_sdbSizer

inherited

Definition at line 58 of file dialog_kicad_diff_base.h.

Referenced by DIALOG_KICAD_DIFF_BASE().

◆ m_sdbSizerOK

wxButton* DIALOG_KICAD_DIFF_BASE::m_sdbSizerOK

inherited

Definition at line 59 of file dialog_kicad_diff_base.h.

Referenced by DIALOG_KICAD_DIFF_BASE(), and ~DIALOG_KICAD_DIFF_BASE().

◆ m_searchFilter

wxString DIALOG_KICAD_DIFF::m_searchFilter

private

Lowercased free-text filter applied to typeName / refdes.

Empty string means no filter.

Definition at line 136 of file dialog_kicad_diff.h.

Referenced by buildTree(), and DIALOG_KICAD_DIFF().

◆ m_separator

wxStaticLine* DIALOG_KICAD_DIFF_BASE::m_separator

protectedinherited

Definition at line 43 of file dialog_kicad_diff_base.h.

Referenced by DIALOG_KICAD_DIFF_BASE().

◆ m_sheetSwitcher

SHEET_SWITCHER DIALOG_KICAD_DIFF::m_sheetSwitcher

private

Definition at line 147 of file dialog_kicad_diff.h.

Referenced by DIALOG_KICAD_DIFF(), Reload(), showChange(), and SwitchCanvasToSheet().

◆ m_splitter

wxSplitterWindow* DIALOG_KICAD_DIFF_BASE::m_splitter

protectedinherited

Definition at line 44 of file dialog_kicad_diff_base.h.

Referenced by DIALOG_KICAD_DIFF_BASE(), and m_splitterOnIdle().

◆ m_suppressCenter

bool DIALOG_KICAD_DIFF::m_suppressCenter = false

private

True while a canvas click is propagating into the tree, so the tree- selection handler skips re-centering on a shape that is already under the cursor.

Definition at line 145 of file dialog_kicad_diff.h.

Referenced by DIALOG_KICAD_DIFF(), and showChange().

◆ m_tabOrder

std::vector<wxWindow*> DIALOG_SHIM::m_tabOrder

protectedinherited

Definition at line 393 of file dialog_shim.h.

Referenced by DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_SCH_FIND::DIALOG_SCH_FIND(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), and OnCharHook().

◆ m_treeChanges

wxTreeCtrl* DIALOG_KICAD_DIFF_BASE::m_treeChanges

protectedinherited

Definition at line 46 of file dialog_kicad_diff_base.h.

Referenced by DIALOG_KICAD_DIFF::applyHiddenToTree(), DIALOG_KICAD_DIFF::buildTree(), DIALOG_KICAD_DIFF::DIALOG_KICAD_DIFF(), DIALOG_KICAD_DIFF_BASE(), DIALOG_KICAD_DIFF::OnTreeItemMenu(), DIALOG_KICAD_DIFF::selectChangeById(), DIALOG_KICAD_DIFF::SwitchCanvasToSheet(), and ~DIALOG_KICAD_DIFF_BASE().

◆ m_type

HOLDER_TYPE KIWAY_HOLDER::m_type

privateinherited

Definition at line 86 of file kiway_holder.h.

Referenced by GetType(), and KIWAY_HOLDER().

◆ m_undoStack

std::vector<UNDO_STEP> DIALOG_SHIM::m_undoStack

protectedinherited

Definition at line 411 of file dialog_shim.h.

Referenced by doRedo(), doUndo(), flushPendingControlChanges(), and resetUndoRedoForNewContent().

◆ m_unitBinders

std::map<wxWindow*, UNIT_BINDER*> DIALOG_SHIM::m_unitBinders

protectedinherited

Definition at line 402 of file dialog_shim.h.

Referenced by LoadControlState(), RegisterUnitBinder(), SaveControlState(), UnregisterUnitBinder(), unregisterUnitBinders(), and ~DIALOG_SHIM().

◆ m_units

EDA_UNITS DIALOG_SHIM::m_units

protectedinherited

Definition at line 372 of file dialog_shim.h.

Referenced by DIALOG_GEN_FOOTPRINT_POSITION::DIALOG_GEN_FOOTPRINT_POSITION(), DIALOG_SHIM(), GetUserUnits(), DIALOG_GEN_FOOTPRINT_POSITION::onGenerate(), and DIALOG_GENERATORS::onUnitsChanged().

◆ m_upHandler

UP_HANDLER DIALOG_KICAD_DIFF::m_upHandler

private

Definition at line 125 of file dialog_kicad_diff.h.

Referenced by SetUpHandler().

◆ m_useCalculatedSize

bool DIALOG_SHIM::m_useCalculatedSize

protectedinherited

Definition at line 377 of file dialog_shim.h.

Referenced by DIALOG_TRACK_VIA_PROPERTIES::commonInit(), DIALOG_SHIM(), PCB_ONE_LAYER_SELECTOR::PCB_ONE_LAYER_SELECTOR(), and Show().

◆ m_userPositioned

bool DIALOG_SHIM::m_userPositioned

protectedinherited

Definition at line 397 of file dialog_shim.h.

Referenced by DIALOG_SHIM(), OnMove(), and Show().

◆ m_userResized

bool DIALOG_SHIM::m_userResized

protectedinherited

Definition at line 398 of file dialog_shim.h.

Referenced by DIALOG_SHIM(), OnSize(), and Show().

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

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ CHANGE_SELECTED_FN

◆ REVISION_HANDLER

◆ SHEET_SWITCHER

◆ UP_HANDLER

Member Enumeration Documentation

◆ HOLDER_TYPE

Constructor & Destructor Documentation

◆ DIALOG_KICAD_DIFF()

◆ ~DIALOG_KICAD_DIFF()

Member Function Documentation

◆ applyHiddenToTree()

◆ buildTree()

◆ changeRowIds()

◆ clampToWorkArea()

◆ CleanupAfterModalSubDialog()

◆ ClearModify()

◆ CurrentCanvasSheet()

◆ DECLARE_EVENT_TABLE()

◆ DiffCanvas()

◆ doRedo()

◆ doUndo()

◆ Enable()

◆ EnableUp()

◆ EndDialogShim()

◆ EndQuasiModal()

◆ ExcludeFromControlUndoRedo()

◆ finishDialogSettings()

◆ flushPendingControlChanges()

◆ focusParentCanvas()

◆ forceInitialFocus()

◆ generateKey()

◆ getControlValue()

◆ GetType()

◆ GetUserUnits()

◆ HasKiway()

◆ horizPixelsFromDU()

◆ IsCtrl()

◆ IsQuasiModal()

◆ IsShiftCtrl()

◆ Kiway()

◆ LoadControlState()

◆ m_splitterOnIdle()

◆ OnActivate()

◆ OnButton()

◆ OnCharHook()

◆ onChildSetFocus()

◆ OnClose()

◆ OnCloseWindow()

◆ onCommandEvent()

◆ onDataViewListChanged()

◆ onGridCellChanged()

◆ onInitDialog()

◆ OnModify()

◆ OnMove()

◆ OnOK()

◆ OnPaint()

◆ onPropertyGridChanged()

◆ OnSize()

◆ onSpinDoubleEvent()

◆ onSpinEvent()

◆ onStyledTextChanged()

◆ OnTreeItemMenu()

◆ OnTreeSelectionChanged()

◆ OptOut()

◆ PrepareForModalSubDialog()

◆ Prj()

◆ recordControlChange()

◆ registerUndoRedoHandlers()

◆ RegisterUnitBinder()

◆ Reload()