#include <dialog_drc_rule_editor.h>

Inheritance diagram for DIALOG_DRC_RULE_EDITOR:

Public Types
enum	RULE_EDITOR_TREE_CONTEXT_OPT_ID { ID_NEWRULE = wxID_HIGHEST + 1 , ID_COPYRULE , ID_DELETERULE , ID_MOVEUP , ID_MOVEDOWN }
	Enumeration representing the available context menu options for the rule editor tree. More...

enum	HOLDER_TYPE { DIALOG , FRAME , PANEL }

Public Member Functions
	DIALOG_DRC_RULE_EDITOR (PCB_EDIT_FRAME aEditorFrame, wxWindow aParent)

	~DIALOG_DRC_RULE_EDITOR ()

bool	TransferDataToWindow () override

bool	TransferDataFromWindow () override

std::vector< RULE_TREE_NODE >	GetDefaultRuleTreeItems () override
	Pure virtual method to get the default rule tree items.

void	AddNewRule (RULE_TREE_ITEM_DATA *aRuleTreeItemData) override
	Adds a new rule to the rule tree, either as a child or under the parent, based on the node type (CONSTRAINT or not).

void	DuplicateRule (RULE_TREE_ITEM_DATA *aRuleTreeItemData) override
	Duplicates a rule from the source tree node and appends it as a new item under the same parent.

void	RuleTreeItemSelectionChanged (RULE_TREE_ITEM_DATA *aCurrentRuleTreeItemData) override
	Handles rule tree item selection changes, updating the content panel with appropriate editor or header panel.

void	UpdateRuleTypeTreeItemData (RULE_TREE_ITEM_DATA *aCurrentRuleTreeItemData) override
	Updates the rule tree item data by transferring data from the rule editor panel and updating the item text.

bool	isEnabled (RULE_TREE_ITEM_DATA *aRuleTreeItemData, RULE_EDITOR_TREE_CONTEXT_OPT aOption) override
	Verifies if a context menu option should be enabled based on the rule tree item type.

void	RemoveRule (int aNodeId) override
	Removes a rule from the rule tree after confirmation, deleting the item and associated data.

void	UpdateData ()

void	OnSave (wxCommandEvent &aEvent) override

void	OnCancel (wxCommandEvent &aEvent) override

wxTreeCtrl *	GetRuleTreeCtrl ()
	Gets the tree control used for displaying and managing rules.

void	SetModified ()
	Marks the dialog as modified, indicating unsaved changes.

void	ClearModified ()
	Clears the modified flag, typically after saving.

bool	IsModified () const
	Returns whether the dialog has unsaved changes.

void	InitRuleTreeItems (const std::vector< RULE_TREE_NODE > &aRuleTreeNodes)
	Initializes the rule tree by adding nodes, setting up the structure, and saving its state.

wxPanel *	GetContentPanel ()
	Retrieves the current content panel.

void	SetContentPanel (wxPanel *aContentPanel)
	Replaces the current content panel with a new one based on the selected constraint type.

void	RefreshContentScrollArea ()
	Recalculates the scrolled content area's virtual size based on the current content panel's best size, and updates the scrollbar accordingly.

void	AppendNewRuleTreeItem (const RULE_TREE_NODE &aRuleTreeNode, wxTreeItemId aParentTreeItemId)
	Adds a new rule tree item under the specified parent and updates the tree history.

RULE_TREE_ITEM_DATA *	GetCurrentlySelectedRuleTreeItemData ()
	Retrieves the currently selected rule tree item data.

wxTreeItemId	GetPreviouslySelectedRuleTreeItemId ()
	Retrieves the previously selected rule tree item ID.

void	UpdateRuleTreeItemText (wxTreeItemId aItemId, wxString aItemText)
	Updates the text of a specified rule tree item.

void	SetControlsEnabled (bool aEnable)
	Enables or disables controls within the rule editor dialog.

void	DeleteRuleTreeItem (wxTreeItemId aItemId, const int &aNodeId)
	Deletes a tree item and removes its corresponding node from history.

bool	Show (bool show) override

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

int	ShowModal () override

int	ShowQuasiModal ()

void	EndQuasiModal (int retCode)

bool	IsQuasiModal () const

void	PrepareForModalSubDialog ()

void	CleanupAfterModalSubDialog ()

bool	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	SaveControlState ()
	Save control values and geometry to the current project's local settings.

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

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

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 RULE_EDITOR_DIALOG_BASE *	GetDialog (wxWindow *aWindow)
	Static method to retrieve the rule editor dialog instance associated with a given window.

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

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

Protected Member Functions
BOARD_DESIGN_SETTINGS &	bds ()

void	finishInitialization ()

void	OnCharHook (wxKeyEvent &aEvt) 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	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	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
BOARD *	m_currentBoard

PCB_EDIT_FRAME *	m_frame

REPORTER *	m_reporter

DRC_TOOL *	m_drcTool

wxDataViewCtrl *	m_markerDataView

wxTreeCtrl *	m_ruleTreeCtrl

WX_INFOBAR *	m_infoBar

wxPanel *	m_contentPanel

wxScrolledWindow *	m_scrolledContentWin

wxSplitterWindow *	m_splitter

wxSearchCtrl *	m_filterSearch

wxTextCtrl *	m_filterText

wxBoxSizer *	m_buttonsSizer

wxBitmapButton *	m_addRuleButton

wxBitmapButton *	m_copyRuleButton

wxBitmapButton *	m_moveTreeItemUpButton

wxBitmapButton *	m_moveTreeItemDownButton

wxBitmapButton *	m_deleteRuleButton

wxButton *	m_saveRuleButton

wxButton *	m_cancelRuleButton

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

bool	m_handlingUndoRedo

bool	m_childReleased

Private Member Functions
std::vector< RULE_TREE_NODE >	buildElectricalRuleTreeNodes (int &aParentId)

std::vector< RULE_TREE_NODE >	buildManufacturabilityRuleTreeNodes (int &aParentId)

std::vector< RULE_TREE_NODE >	buildHighspeedDesignRuleTreeNodes (int &aParentId)

std::vector< RULE_TREE_NODE >	buildFootprintsRuleTreeNodes (int &aParentId)

void	LoadExistingRules ()

void	SaveRulesToFile ()

RULE_TREE_NODE	buildRuleTreeNode (RULE_TREE_ITEM_DATA *aRuleTreeItemData, const wxString &aBaseName=wxEmptyString)
	Creates a new rule tree node with a unique name and assigns the appropriate constraint data.

RULE_TREE_NODE	buildRuleTreeNodeData (const wxString &aName, const DRC_RULE_EDITOR_ITEM_TYPE &aNodeType, const std::optional< int > &aParentId=std::nullopt, const std::optional< DRC_RULE_EDITOR_CONSTRAINT_NAME > &aConstraintType=std::nullopt, const std::vector< RULE_TREE_NODE > &aChildNodes={}, const std::optional< int > &aId=std::nullopt)
	Creates a new rule tree node with the specified parameters, generating a new ID if not provided.

RULE_TREE_NODE	buildRuleNodeFromKicadDrc (const wxString &aName, const wxString &aCode, const std::optional< int > &aParentId=std::nullopt)
	Build a rule tree node from a constraint keyword loaded from a .kicad_drc file.

RULE_TREE_NODE *	getRuleTreeNodeInfo (const int &aNodeId)
	Retrieves the rule tree node for a given ID.

void	saveRule (int aNodeId)
	Saves the rule after validating the rule editor panel.

void	closeRuleEntryView (int aNodeId)
	Closes the rule entry view and re-enables controls.

int	highlightMatchingItems (int aNodeId)
	Highlights board items matching the current rule condition.

bool	validateRuleName (int aNodeId, wxString aRuleName)
	Validates if the rule name is unique for the given node ID.

bool	deleteTreeNodeData (const int &aNodeId)
	Deletes a rule tree node by its ID.

void	collectChildRuleNodes (int aParentId, std::vector< RULE_TREE_NODE * > &aResult)
	Collects all child rule nodes for a given parent node ID.

void	collectModifiedRules (std::vector< RULE_TREE_NODE * > &aResult)
	Collects all rule nodes that have unsaved changes (new or edited).

bool	validateAllRules (std::map< wxString, wxString > &aErrors)
	Validates all rules and returns any that have validation errors.

int	promptUnsavedChanges ()
	Shows a prompt for unsaved changes when closing with modifications.

void	selectRuleNode (int aNodeId)
	Selects a rule node in the tree by its ID.

bool	updateUI () override

void	AdvancePhase (const wxString &aMessage) override
	Use the next available virtual zone of the dialog progress bar and updates the message.

void	populateRuleTreeCtrl (const std::vector< RULE_TREE_NODE > &aRuleTreeNodes, const RULE_TREE_NODE &aRuleTreeNode, wxTreeItemId aParentTreeItemId)
	Populates the rule tree with nodes and their children.

void	onRuleTreeItemRightClick (wxTreeEvent &aEvent)
	Handles right-click on a rule tree item to create a context menu.

void	onRuleTreeItemSelectionChanged (wxTreeEvent &aEvent)
	Updates action buttons based on the selected tree item.

void	onRuleTreeItemActivated (wxTreeEvent &aEvent)
	Handles double-click activation of a tree item.

void	onNewRuleOptionClick (wxCommandEvent &aEvent)
	Creates a new rule when the "New Rule" option is clicked.

void	onDuplicateRuleOptionClick (wxCommandEvent &aEvent)
	Duplicates the selected rule when "Duplicate Rule" is clicked.

void	onDeleteRuleOptionClick (wxCommandEvent &aEvent)
	Deletes the selected rule when "Delete Rule" is clicked.

void	onMoveUpRuleOptionClick (wxCommandEvent &aEvent)
	Moves a rule item up in the tree when "Move Up" is clicked.

void	onMoveDownRuleOptionClick (wxCommandEvent &aEvent)
	Moves a rule item down in the tree when "Move Down" is clicked.

void	onRuleTreeItemLeftDown (wxMouseEvent &aEvent)
	Initiates drag operation for a tree item on mouse down.

void	onRuleTreeItemMouseMotion (wxMouseEvent &aEvent)
	Handles drag motion to move the item along with the cursor.

void	onRuleTreeItemLeftUp (wxMouseEvent &aEvent)
	Completes the drag operation on mouse release.

void	onFilterSearch (wxCommandEvent &aEvent)
	Applies filter to the rule tree based on the search string.

bool	filterRuleTree (const wxTreeItemId &aItem, const wxString &aFilter)
	Recursively filters tree items to show only those matching the filter.

void	saveRuleTreeState (const wxTreeItemId &aItem, const int &aNodeId=0)
	Saves the state of a tree item to history.

void	restoreRuleTree (const wxTreeItemId &aParent, const int &aNodeId)
	Restores a tree item from history and appends it under a parent.

wxTreeItemId	appendRuleTreeItem (const RULE_TREE_NODE &aRuleTreeNode, wxTreeItemId aParentTreeItemId)
	Appends a new rule item to the tree.

void	getRuleTreeChildNodes (const std::vector< RULE_TREE_NODE > &aNodes, int aParentId, std::vector< RULE_TREE_NODE > &aResult)
	Retrieves child nodes of a given parent node.

void	moveRuleTreeItemChildrensTooOnDrag (wxTreeItemId aSrcTreeItemId, wxTreeItemId aDestTreeItemId)
	Recursively moves all child nodes of a source item to a destination during drag.

void	updateRuleTreeItemMoveOptionState ()
	Updates the state of move options (up/down) for the selected item.

void	updateRuleTreeActionButtonsState (RULE_TREE_ITEM_DATA *aRuleTreeItemData)
	Updates the action buttons based on the current selection.

void	onResize (wxSizeEvent &event)

void	onClose (wxCloseEvent &aEvt)

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

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

void	SetNumPhases (int aNumPhases) override
	Set the number of phases.

void	AddPhases (int aNumPhases) override

virtual void	BeginPhase (int aPhase) override
	Initialize the aPhase virtual zone of the dialog progress bar.

virtual void	AdvancePhase () override
	Use the next available virtual zone of the dialog progress bar.

virtual void	Report (const wxString &aMessage) override
	Display aMessage in the progress bar dialog.

virtual void	SetCurrentProgress (double aProgress) override
	Set the progress value to aProgress (0..1).

void	SetMaxProgress (int aMaxProgress) override
	Fix the value that gives the 100 percent progress bar length (inside the current virtual zone).

void	AdvanceProgress () override
	Increment the progress bar length (inside the current virtual zone).

bool	KeepRefreshing (bool aWait=false) override
	Update the UI dialog.

void	SetTitle (const wxString &aTitle) override
	Change the title displayed on the window caption.

bool	IsCancelled () const override

int	CurrentProgress () const

Private Attributes
int	m_nodeId

std::vector< RULE_TREE_NODE >	m_ruleTreeNodeDatas

PANEL_DRC_RULE_EDITOR *	m_ruleEditorPanel

PANEL_DRC_GROUP_HEADER *	m_groupHeaderPanel

std::shared_ptr< RC_ITEMS_PROVIDER >	m_markersProvider

RC_TREE_MODEL *	m_markersTreeModel

int	m_severities

bool	m_isDragging

bool	m_enableMoveUp

bool	m_enableMoveDown

bool	m_enableAddRule

bool	m_enableDuplicateRule

bool	m_enableDeleteRule

bool	m_modified

int	m_defaultSashPosition

wxString	m_title

std::vector< RULE_TREE_NODE >	m_defaultTreeItems

RULE_TREE_ITEM_DATA *	m_selectedData

wxTreeItemId	m_previousId

wxTreeItemId	m_draggedItem

wxDragImage *	m_dragImage

std::unordered_map< int, std::tuple< wxString, std::vector< int >, wxTreeItemId > >	m_treeHistoryData

KIWAY *	m_kiway

HOLDER_TYPE	m_type

wxString	m_rptMessage

std::mutex	m_mutex

std::atomic_int	m_phase

std::atomic_int	m_numPhases

std::atomic_int	m_progress

std::atomic_int	m_maxProgress

std::atomic_bool	m_cancelled

std::atomic_bool	m_messageChanged

Detailed Description

Definition at line 48 of file dialog_drc_rule_editor.h.

Member Enumeration Documentation

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE

inherited

Enumerator
DIALOG
FRAME
PANEL

Definition at line 41 of file kiway_holder.h.

◆ RULE_EDITOR_TREE_CONTEXT_OPT_ID

enum RULE_EDITOR_DIALOG_BASE::RULE_EDITOR_TREE_CONTEXT_OPT_ID

inherited

Enumeration representing the available context menu options for the rule editor tree.

Enumerator
ID_NEWRULE
ID_COPYRULE
ID_DELETERULE
ID_MOVEUP
ID_MOVEDOWN

Definition at line 115 of file rule_editor_dialog_base.h.

Constructor & Destructor Documentation

◆ DIALOG_DRC_RULE_EDITOR()

DIALOG_DRC_RULE_EDITOR::DIALOG_DRC_RULE_EDITOR	(	PCB_EDIT_FRAME *	aEditorFrame,
		wxWindow *	aParent )

◆ ~DIALOG_DRC_RULE_EDITOR()

DIALOG_DRC_RULE_EDITOR::~DIALOG_DRC_RULE_EDITOR ( )

Definition at line 117 of file dialog_drc_rule_editor.cpp.

Member Function Documentation

◆ AddNewRule()

void DIALOG_DRC_RULE_EDITOR::AddNewRule ( RULE_TREE_ITEM_DATA * aRuleTreeItemData )

overridevirtual

Adds a new rule to the rule tree, either as a child or under the parent, based on the node type (CONSTRAINT or not).

Parameters

aRuleTreeItemData The data for the rule tree item to be added.

Implements RULE_EDITOR_DIALOG_BASE.

Definition at line 325 of file dialog_drc_rule_editor.cpp.

References RULE_EDITOR_DIALOG_BASE::AppendNewRuleTreeItem(), buildRuleTreeNode(), CONSTRAINT, RULE_TREE_ITEM_DATA::GetNodeId(), RULE_TREE_ITEM_DATA::GetParentTreeItemId(), getRuleTreeNodeInfo(), RULE_TREE_ITEM_DATA::GetTreeItemId(), RULE_TREE_NODE::m_nodeType, and RULE_EDITOR_DIALOG_BASE::SetModified().

◆ AddPhases()

void PROGRESS_REPORTER_BASE::AddPhases ( int aNumPhases )

overridevirtualinherited

Implements PROGRESS_REPORTER.

Definition at line 98 of file progress_reporter_base.cpp.

References m_numPhases.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ AdvancePhase() [1/2]

void DIALOG_DRC_RULE_EDITOR::AdvancePhase ( const wxString & aMessage )

overrideprivatevirtual

Use the next available virtual zone of the dialog progress bar and updates the message.

Reimplemented from PROGRESS_REPORTER_BASE.

Definition at line 1320 of file dialog_drc_rule_editor.cpp.

References PROGRESS_REPORTER_BASE::AdvancePhase(), and PROGRESS_REPORTER_BASE::SetCurrentProgress().

◆ AdvancePhase() [2/2]

void PROGRESS_REPORTER_BASE::AdvancePhase ( )

overridevirtualinherited

Use the next available virtual zone of the dialog progress bar.

Implements PROGRESS_REPORTER.

Reimplemented in BACKGROUND_JOB_REPORTER, DIALOG_PCM_PROGRESS, and JOBS_PROGRESS_REPORTER.

Definition at line 50 of file progress_reporter_base.cpp.

References m_phase, and m_progress.

Referenced by BACKGROUND_JOB_REPORTER::AdvancePhase(), DIALOG_DRC::AdvancePhase(), DIALOG_DRC_RULE_EDITOR::AdvancePhase(), DIALOG_ERC::AdvancePhase(), DIALOG_PCM_PROGRESS::AdvancePhase(), AdvancePhase(), and PCB_EDIT_FRAME::OpenProjectFiles().

◆ AdvanceProgress()

void PROGRESS_REPORTER_BASE::AdvanceProgress ( )

overridevirtualinherited

Increment the progress bar length (inside the current virtual zone).

Implements PROGRESS_REPORTER.

Definition at line 86 of file progress_reporter_base.cpp.

References m_progress.

◆ AppendNewRuleTreeItem()

void RULE_EDITOR_DIALOG_BASE::AppendNewRuleTreeItem	(	const RULE_TREE_NODE &	aRuleTreeNode,
		wxTreeItemId	aParentTreeItemId )

inherited

Adds a new rule tree item under the specified parent and updates the tree history.

Parameters

aRuleTreeNode	The node data to add.
aParentTreeItemId	The parent item's ID.

Definition at line 439 of file rule_editor_dialog_base.cpp.

References appendRuleTreeItem(), RULE_EDITOR_DATA_BASE::GetParentId(), RULE_TREE_NODE::m_nodeData, RULE_TREE_NODE::m_nodeId, RULE_TREE_NODE::m_nodeName, m_ruleTreeCtrl, and m_treeHistoryData.

Referenced by DIALOG_DRC_RULE_EDITOR::AddNewRule(), DIALOG_DRC_RULE_EDITOR::DuplicateRule(), and DIALOG_DRC_RULE_EDITOR::LoadExistingRules().

◆ appendRuleTreeItem()

wxTreeItemId RULE_EDITOR_DIALOG_BASE::appendRuleTreeItem	(	const RULE_TREE_NODE &	aRuleTreeNode,
		wxTreeItemId	aParentTreeItemId )

privateinherited

Appends a new rule item to the tree.

Parameters

aRuleTreeNode	The rule tree node for the new item.
aParentTreeItemId	Parent item ID.

Returns: The newly created tree item ID.

Definition at line 1057 of file rule_editor_dialog_base.cpp.

References RULE_TREE_NODE::m_nodeId, RULE_TREE_NODE::m_nodeName, and m_ruleTreeCtrl.

Referenced by AppendNewRuleTreeItem(), and populateRuleTreeCtrl().

◆ bds()

BOARD_DESIGN_SETTINGS & DIALOG_DRC_RULE_EDITOR::bds ( )

inlineprotected

Definition at line 261 of file dialog_drc_rule_editor.h.

References m_currentBoard.

◆ BeginPhase()

void PROGRESS_REPORTER_BASE::BeginPhase ( int aPhase )

overridevirtualinherited

Initialize the aPhase virtual zone of the dialog progress bar.

Implements PROGRESS_REPORTER.

Definition at line 43 of file progress_reporter_base.cpp.

References m_phase, and m_progress.

◆ buildElectricalRuleTreeNodes()

std::vector< RULE_TREE_NODE > DIALOG_DRC_RULE_EDITOR::buildElectricalRuleTreeNodes ( int & aParentId )

private

Definition at line 592 of file dialog_drc_rule_editor.cpp.

References buildRuleTreeNodeData(), CATEGORY, CONSTRAINT, COPPER_TO_EDGE_CLEARANCE, COPPER_TO_HOLE_CLEARANCE, COURTYARD_CLEARANCE, CREEPAGE_DISTANCE, HOLE_TO_HOLE_CLEARANCE, m_nodeId, MINIMUM_CLEARANCE, MINIMUM_CONNECTION_WIDTH, MINIMUM_THERMAL_RELIEF_SPOKE_COUNT, PHYSICAL_CLEARANCE, and result.

Referenced by GetDefaultRuleTreeItems().

◆ buildFootprintsRuleTreeNodes()

std::vector< RULE_TREE_NODE > DIALOG_DRC_RULE_EDITOR::buildFootprintsRuleTreeNodes ( int & aParentId )

private

Definition at line 736 of file dialog_drc_rule_editor.cpp.

References ALLOWED_ORIENTATION, buildRuleTreeNodeData(), CATEGORY, CONSTRAINT, m_nodeId, PERMITTED_LAYERS, result, and VIAS_UNDER_SMD.

Referenced by GetDefaultRuleTreeItems().

◆ buildHighspeedDesignRuleTreeNodes()

std::vector< RULE_TREE_NODE > DIALOG_DRC_RULE_EDITOR::buildHighspeedDesignRuleTreeNodes ( int & aParentId )

private

Definition at line 703 of file dialog_drc_rule_editor.cpp.

References ABSOLUTE_LENGTH, buildRuleTreeNodeData(), CATEGORY, CONSTRAINT, m_nodeId, MATCHED_LENGTH_DIFF_PAIR, MAXIMUM_VIA_COUNT, result, ROUTING_DIFF_PAIR, and ROUTING_WIDTH.

Referenced by GetDefaultRuleTreeItems().

◆ buildManufacturabilityRuleTreeNodes()

std::vector< RULE_TREE_NODE > DIALOG_DRC_RULE_EDITOR::buildManufacturabilityRuleTreeNodes ( int & aParentId )

private

◆ buildRuleNodeFromKicadDrc()

RULE_TREE_NODE DIALOG_DRC_RULE_EDITOR::buildRuleNodeFromKicadDrc	(	const wxString &	aName,
		const wxString &	aCode,
		const std::optional< int > &	aParentId = std::nullopt )

private

Build a rule tree node from a constraint keyword loaded from a .kicad_drc file.

Definition at line 1300 of file dialog_drc_rule_editor.cpp.

References buildRuleTreeNodeData(), CONSTRAINT, DRC_RULE_EDITOR_UTILS::ConstraintFromKicadDrc(), DRC_RULE_EDITOR_UTILS::GetConstraintTypeFromCode(), and RULE_TREE_NODE::m_nodeData.

◆ buildRuleTreeNode()

RULE_TREE_NODE DIALOG_DRC_RULE_EDITOR::buildRuleTreeNode	(	RULE_TREE_ITEM_DATA *	aRuleTreeItemData,
		const wxString &	aBaseName = wxEmptyString )

private

Creates a new rule tree node with a unique name and assigns the appropriate constraint data.

Parameters

aRuleTreeItemData	The rule tree item data for the node.
aBaseName	Optional base name for unique name generation. If empty, the parent constraint node name is used.

Returns: The newly created rule tree node.

Definition at line 810 of file dialog_drc_rule_editor.cpp.

References ABSOLUTE_LENGTH, ALLOWED_ORIENTATION, buildRuleTreeNodeData(), CONSTRAINT, DRC_RULE_EDITOR_UTILS::ConstraintToKicadDrc(), DRC_RULE_EDITOR_UTILS::CreateNumericConstraintData(), CUSTOM_RULE, RULE_EDITOR_DATA_BASE::GetId(), RULE_TREE_ITEM_DATA::GetNodeId(), RULE_TREE_ITEM_DATA::GetParentTreeItemId(), getRuleTreeNodeInfo(), DRC_RULE_EDITOR_UTILS::IsBoolInputType(), DRC_RULE_EDITOR_UTILS::IsNumericInputType(), RULE_TREE_NODE::m_nodeData, m_nodeId, RULE_TREE_NODE::m_nodeId, RULE_TREE_NODE::m_nodeName, RULE_TREE_NODE::m_nodeType, RULE_TREE_NODE::m_nodeTypeMap, RULE_EDITOR_DIALOG_BASE::m_ruleTreeCtrl, m_ruleTreeNodeDatas, MATCHED_LENGTH_DIFF_PAIR, MINIMUM_TEXT_HEIGHT_AND_THICKNESS, nodeExists(), PERMITTED_LAYERS, ROUTING_DIFF_PAIR, ROUTING_WIDTH, RULE, RULE_EDITOR_DATA_BASE::SetIsNew(), and VIA_STYLE.

Referenced by AddNewRule(), and DuplicateRule().

◆ buildRuleTreeNodeData()

RULE_TREE_NODE DIALOG_DRC_RULE_EDITOR::buildRuleTreeNodeData	(	const wxString &	aName,
		const DRC_RULE_EDITOR_ITEM_TYPE &	aNodeType,
		const std::optional< int > &	aParentId = std::nullopt,
		const std::optional< DRC_RULE_EDITOR_CONSTRAINT_NAME > &	aConstraintType = std::nullopt,
		const std::vector< RULE_TREE_NODE > &	aChildNodes = {},
		const std::optional< int > &	aId = std::nullopt )

private

Creates a new rule tree node with the specified parameters, generating a new ID if not provided.

Parameters

aName	The name of the node.
aNodeType	The type of the node (e.g., RULE, CONSTRAINT).
aParentId	The ID of the parent node, if any.
aConstraintType	The constraint type, if any.
aChildNodes	List of child nodes.
id	Optional ID for the node.

Returns: The newly created RULE_TREE_NODE.

Definition at line 1261 of file dialog_drc_rule_editor.cpp.

References m_nodeId, RULE_EDITOR_DATA_BASE::SetId(), and RULE_EDITOR_DATA_BASE::SetParentId().

Referenced by buildElectricalRuleTreeNodes(), buildFootprintsRuleTreeNodes(), buildHighspeedDesignRuleTreeNodes(), buildManufacturabilityRuleTreeNodes(), buildRuleNodeFromKicadDrc(), buildRuleTreeNode(), GetDefaultRuleTreeItems(), and LoadExistingRules().

◆ CleanupAfterModalSubDialog()

void DIALOG_SHIM::CleanupAfterModalSubDialog ( )

inherited

Definition at line 1406 of file dialog_shim.cpp.

References m_qmodal_parent_disabler.

◆ ClearModified()

void RULE_EDITOR_DIALOG_BASE::ClearModified ( )

inherited

Clears the modified flag, typically after saving.

Updates button states to reflect no unsaved changes.

Definition at line 503 of file rule_editor_dialog_base.cpp.

References _, m_cancelRuleButton, m_modified, m_ruleTreeCtrl, and m_saveRuleButton.

Referenced by DIALOG_DRC_RULE_EDITOR::OnCancel(), and DIALOG_DRC_RULE_EDITOR::saveRule().

◆ ClearModify()

void DIALOG_SHIM::ClearModify ( )

inherited

Definition at line 1314 of file dialog_shim.cpp.

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

◆ closeRuleEntryView()

void DIALOG_DRC_RULE_EDITOR::closeRuleEntryView ( int aNodeId )

private

Closes the rule entry view and re-enables controls.

Parameters

aNodeId The ID of the rule node being closed.

Definition at line 979 of file dialog_drc_rule_editor.cpp.

References RULE_EDITOR_DIALOG_BASE::SetControlsEnabled().

Referenced by RuleTreeItemSelectionChanged().

◆ collectChildRuleNodes()

void DIALOG_DRC_RULE_EDITOR::collectChildRuleNodes	(	int	aParentId,
		std::vector< RULE_TREE_NODE * > &	aResult )

private

Collects all child rule nodes for a given parent node ID.

Parameters

aParentId	The ID of the parent node.
aResult	The vector to store the child nodes.

Definition at line 1102 of file dialog_drc_rule_editor.cpp.

References collectChildRuleNodes(), RULE_EDITOR_DIALOG_BASE::getRuleTreeChildNodes(), getRuleTreeNodeInfo(), RULE_TREE_NODE::m_nodeId, RULE_TREE_NODE::m_nodeType, m_ruleTreeNodeDatas, and RULE.

Referenced by collectChildRuleNodes(), and RuleTreeItemSelectionChanged().

◆ collectModifiedRules()

void DIALOG_DRC_RULE_EDITOR::collectModifiedRules ( std::vector< RULE_TREE_NODE * > & aResult )

private

Collects all rule nodes that have unsaved changes (new or edited).

Parameters

aResult The vector to store the modified rule nodes.

Definition at line 1119 of file dialog_drc_rule_editor.cpp.

References m_ruleTreeNodeDatas, and RULE.

Referenced by OnCancel(), and promptUnsavedChanges().

◆ CurrentProgress()

int PROGRESS_REPORTER_BASE::CurrentProgress ( ) const

inherited

Definition at line 104 of file progress_reporter_base.cpp.

References m_maxProgress, m_numPhases, m_phase, and m_progress.

Referenced by GAUGE_PROGRESS_REPORTER::updateUI(), and WX_PROGRESS_REPORTER::updateUI().

◆ DECLARE_EVENT_TABLE()

DIALOG_SHIM::DECLARE_EVENT_TABLE ( )

privateinherited

◆ DeleteRuleTreeItem()

void RULE_EDITOR_DIALOG_BASE::DeleteRuleTreeItem	(	wxTreeItemId	aItemId,
		const int &	aNodeId )

inherited

Deletes a tree item and removes its corresponding node from history.

Parameters

aItemId	The tree item ID to delete.
aNodeId	The node ID to remove from history.

Definition at line 515 of file rule_editor_dialog_base.cpp.

References m_ruleTreeCtrl, and m_treeHistoryData.

Referenced by DIALOG_DRC_RULE_EDITOR::RemoveRule().

◆ deleteTreeNodeData()

bool DIALOG_DRC_RULE_EDITOR::deleteTreeNodeData ( const int & aNodeId )

private

Deletes a rule tree node by its ID.

Parameters

aNodeId The ID of the node to delete.

Returns: True if the node was found and deleted, false otherwise.

Definition at line 1084 of file dialog_drc_rule_editor.cpp.

References m_ruleTreeNodeDatas.

Referenced by RemoveRule().

◆ doRedo()

void DIALOG_SHIM::doRedo ( )

privateinherited

Definition at line 1271 of file dialog_shim.cpp.

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

Referenced by OnCharHook().

◆ doUndo()

void DIALOG_SHIM::doUndo ( )

privateinherited

Definition at line 1256 of file dialog_shim.cpp.

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

Referenced by OnCharHook().

◆ DuplicateRule()

void DIALOG_DRC_RULE_EDITOR::DuplicateRule ( RULE_TREE_ITEM_DATA * aRuleTreeItemData )

overridevirtual

Duplicates a rule from the source tree node and appends it as a new item under the same parent.

Parameters

aRuleTreeItemData The data of the rule to be duplicated.

Implements RULE_EDITOR_DIALOG_BASE.

Definition at line 344 of file dialog_drc_rule_editor.cpp.

References RULE_EDITOR_DIALOG_BASE::AppendNewRuleTreeItem(), buildRuleTreeNode(), RULE_EDITOR_DATA_BASE::CopyFrom(), RULE_TREE_ITEM_DATA::GetNodeId(), RULE_TREE_ITEM_DATA::GetParentTreeItemId(), getRuleTreeNodeInfo(), RULE_TREE_NODE::m_nodeData, and RULE_EDITOR_DIALOG_BASE::SetModified().

◆ Enable()

bool DIALOG_SHIM::Enable ( bool enable )

overrideinherited

Definition at line 512 of file dialog_shim.cpp.

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

◆ EndQuasiModal()

void DIALOG_SHIM::EndQuasiModal ( int retCode )

inherited

◆ filterRuleTree()

bool RULE_EDITOR_DIALOG_BASE::filterRuleTree	(	const wxTreeItemId &	aItem,
		const wxString &	aFilter )

privateinherited

Recursively filters tree items to show only those matching the filter.

Parameters

aItem	The tree item to check.
aFilter	The filter string.

Returns: True if the item matches the filter or has visible children.

Definition at line 963 of file rule_editor_dialog_base.cpp.

References filterRuleTree(), and m_ruleTreeCtrl.

Referenced by filterRuleTree(), and onFilterSearch().

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

◆ finishInitialization()

void RULE_EDITOR_DIALOG_BASE::finishInitialization ( )

protectedinherited

Definition at line 247 of file rule_editor_dialog_base.cpp.

References DIALOG_SHIM::finishDialogSettings(), and DIALOG_SHIM::m_initialSize.

Referenced by TransferDataToWindow().

◆ focusParentCanvas()

void DIALOG_SHIM::focusParentCanvas ( )

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.

Definition at line 339 of file dialog_shim.cpp.

References m_parentFrame.

Referenced by Show(), and ShowQuasiModal().

◆ generateKey()

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

privateinherited

Definition at line 519 of file dialog_shim.cpp.

References index, and makeKey().

Referenced by LoadControlState(), and SaveControlState().

◆ GetContentPanel()

wxPanel * RULE_EDITOR_DIALOG_BASE::GetContentPanel ( )

inlineinherited

Retrieves the current content panel.

Returns: A pointer to the current content panel.

Definition at line 229 of file rule_editor_dialog_base.h.

References m_contentPanel.

◆ getControlValue()

wxVariant DIALOG_SHIM::getControlValue ( wxWindow * aCtrl )

privateinherited

Definition at line 1073 of file dialog_shim.cpp.

References grid.

Referenced by recordControlChange(), and registerUndoRedoHandlers().

◆ GetCurrentlySelectedRuleTreeItemData()

RULE_TREE_ITEM_DATA * RULE_EDITOR_DIALOG_BASE::GetCurrentlySelectedRuleTreeItemData ( )

inlineinherited

Retrieves the currently selected rule tree item data.

Returns: A pointer to the currently selected rule tree item data.

Definition at line 258 of file rule_editor_dialog_base.h.

References m_selectedData.

Referenced by DIALOG_DRC_RULE_EDITOR::RemoveRule(), and DIALOG_DRC_RULE_EDITOR::saveRule().

◆ GetDefaultRuleTreeItems()

std::vector< RULE_TREE_NODE > DIALOG_DRC_RULE_EDITOR::GetDefaultRuleTreeItems ( )

overridevirtual

Pure virtual method to get the default rule tree items.

Must be implemented by derived classes.

Returns: A vector of default RULE_TREE_NODE items.

Implements RULE_EDITOR_DIALOG_BASE.

Definition at line 152 of file dialog_drc_rule_editor.cpp.

References buildElectricalRuleTreeNodes(), buildFootprintsRuleTreeNodes(), buildHighspeedDesignRuleTreeNodes(), buildManufacturabilityRuleTreeNodes(), buildRuleTreeNodeData(), CATEGORY, CONSTRAINT, CUSTOM_RULE, m_nodeId, result, and ROOT.

Referenced by DIALOG_DRC_RULE_EDITOR().

◆ GetDialog()

RULE_EDITOR_DIALOG_BASE * RULE_EDITOR_DIALOG_BASE::GetDialog ( wxWindow * aWindow )

staticinherited

Static method to retrieve the rule editor dialog instance associated with a given window.

Parameters

aWindow The window for which the dialog is being retrieved.

Returns: A pointer to the RULE_EDITOR_DIALOG_BASE instance, or nullptr if not found.

Definition at line 357 of file rule_editor_dialog_base.cpp.

References RULE_EDITOR_DIALOG_BASE().

◆ GetPreviouslySelectedRuleTreeItemId()

wxTreeItemId RULE_EDITOR_DIALOG_BASE::GetPreviouslySelectedRuleTreeItemId ( )

inlineinherited

Retrieves the previously selected rule tree item ID.

Returns: The ID of the previously selected rule tree item.

Definition at line 265 of file rule_editor_dialog_base.h.

References m_previousId.

◆ getRuleTreeChildNodes()

void RULE_EDITOR_DIALOG_BASE::getRuleTreeChildNodes	(	const std::vector< RULE_TREE_NODE > &	aNodes,
		int	aParentId,
		std::vector< RULE_TREE_NODE > &	aResult )

privateinherited

Retrieves child nodes of a given parent node.

Parameters

aNodes	List of all nodes.
aParentId	The parent node ID.
aResult	A vector to store child nodes.

Definition at line 1070 of file rule_editor_dialog_base.cpp.

Referenced by DIALOG_DRC_RULE_EDITOR::collectChildRuleNodes(), InitRuleTreeItems(), and populateRuleTreeCtrl().

◆ GetRuleTreeCtrl()

wxTreeCtrl * RULE_EDITOR_DIALOG_BASE::GetRuleTreeCtrl ( )

inlineinherited

Gets the tree control used for displaying and managing rules.

Returns: A pointer to the wxTreeCtrl instance.

Definition at line 129 of file rule_editor_dialog_base.h.

References m_ruleTreeCtrl.

◆ getRuleTreeNodeInfo()

RULE_TREE_NODE * DIALOG_DRC_RULE_EDITOR::getRuleTreeNodeInfo ( const int & aNodeId )

private

Retrieves the rule tree node for a given ID.

Returns a pointer to the node if found, or nullptr if not.

Parameters

aNodeId The node ID to search for.

Returns: A pointer to the node, or nullptr if not found.

Definition at line 936 of file dialog_drc_rule_editor.cpp.

References m_ruleTreeNodeDatas.

Referenced by AddNewRule(), buildRuleTreeNode(), collectChildRuleNodes(), DuplicateRule(), isEnabled(), RemoveRule(), RuleTreeItemSelectionChanged(), and UpdateRuleTypeTreeItemData().

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( ) const

inlineinherited

Definition at line 48 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 118 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_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 65 of file kiway_holder.h.

References m_kiway.

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

◆ highlightMatchingItems()

int DIALOG_DRC_RULE_EDITOR::highlightMatchingItems ( int aNodeId )

private

Highlights board items matching the current rule condition.

Parameters

aNodeId The ID of the rule node (currently unused).

Returns: The number of matching items, or -1 if the condition has a syntax error.

Definition at line 985 of file dialog_drc_rule_editor.cpp.

References ASSERTION_CONSTRAINT, DRC_RULE_CONDITION::Compile(), m_drcTool, m_frame, m_reporter, m_ruleEditorPanel, PCB_GENERATOR_T, PCB_GROUP_T, PCB_NETINFO_T, ACTIONS::selectionClear, ACTIONS::selectItems, and ACTIONS::zoomFitSelection.

Referenced by RuleTreeItemSelectionChanged().

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

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

◆ InitRuleTreeItems()

void RULE_EDITOR_DIALOG_BASE::InitRuleTreeItems ( const std::vector< RULE_TREE_NODE > & aRuleTreeNodes )

inherited

Initializes the rule tree by adding nodes, setting up the structure, and saving its state.

Parameters

aRuleTreeNodes A vector of rule tree nodes with their IDs, names, and child nodes.

Definition at line 372 of file rule_editor_dialog_base.cpp.

References getRuleTreeChildNodes(), m_defaultTreeItems, m_ruleTreeCtrl, m_treeHistoryData, populateRuleTreeCtrl(), and saveRuleTreeState().

Referenced by DIALOG_DRC_RULE_EDITOR::DIALOG_DRC_RULE_EDITOR().

◆ IsCancelled()

bool PROGRESS_REPORTER_BASE::IsCancelled ( ) const

inlineoverridevirtualinherited

Implements PROGRESS_REPORTER.

Definition at line 108 of file progress_reporter_base.h.

References m_cancelled.

◆ IsCtrl()

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

inlinestaticinherited

Definition at line 127 of file dialog_shim.h.

◆ isEnabled()

bool DIALOG_DRC_RULE_EDITOR::isEnabled	(	RULE_TREE_ITEM_DATA *	aRuleTreeItemData,
		RULE_EDITOR_TREE_CONTEXT_OPT	aOption )

overridevirtual

Verifies if a context menu option should be enabled based on the rule tree item type.

Parameters

aRuleTreeItemData	The data of the rule tree item.
aOption	The context menu option to verify.

Returns: true if the option should be enabled, false otherwise.

Implements RULE_EDITOR_DIALOG_BASE.

Definition at line 544 of file dialog_drc_rule_editor.cpp.

References ADD_RULE, CONSTRAINT, DELETE_RULE, DUPLICATE_RULE, RULE_TREE_ITEM_DATA::GetNodeId(), getRuleTreeNodeInfo(), RULE_TREE_NODE::m_nodeType, MOVE_DOWN, MOVE_UP, and RULE.

◆ IsModified()

bool RULE_EDITOR_DIALOG_BASE::IsModified ( ) const

inlineinherited

Returns whether the dialog has unsaved changes.

Definition at line 146 of file rule_editor_dialog_base.h.

References m_modified.

Referenced by DIALOG_DRC_RULE_EDITOR::OnCancel().

◆ IsQuasiModal()

bool DIALOG_SHIM::IsQuasiModal ( ) const

inlineinherited

Definition at line 93 of file dialog_shim.h.

References m_qmodal_showing.

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

◆ IsShiftCtrl()

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

inlinestaticinherited

Definition at line 133 of file dialog_shim.h.

◆ KeepRefreshing()

bool PROGRESS_REPORTER_BASE::KeepRefreshing ( bool aWait = false )

overridevirtualinherited

Update the UI dialog.

Warning: This should only be called from the main thread.

Returns: false if the user clicked Cancel.

Implements PROGRESS_REPORTER.

Definition at line 113 of file progress_reporter_base.cpp.

References m_cancelled, m_maxProgress, m_progress, and updateUI().

Referenced by SCH_EDIT_FRAME::importFile(), PCB_EDIT_FRAME::OpenProjectFiles(), and SCH_EDIT_FRAME::OpenProjectFiles().

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

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

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

Referenced by onInitDialog().

◆ LoadExistingRules()

void DIALOG_DRC_RULE_EDITOR::LoadExistingRules ( )

private

Definition at line 198 of file dialog_drc_rule_editor.cpp.

References RULE_EDITOR_DIALOG_BASE::AppendNewRuleTreeItem(), buildRuleTreeNodeData(), CONSTRAINT, RULE_EDITOR_DATA_BASE::GetId(), RULE_TREE_ITEM_DATA::GetNodeId(), DRC_RULE_LOADER::LoadFile(), m_frame, RULE_TREE_NODE::m_nodeData, RULE_EDITOR_DIALOG_BASE::m_ruleTreeCtrl, m_ruleTreeNodeDatas, res, and RULE.

Referenced by DIALOG_DRC_RULE_EDITOR().

◆ moveRuleTreeItemChildrensTooOnDrag()

void RULE_EDITOR_DIALOG_BASE::moveRuleTreeItemChildrensTooOnDrag	(	wxTreeItemId	aSrcTreeItemId,
		wxTreeItemId	aDestTreeItemId )

privateinherited

Recursively moves all child nodes of a source item to a destination during drag.

Parameters

aSrcTreeItemId	Source item ID.
aDestTreeItemId	Destination item ID.

Definition at line 1088 of file rule_editor_dialog_base.cpp.

References m_ruleTreeCtrl, moveRuleTreeItemChildrensTooOnDrag(), RULE_TREE_ITEM_DATA::SetParentTreeItemId(), and RULE_TREE_ITEM_DATA::SetTreeItemId().

Referenced by moveRuleTreeItemChildrensTooOnDrag(), onMoveDownRuleOptionClick(), onMoveUpRuleOptionClick(), and onRuleTreeItemLeftUp().

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

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

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

◆ OnCancel()

void DIALOG_DRC_RULE_EDITOR::OnCancel ( wxCommandEvent & aEvent )

overridevirtual

Implements RULE_EDITOR_DIALOG_BASE.

Definition at line 456 of file dialog_drc_rule_editor.cpp.

References _, RULE_EDITOR_DIALOG_BASE::ClearModified(), collectModifiedRules(), DisplayErrorMessage(), RULE_EDITOR_DIALOG_BASE::IsModified(), m_ruleEditorPanel, m_ruleTreeNodeDatas, promptUnsavedChanges(), result, SaveRulesToFile(), selectRuleNode(), and validateAllRules().

◆ OnCharHook()

void RULE_EDITOR_DIALOG_BASE::OnCharHook ( wxKeyEvent & aEvt )

overrideprotectedvirtualinherited

Reimplemented from DIALOG_SHIM.

Definition at line 344 of file rule_editor_dialog_base.cpp.

References DIALOG_SHIM::OnCharHook(), and OnSave().

◆ onChildSetFocus()

void DIALOG_SHIM::onChildSetFocus ( wxFocusEvent & aEvent )

privateinherited

Definition at line 1517 of file dialog_shim.cpp.

References m_beforeEditValues, and m_isClosing.

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

◆ onClose()

void RULE_EDITOR_DIALOG_BASE::onClose ( wxCloseEvent & aEvt )

privateinherited

Definition at line 1203 of file rule_editor_dialog_base.cpp.

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

◆ 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 1463 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 1013 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 1065 of file dialog_shim.cpp.

References m_handlingUndoRedo, and recordControlChange().

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

◆ onDeleteRuleOptionClick()

void RULE_EDITOR_DIALOG_BASE::onDeleteRuleOptionClick ( wxCommandEvent & aEvent )

privateinherited

Deletes the selected rule when "Delete Rule" is clicked.

Parameters

aEvent The command event triggered by the click.

Definition at line 655 of file rule_editor_dialog_base.cpp.

References m_selectedData, and RemoveRule().

Referenced by onRuleTreeItemRightClick(), RULE_EDITOR_DIALOG_BASE(), and ~RULE_EDITOR_DIALOG_BASE().

◆ onDuplicateRuleOptionClick()

void RULE_EDITOR_DIALOG_BASE::onDuplicateRuleOptionClick ( wxCommandEvent & aEvent )

privateinherited

Duplicates the selected rule when "Duplicate Rule" is clicked.

Parameters

aEvent The command event triggered by the click.

Definition at line 649 of file rule_editor_dialog_base.cpp.

References DuplicateRule(), and m_selectedData.

Referenced by onRuleTreeItemRightClick(), RULE_EDITOR_DIALOG_BASE(), and ~RULE_EDITOR_DIALOG_BASE().

◆ onFilterSearch()

void RULE_EDITOR_DIALOG_BASE::onFilterSearch ( wxCommandEvent & aEvent )

privateinherited

Applies filter to the rule tree based on the search string.

Parameters

aEvent The command event containing the filter string.

Definition at line 946 of file rule_editor_dialog_base.cpp.

References filterRuleTree(), m_defaultTreeItems, m_ruleTreeCtrl, and restoreRuleTree().

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

◆ onGridCellChanged()

void DIALOG_SHIM::onGridCellChanged ( wxGridEvent & aEvent )

privateinherited

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

References LoadControlState().

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

◆ OnModify()

void DIALOG_SHIM::OnModify ( )

inherited

Definition at line 1307 of file dialog_shim.cpp.

◆ OnMove()

void DIALOG_SHIM::OnMove ( wxMoveEvent & aEvent )

privateinherited

Definition at line 480 of file dialog_shim.cpp.

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

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

◆ onMoveDownRuleOptionClick()

void RULE_EDITOR_DIALOG_BASE::onMoveDownRuleOptionClick ( wxCommandEvent & aEvent )

privateinherited

Moves a rule item down in the tree when "Move Down" is clicked.

Parameters

aEvent The command event triggered by the click.

Definition at line 722 of file rule_editor_dialog_base.cpp.

References RULE_TREE_ITEM_DATA::GetNodeId(), m_enableMoveDown, m_ruleTreeCtrl, moveRuleTreeItemChildrensTooOnDrag(), next(), saveRuleTreeState(), and RULE_TREE_ITEM_DATA::SetTreeItemId().

Referenced by onRuleTreeItemRightClick(), RULE_EDITOR_DIALOG_BASE(), and ~RULE_EDITOR_DIALOG_BASE().

◆ onMoveUpRuleOptionClick()

void RULE_EDITOR_DIALOG_BASE::onMoveUpRuleOptionClick ( wxCommandEvent & aEvent )

privateinherited

Moves a rule item up in the tree when "Move Up" is clicked.

Parameters

aEvent The command event triggered by the click.

Definition at line 661 of file rule_editor_dialog_base.cpp.

References RULE_TREE_ITEM_DATA::GetNodeId(), m_enableMoveUp, m_ruleTreeCtrl, moveRuleTreeItemChildrensTooOnDrag(), saveRuleTreeState(), and RULE_TREE_ITEM_DATA::SetTreeItemId().

Referenced by onRuleTreeItemRightClick(), RULE_EDITOR_DIALOG_BASE(), and ~RULE_EDITOR_DIALOG_BASE().

◆ onNewRuleOptionClick()

void RULE_EDITOR_DIALOG_BASE::onNewRuleOptionClick ( wxCommandEvent & aEvent )

privateinherited

Creates a new rule when the "New Rule" option is clicked.

Parameters

aEvent The command event triggered by the click.

Definition at line 643 of file rule_editor_dialog_base.cpp.

References AddNewRule(), and m_selectedData.

Referenced by onRuleTreeItemRightClick(), RULE_EDITOR_DIALOG_BASE(), and ~RULE_EDITOR_DIALOG_BASE().

◆ OnPaint()

void DIALOG_SHIM::OnPaint ( wxPaintEvent & event )

inherited

Definition at line 1286 of file dialog_shim.cpp.

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

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

◆ onPropertyGridChanged()

void DIALOG_SHIM::onPropertyGridChanged ( wxPropertyGridEvent & aEvent )

privateinherited

Definition at line 1057 of file dialog_shim.cpp.

References m_handlingUndoRedo, and recordControlChange().

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

◆ onResize()

void RULE_EDITOR_DIALOG_BASE::onResize ( wxSizeEvent & event )

privateinherited

Definition at line 1195 of file rule_editor_dialog_base.cpp.

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

◆ onRuleTreeItemActivated()

void RULE_EDITOR_DIALOG_BASE::onRuleTreeItemActivated ( wxTreeEvent & aEvent )

privateinherited

Handles double-click activation of a tree item.

Creates a new rule of the activated type when appropriate.

Definition at line 630 of file rule_editor_dialog_base.cpp.

References ADD_RULE, AddNewRule(), isEnabled(), and m_ruleTreeCtrl.

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

◆ onRuleTreeItemLeftDown()

void RULE_EDITOR_DIALOG_BASE::onRuleTreeItemLeftDown ( wxMouseEvent & aEvent )

privateinherited

Initiates drag operation for a tree item on mouse down.

Parameters

aEvent The mouse down event.

Definition at line 775 of file rule_editor_dialog_base.cpp.

References m_draggedItem, m_dragImage, m_isDragging, m_ruleTreeCtrl, and text.

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

◆ onRuleTreeItemLeftUp()

void RULE_EDITOR_DIALOG_BASE::onRuleTreeItemLeftUp ( wxMouseEvent & aEvent )

privateinherited

Completes the drag operation on mouse release.

Parameters

aEvent The mouse release event.

Definition at line 839 of file rule_editor_dialog_base.cpp.

References RULE_TREE_ITEM_DATA::GetNodeId(), m_draggedItem, m_dragImage, m_isDragging, m_ruleTreeCtrl, moveRuleTreeItemChildrensTooOnDrag(), saveRuleTreeState(), and RULE_TREE_ITEM_DATA::SetTreeItemId().

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

◆ onRuleTreeItemMouseMotion()

void RULE_EDITOR_DIALOG_BASE::onRuleTreeItemMouseMotion ( wxMouseEvent & aEvent )

privateinherited

Handles drag motion to move the item along with the cursor.

Parameters

aEvent The mouse motion event during drag.

Definition at line 811 of file rule_editor_dialog_base.cpp.

References m_draggedItem, m_dragImage, m_isDragging, and m_ruleTreeCtrl.

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

◆ onRuleTreeItemRightClick()

void RULE_EDITOR_DIALOG_BASE::onRuleTreeItemRightClick ( wxTreeEvent & aEvent )

privateinherited

Handles right-click on a rule tree item to create a context menu.

Parameters

aEvent The right-click event.

Definition at line 540 of file rule_editor_dialog_base.cpp.

References _, KIUI::AddMenuItem(), copy, ID_COPYRULE, ID_DELETERULE, ID_MOVEDOWN, ID_MOVEUP, ID_NEWRULE, isEnabled(), KiBitmap(), m_enableAddRule, m_enableDeleteRule, m_enableMoveDown, m_enableMoveUp, m_ruleTreeCtrl, MOVE_DOWN, MOVE_UP, onDeleteRuleOptionClick(), onDuplicateRuleOptionClick(), onMoveDownRuleOptionClick(), onMoveUpRuleOptionClick(), onNewRuleOptionClick(), small_down, small_plus, small_trash, small_up, and updateRuleTreeActionButtonsState().

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

◆ onRuleTreeItemSelectionChanged()

void RULE_EDITOR_DIALOG_BASE::onRuleTreeItemSelectionChanged ( wxTreeEvent & aEvent )

privateinherited

Updates action buttons based on the selected tree item.

Parameters

aEvent The selection change event.

Definition at line 601 of file rule_editor_dialog_base.cpp.

References RULE_TREE_ITEM_DATA::GetNodeId(), m_previousId, m_ruleTreeCtrl, m_selectedData, RuleTreeItemSelectionChanged(), and updateRuleTreeActionButtonsState().

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

◆ OnSave()

void DIALOG_DRC_RULE_EDITOR::OnSave ( wxCommandEvent & aEvent )

overridevirtual

Implements RULE_EDITOR_DIALOG_BASE.

Definition at line 449 of file dialog_drc_rule_editor.cpp.

References m_ruleEditorPanel.

◆ OnSize()

void DIALOG_SHIM::OnSize ( wxSizeEvent & aEvent )

privateinherited

Definition at line 473 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 1031 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 1022 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 1040 of file dialog_shim.cpp.

References m_handlingUndoRedo, and recordControlChange().

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

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

References PROPERTY_HOLDER::SetProperty().

Referenced by DIALOG_FOOTPRINT_WIZARD_LIST::DIALOG_FOOTPRINT_WIZARD_LIST(), DIALOG_GLOBAL_DELETION::DIALOG_GLOBAL_DELETION(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), DIALOG_MIGRATE_BUSES::DIALOG_MIGRATE_BUSES(), DIALOG_SIM_FORMAT_VALUE::DIALOG_SIM_FORMAT_VALUE(), EDA_LIST_DIALOG::initDialog(), and SAVE_AS_DIALOG::SAVE_AS_DIALOG().

◆ populateRuleTreeCtrl()

void RULE_EDITOR_DIALOG_BASE::populateRuleTreeCtrl	(	const std::vector< RULE_TREE_NODE > &	aRuleTreeNodes,
		const RULE_TREE_NODE &	aRuleTreeNode,
		wxTreeItemId	aParentTreeItemId )

privateinherited

Populates the rule tree with nodes and their children.

Parameters

aRuleTreeNodes	All rule tree nodes.
aRuleTreeNode	Current node to add.
aParentTreeItemId	Parent item ID for the current node.

Definition at line 522 of file rule_editor_dialog_base.cpp.

References appendRuleTreeItem(), getRuleTreeChildNodes(), RULE_TREE_NODE::m_nodeId, m_ruleTreeCtrl, and populateRuleTreeCtrl().

Referenced by InitRuleTreeItems(), and populateRuleTreeCtrl().

◆ PrepareForModalSubDialog()

void DIALOG_SHIM::PrepareForModalSubDialog ( )

inherited

Definition at line 1399 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 36 of file kiway_holder.cpp.

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

◆ promptUnsavedChanges()

int DIALOG_DRC_RULE_EDITOR::promptUnsavedChanges ( )

private

Shows a prompt for unsaved changes when closing with modifications.

Returns: wxID_YES to save and close, wxID_NO to discard and close, wxID_CANCEL to abort close.

Definition at line 1198 of file dialog_drc_rule_editor.cpp.

References _, collectModifiedRules(), and result.

Referenced by OnCancel().

◆ recordControlChange()

void DIALOG_SHIM::recordControlChange ( wxWindow * aCtrl )

privateinherited

Definition at line 999 of file dialog_shim.cpp.

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

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

◆ RefreshContentScrollArea()

void RULE_EDITOR_DIALOG_BASE::RefreshContentScrollArea ( )

inherited

Recalculates the scrolled content area's virtual size based on the current content panel's best size, and updates the scrollbar accordingly.

Definition at line 421 of file rule_editor_dialog_base.cpp.

References m_contentPanel, and m_scrolledContentWin.

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

◆ registerUndoRedoHandlers()

void DIALOG_SHIM::registerUndoRedoHandlers ( wxWindowList & aChildren )

privateinherited

Definition at line 919 of file dialog_shim.cpp.

References getControlValue(), grid, m_currentValues, 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 839 of file dialog_shim.cpp.

References m_unitBinders.

◆ RemoveRule()

void DIALOG_DRC_RULE_EDITOR::RemoveRule ( int aNodeId )

overridevirtual

Removes a rule from the rule tree after confirmation, deleting the item and associated data.

Parameters

aNodeId The ID of the node to be removed.

Implements RULE_EDITOR_DIALOG_BASE.

Definition at line 564 of file dialog_drc_rule_editor.cpp.

References _, RULE_EDITOR_DIALOG_BASE::DeleteRuleTreeItem(), deleteTreeNodeData(), RULE_EDITOR_DIALOG_BASE::GetCurrentlySelectedRuleTreeItemData(), RULE_TREE_ITEM_DATA::GetNodeId(), getRuleTreeNodeInfo(), RULE_EDITOR_DATA_BASE::IsNew(), RULE_TREE_NODE::m_nodeData, RULE_EDITOR_DIALOG_BASE::m_ruleTreeCtrl, OKOrCancelDialog(), RULE_EDITOR_DIALOG_BASE::SetControlsEnabled(), and RULE_EDITOR_DIALOG_BASE::SetModified().

Referenced by RuleTreeItemSelectionChanged().

◆ Report()

void PROGRESS_REPORTER_BASE::Report ( const wxString & aMessage )

overridevirtualinherited

Display aMessage in the progress bar dialog.

Implements PROGRESS_REPORTER.

Reimplemented in BACKGROUND_JOB_REPORTER, DIALOG_ERC, and JOBS_PROGRESS_REPORTER.

Definition at line 64 of file progress_reporter_base.cpp.

References m_messageChanged, m_mutex, and m_rptMessage.

Referenced by AdvancePhase(), SCH_EDIT_FRAME::importFile(), and SCH_EDIT_FRAME::OpenProjectFiles().

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

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

Referenced by RULE_EDITOR_DIALOG_BASE::SetContentPanel().

◆ restoreRuleTree()

void RULE_EDITOR_DIALOG_BASE::restoreRuleTree	(	const wxTreeItemId &	aParent,
		const int &	aNodeId )

privateinherited

Restores a tree item from history and appends it under a parent.

Parameters

aParent	The parent item to append to.
aNodeId	The node ID to restore.

Definition at line 1021 of file rule_editor_dialog_base.cpp.

References m_ruleTreeCtrl, m_treeHistoryData, and restoreRuleTree().

Referenced by onFilterSearch(), and restoreRuleTree().

◆ RuleTreeItemSelectionChanged()

void DIALOG_DRC_RULE_EDITOR::RuleTreeItemSelectionChanged ( RULE_TREE_ITEM_DATA * aCurrentRuleTreeItemData )

overridevirtual

Handles rule tree item selection changes, updating the content panel with appropriate editor or header panel.

Parameters

aCurrentRuleTreeItemData The data of the currently selected rule tree item.

Implements RULE_EDITOR_DIALOG_BASE.

Definition at line 375 of file dialog_drc_rule_editor.cpp.

References closeRuleEntryView(), collectChildRuleNodes(), CONSTRAINT, RULE_TREE_ITEM_DATA::GetNodeId(), RULE_TREE_ITEM_DATA::GetParentTreeItemId(), getRuleTreeNodeInfo(), highlightMatchingItems(), m_frame, m_groupHeaderPanel, RULE_TREE_NODE::m_nodeData, RULE_TREE_NODE::m_nodeId, RULE_TREE_NODE::m_nodeName, RULE_TREE_NODE::m_nodeType, RULE_TREE_NODE::m_nodeTypeMap, m_ruleEditorPanel, RULE_EDITOR_DIALOG_BASE::m_ruleTreeCtrl, RULE_EDITOR_DIALOG_BASE::m_scrolledContentWin, RemoveRule(), ROOT, RULE, saveRule(), RULE_EDITOR_DIALOG_BASE::SetContentPanel(), and validateRuleName().

◆ SaveControlState()

void DIALOG_SHIM::SaveControlState ( )

inherited

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

Definition at line 561 of file dialog_shim.cpp.

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

Referenced by OnCloseWindow(), and Show().

◆ saveRule()

void DIALOG_DRC_RULE_EDITOR::saveRule ( int aNodeId )

private

Saves the rule after validating the rule editor panel.

Displays an error message if validation fails, otherwise updates the rule tree data.

Parameters

aNodeId The ID of the rule node to save.

Definition at line 953 of file dialog_drc_rule_editor.cpp.

References RULE_EDITOR_DIALOG_BASE::ClearModified(), DisplayErrorMessage(), RULE_EDITOR_DIALOG_BASE::GetCurrentlySelectedRuleTreeItemData(), m_ruleEditorPanel, RULE_EDITOR_DIALOG_BASE::m_ruleTreeCtrl, SaveRulesToFile(), RULE_EDITOR_DIALOG_BASE::SetControlsEnabled(), and UpdateRuleTypeTreeItemData().

Referenced by RuleTreeItemSelectionChanged().

◆ SaveRulesToFile()

void DIALOG_DRC_RULE_EDITOR::SaveRulesToFile ( )

private

◆ saveRuleTreeState()

void RULE_EDITOR_DIALOG_BASE::saveRuleTreeState	(	const wxTreeItemId &	aItem,
		const int &	aNodeId = 0 )

privateinherited

Saves the state of a tree item to history.

Parameters

aItem	The item to save.
aNodeId	The node ID (optional).

Definition at line 996 of file rule_editor_dialog_base.cpp.

References RULE_TREE_ITEM_DATA::GetNodeId(), m_ruleTreeCtrl, m_treeHistoryData, and saveRuleTreeState().

Referenced by InitRuleTreeItems(), onMoveDownRuleOptionClick(), onMoveUpRuleOptionClick(), onRuleTreeItemLeftUp(), and saveRuleTreeState().

◆ SelectAllInTextCtrls()

void DIALOG_SHIM::SelectAllInTextCtrls ( wxWindowList & children )

inherited

Definition at line 848 of file dialog_shim.cpp.

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

Referenced by OnPaint(), and SelectAllInTextCtrls().

◆ selectRuleNode()

void DIALOG_DRC_RULE_EDITOR::selectRuleNode ( int aNodeId )

private

Selects a rule node in the tree by its ID.

Parameters

aNodeId The ID of the node to select.

Definition at line 1225 of file dialog_drc_rule_editor.cpp.

References RULE_TREE_ITEM_DATA::GetNodeId(), and RULE_EDITOR_DIALOG_BASE::m_ruleTreeCtrl.

Referenced by OnCancel().

◆ SetContentPanel()

void RULE_EDITOR_DIALOG_BASE::SetContentPanel ( wxPanel * aContentPanel )

inherited

Replaces the current content panel with a new one based on the selected constraint type.

Parameters

aContentPanel The new content panel to replace the existing one.

Definition at line 401 of file rule_editor_dialog_base.cpp.

References m_contentPanel, m_scrolledContentWin, Refresh(), RefreshContentScrollArea(), DIALOG_SHIM::resetUndoRedoForNewContent(), and DIALOG_SHIM::unregisterUnitBinders().

Referenced by DIALOG_DRC_RULE_EDITOR::RuleTreeItemSelectionChanged().

◆ SetControlsEnabled()

void RULE_EDITOR_DIALOG_BASE::SetControlsEnabled ( bool aEnable )

inherited

Enables or disables controls within the rule editor dialog.

Parameters

aEnable true to enable the controls, false to disable them.

Definition at line 466 of file rule_editor_dialog_base.cpp.

References _, m_cancelRuleButton, m_filterSearch, m_modified, m_ruleTreeCtrl, m_selectedData, and updateRuleTreeActionButtonsState().

Referenced by DIALOG_DRC_RULE_EDITOR::closeRuleEntryView(), DIALOG_DRC_RULE_EDITOR::RemoveRule(), and DIALOG_DRC_RULE_EDITOR::saveRule().

◆ setControlValue()

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

privateinherited

Definition at line 1163 of file dialog_shim.cpp.

References grid.

Referenced by doRedo(), and doUndo().

◆ SetCurrentProgress()

void PROGRESS_REPORTER_BASE::SetCurrentProgress ( double aProgress )

overridevirtualinherited

Set the progress value to aProgress (0..1).

Implements PROGRESS_REPORTER.

Reimplemented in BACKGROUND_JOB_REPORTER, CONSOLE_PROGRESS_REPORTER, and CONSOLE_PROGRESS_REPORTER.

Definition at line 79 of file progress_reporter_base.cpp.

References m_maxProgress, and m_progress.

Referenced by DIALOG_DRC::AdvancePhase(), DIALOG_DRC_RULE_EDITOR::AdvancePhase(), DIALOG_ERC::AdvancePhase(), BACKGROUND_JOB_REPORTER::SetCurrentProgress(), and CONSOLE_PROGRESS_REPORTER::SetCurrentProgress().

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

References ignore_unused(), m_kiway, and name.

Referenced by DIALOG_SHIM::DIALOG_SHIM(), InvokePcbLibTableEditor(), and InvokeSchEditSymbolLibTable().

◆ SetMaxProgress()

void PROGRESS_REPORTER_BASE::SetMaxProgress ( int aMaxProgress )

overridevirtualinherited

Fix the value that gives the 100 percent progress bar length (inside the current virtual zone).

Implements PROGRESS_REPORTER.

Definition at line 73 of file progress_reporter_base.cpp.

References m_maxProgress.

◆ SetModified()

void RULE_EDITOR_DIALOG_BASE::SetModified ( )

inherited

Marks the dialog as modified, indicating unsaved changes.

Updates button states to reflect that changes can be discarded or saved.

Definition at line 491 of file rule_editor_dialog_base.cpp.

References _, m_cancelRuleButton, m_modified, m_ruleTreeCtrl, and m_saveRuleButton.

◆ SetNumPhases()

void PROGRESS_REPORTER_BASE::SetNumPhases ( int aNumPhases )

overridevirtualinherited

Set the number of phases.

Implements PROGRESS_REPORTER.

Definition at line 92 of file progress_reporter_base.cpp.

References m_numPhases.

Referenced by DIALOG_PCM_PROGRESS::OnCancelClicked(), and BACKGROUND_JOB_REPORTER::SetNumPhases().

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

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

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

◆ SetTitle()

void PROGRESS_REPORTER_BASE::SetTitle ( const wxString & aTitle )

inlineoverridevirtualinherited

Change the title displayed on the window caption.

Has meaning only for some reporters. Does nothing for others.

Warning: This should only be called from the main thread.

Implements PROGRESS_REPORTER.

Reimplemented in WX_PROGRESS_REPORTER.

Definition at line 106 of file progress_reporter_base.h.

◆ SetupStandardButtons()

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

inherited

Definition at line 1758 of file dialog_shim.cpp.

References recursiveDescent().

◆ Show()

bool RULE_EDITOR_DIALOG_BASE::Show ( bool show )

overrideinherited

Definition at line 264 of file rule_editor_dialog_base.cpp.

References minSize, and DIALOG_SHIM::Show().

◆ ShowModal()

int DIALOG_SHIM::ShowModal ( )

overrideinherited

Definition at line 1320 of file dialog_shim.cpp.

References KIPLATFORM::UI::ReparentModal().

Referenced by PANEL_SETUP_LAYERS::addUserDefinedLayer(), MULTICHANNEL_TOOL::AutogenerateRuleAreas(), GRID_CELL_COLOR_SELECTOR::BeginEdit(), SCH_INSPECTION_TOOL::CheckSymbol(), FOOTPRINT_EDITOR_CONTROL::CleanupGraphics(), GLOBAL_EDIT_TOOL::CleanupGraphics(), GLOBAL_EDIT_TOOL::CleanupTracksAndVias(), COMMON_CONTROL::ConfigurePaths(), DIALOG_PLOT::CreateDrillFile(), CONVERT_TOOL::CreateLines(), SYMBOL_EDIT_FRAME::CreateNewSymbol(), MICROWAVE_TOOL::createPolygonShape(), CONVERT_TOOL::CreatePolys(), ROUTER_TOOL::CustomTrackWidthDialog(), PANEL_DESIGN_BLOCK_CHOOSER::displayErrors(), DisplayHotkeyList(), CURSORS_GRID_TRICKS::doPopupSelection(), LIB_FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), MEASUREMENTS_GRID_TRICKS::doPopupSelection(), SIGNALS_GRID_TRICKS::doPopupSelection(), ROUTER_TOOL::DpDimensionsDialog(), DRAWING_TOOL::DrawBarcode(), SIMULATOR_FRAME::EditAnalysis(), DESIGN_BLOCK_PANE::EditDesignBlockProperties(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), 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(), 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(), SCH_DRAWING_TOOLS::ImportGraphics(), SYMBOL_EDITOR_DRAWING_TOOLS::ImportGraphics(), SYMBOL_EDIT_FRAME::ImportSymbol(), SCH_EDITOR_CONTROL::IncrementAnnotations(), PCB_EDIT_FRAME::InstallNetlistFrame(), POSITION_RELATIVE_TOOL::InteractiveOffset(), InvokeCopperZonesEditor(), InvokeDialogNetList(), InvokeEditDesignBlockLibTable(), InvokePcbLibTableEditor(), InvokeRuleAreaEditor(), InvokeSchEditSymbolLibTable(), PROJECT_SCH::LegacySchLibs(), GERBVIEW_FRAME::LoadGerberJobFile(), GERBVIEW_FRAME::LoadListOfGerberAndDrillFiles(), GERBVIEW_FRAME::LoadZipArchiveFile(), SCH_EDIT_FRAME::ModalAnnotate(), EDIT_TOOL::MoveExact(), PCB_POINT_EDITOR::movePoint(), SIMULATOR_CONTROL::NewAnalysisTab(), KICAD_MANAGER_CONTROL::NewFromRepository(), KICAD_MANAGER_CONTROL::NewProject(), PANEL_JOBSET::OnAddDestinationClick(), PANEL_SETUP_BOARD_STACKUP::onAddDielectricLayer(), DIALOG_LIB_SYMBOL_PROPERTIES::OnAddFootprintFilter(), DIALOG_EXPORT_NETLIST::OnAddGenerator(), PANEL_GRID_SETTINGS::OnAddGrid(), PCB_NET_INSPECTOR_PANEL::onAddGroup(), PANEL_JOBSET::OnAddJobClick(), PCB_NET_INSPECTOR_PANEL::onAddNet(), PANEL_REGULATOR::OnAddRegulator(), DIALOG_BOARD_SETUP::onAuxiliaryAction(), DIALOG_SCHEMATIC_SETUP::onAuxiliaryAction(), DIALOG_SYMBOL_FIELDS_TABLE::onBomFmtPresetChanged(), DIALOG_SYMBOL_FIELDS_TABLE::onBomPresetChanged(), PANEL_SETUP_BOARD_STACKUP::onColorSelected(), PANEL_REMOTE_SYMBOL::onConfigure(), DIALOG_DRC::OnDRCItemRClick(), DIALOG_LIB_SYMBOL_PROPERTIES::OnEditFootprintFilter(), PANEL_GRID_SETTINGS::onEditGrid(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), PCB_EDIT_FRAME::OnEditItemRequest(), PANEL_REGULATOR::OnEditRegulator(), DIALOG_LIB_SYMBOL_PROPERTIES::OnEditSpiceModel(), DIALOG_SYMBOL_PROPERTIES::OnEditSpiceModel(), DIALOG_ERC::OnERCItemRClick(), DIALOG_EXPORT_STEP::onExportButton(), PROJECT_TREE_PANE::onGitCommit(), PROJECT_TREE_PANE::onGitInitializeProject(), PROJECT_TREE_PANE::onGitSwitchBranch(), LIB_TREE::onHeaderContextMenu(), PROPERTIES_FRAME::onHelp(), PANEL_DESTINATION::OnLastStatusClick(), APPEARANCE_CONTROLS::onLayerPresetChanged(), APPEARANCE_CONTROLS_3D::onLayerPresetChanged(), KISTATUSBAR::onLoadWarningsIconClick(), PANEL_SCH_DATA_SOURCES::OnManageDataSources(), DIALOG_PCM::OnManageRepositoriesClicked(), PANEL_SETUP_BOARD_STACKUP::onMaterialChange(), PANEL_FP_LIB_TABLE::onMigrateLibraries(), PANEL_DESTINATION::OnProperties(), PANEL_SETUP_BOARD_STACKUP::onRemoveDielectricLayer(), PCB_NET_INSPECTOR_PANEL::onRenameSelectedNet(), PANEL_PCBNEW_ACTION_PLUGINS::OnShowErrorsButtonClick(), DIALOG_FOOTPRINT_WIZARD_LIST::onShowTrace(), APPEARANCE_CONTROLS::onViewportChanged(), APPEARANCE_CONTROLS_3D::onViewportChanged(), 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(), DRAWING_TOOL::PlaceTuningPattern(), SCH_EDITOR_CONTROL::Plot(), GERBVIEW_CONTROL::Print(), PCB_CONTROL::Print(), SCH_EDITOR_CONTROL::Print(), 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(), MULTICHANNEL_TOOL::repeatLayout(), DIALOG_IMPORT_CHOOSE_PROJECT::RunModal(), DIALOG_MAP_LAYERS::RunModal(), PCB_EDIT_FRAME::SaveBoardAsDesignBlock(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), 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(), SYMBOL_LIBRARY_ADAPTER::ShowConfigurationDialog(), PL_EDITOR_FRAME::ShowDesignInspector(), CVPCB_CONTROL::ShowEquFileTable(), BOARD_INSPECTION_TOOL::ShowFootprintLinks(), SYMBOL_EDITOR_CONTROL::ShowLibraryTable(), SIMULATOR_CONTROL::ShowNetlist(), KICAD_MANAGER_CONTROL::ShowPluginManager(), EDA_BASE_FRAME::ShowPreferences(), PCB_TUNING_PATTERN::ShowPropertiesDialog(), BOARD_REANNOTATE_TOOL::ShowReannotateDialog(), PCB_BASE_EDIT_FRAME::ShowReferenceImagePropertiesDialog(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), PCB_EDIT_FRAME::ShowTargetOptionsDialog(), EDIT_TOOL::SimplifyPolygons(), SCH_DRAWING_TOOLS::SingleClickPlace(), GLOBAL_EDIT_TOOL::SwapLayers(), DIALOG_IMPORT_GFX_SCH::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 1358 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(), DIALOG_SELECT_3DMODEL::Cfg3DPaths(), SCH_EDIT_TOOL::ChangeSymbols(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), SCH_DRAWING_TOOLS::createNewLabel(), SCH_DRAWING_TOOLS::createNewText(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), SCH_DRAWING_TOOLS::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::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(), InvokeNonCopperZonesEditor(), PANEL_FP_PROPERTIES_3D_MODEL::OnAdd3DModel(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), PCB_EDIT_FRAME::OnEditItemRequest(), 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().

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

Referenced by EndQuasiModal().

◆ TransferDataFromWindow()

bool DIALOG_DRC_RULE_EDITOR::TransferDataFromWindow ( )

override

Definition at line 141 of file dialog_drc_rule_editor.cpp.

References SaveRulesToFile(), and RULE_EDITOR_DIALOG_BASE::TransferDataFromWindow().

◆ TransferDataToWindow()

bool DIALOG_DRC_RULE_EDITOR::TransferDataToWindow ( )

override

Definition at line 122 of file dialog_drc_rule_editor.cpp.

References DIALOG_SHIM::m_initialSize, and RULE_EDITOR_DIALOG_BASE::TransferDataToWindow().

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

References m_unitBinders, and unregisterUnitBinders().

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

◆ UpdateData()

void DIALOG_DRC_RULE_EDITOR::UpdateData ( )

Definition at line 1327 of file dialog_drc_rule_editor.cpp.

References m_markersProvider, m_markersTreeModel, and m_severities.

◆ updateRuleTreeActionButtonsState()

void RULE_EDITOR_DIALOG_BASE::updateRuleTreeActionButtonsState ( RULE_TREE_ITEM_DATA * aRuleTreeItemData )

privateinherited

Updates the action buttons based on the current selection.

Definition at line 1157 of file rule_editor_dialog_base.cpp.

References ADD_RULE, DELETE_RULE, DUPLICATE_RULE, isEnabled(), m_addRuleButton, m_copyRuleButton, m_deleteRuleButton, m_enableAddRule, m_enableDeleteRule, m_enableDuplicateRule, m_enableMoveDown, m_enableMoveUp, m_moveTreeItemDownButton, m_moveTreeItemUpButton, m_ruleTreeCtrl, and updateRuleTreeItemMoveOptionState().

Referenced by onRuleTreeItemRightClick(), onRuleTreeItemSelectionChanged(), and SetControlsEnabled().

◆ updateRuleTreeItemMoveOptionState()

void RULE_EDITOR_DIALOG_BASE::updateRuleTreeItemMoveOptionState ( )

privateinherited

Updates the state of move options (up/down) for the selected item.

Definition at line 1114 of file rule_editor_dialog_base.cpp.

References isEnabled(), m_enableMoveDown, m_enableMoveUp, m_ruleTreeCtrl, MOVE_DOWN, MOVE_UP, and next().

Referenced by updateRuleTreeActionButtonsState().

◆ UpdateRuleTreeItemText()

void RULE_EDITOR_DIALOG_BASE::UpdateRuleTreeItemText	(	wxTreeItemId	aItemId,
		wxString	aItemText )

inherited

Updates the text of a specified rule tree item.

Parameters

aItemId	The ID of the tree item to update.
aItemText	The new text to set for the tree item.

Definition at line 460 of file rule_editor_dialog_base.cpp.

References m_ruleTreeCtrl.

Referenced by DIALOG_DRC_RULE_EDITOR::UpdateRuleTypeTreeItemData().

◆ UpdateRuleTypeTreeItemData()

void DIALOG_DRC_RULE_EDITOR::UpdateRuleTypeTreeItemData ( RULE_TREE_ITEM_DATA * aCurrentRuleTreeItemData )

overridevirtual

Updates the rule tree item data by transferring data from the rule editor panel and updating the item text.

Parameters

aRuleTreeItemData The data of the rule tree item to be updated.

Implements RULE_EDITOR_DIALOG_BASE.

Definition at line 521 of file dialog_drc_rule_editor.cpp.

References RULE_TREE_ITEM_DATA::GetNodeId(), RULE_EDITOR_DATA_BASE::GetRuleName(), getRuleTreeNodeInfo(), RULE_TREE_ITEM_DATA::GetTreeItemId(), RULE_TREE_NODE::m_nodeData, RULE_TREE_NODE::m_nodeName, RULE_TREE_NODE::m_nodeType, m_ruleEditorPanel, RULE, RULE_EDITOR_DATA_BASE::SetIsNew(), and RULE_EDITOR_DIALOG_BASE::UpdateRuleTreeItemText().

Referenced by saveRule().

◆ updateUI()

bool DIALOG_DRC_RULE_EDITOR::updateUI ( )

overrideprivatevirtual

Implements PROGRESS_REPORTER_BASE.

Definition at line 1314 of file dialog_drc_rule_editor.cpp.

References PROGRESS_REPORTER_BASE::m_cancelled.

◆ validateAllRules()

bool DIALOG_DRC_RULE_EDITOR::validateAllRules ( std::map< wxString, wxString > & aErrors )

private

Validates all rules and returns any that have validation errors.

Parameters

aErrors Output map of rule names to error messages.

Returns: True if all rules are valid, false if any have errors.

Definition at line 1140 of file dialog_drc_rule_editor.cpp.

References _, m_ruleTreeNodeDatas, result, and RULE.

Referenced by OnCancel().

◆ validateRuleName()

bool DIALOG_DRC_RULE_EDITOR::validateRuleName	(	int	aNodeId,
		wxString	aRuleName )

private

Validates if the rule name is unique for the given node ID.

Parameters

aNodeId	The ID of the node to exclude from the check.
aRuleName	The rule name to validate.

Returns: True if the rule name is unique, false otherwise.

Definition at line 1066 of file dialog_drc_rule_editor.cpp.

References m_ruleTreeNodeDatas.

Referenced by RuleTreeItemSelectionChanged().

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

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

Member Data Documentation

◆ m_addRuleButton

wxBitmapButton* RULE_EDITOR_DIALOG_BASE::m_addRuleButton

protectedinherited

Definition at line 477 of file rule_editor_dialog_base.h.

Referenced by RULE_EDITOR_DIALOG_BASE(), updateRuleTreeActionButtonsState(), and ~RULE_EDITOR_DIALOG_BASE().

◆ m_beforeEditValues

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

protectedinherited

Definition at line 311 of file dialog_shim.h.

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

◆ m_buttonsSizer

wxBoxSizer* RULE_EDITOR_DIALOG_BASE::m_buttonsSizer

protectedinherited

Definition at line 476 of file rule_editor_dialog_base.h.

◆ m_cancelled

std::atomic_bool PROGRESS_REPORTER_BASE::m_cancelled

protectedinherited

Definition at line 123 of file progress_reporter_base.h.

Referenced by BACKGROUND_JOB_REPORTER::Cancel(), IsCancelled(), KeepRefreshing(), DIALOG_DRC::OnCancelClick(), DIALOG_ERC::OnCancelClick(), DIALOG_PCM_PROGRESS::OnCancelClicked(), DIALOG_DRC::OnRunDRCClick(), DIALOG_ERC::OnRunERCClick(), PROGRESS_REPORTER_BASE(), BACKGROUND_JOB_REPORTER::updateUI(), DIALOG_DRC::updateUI(), DIALOG_DRC_RULE_EDITOR::updateUI(), and DIALOG_ERC::updateUI().

◆ m_cancelRuleButton

wxButton* RULE_EDITOR_DIALOG_BASE::m_cancelRuleButton

protectedinherited

Definition at line 483 of file rule_editor_dialog_base.h.

Referenced by ClearModified(), RULE_EDITOR_DIALOG_BASE(), SetControlsEnabled(), SetModified(), and ~RULE_EDITOR_DIALOG_BASE().

◆ m_childReleased

bool DIALOG_SHIM::m_childReleased

protectedinherited

Definition at line 325 of file dialog_shim.h.

Referenced by DIALOG_SHIM(), and OnMove().

◆ m_contentPanel

wxPanel* RULE_EDITOR_DIALOG_BASE::m_contentPanel

protectedinherited

Definition at line 471 of file rule_editor_dialog_base.h.

Referenced by GetContentPanel(), RefreshContentScrollArea(), RULE_EDITOR_DIALOG_BASE(), and SetContentPanel().

◆ m_copyRuleButton

wxBitmapButton* RULE_EDITOR_DIALOG_BASE::m_copyRuleButton

protectedinherited

Definition at line 478 of file rule_editor_dialog_base.h.

Referenced by RULE_EDITOR_DIALOG_BASE(), updateRuleTreeActionButtonsState(), and ~RULE_EDITOR_DIALOG_BASE().

◆ m_currentBoard

BOARD* DIALOG_DRC_RULE_EDITOR::m_currentBoard

protected

Definition at line 263 of file dialog_drc_rule_editor.h.

Referenced by bds(), DIALOG_DRC_RULE_EDITOR(), and SaveRulesToFile().

◆ m_currentValues

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

protectedinherited

Definition at line 323 of file dialog_shim.h.

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

◆ m_defaultSashPosition

int RULE_EDITOR_DIALOG_BASE::m_defaultSashPosition

privateinherited

Definition at line 493 of file rule_editor_dialog_base.h.

Referenced by RULE_EDITOR_DIALOG_BASE().

◆ m_defaultTreeItems

std::vector<RULE_TREE_NODE> RULE_EDITOR_DIALOG_BASE::m_defaultTreeItems

privateinherited

Definition at line 496 of file rule_editor_dialog_base.h.

Referenced by InitRuleTreeItems(), and onFilterSearch().

◆ m_deleteRuleButton

wxBitmapButton* RULE_EDITOR_DIALOG_BASE::m_deleteRuleButton

protectedinherited

Definition at line 481 of file rule_editor_dialog_base.h.

Referenced by RULE_EDITOR_DIALOG_BASE(), updateRuleTreeActionButtonsState(), and ~RULE_EDITOR_DIALOG_BASE().

◆ m_draggedItem

wxTreeItemId RULE_EDITOR_DIALOG_BASE::m_draggedItem

privateinherited

Definition at line 499 of file rule_editor_dialog_base.h.

Referenced by onRuleTreeItemLeftDown(), onRuleTreeItemLeftUp(), onRuleTreeItemMouseMotion(), and RULE_EDITOR_DIALOG_BASE().

◆ m_dragImage

wxDragImage* RULE_EDITOR_DIALOG_BASE::m_dragImage

privateinherited

Definition at line 500 of file rule_editor_dialog_base.h.

Referenced by onRuleTreeItemLeftDown(), onRuleTreeItemLeftUp(), onRuleTreeItemMouseMotion(), RULE_EDITOR_DIALOG_BASE(), and ~RULE_EDITOR_DIALOG_BASE().

◆ m_drcTool

DRC_TOOL* DIALOG_DRC_RULE_EDITOR::m_drcTool

protected

Definition at line 266 of file dialog_drc_rule_editor.h.

Referenced by highlightMatchingItems().

◆ m_enableAddRule

bool RULE_EDITOR_DIALOG_BASE::m_enableAddRule

privateinherited

Definition at line 489 of file rule_editor_dialog_base.h.

Referenced by onRuleTreeItemRightClick(), RULE_EDITOR_DIALOG_BASE(), and updateRuleTreeActionButtonsState().

◆ m_enableDeleteRule

bool RULE_EDITOR_DIALOG_BASE::m_enableDeleteRule

privateinherited

Definition at line 491 of file rule_editor_dialog_base.h.

Referenced by onRuleTreeItemRightClick(), RULE_EDITOR_DIALOG_BASE(), and updateRuleTreeActionButtonsState().

◆ m_enableDuplicateRule

bool RULE_EDITOR_DIALOG_BASE::m_enableDuplicateRule

privateinherited

Definition at line 490 of file rule_editor_dialog_base.h.

Referenced by RULE_EDITOR_DIALOG_BASE(), and updateRuleTreeActionButtonsState().

◆ m_enableMoveDown

bool RULE_EDITOR_DIALOG_BASE::m_enableMoveDown

privateinherited

Definition at line 488 of file rule_editor_dialog_base.h.

Referenced by onMoveDownRuleOptionClick(), onRuleTreeItemRightClick(), RULE_EDITOR_DIALOG_BASE(), updateRuleTreeActionButtonsState(), and updateRuleTreeItemMoveOptionState().

◆ m_enableMoveUp

bool RULE_EDITOR_DIALOG_BASE::m_enableMoveUp

privateinherited

Definition at line 487 of file rule_editor_dialog_base.h.

Referenced by onMoveUpRuleOptionClick(), onRuleTreeItemRightClick(), RULE_EDITOR_DIALOG_BASE(), updateRuleTreeActionButtonsState(), and updateRuleTreeItemMoveOptionState().

◆ m_filterSearch

wxSearchCtrl* RULE_EDITOR_DIALOG_BASE::m_filterSearch

protectedinherited

Definition at line 474 of file rule_editor_dialog_base.h.

Referenced by RULE_EDITOR_DIALOG_BASE(), SetControlsEnabled(), and ~RULE_EDITOR_DIALOG_BASE().

◆ m_filterText

wxTextCtrl* RULE_EDITOR_DIALOG_BASE::m_filterText

protectedinherited

Definition at line 475 of file rule_editor_dialog_base.h.

◆ m_firstPaintEvent

bool DIALOG_SHIM::m_firstPaintEvent

protectedinherited

Definition at line 292 of file dialog_shim.h.

Referenced by DIALOG_SHIM(), and OnPaint().

◆ m_frame

PCB_EDIT_FRAME* DIALOG_DRC_RULE_EDITOR::m_frame

protected

Definition at line 264 of file dialog_drc_rule_editor.h.

Referenced by DIALOG_DRC_RULE_EDITOR(), highlightMatchingItems(), LoadExistingRules(), RuleTreeItemSelectionChanged(), and SaveRulesToFile().

◆ m_groupHeaderPanel

PANEL_DRC_GROUP_HEADER* DIALOG_DRC_RULE_EDITOR::m_groupHeaderPanel

private

Definition at line 273 of file dialog_drc_rule_editor.h.

Referenced by RuleTreeItemSelectionChanged().

◆ m_handlingUndoRedo

bool DIALOG_SHIM::m_handlingUndoRedo

protectedinherited

Definition at line 324 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 283 of file dialog_shim.h.

Referenced by CONVERT_SETTINGS_DIALOG::CONVERT_SETTINGS_DIALOG(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), 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_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_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(), LoadControlState(), PAGED_DIALOG::PAGED_DIALOG(), resetSize(), SaveControlState(), 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_infoBar

WX_INFOBAR* RULE_EDITOR_DIALOG_BASE::m_infoBar

protectedinherited

Definition at line 470 of file rule_editor_dialog_base.h.

Referenced by DIALOG_DRC_RULE_EDITOR::DIALOG_DRC_RULE_EDITOR(), and RULE_EDITOR_DIALOG_BASE().

◆ m_initialFocusTarget

wxWindow* DIALOG_SHIM::m_initialFocusTarget

protectedinherited

Definition at line 293 of file dialog_shim.h.

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

◆ m_initialSize

wxSize DIALOG_SHIM::m_initialSize

protectedinherited

Definition at line 306 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 294 of file dialog_shim.h.

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

◆ m_isDragging

bool RULE_EDITOR_DIALOG_BASE::m_isDragging

privateinherited

Definition at line 486 of file rule_editor_dialog_base.h.

Referenced by onRuleTreeItemLeftDown(), onRuleTreeItemLeftUp(), onRuleTreeItemMouseMotion(), and RULE_EDITOR_DIALOG_BASE().

◆ m_kiway

KIWAY* KIWAY_HOLDER::m_kiway

privateinherited

Definition at line 86 of file kiway_holder.h.

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

◆ m_markerDataView

wxDataViewCtrl* DIALOG_DRC_RULE_EDITOR::m_markerDataView

protected

Definition at line 267 of file dialog_drc_rule_editor.h.

Referenced by DIALOG_DRC_RULE_EDITOR().

◆ m_markersProvider

std::shared_ptr<RC_ITEMS_PROVIDER> DIALOG_DRC_RULE_EDITOR::m_markersProvider

private

Definition at line 275 of file dialog_drc_rule_editor.h.

Referenced by DIALOG_DRC_RULE_EDITOR(), and UpdateData().

◆ m_markersTreeModel

RC_TREE_MODEL* DIALOG_DRC_RULE_EDITOR::m_markersTreeModel

private

Definition at line 276 of file dialog_drc_rule_editor.h.

Referenced by DIALOG_DRC_RULE_EDITOR(), and UpdateData().

◆ m_maxProgress

std::atomic_int PROGRESS_REPORTER_BASE::m_maxProgress

protectedinherited

Definition at line 122 of file progress_reporter_base.h.

Referenced by CurrentProgress(), KeepRefreshing(), DIALOG_PCM_PROGRESS::OnCloseClicked(), PROGRESS_REPORTER_BASE(), SetCurrentProgress(), SetMaxProgress(), CONSOLE_PROGRESS_REPORTER::updateUI(), and DIALOG_DRC::updateUI().

◆ m_messageChanged

std::atomic_bool PROGRESS_REPORTER_BASE::m_messageChanged

protectedinherited

Definition at line 129 of file progress_reporter_base.h.

Referenced by PROGRESS_REPORTER_BASE(), Report(), and WX_PROGRESS_REPORTER::updateUI().

◆ m_modified

bool RULE_EDITOR_DIALOG_BASE::m_modified

privateinherited

Definition at line 492 of file rule_editor_dialog_base.h.

Referenced by ClearModified(), IsModified(), RULE_EDITOR_DIALOG_BASE(), SetControlsEnabled(), and SetModified().

◆ m_moveTreeItemDownButton

wxBitmapButton* RULE_EDITOR_DIALOG_BASE::m_moveTreeItemDownButton

protectedinherited

Definition at line 480 of file rule_editor_dialog_base.h.

Referenced by RULE_EDITOR_DIALOG_BASE(), updateRuleTreeActionButtonsState(), and ~RULE_EDITOR_DIALOG_BASE().

◆ m_moveTreeItemUpButton

wxBitmapButton* RULE_EDITOR_DIALOG_BASE::m_moveTreeItemUpButton

protectedinherited

Definition at line 479 of file rule_editor_dialog_base.h.

Referenced by RULE_EDITOR_DIALOG_BASE(), updateRuleTreeActionButtonsState(), and ~RULE_EDITOR_DIALOG_BASE().

◆ m_mutex

std::mutex PROGRESS_REPORTER_BASE::m_mutex

mutableprotectedinherited

Definition at line 118 of file progress_reporter_base.h.

Referenced by DIALOG_PCM_PROGRESS::PCMReport(), Report(), DIALOG_PCM_PROGRESS::updateUI(), and WX_PROGRESS_REPORTER::updateUI().

◆ m_nodeId

int DIALOG_DRC_RULE_EDITOR::m_nodeId

private

Definition at line 270 of file dialog_drc_rule_editor.h.

Referenced by buildElectricalRuleTreeNodes(), buildFootprintsRuleTreeNodes(), buildHighspeedDesignRuleTreeNodes(), buildManufacturabilityRuleTreeNodes(), buildRuleTreeNode(), buildRuleTreeNodeData(), DIALOG_DRC_RULE_EDITOR(), and GetDefaultRuleTreeItems().

◆ m_numPhases

std::atomic_int PROGRESS_REPORTER_BASE::m_numPhases

protectedinherited

Definition at line 120 of file progress_reporter_base.h.

Referenced by AddPhases(), CurrentProgress(), PROGRESS_REPORTER_BASE(), BACKGROUND_JOB_REPORTER::SetNumPhases(), SetNumPhases(), and DIALOG_PCM_PROGRESS::updateUI().

◆ m_parentFrame

EDA_BASE_FRAME* DIALOG_SHIM::m_parentFrame

protectedinherited

Definition at line 301 of file dialog_shim.h.

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

◆ m_phase

std::atomic_int PROGRESS_REPORTER_BASE::m_phase

protectedinherited

Definition at line 119 of file progress_reporter_base.h.

Referenced by BACKGROUND_JOB_REPORTER::AdvancePhase(), AdvancePhase(), BeginPhase(), CurrentProgress(), PROGRESS_REPORTER_BASE(), and DIALOG_PCM_PROGRESS::updateUI().

◆ m_previousId

wxTreeItemId RULE_EDITOR_DIALOG_BASE::m_previousId

privateinherited

Definition at line 498 of file rule_editor_dialog_base.h.

Referenced by GetPreviouslySelectedRuleTreeItemId(), onRuleTreeItemSelectionChanged(), RULE_EDITOR_DIALOG_BASE(), and ~RULE_EDITOR_DIALOG_BASE().

◆ m_progress

std::atomic_int PROGRESS_REPORTER_BASE::m_progress

protectedinherited

Definition at line 121 of file progress_reporter_base.h.

Referenced by AdvancePhase(), AdvanceProgress(), BeginPhase(), CurrentProgress(), KeepRefreshing(), DIALOG_PCM_PROGRESS::OnCloseClicked(), PROGRESS_REPORTER_BASE(), SetCurrentProgress(), CONSOLE_PROGRESS_REPORTER::updateUI(), and DIALOG_DRC::updateUI().

◆ m_qmodal_loop

wxGUIEventLoop* DIALOG_SHIM::m_qmodal_loop

protectedinherited

Definition at line 296 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 299 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 298 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 322 of file dialog_shim.h.

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

◆ m_reporter

REPORTER* DIALOG_DRC_RULE_EDITOR::m_reporter

protected

Definition at line 265 of file dialog_drc_rule_editor.h.

Referenced by DIALOG_DRC_RULE_EDITOR(), and highlightMatchingItems().

◆ m_rptMessage

wxString PROGRESS_REPORTER_BASE::m_rptMessage

protectedinherited

Definition at line 116 of file progress_reporter_base.h.

Referenced by Report(), CONSOLE_PROGRESS_REPORTER::updateUI(), and WX_PROGRESS_REPORTER::updateUI().

◆ m_ruleEditorPanel

PANEL_DRC_RULE_EDITOR* DIALOG_DRC_RULE_EDITOR::m_ruleEditorPanel

private

Definition at line 272 of file dialog_drc_rule_editor.h.

Referenced by DIALOG_DRC_RULE_EDITOR(), highlightMatchingItems(), OnCancel(), OnSave(), RuleTreeItemSelectionChanged(), saveRule(), and UpdateRuleTypeTreeItemData().

◆ m_ruleTreeCtrl

wxTreeCtrl* RULE_EDITOR_DIALOG_BASE::m_ruleTreeCtrl

protectedinherited

Definition at line 469 of file rule_editor_dialog_base.h.

Referenced by AppendNewRuleTreeItem(), appendRuleTreeItem(), DIALOG_DRC_RULE_EDITOR::buildRuleTreeNode(), ClearModified(), DeleteRuleTreeItem(), DIALOG_DRC_RULE_EDITOR::DIALOG_DRC_RULE_EDITOR(), filterRuleTree(), GetRuleTreeCtrl(), InitRuleTreeItems(), DIALOG_DRC_RULE_EDITOR::LoadExistingRules(), moveRuleTreeItemChildrensTooOnDrag(), onFilterSearch(), onMoveDownRuleOptionClick(), onMoveUpRuleOptionClick(), onRuleTreeItemActivated(), onRuleTreeItemLeftDown(), onRuleTreeItemLeftUp(), onRuleTreeItemMouseMotion(), onRuleTreeItemRightClick(), onRuleTreeItemSelectionChanged(), populateRuleTreeCtrl(), DIALOG_DRC_RULE_EDITOR::RemoveRule(), restoreRuleTree(), RULE_EDITOR_DIALOG_BASE(), DIALOG_DRC_RULE_EDITOR::RuleTreeItemSelectionChanged(), DIALOG_DRC_RULE_EDITOR::saveRule(), saveRuleTreeState(), DIALOG_DRC_RULE_EDITOR::selectRuleNode(), SetControlsEnabled(), SetModified(), updateRuleTreeActionButtonsState(), updateRuleTreeItemMoveOptionState(), UpdateRuleTreeItemText(), and ~RULE_EDITOR_DIALOG_BASE().

◆ m_ruleTreeNodeDatas

std::vector<RULE_TREE_NODE> DIALOG_DRC_RULE_EDITOR::m_ruleTreeNodeDatas

private

Definition at line 271 of file dialog_drc_rule_editor.h.

Referenced by buildRuleTreeNode(), collectChildRuleNodes(), collectModifiedRules(), deleteTreeNodeData(), DIALOG_DRC_RULE_EDITOR(), getRuleTreeNodeInfo(), LoadExistingRules(), OnCancel(), SaveRulesToFile(), validateAllRules(), and validateRuleName().

◆ m_saveRuleButton

wxButton* RULE_EDITOR_DIALOG_BASE::m_saveRuleButton

protectedinherited

Definition at line 482 of file rule_editor_dialog_base.h.

Referenced by ClearModified(), RULE_EDITOR_DIALOG_BASE(), SetModified(), and ~RULE_EDITOR_DIALOG_BASE().

◆ m_scrolledContentWin

wxScrolledWindow* RULE_EDITOR_DIALOG_BASE::m_scrolledContentWin

protectedinherited

Definition at line 472 of file rule_editor_dialog_base.h.

Referenced by RefreshContentScrollArea(), RULE_EDITOR_DIALOG_BASE(), DIALOG_DRC_RULE_EDITOR::RuleTreeItemSelectionChanged(), and SetContentPanel().

◆ m_selectedData

RULE_TREE_ITEM_DATA* RULE_EDITOR_DIALOG_BASE::m_selectedData

privateinherited

Definition at line 497 of file rule_editor_dialog_base.h.

Referenced by GetCurrentlySelectedRuleTreeItemData(), onDeleteRuleOptionClick(), onDuplicateRuleOptionClick(), onNewRuleOptionClick(), onRuleTreeItemSelectionChanged(), RULE_EDITOR_DIALOG_BASE(), SetControlsEnabled(), and ~RULE_EDITOR_DIALOG_BASE().

◆ m_severities

int DIALOG_DRC_RULE_EDITOR::m_severities

private

Definition at line 277 of file dialog_drc_rule_editor.h.

Referenced by DIALOG_DRC_RULE_EDITOR(), and UpdateData().

◆ m_splitter

wxSplitterWindow* RULE_EDITOR_DIALOG_BASE::m_splitter

protectedinherited

Definition at line 473 of file rule_editor_dialog_base.h.

Referenced by RULE_EDITOR_DIALOG_BASE().

◆ m_tabOrder

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

protectedinherited

Definition at line 303 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_title

wxString RULE_EDITOR_DIALOG_BASE::m_title

privateinherited

Definition at line 495 of file rule_editor_dialog_base.h.

Referenced by RULE_EDITOR_DIALOG_BASE().

◆ m_treeHistoryData

std::unordered_map<int, std::tuple<wxString, std::vector<int>, wxTreeItemId> > RULE_EDITOR_DIALOG_BASE::m_treeHistoryData

privateinherited

Definition at line 502 of file rule_editor_dialog_base.h.

Referenced by AppendNewRuleTreeItem(), DeleteRuleTreeItem(), InitRuleTreeItems(), restoreRuleTree(), and saveRuleTreeState().

◆ m_type

HOLDER_TYPE KIWAY_HOLDER::m_type

privateinherited

Definition at line 87 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 321 of file dialog_shim.h.

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

◆ m_unitBinders

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

protectedinherited

Definition at line 312 of file dialog_shim.h.

Referenced by LoadControlState(), RegisterUnitBinder(), SaveControlState(), and unregisterUnitBinders().

◆ m_units

EDA_UNITS DIALOG_SHIM::m_units

protectedinherited

Definition at line 282 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_useCalculatedSize

bool DIALOG_SHIM::m_useCalculatedSize

protectedinherited

Definition at line 287 of file dialog_shim.h.

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

◆ m_userPositioned

bool DIALOG_SHIM::m_userPositioned

protectedinherited

Definition at line 307 of file dialog_shim.h.

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

◆ m_userResized

bool DIALOG_SHIM::m_userResized

protectedinherited

Definition at line 308 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

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ HOLDER_TYPE

◆ RULE_EDITOR_TREE_CONTEXT_OPT_ID

Constructor & Destructor Documentation

◆ DIALOG_DRC_RULE_EDITOR()

◆ ~DIALOG_DRC_RULE_EDITOR()

Member Function Documentation

◆ AddNewRule()

◆ AddPhases()

◆ AdvancePhase() [1/2]

◆ AdvancePhase() [2/2]

◆ AdvanceProgress()

◆ AppendNewRuleTreeItem()

◆ appendRuleTreeItem()

◆ bds()

◆ BeginPhase()

◆ buildElectricalRuleTreeNodes()

◆ buildFootprintsRuleTreeNodes()

◆ buildHighspeedDesignRuleTreeNodes()

◆ buildManufacturabilityRuleTreeNodes()

◆ buildRuleNodeFromKicadDrc()

◆ buildRuleTreeNode()

◆ buildRuleTreeNodeData()

◆ CleanupAfterModalSubDialog()

◆ ClearModified()

◆ ClearModify()

◆ closeRuleEntryView()

◆ collectChildRuleNodes()

◆ collectModifiedRules()

◆ CurrentProgress()

◆ DECLARE_EVENT_TABLE()

◆ DeleteRuleTreeItem()

◆ deleteTreeNodeData()

◆ doRedo()

◆ doUndo()

◆ DuplicateRule()

◆ Enable()

◆ EndQuasiModal()

◆ filterRuleTree()

◆ finishDialogSettings()

◆ finishInitialization()

◆ focusParentCanvas()

◆ generateKey()

◆ GetContentPanel()

◆ getControlValue()

◆ GetCurrentlySelectedRuleTreeItemData()

◆ GetDefaultRuleTreeItems()

◆ GetDialog()

◆ GetPreviouslySelectedRuleTreeItemId()

◆ getRuleTreeChildNodes()

◆ GetRuleTreeCtrl()

◆ getRuleTreeNodeInfo()

◆ GetType()

◆ GetUserUnits()

◆ HasKiway()

◆ highlightMatchingItems()

◆ horizPixelsFromDU()

◆ InitRuleTreeItems()

◆ IsCancelled()

◆ IsCtrl()

◆ isEnabled()

◆ IsModified()

◆ IsQuasiModal()

◆ IsShiftCtrl()

◆ KeepRefreshing()

◆ Kiway()

◆ LoadControlState()

◆ LoadExistingRules()

◆ moveRuleTreeItemChildrensTooOnDrag()

◆ OnButton()

◆ OnCancel()

◆ OnCharHook()