#include <properties_panel.h>

Inheritance diagram for PROPERTIES_PANEL:

Public Member Functions
	PROPERTIES_PANEL (wxWindow aParent, EDA_BASE_FRAME aFrame)

virtual	~PROPERTIES_PANEL ()

virtual void	UpdateData ()=0

virtual void	AfterCommit ()

wxPropertyGrid *	GetPropertyGrid ()

int	PropertiesCount () const

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

void	RecalculateSplitterPos ()

void	SetSplitterProportion (float aProportion)

float	SplitterProportion () const

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

virtual wxPGProperty *	createPGProperty (const PROPERTY_BASE *aProperty) const =0

virtual void	valueChanging (wxPropertyGridEvent &aEvent)

virtual void	valueChanged (wxPropertyGridEvent &aEvent)

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, PROPERTY_BASE *aProperty, wxVariant &aValue, bool &aWritable)
	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
std::vector< PROPERTY_BASE * >	m_displayed

wxPropertyGrid *	m_grid

EDA_BASE_FRAME *	m_frame

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)

Detailed Description

Definition at line 39 of file properties_panel.h.

Constructor & Destructor Documentation

◆ PROPERTIES_PANEL()

PROPERTIES_PANEL::PROPERTIES_PANEL	(	wxWindow *	aParent,
		EDA_BASE_FRAME *	aFrame
	)

Definition at line 43 of file properties_panel.cpp.

References _, KIUI::GetDockedPaneFont(), m_caption, m_frame, m_grid, PGM_BASE::m_PropertyGridInitialized, m_splitter_key_proportion, onCharHook(), OnLanguageChanged(), onShow(), Pgm(), RecalculateSplitterPos(), valueChanged(), valueChanging(), and wxPGGlobalVars.

◆ ~PROPERTIES_PANEL()

PROPERTIES_PANEL::~PROPERTIES_PANEL ( )

virtual

Definition at line 149 of file properties_panel.cpp.

References m_frame, and OnLanguageChanged().

Member Function Documentation

◆ AfterCommit()

virtual void PROPERTIES_PANEL::AfterCommit ( )

inlinevirtual

Reimplemented in SCH_PROPERTIES_PANEL, and PCB_PROPERTIES_PANEL.

Definition at line 48 of file properties_panel.h.

◆ createPGProperty()

virtual wxPGProperty * PROPERTIES_PANEL::createPGProperty ( const PROPERTY_BASE * aProperty ) const

protectedpure virtual

Implemented in SCH_PROPERTIES_PANEL, and PCB_PROPERTIES_PANEL.

Referenced by rebuildProperties().

◆ extractValueAndWritability()

bool PROPERTIES_PANEL::extractValueAndWritability	(	const SELECTION &	aSelection,
		PROPERTY_BASE *	aProperty,
		wxVariant &	aValue,
		bool &	aWritable
	)

protected

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