#include <pcb_properties_panel.h>

Inheritance diagram for PCB_PROPERTIES_PANEL:

Public Member Functions
	PCB_PROPERTIES_PANEL (wxWindow aParent, PCB_BASE_EDIT_FRAME aFrame)

virtual	~PCB_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

PROPERTY_BASE *	getPropertyFromEvent (const wxPropertyGridEvent &aEvent) const

void	valueChanging (wxPropertyGridEvent &aEvent) override

void	valueChanged (wxPropertyGridEvent &aEvent) override
	Regenerates caches storing layer and net names.

void	updateLists (const BOARD *aBoard)

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	onCharHook (wxKeyEvent &aEvent)

void	onShow (wxShowEvent &aEvent)

virtual void	OnLanguageChanged (wxCommandEvent &aEvent)

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

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.

Protected Attributes
PCB_BASE_EDIT_FRAME *	m_frame

PROPERTY_MANAGER &	m_propMgr

PG_UNIT_EDITOR *	m_unitEditorInstance

PG_CHECKBOX_EDITOR *	m_checkboxEditorInstance

PG_RATIO_EDITOR *	m_ratioEditorInstance

PG_NET_SELECTOR_EDITOR *	m_netSelectorEditorInstance

PG_FPID_EDITOR *	m_fpEditorInstance

PG_URL_EDITOR *	m_urlEditorInstance

wxPGChoices	m_nets

std::vector< PROPERTY_BASE * >	m_displayed

wxPropertyGrid *	m_grid

wxStaticText *	m_caption

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

Static Protected Attributes
static std::set< wxString >	m_currentFieldNames

Detailed Description

Definition at line 40 of file pcb_properties_panel.h.

Constructor & Destructor Documentation

◆ PCB_PROPERTIES_PANEL()

PCB_PROPERTIES_PANEL::PCB_PROPERTIES_PANEL	(	wxWindow *	aParent,
		PCB_BASE_EDIT_FRAME *	aFrame )

Definition at line 187 of file pcb_properties_panel.cpp.

References PG_FPID_EDITOR::BuildEditorName(), PG_UNIT_EDITOR::BuildEditorName(), PG_URL_EDITOR::BuildEditorName(), PG_CHECKBOX_EDITOR::EDITOR_NAME, PG_NET_SELECTOR_EDITOR::EDITOR_NAME, PG_RATIO_EDITOR::EDITOR_NAME, m_checkboxEditorInstance, m_fpEditorInstance, m_frame, m_netSelectorEditorInstance, m_propMgr, m_ratioEditorInstance, m_unitEditorInstance, m_urlEditorInstance, PROPERTIES_PANEL::PROPERTIES_PANEL(), and wxPGGlobalVars.

Referenced by getPropertyFromEvent().

◆ ~PCB_PROPERTIES_PANEL()

PCB_PROPERTIES_PANEL::~PCB_PROPERTIES_PANEL ( )

virtual

Definition at line 278 of file pcb_properties_panel.cpp.

References m_fpEditorInstance, m_unitEditorInstance, and m_urlEditorInstance.

Member Function Documentation

◆ AfterCommit()

void PCB_PROPERTIES_PANEL::AfterCommit ( )

overridevirtual

Reimplemented from PROPERTIES_PANEL.

Definition at line 330 of file pcb_properties_panel.cpp.

References getSelection(), and rebuildProperties().

Referenced by valueChanged().

◆ createPGProperty()

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

overrideprotectedvirtual

Implements PROPERTIES_PANEL.

Definition at line 372 of file pcb_properties_panel.cpp.

References PG_FPID_EDITOR::BuildEditorName(), PG_URL_EDITOR::BuildEditorName(), PROPERTY_BASE::Choices(), DATASHEET, FOOTPRINT, GetCanonicalFieldName(), PROPERTY_BASE::HasChoices(), m_frame, PROPERTY_BASE::Name(), PGPropertyFactory(), ToLAYER_ID(), TYPE_HASH, and PROPERTY_BASE::TypeHash().

◆ 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 412 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 * PCB_PROPERTIES_PANEL::getFrontItem ( )

protected

Get the front item of the current selection.

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

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

Definition at line 308 of file pcb_properties_panel.cpp.

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

Referenced by getPropertyFromEvent(), and valueChanging().

◆ getItemValue()

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

protectedinherited

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

Returns: true if conversion succeeded

Definition at line 381 of file properties_panel.cpp.

References INSPECTABLE::Get(), KIGFX::VIEW_ITEM::GetClass(), PROPERTY_BASE::HasChoices(), and PROPERTY_BASE::Name().

Referenced by extractValueAndWritability().

◆ getPropertyFromEvent()

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

protected

Definition at line 417 of file pcb_properties_panel.cpp.

References getFrontItem(), KIGFX::VIEW_ITEM::IsBOARD_ITEM(), m_propMgr, PCB_PROPERTIES_PANEL(), and TYPE_HASH.

Referenced by valueChanged(), and valueChanging().

◆ GetPropertyGrid()

wxPropertyGrid * PROPERTIES_PANEL::GetPropertyGrid ( )

inlineinherited

Definition at line 50 of file properties_panel.h.

References m_grid.

◆ getSelection()

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

protected

Get the current selection from the selection tool.

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

Parameters

aSelection	[out] reference to a SELECTION pointer that will be set to the selection
aFallbackSelection	[out] local SELECTION object for fallback footprint selection