#include <sch_properties_panel.h>

Inheritance diagram for SCH_PROPERTIES_PANEL:

Public Member Functions
	SCH_PROPERTIES_PANEL (wxWindow aParent, SCH_BASE_FRAME aFrame)

virtual	~SCH_PROPERTIES_PANEL ()

void	UpdateData () override

void	AfterCommit () override

wxPropertyGrid *	GetPropertyGrid ()

int	PropertiesCount () const

const std::vector< PROPERTY_BASE * > &	Properties () const

void	RecalculateSplitterPos ()

void	SetSplitterProportion (float aProportion)

float	SplitterProportion () const

Public Attributes
int	m_SuppressGridChangeEvents

Protected Member Functions
void	rebuildProperties (const SELECTION &aSelection) override
	Generates the property grid for a given selection of items.

wxPGProperty *	createPGProperty (const PROPERTY_BASE *aProperty) const override

bool	getItemValue (EDA_ITEM aItem, PROPERTY_BASE aProperty, wxVariant &aValue) override
	Utility to fetch a property value and convert to wxVariant Precondition: aItem is known to have property aProperty.

PROPERTY_BASE *	getPropertyFromEvent (const wxPropertyGridEvent &aEvent) const

void	valueChanging (wxPropertyGridEvent &aEvent) override

void	valueChanged (wxPropertyGridEvent &aEvent) override

bool	isKeyEditable (const wxPGProperty *aPGProp) const override

bool	isKeyNameInUse (const wxString &aName) const override

void	onKeyRenamed (const wxString &aOldName, const wxString &aNewName) override

bool	buildContextMenu (wxMenu &aMenu, wxPGProperty *aPGProp) override

void	onNewItemLeftBlank (const wxString &aKey) override

void	addBlankField ()

void	addBlankCustomProperty ()

void	removeField (const wxString &aName)

void	removeCustomProperty (const wxString &aName)

void	onContextMenu (wxCommandEvent &aEvent)

bool	handleSheetFilenameChange (SCH_EDIT_FRAME aFrame, SCH_SHEET aSheet, SCH_COMMIT &aChanges, const wxString &aNewFilename)

void	OnLanguageChanged (wxCommandEvent &aEvent) override

const SELECTION &	getSelection (SELECTION &aFallbackSelection)
	Get the current selection from the selection tool.

EDA_ITEM *	getFrontItem ()
	Get the front item of the current selection.

void	onEditPinMap ()
	Open the symbol properties dialog on its Pin Map page for the single selected symbol (issue #2282).

SCH_SYMBOL *	getSinglePinMappedSymbol ()

void	onCharHook (wxKeyEvent &aEvent)

void	onShow (wxShowEvent &aEvent)

virtual void	onLabelEditBegin (wxPropertyGridEvent &aEvent)

virtual void	onLabelEditEnding (wxPropertyGridEvent &aEvent)

void	onRightClick (wxPropertyGridEvent &aEvent)

void	beginLabelEdit (const wxString &aKey, bool aStartBlank=false)

void	settlePendingLabelEdit ()
	Synchronously ends any in-progress label edit; potentially canceling a newly added row.

bool	extractValueAndWritability (const SELECTION &aSelection, const wxString &aPropName, wxVariant &aValue, bool &aWritable, wxPGChoices &aChoices)
	Processes a selection and determines whether the given property should be available or not and what the common value should be for the items in the selection.

void	addCategoryButton (const wxString &aGroupKey, const wxString &aTooltip, BITMAPS aBitmap, std::function< void()> aAction, std::function< bool()> aEnableFunc=nullptr, bool aForceCategory=false)
	Registers an overlay button on a category caption row.

void	updateCategoryButtons ()
	Updates overlay button visibility/positions; called after rebuilds and on scroll.

void	hideCategoryButtons ()
	Hides all overlay buttons (used when no selection or a rebuild is deferred).

void	positionCategoryButtons ()
	Find the caption row for the given untranslated group name, if present.

wxPGProperty *	categoryForGroup (const wxString &aGroupKey) const

Protected Attributes
SCH_BASE_FRAME *	m_frame

PROPERTY_MANAGER &	m_propMgr

PG_UNIT_EDITOR *	m_unitEditorInstance

PG_CHECKBOX_EDITOR *	m_checkboxEditorInstance

PG_COLOR_EDITOR *	m_colorEditorInstance

PG_FPID_EDITOR *	m_fpEditorInstance

PG_URL_EDITOR *	m_urlEditorInstance

wxPGChoices	m_nets

wxStaticText *	m_caption

std::vector< PROPERTY_BASE * >	m_displayed

wxPropertyGrid *	m_grid

float	m_splitter_key_proportion
	Proportion of the grid column splitter that is used for the key column (0.0 - 1.0)

wxString	m_editingOriginalLabel

wxString	m_contextMenuPropertyName

std::vector< CATEGORY_BUTTON >	m_categoryButtons

bool	m_resolvingPendingKey = false
	True while settling a pending label edit synchronously (see settlePendingLabelEdit).

wxString	m_pendingNewKey
	Key of a freshly-added blank field/custom property awaiting a name from the user.

Static Protected Attributes
static bool	m_selContainsJunctions

static bool	m_selContainsWiresOrBuses

Detailed Description

Definition at line 42 of file sch_properties_panel.h.

Constructor & Destructor Documentation

◆ SCH_PROPERTIES_PANEL()

SCH_PROPERTIES_PANEL::SCH_PROPERTIES_PANEL	(	wxWindow *	aParent,
		SCH_BASE_FRAME *	aFrame )

Definition at line 59 of file sch_properties_panel.cpp.

References _, _HKI, addBlankCustomProperty(), addBlankField(), PROPERTIES_PANEL::addCategoryButton(), PG_FPID_EDITOR::BuildEditorName(), PG_UNIT_EDITOR::BuildEditorName(), PG_URL_EDITOR::BuildEditorName(), CTX_LINE, PG_CHECKBOX_EDITOR::EDITOR_NAME, PG_COLOR_EDITOR::EDITOR_NAME, EscapeString(), FRAME_SCH, LIB_SYMBOL::GetFPFilters(), LIB_SYMBOL::GetGraphicalPins(), SCH_SYMBOL::GetLibSymbolRef(), getSinglePinMappedSymbol(), ID_CTX_ADD_CUSTOM_PROPERTY, ID_CTX_ADD_FIELD, ID_CTX_REMOVE_CUSTOM_PROPERTY, ID_CTX_REMOVE_FIELD, m_checkboxEditorInstance, m_colorEditorInstance, m_fpEditorInstance, m_frame, m_propMgr, m_unitEditorInstance, m_urlEditorInstance, onContextMenu(), onEditPinMap(), pin, PROPERTIES_PANEL::PROPERTIES_PANEL(), SCH_SYMBOL_T, small_edit, small_plus, and wxPGGlobalVars.

Referenced by getPropertyFromEvent(), isKeyEditable(), and isKeyNameInUse().

◆ ~SCH_PROPERTIES_PANEL()

SCH_PROPERTIES_PANEL::~SCH_PROPERTIES_PANEL ( )

virtual

Definition at line 215 of file sch_properties_panel.cpp.

References m_fpEditorInstance, m_unitEditorInstance, and m_urlEditorInstance.

Member Function Documentation

◆ addBlankCustomProperty()

void SCH_PROPERTIES_PANEL::addBlankCustomProperty ( )

protected

Definition at line 789 of file sch_properties_panel.cpp.

References _, AfterCommit(), PROPERTIES_PANEL::beginLabelEdit(), dummy, SELECTION::Empty(), getSelection(), m_frame, PROPERTIES_PANEL::m_pendingNewKey, COMMIT::Modify(), name, NO_RECURSE, SCH_COMMIT::Push(), EDA_ITEM::SetCustomProperty(), and PROPERTIES_PANEL::settlePendingLabelEdit().

Referenced by onContextMenu(), and SCH_PROPERTIES_PANEL().

◆ addBlankField()

void SCH_PROPERTIES_PANEL::addBlankField ( )

protected

Definition at line 720 of file sch_properties_panel.cpp.

References _, SCH_SHEET::AddField(), SCH_SYMBOL::AddField(), AfterCommit(), PROPERTIES_PANEL::beginLabelEdit(), SELECTION::Empty(), SCH_SHEET::GetField(), SCH_SYMBOL::GetField(), getSelection(), GetUserFieldName(), m_frame, PROPERTIES_PANEL::m_pendingNewKey, COMMIT::Modify(), name, NO_RECURSE, SCH_COMMIT::Push(), SCH_SHEET_T, SCH_SYMBOL_T, PROPERTIES_PANEL::settlePendingLabelEdit(), EDA_TEXT::SetVisible(), EDA_ITEM::Type(), UNTRANSLATED, and USER.

Referenced by onContextMenu(), and SCH_PROPERTIES_PANEL().

◆ addCategoryButton()

void PROPERTIES_PANEL::addCategoryButton	(	const wxString &	aGroupKey,
		const wxString &	aTooltip,
		BITMAPS	aBitmap,
		std::function< void()>	aAction,
		std::function< bool()>	aEnableFunc = nullptr,
		bool	aForceCategory = false )

protectedinherited

Registers an overlay button on a category caption row.

The button is shown when its category row is on-screen and selection-appropriate (the optional enable predicate is consulted; it is re-evaluated on every rebuild).

TODO it would be nice to remove this hack by getting upstream wxWidgets to support customizing/subclassing the property group widgets

Parameters

aGroupKey	is the untranslated group name (e.g. _HKI( "Fields" )).
aTooltip	is the tooltip text (translated by the caller).
aBitmap	is the icon shown on the button.
aAction	is invoked when the button is clicked.
aEnableFunc	optionally controls visibility (evaluated on each rebuild).
aForceCategory	optionally forces the category caption row to be emitted during rebuilds (only when aEnableFunc, if set, returns true).

Definition at line 932 of file properties_panel.cpp.

References KiBitmapBundle(), m_categoryButtons, m_grid, and BITMAP_BUTTON::SetBitmap().

Referenced by PCB_PROPERTIES_PANEL::PCB_PROPERTIES_PANEL(), and SCH_PROPERTIES_PANEL::SCH_PROPERTIES_PANEL().

◆ AfterCommit()

void SCH_PROPERTIES_PANEL::AfterCommit ( )

overridevirtual

Reimplemented from PROPERTIES_PANEL.

Definition at line 263 of file sch_properties_panel.cpp.

References getSelection(), and rebuildProperties().

Referenced by addBlankCustomProperty(), addBlankField(), onEditPinMap(), onKeyRenamed(), removeCustomProperty(), removeField(), and valueChanged().

◆ beginLabelEdit()

void PROPERTIES_PANEL::beginLabelEdit	(	const wxString &	aKey,
		bool	aStartBlank = false )

protectedinherited

Definition at line 786 of file properties_panel.cpp.

References m_grid.

Referenced by PCB_PROPERTIES_PANEL::addBlankCustomProperty(), SCH_PROPERTIES_PANEL::addBlankCustomProperty(), PCB_PROPERTIES_PANEL::addBlankField(), and SCH_PROPERTIES_PANEL::addBlankField().

◆ buildContextMenu()

bool SCH_PROPERTIES_PANEL::buildContextMenu	(	wxMenu &	aMenu,
		wxPGProperty *	aPGProp )

overrideprotectedvirtual

Reimplemented from PROPERTIES_PANEL.

Definition at line 673 of file sch_properties_panel.cpp.

References _, _HKI, PROPERTY_BASE::Group(), ID_CTX_ADD_CUSTOM_PROPERTY, ID_CTX_ADD_FIELD, ID_CTX_REMOVE_CUSTOM_PROPERTY, ID_CTX_REMOVE_FIELD, and isKeyEditable().

◆ categoryForGroup()

wxPGProperty * PROPERTIES_PANEL::categoryForGroup ( const wxString & aGroupKey ) const

protectedinherited

Definition at line 962 of file properties_panel.cpp.

References m_grid.

Referenced by positionCategoryButtons().

◆ createPGProperty()

wxPGProperty * SCH_PROPERTIES_PANEL::createPGProperty ( const PROPERTY_BASE * aProperty ) const

overrideprotectedvirtual

Implements PROPERTIES_PANEL.

Definition at line 363 of file sch_properties_panel.cpp.

References PG_FPID_EDITOR::BuildEditorName(), PG_URL_EDITOR::BuildEditorName(), DATASHEET, FOOTPRINT, GetDefaultFieldName(), LAYER_SCHEMATIC_BACKGROUND, m_frame, PROPERTY_BASE::Name(), PGPropertyFactory(), and UNTRANSLATED.

◆ extractValueAndWritability()

bool PROPERTIES_PANEL::extractValueAndWritability	(	const SELECTION &	aSelection,
		const wxString &	aPropName,
		wxVariant &	aValue,
		bool &	aWritable,
		wxPGChoices &	aChoices )

protectedinherited

Processes a selection and determines whether the given property should be available or not and what the common value should be for the items in the selection.

Parameters

aSelection	is a set of EDA_ITEMs to process
aProperty	is the property to look up
aValue	will be filled with the value common to the selection, or null if different
aWritable	will be set to whether or not the property can be written for the selection

Returns: true if the property is available for all the items in the selection

Definition at line 557 of file properties_panel.cpp.

References PROPERTY_BASE::GetChoices(), getItemValue(), PROPERTY_MANAGER::GetProperty(), PROPERTY_MANAGER::Instance(), PROPERTY_MANAGER::IsAvailableFor(), PROPERTY_MANAGER::IsWriteableFor(), and TYPE_HASH.

Referenced by rebuildProperties().

◆ getFrontItem()

EDA_ITEM * SCH_PROPERTIES_PANEL::getFrontItem ( )

protected

Get the front item of the current selection.

If the selection is empty and we're in the symbol editor, returns the current symbol instead.

Returns: EDA_ITEM* pointer to the front item, or nullptr if no selection

Definition at line 244 of file sch_properties_panel.cpp.

References SELECTION::Empty(), SELECTION::Front(), and getSelection().

Referenced by getPropertyFromEvent(), isKeyEditable(), isKeyNameInUse(), onNewItemLeftBlank(), and valueChanging().

◆ getItemValue()

bool SCH_PROPERTIES_PANEL::getItemValue	(	EDA_ITEM *	aItem,
		PROPERTY_BASE *	aProperty,
		wxVariant &	aValue )

overrideprotectedvirtual

Utility to fetch a property value and convert to wxVariant Precondition: aItem is known to have property aProperty.

Returns: true if conversion succeeded

Reimplemented from PROPERTIES_PANEL.

Definition at line 941 of file sch_properties_panel.cpp.

References SCHEMATIC::CurrentSheet(), FRAME_SCH, SCHEMATIC::GetCurrentVariant(), PROPERTIES_PANEL::getItemValue(), SCH_ITEM::GetParentSymbol(), SCH_FIELD::GetText(), m_frame, PROPERTY_BASE::Name(), SCH_FIELD_T, SCH_ITEM::Schematic(), text, and EDA_ITEM::Type().

◆ getPropertyFromEvent()

PROPERTY_BASE * SCH_PROPERTIES_PANEL::getPropertyFromEvent ( const wxPropertyGridEvent & aEvent ) const

protected

Definition at line 382 of file sch_properties_panel.cpp.

References getFrontItem(), KIGFX::VIEW_ITEM::IsSCH_ITEM(), m_propMgr, and SCH_PROPERTIES_PANEL().

Referenced by valueChanged(), and valueChanging().

◆ GetPropertyGrid()

wxPropertyGrid * PROPERTIES_PANEL::GetPropertyGrid ( )

inlineinherited

Definition at line 59 of file properties_panel.h.

References m_grid.

◆ getSelection()

const SELECTION & SCH_PROPERTIES_PANEL::getSelection ( SELECTION & aFallbackSelection )

protected

Get the current selection from the selection tool.

If the selection is empty and we're in the symbol editor, returns the current symbol instead.

Parameters

aFallbackSelection [out] local SELECTION object for fallback symbol selection

Returns: const SELECTION& reference to the selection (either real selection or fallback)

Definition at line 223 of file sch_properties_panel.cpp.

References SELECTION::Add(), SELECTION::Clear(), FRAME_SCH_SYMBOL_EDITOR, SYMBOL_EDIT_FRAME::GetCurSymbol(), SCH_SELECTION_TOOL::GetSelection(), and m_frame.

Referenced by addBlankCustomProperty(), addBlankField(), AfterCommit(), getFrontItem(), getSinglePinMappedSymbol(), onKeyRenamed(), removeCustomProperty(), removeField(), UpdateData(), and valueChanged().

◆ getSinglePinMappedSymbol()

SCH_SYMBOL * SCH_PROPERTIES_PANEL::getSinglePinMappedSymbol ( )

protected

Returns: the single selected SCH_SYMBOL with an effective associated footprint, else nullptr.

Definition at line 317 of file sch_properties_panel.cpp.

References SELECTION::Front(), getSelection(), SCH_SYMBOL::HasEffectiveAssociatedFootprint(), SCH_SYMBOL_T, SELECTION::Size(), and EDA_ITEM::Type().

Referenced by onEditPinMap(), and SCH_PROPERTIES_PANEL().

◆ handleSheetFilenameChange()

bool SCH_PROPERTIES_PANEL::handleSheetFilenameChange	(	SCH_EDIT_FRAME *	aFrame,
		SCH_SHEET *	aSheet,
		SCH_COMMIT &	aChanges,
		const wxString &	aNewFilename )

protected

Definition at line 541 of file sch_properties_panel.cpp.

References _, SCH_EDIT_FRAME::ChangeSheetFile(), DisplayError(), EnsureFileExtension(), SCH_EDIT_FRAME::GetCurrentSheet(), SCH_SHEET::GetFileName(), IsFullFileNameValid(), FILEEXT::KiCadSchematicFileExtension, SCH_SHEET_PATH::LastScreen(), COMMIT::Modify(), NO_RECURSE, and SCH_SHEET::SetFileName().

Referenced by valueChanged().

◆ hideCategoryButtons()

void PROPERTIES_PANEL::hideCategoryButtons ( )

protectedinherited

Hides all overlay buttons (used when no selection or a rebuild is deferred).

Definition at line 982 of file properties_panel.cpp.

References m_categoryButtons.

Referenced by rebuildProperties().

◆ isKeyEditable()

bool SCH_PROPERTIES_PANEL::isKeyEditable ( const wxPGProperty * aPGProp ) const

overrideprotectedvirtual

Reimplemented from PROPERTIES_PANEL.

Definition at line 573 of file sch_properties_panel.cpp.

References _HKI, getFrontItem(), PROPERTY_BASE::Group(), SCH_FIELD::IsMandatory(), PROPERTY_BASE::Name(), SCH_PROPERTIES_PANEL(), SCH_SHEET_T, SCH_SYMBOL_T, and EDA_ITEM::Type().

Referenced by buildContextMenu().

◆ isKeyNameInUse()

bool SCH_PROPERTIES_PANEL::isKeyNameInUse ( const wxString & aName ) const

overrideprotectedvirtual

Reimplemented from PROPERTIES_PANEL.

Definition at line 603 of file sch_properties_panel.cpp.

References getFrontItem(), m_propMgr, and SCH_PROPERTIES_PANEL().

◆ onCharHook()

void PROPERTIES_PANEL::onCharHook ( wxKeyEvent & aEvent )

protectedinherited

Definition at line 808 of file properties_panel.cpp.

References m_grid.

Referenced by PROPERTIES_PANEL().

◆ onContextMenu()

void SCH_PROPERTIES_PANEL::onContextMenu ( wxCommandEvent & aEvent )

protected

Definition at line 707 of file sch_properties_panel.cpp.

References addBlankCustomProperty(), addBlankField(), ID_CTX_ADD_CUSTOM_PROPERTY, ID_CTX_ADD_FIELD, ID_CTX_REMOVE_CUSTOM_PROPERTY, ID_CTX_REMOVE_FIELD, PROPERTIES_PANEL::m_contextMenuPropertyName, removeCustomProperty(), and removeField().

Referenced by SCH_PROPERTIES_PANEL().

◆ onEditPinMap()

void SCH_PROPERTIES_PANEL::onEditPinMap ( )

protected

Open the symbol properties dialog on its Pin Map page for the single selected symbol (issue #2282).

Only enabled in the schematic editor.

Definition at line 331 of file sch_properties_panel.cpp.

References AfterCommit(), SCH_ACTIONS::clearVariantSymbol, FRAME_SCH, getSinglePinMappedSymbol(), TOOLS_HOLDER::GetToolManager(), m_frame, SCH_EDIT_FRAME::OnModify(), TOOL_MANAGER::RunAction(), DIALOG_SYMBOL_PROPERTIES::SelectPinMapPage(), SCH_ACTIONS::setVariantSymbol, DIALOG_SHIM::ShowQuasiModal(), SYMBOL_PROPS_EDIT_OK, SYMBOL_PROPS_WANT_CLEAR_VARIANT_SYMBOL, and SYMBOL_PROPS_WANT_SET_VARIANT_SYMBOL.

Referenced by SCH_PROPERTIES_PANEL().

◆ onKeyRenamed()

void SCH_PROPERTIES_PANEL::onKeyRenamed	(	const wxString &	aOldName,
		const wxString &	aNewName )

overrideprotectedvirtual

Reimplemented from PROPERTIES_PANEL.

Definition at line 614 of file sch_properties_panel.cpp.

References _, AfterCommit(), EDA_ITEM::GetCustomProperty(), SCH_SHEET::GetField(), SCH_SYMBOL::GetField(), getSelection(), SCH_FIELD::IsMandatory(), m_frame, COMMIT::Modify(), NO_RECURSE, SCH_COMMIT::Push(), EDA_ITEM::RemoveCustomProperty(), SCH_SHEET_T, SCH_SYMBOL_T, EDA_ITEM::SetCustomProperty(), SCH_FIELD::SetName(), and EDA_ITEM::Type().

◆ onLabelEditBegin()

void PROPERTIES_PANEL::onLabelEditBegin ( wxPropertyGridEvent & aEvent )

protectedvirtualinherited

Definition at line 637 of file properties_panel.cpp.

References isKeyEditable(), and m_editingOriginalLabel.

Referenced by PROPERTIES_PANEL().

◆ onLabelEditEnding()

void PROPERTIES_PANEL::onLabelEditEnding ( wxPropertyGridEvent & aEvent )

protectedvirtualinherited

Definition at line 652 of file properties_panel.cpp.

References isKeyEditable(), isKeyNameInUse(), m_editingOriginalLabel, m_grid, m_pendingNewKey, m_resolvingPendingKey, onKeyRenamed(), and onNewItemLeftBlank().

Referenced by PROPERTIES_PANEL().

◆ OnLanguageChanged()

void SCH_PROPERTIES_PANEL::OnLanguageChanged ( wxCommandEvent & aEvent )

overrideprotectedvirtual

Reimplemented from PROPERTIES_PANEL.

Definition at line 933 of file sch_properties_panel.cpp.

References PROPERTIES_PANEL::OnLanguageChanged().

◆ onNewItemLeftBlank()

void SCH_PROPERTIES_PANEL::onNewItemLeftBlank ( const wxString & aKey )

overrideprotectedvirtual

Reimplemented from PROPERTIES_PANEL.

Definition at line 917 of file sch_properties_panel.cpp.

References SCH_SHEET::GetField(), SCH_SYMBOL::GetField(), getFrontItem(), removeCustomProperty(), removeField(), SCH_SHEET_T, and SCH_SYMBOL_T.

◆ onRightClick()

void PROPERTIES_PANEL::onRightClick ( wxPropertyGridEvent & aEvent )

protectedinherited

Definition at line 734 of file properties_panel.cpp.

References buildContextMenu(), and m_contextMenuPropertyName.

Referenced by PROPERTIES_PANEL().

◆ onShow()

void PROPERTIES_PANEL::onShow ( wxShowEvent & aEvent )

protectedinherited

Definition at line 628 of file properties_panel.cpp.

References UpdateData().

Referenced by PROPERTIES_PANEL().

◆ positionCategoryButtons()

void PROPERTIES_PANEL::positionCategoryButtons ( )

protectedinherited

Find the caption row for the given untranslated group name, if present.

Definition at line 989 of file properties_panel.cpp.

References categoryForGroup(), m_categoryButtons, and m_grid.

Referenced by PROPERTIES_PANEL(), and updateCategoryButtons().

◆ Properties()

const std::vector< PROPERTY_BASE * > & PROPERTIES_PANEL::Properties ( ) const

inlineinherited

Definition at line 69 of file properties_panel.h.

References m_displayed.

◆ PropertiesCount()

int PROPERTIES_PANEL::PropertiesCount ( ) const

inlineinherited

Definition at line 64 of file properties_panel.h.

References m_displayed.

◆ rebuildProperties()

void SCH_PROPERTIES_PANEL::rebuildProperties ( const SELECTION & aSelection )

overrideprotectedvirtual

Generates the property grid for a given selection of items.

Parameters

aSelection is a set of items to show properties for.

Reimplemented from PROPERTIES_PANEL.

Definition at line 272 of file sch_properties_panel.cpp.

References _HKI, m_propMgr, m_selContainsJunctions, m_selContainsWiresOrBuses, PROPERTIES_PANEL::rebuildProperties(), and SCH_JUNCTION_T.

Referenced by AfterCommit(), and UpdateData().

◆ RecalculateSplitterPos()

void PROPERTIES_PANEL::RecalculateSplitterPos ( )

inherited

Definition at line 916 of file properties_panel.cpp.

References m_grid, and m_splitter_key_proportion.

Referenced by PROPERTIES_PANEL(), FOOTPRINT_WIZARD_PROPERTIES_PANEL::RebuildParameters(), rebuildProperties(), and SetSplitterProportion().

◆ removeCustomProperty()

void SCH_PROPERTIES_PANEL::removeCustomProperty ( const wxString & aName )

protected

Definition at line 892 of file sch_properties_panel.cpp.

References _, AfterCommit(), getSelection(), m_frame, COMMIT::Modify(), NO_RECURSE, SCH_COMMIT::Push(), and EDA_ITEM::RemoveCustomProperty().

Referenced by onContextMenu(), and onNewItemLeftBlank().

◆ removeField()

void SCH_PROPERTIES_PANEL::removeField ( const wxString & aName )

protected

Definition at line 843 of file sch_properties_panel.cpp.

References _, AfterCommit(), SCH_SYMBOL::GetField(), SCH_SHEET::GetFields(), getSelection(), SCH_FIELD::IsMandatory(), m_frame, COMMIT::Modify(), NO_RECURSE, SCH_COMMIT::Push(), SCH_SYMBOL::RemoveField(), SCH_SHEET_T, SCH_SYMBOL_T, and EDA_ITEM::Type().

Referenced by onContextMenu(), and onNewItemLeftBlank().

◆ SetSplitterProportion()

void PROPERTIES_PANEL::SetSplitterProportion ( float aProportion )

inherited

Definition at line 925 of file properties_panel.cpp.

References m_splitter_key_proportion, and RecalculateSplitterPos().

◆ settlePendingLabelEdit()

void PROPERTIES_PANEL::settlePendingLabelEdit ( )

protectedinherited

Synchronously ends any in-progress label edit; potentially canceling a newly added row.

Definition at line 761 of file properties_panel.cpp.

References isKeyNameInUse(), m_grid, m_pendingNewKey, m_resolvingPendingKey, onKeyRenamed(), and onNewItemLeftBlank().

Referenced by PCB_PROPERTIES_PANEL::addBlankCustomProperty(), SCH_PROPERTIES_PANEL::addBlankCustomProperty(), PCB_PROPERTIES_PANEL::addBlankField(), and SCH_PROPERTIES_PANEL::addBlankField().

◆ SplitterProportion()

float PROPERTIES_PANEL::SplitterProportion ( ) const

inlineinherited

Definition at line 77 of file properties_panel.h.

References m_splitter_key_proportion.

◆ updateCategoryButtons()

void PROPERTIES_PANEL::updateCategoryButtons ( )

protectedinherited

Updates overlay button visibility/positions; called after rebuilds and on scroll.

Definition at line 976 of file properties_panel.cpp.

References positionCategoryButtons().

Referenced by rebuildProperties().

◆ UpdateData()

void SCH_PROPERTIES_PANEL::UpdateData ( )

overridevirtual

Implements PROPERTIES_PANEL.

Definition at line 253 of file sch_properties_panel.cpp.

References getSelection(), and rebuildProperties().

Referenced by valueChanged().

◆ valueChanged()

void SCH_PROPERTIES_PANEL::valueChanged ( wxPropertyGridEvent & aEvent )

overrideprotectedvirtual

◆ valueChanging()

void SCH_PROPERTIES_PANEL::valueChanging ( wxPropertyGridEvent & aEvent )

overrideprotectedvirtual

Reimplemented from PROPERTIES_PANEL.

Definition at line 400 of file sch_properties_panel.cpp.

References getFrontItem(), getPropertyFromEvent(), m_frame, and PROPERTIES_PANEL::m_SuppressGridChangeEvents.

Member Data Documentation

◆ m_caption

wxStaticText* PROPERTIES_PANEL::m_caption

protectedinherited

Definition at line 164 of file properties_panel.h.

Referenced by FOOTPRINT_WIZARD_PROPERTIES_PANEL::FOOTPRINT_WIZARD_PROPERTIES_PANEL(), PROPERTIES_PANEL(), and rebuildProperties().

◆ m_categoryButtons

std::vector<CATEGORY_BUTTON> PROPERTIES_PANEL::m_categoryButtons

protectedinherited

Definition at line 193 of file properties_panel.h.

Referenced by addCategoryButton(), hideCategoryButtons(), positionCategoryButtons(), and rebuildProperties().

◆ m_checkboxEditorInstance

PG_CHECKBOX_EDITOR* SCH_PROPERTIES_PANEL::m_checkboxEditorInstance

protected

Definition at line 111 of file sch_properties_panel.h.

Referenced by SCH_PROPERTIES_PANEL().

◆ m_colorEditorInstance

PG_COLOR_EDITOR* SCH_PROPERTIES_PANEL::m_colorEditorInstance

protected

Definition at line 112 of file sch_properties_panel.h.

Referenced by SCH_PROPERTIES_PANEL().

◆ m_contextMenuPropertyName

wxString PROPERTIES_PANEL::m_contextMenuPropertyName

protectedinherited

Definition at line 179 of file properties_panel.h.

Referenced by PCB_PROPERTIES_PANEL::onContextMenu(), SCH_PROPERTIES_PANEL::onContextMenu(), and onRightClick().

◆ m_displayed

std::vector<PROPERTY_BASE*> PROPERTIES_PANEL::m_displayed

protectedinherited

Definition at line 170 of file properties_panel.h.

Referenced by OnLanguageChanged(), Properties(), PropertiesCount(), and rebuildProperties().

◆ m_editingOriginalLabel

wxString PROPERTIES_PANEL::m_editingOriginalLabel

protectedinherited

Definition at line 177 of file properties_panel.h.

Referenced by onLabelEditBegin(), and onLabelEditEnding().

◆ m_fpEditorInstance

PG_FPID_EDITOR* SCH_PROPERTIES_PANEL::m_fpEditorInstance

protected

Definition at line 113 of file sch_properties_panel.h.

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

◆ m_frame

SCH_BASE_FRAME* SCH_PROPERTIES_PANEL::m_frame

protected

Definition at line 108 of file sch_properties_panel.h.

Referenced by addBlankCustomProperty(), addBlankField(), createPGProperty(), getItemValue(), getSelection(), onEditPinMap(), onKeyRenamed(), removeCustomProperty(), removeField(), SCH_PROPERTIES_PANEL(), valueChanged(), and valueChanging().

◆ m_grid

wxPropertyGrid* PROPERTIES_PANEL::m_grid

protectedinherited

Definition at line 171 of file properties_panel.h.

Referenced by addCategoryButton(), PCB_PROPERTIES_PANEL::applyConfirmedScale(), beginLabelEdit(), categoryForGroup(), GetPropertyGrid(), onCharHook(), onLabelEditEnding(), OnLanguageChanged(), positionCategoryButtons(), PROPERTIES_PANEL(), FOOTPRINT_WIZARD_PROPERTIES_PANEL::RebuildParameters(), rebuildProperties(), RecalculateSplitterPos(), and settlePendingLabelEdit().

◆ m_nets

wxPGChoices SCH_PROPERTIES_PANEL::m_nets

protected

Definition at line 119 of file sch_properties_panel.h.

◆ m_pendingNewKey

wxString PROPERTIES_PANEL::m_pendingNewKey

protectedinherited

Key of a freshly-added blank field/custom property awaiting a name from the user.

Definition at line 199 of file properties_panel.h.

Referenced by PCB_PROPERTIES_PANEL::addBlankCustomProperty(), SCH_PROPERTIES_PANEL::addBlankCustomProperty(), PCB_PROPERTIES_PANEL::addBlankField(), SCH_PROPERTIES_PANEL::addBlankField(), onLabelEditEnding(), and settlePendingLabelEdit().

◆ m_propMgr

PROPERTY_MANAGER& SCH_PROPERTIES_PANEL::m_propMgr

protected

Definition at line 109 of file sch_properties_panel.h.

Referenced by getPropertyFromEvent(), isKeyNameInUse(), rebuildProperties(), SCH_PROPERTIES_PANEL(), and valueChanged().

◆ m_resolvingPendingKey

bool PROPERTIES_PANEL::m_resolvingPendingKey = false

protectedinherited

True while settling a pending label edit synchronously (see settlePendingLabelEdit).

Definition at line 196 of file properties_panel.h.

Referenced by onLabelEditEnding(), and settlePendingLabelEdit().

◆ m_selContainsJunctions

bool SCH_PROPERTIES_PANEL::m_selContainsJunctions

staticprotected

Definition at line 116 of file sch_properties_panel.h.

Referenced by rebuildProperties().

◆ m_selContainsWiresOrBuses

bool SCH_PROPERTIES_PANEL::m_selContainsWiresOrBuses

staticprotected

Definition at line 117 of file sch_properties_panel.h.

Referenced by rebuildProperties().

◆ m_splitter_key_proportion

float PROPERTIES_PANEL::m_splitter_key_proportion

protectedinherited

Proportion of the grid column splitter that is used for the key column (0.0 - 1.0)

Definition at line 175 of file properties_panel.h.

Referenced by PROPERTIES_PANEL(), RecalculateSplitterPos(), SetSplitterProportion(), and SplitterProportion().

◆ m_SuppressGridChangeEvents

int PROPERTIES_PANEL::m_SuppressGridChangeEvents

inherited

Definition at line 167 of file properties_panel.h.

Referenced by PROPERTIES_PANEL(), PCB_PROPERTIES_PANEL::valueChanged(), SCH_PROPERTIES_PANEL::valueChanged(), FOOTPRINT_WIZARD_PROPERTIES_PANEL::valueChanging(), PCB_PROPERTIES_PANEL::valueChanging(), and SCH_PROPERTIES_PANEL::valueChanging().

◆ m_unitEditorInstance

PG_UNIT_EDITOR* SCH_PROPERTIES_PANEL::m_unitEditorInstance

protected

Definition at line 110 of file sch_properties_panel.h.

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

◆ m_urlEditorInstance

PG_URL_EDITOR* SCH_PROPERTIES_PANEL::m_urlEditorInstance

protected

Definition at line 114 of file sch_properties_panel.h.

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

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

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SCH_PROPERTIES_PANEL()

◆ ~SCH_PROPERTIES_PANEL()

Member Function Documentation

◆ addBlankCustomProperty()

◆ addBlankField()

◆ addCategoryButton()

◆ AfterCommit()

◆ beginLabelEdit()

◆ buildContextMenu()

◆ categoryForGroup()

◆ createPGProperty()

◆ extractValueAndWritability()

◆ getFrontItem()

◆ getItemValue()

◆ getPropertyFromEvent()

◆ GetPropertyGrid()

◆ getSelection()

◆ getSinglePinMappedSymbol()

◆ handleSheetFilenameChange()

◆ hideCategoryButtons()

◆ isKeyEditable()

◆ isKeyNameInUse()

◆ onCharHook()

◆ onContextMenu()

◆ onEditPinMap()

◆ onKeyRenamed()

◆ onLabelEditBegin()

◆ onLabelEditEnding()

◆ OnLanguageChanged()

◆ onNewItemLeftBlank()

◆ onRightClick()

◆ onShow()

◆ positionCategoryButtons()

◆ Properties()

◆ PropertiesCount()

◆ rebuildProperties()

◆ RecalculateSplitterPos()

◆ removeCustomProperty()

◆ removeField()

◆ SetSplitterProportion()

◆ settlePendingLabelEdit()

◆ SplitterProportion()

◆ updateCategoryButtons()

◆ UpdateData()

◆ valueChanged()

◆ valueChanging()

Member Data Documentation

◆ m_caption

◆ m_categoryButtons

◆ m_checkboxEditorInstance

◆ m_colorEditorInstance

◆ m_contextMenuPropertyName

◆ m_displayed

◆ m_editingOriginalLabel

◆ m_fpEditorInstance

◆ m_frame

◆ m_grid

◆ m_nets

◆ m_pendingNewKey

◆ m_propMgr

◆ m_resolvingPendingKey

◆ m_selContainsJunctions

◆ m_selContainsWiresOrBuses

◆ m_splitter_key_proportion

◆ m_SuppressGridChangeEvents

◆ m_unitEditorInstance

◆ m_urlEditorInstance