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

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

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, 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

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)

Detailed Description

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

References PG_UNIT_EDITOR::BuildEditorName(), PG_CHECKBOX_EDITOR::EDITOR_NAME, PG_RATIO_EDITOR::EDITOR_NAME, m_checkboxEditorInstance, m_frame, m_propMgr, m_ratioEditorInstance, m_unitEditorInstance, PROPERTY_MANAGER::Rebuild(), PG_UNIT_EDITOR::UpdateFrame(), and wxPGGlobalVars.

◆ ~PCB_PROPERTIES_PANEL()

PCB_PROPERTIES_PANEL::~PCB_PROPERTIES_PANEL ( )

virtual

Definition at line 98 of file pcb_properties_panel.cpp.

References m_unitEditorInstance, and PG_UNIT_EDITOR::UpdateFrame().

Member Function Documentation

◆ AfterCommit()

void PCB_PROPERTIES_PANEL::AfterCommit ( )

overridevirtual

Reimplemented from PROPERTIES_PANEL.

Definition at line 117 of file pcb_properties_panel.cpp.

References PCB_SELECTION_TOOL::GetSelection(), TOOL_MANAGER::GetTool(), TOOLS_HOLDER::GetToolManager(), m_frame, and PROPERTIES_PANEL::rebuildProperties().

Referenced by valueChanged().

◆ createPGProperty()

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

overrideprotectedvirtual

Implements PROPERTIES_PANEL.

Definition at line 126 of file pcb_properties_panel.cpp.

References PROPERTY_BASE::Choices(), PCB_BASE_FRAME::GetBoard(), PCB_BASE_EDIT_FRAME::GetColorSettings(), BOARD::GetLayerName(), 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,
		PROPERTY_BASE *	aProperty,
		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 402 of file properties_panel.cpp.

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

Referenced by PROPERTIES_PANEL::rebuildProperties().

◆ 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 371 of file properties_panel.cpp.

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

Referenced by PROPERTIES_PANEL::extractValueAndWritability().

◆ getPropertyFromEvent()

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

protected

Definition at line 164 of file pcb_properties_panel.cpp.

References PROPERTY_MANAGER::GetProperty(), PCB_SELECTION_TOOL::GetSelection(), TOOL_MANAGER::GetTool(), TOOLS_HOLDER::GetToolManager(), m_frame, m_propMgr, and TYPE_HASH.

Referenced by valueChanged(), and valueChanging().

◆ GetPropertyGrid()

wxPropertyGrid * PROPERTIES_PANEL::GetPropertyGrid ( )

inlineinherited

Definition at line 50 of file properties_panel.h.

References PROPERTIES_PANEL::m_grid.

◆ onCharHook()

void PROPERTIES_PANEL::onCharHook ( wxKeyEvent & aEvent )

protectedinherited

Definition at line 474 of file properties_panel.cpp.

References PROPERTIES_PANEL::m_grid.

Referenced by PROPERTIES_PANEL::PROPERTIES_PANEL().

◆ OnLanguageChanged()

void PROPERTIES_PANEL::OnLanguageChanged ( wxCommandEvent & aEvent )

protectedvirtualinherited

Reimplemented in SCH_PROPERTIES_PANEL.

Definition at line 155 of file properties_panel.cpp.

References PROPERTIES_PANEL::m_displayed, PROPERTIES_PANEL::m_grid, and PROPERTIES_PANEL::UpdateData().

Referenced by SCH_PROPERTIES_PANEL::OnLanguageChanged(), PROPERTIES_PANEL::PROPERTIES_PANEL(), and PROPERTIES_PANEL::~PROPERTIES_PANEL().

◆ onShow()

void PROPERTIES_PANEL::onShow ( wxShowEvent & aEvent )

protectedinherited

Definition at line 465 of file properties_panel.cpp.

References PROPERTIES_PANEL::UpdateData().

Referenced by PROPERTIES_PANEL::PROPERTIES_PANEL().

◆ Properties()

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

inlineinherited

Definition at line 60 of file properties_panel.h.

References PROPERTIES_PANEL::m_displayed.

◆ PropertiesCount()

int PROPERTIES_PANEL::PropertiesCount ( ) const

inlineinherited

Definition at line 55 of file properties_panel.h.

References PROPERTIES_PANEL::m_displayed.

◆ rebuildProperties()

void PROPERTIES_PANEL::rebuildProperties ( const SELECTION & aSelection )

protectedvirtualinherited

Generates the property grid for a given selection of items.

Parameters

aSelection is a set of items to show properties for.

Definition at line 188 of file properties_panel.cpp.

References _, copy, PROPERTIES_PANEL::createPGProperty(), SELECTION::Empty(), PROPERTIES_PANEL::extractValueAndWritability(), FRAME_FOOTPRINT_EDITOR, FRAME_PCB_EDITOR, FRAME_SCH, FRAME_SCH_SYMBOL_EDITOR, SELECTION::Front(), PROPERTY_MANAGER::GetDisplayOrder(), EDA_ITEM::GetFriendlyName(), PROPERTY_MANAGER::GetGroupDisplayOrder(), PROPERTY_MANAGER::GetProperties(), PROPERTY_MANAGER::GetProperty(), group, PROPERTY_MANAGER::Instance(), PROPERTY_MANAGER::IsAvailableFor(), EDA_BASE_FRAME::IsType(), PROPERTIES_PANEL::m_caption, PROPERTIES_PANEL::m_displayed, PROPERTIES_PANEL::m_frame, PROPERTIES_PANEL::m_grid, PROPERTIES_PANEL::RecalculateSplitterPos(), SELECTION::Size(), and TYPE_HASH.

Referenced by SCH_PROPERTIES_PANEL::AfterCommit(), AfterCommit(), SCH_PROPERTIES_PANEL::UpdateData(), and UpdateData().

◆ RecalculateSplitterPos()

void PROPERTIES_PANEL::RecalculateSplitterPos ( )

inherited

Definition at line 523 of file properties_panel.cpp.

References PROPERTIES_PANEL::m_grid, and PROPERTIES_PANEL::m_splitter_key_proportion.

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

◆ SetSplitterProportion()

void PROPERTIES_PANEL::SetSplitterProportion ( float aProportion )

inherited

Definition at line 532 of file properties_panel.cpp.

References PROPERTIES_PANEL::m_splitter_key_proportion, and PROPERTIES_PANEL::RecalculateSplitterPos().

◆ SplitterProportion()

float PROPERTIES_PANEL::SplitterProportion ( ) const

inlineinherited

Definition at line 68 of file properties_panel.h.

References PROPERTIES_PANEL::m_splitter_key_proportion.

Referenced by SCH_EDIT_FRAME::SaveSettings(), SYMBOL_EDIT_FRAME::SaveSettings(), FOOTPRINT_EDIT_FRAME::SaveSettings(), and PCB_EDIT_FRAME::SaveSettings().

◆ UpdateData()

void PCB_PROPERTIES_PANEL::UpdateData ( )

overridevirtual

Implements PROPERTIES_PANEL.

Definition at line 104 of file pcb_properties_panel.cpp.

References GetBoard(), PCB_SELECTION_TOOL::GetSelection(), TOOL_MANAGER::GetTool(), TOOLS_HOLDER::GetToolManager(), m_frame, PROPERTIES_PANEL::rebuildProperties(), and updateLists().

◆ updateLists()

void PCB_PROPERTIES_PANEL::updateLists ( const BOARD * aBoard )

protected

Definition at line 256 of file pcb_properties_panel.cpp.

References _HKI, LSET::AllCuMask(), fonts, BOARD::GetEnabledLayers(), BOARD::GetNetInfo(), PROPERTY_MANAGER::GetProperty(), m_propMgr, LSET::Name(), NETINFO_LIST::NetsByNetcode(), PROPERTY_BASE::SetChoices(), TYPE_HASH, LSET::UIOrder(), and UnescapeString().

Referenced by UpdateData().

◆ valueChanged()

void PCB_PROPERTIES_PANEL::valueChanged ( wxPropertyGridEvent & aEvent )

overrideprotectedvirtual

Regenerates caches storing layer and net names.

Reimplemented from PROPERTIES_PANEL.

Definition at line 214 of file pcb_properties_panel.cpp.

References _, AfterCommit(), BOARD_ITEM::GetParent(), getPropertyFromEvent(), PCB_SELECTION_TOOL::GetSelection(), TOOL_MANAGER::GetTool(), TOOLS_HOLDER::GetToolManager(), m_frame, PROPERTIES_PANEL::m_SuppressGridChangeEvents, COMMIT::Modify(), PCB_TABLECELL_T, BOARD_COMMIT::Push(), INSPECTABLE::Set(), and EDA_ITEM::Type().

◆ valueChanging()

void PCB_PROPERTIES_PANEL::valueChanging ( wxPropertyGridEvent & aEvent )

overrideprotectedvirtual

Reimplemented from PROPERTIES_PANEL.

Definition at line 186 of file pcb_properties_panel.cpp.

References getPropertyFromEvent(), PCB_SELECTION_TOOL::GetSelection(), TOOL_MANAGER::GetTool(), TOOLS_HOLDER::GetToolManager(), m_frame, PROPERTIES_PANEL::m_SuppressGridChangeEvents, and EDA_BASE_FRAME::ShowInfoBarError().

Member Data Documentation

◆ m_caption

wxStaticText* PROPERTIES_PANEL::m_caption

protectedinherited

Definition at line 114 of file properties_panel.h.

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

◆ m_checkboxEditorInstance

PG_CHECKBOX_EDITOR* PCB_PROPERTIES_PANEL::m_checkboxEditorInstance

protected

Definition at line 62 of file pcb_properties_panel.h.

Referenced by PCB_PROPERTIES_PANEL().

◆ m_displayed

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

protectedinherited

Definition at line 111 of file properties_panel.h.

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

◆ m_frame

PCB_BASE_EDIT_FRAME* PCB_PROPERTIES_PANEL::m_frame

protected

Definition at line 59 of file pcb_properties_panel.h.

Referenced by AfterCommit(), createPGProperty(), getPropertyFromEvent(), PCB_PROPERTIES_PANEL(), UpdateData(), valueChanged(), and valueChanging().

◆ m_grid

wxPropertyGrid* PROPERTIES_PANEL::m_grid

protectedinherited

Definition at line 112 of file properties_panel.h.

Referenced by PROPERTIES_PANEL::GetPropertyGrid(), PROPERTIES_PANEL::onCharHook(), PROPERTIES_PANEL::OnLanguageChanged(), PROPERTIES_PANEL::PROPERTIES_PANEL(), PROPERTIES_PANEL::rebuildProperties(), and PROPERTIES_PANEL::RecalculateSplitterPos().

◆ m_nets

wxPGChoices PCB_PROPERTIES_PANEL::m_nets

protected

Definition at line 65 of file pcb_properties_panel.h.

◆ m_propMgr

PROPERTY_MANAGER& PCB_PROPERTIES_PANEL::m_propMgr

protected

Definition at line 60 of file pcb_properties_panel.h.

Referenced by getPropertyFromEvent(), PCB_PROPERTIES_PANEL(), and updateLists().

◆ m_ratioEditorInstance

PG_RATIO_EDITOR* PCB_PROPERTIES_PANEL::m_ratioEditorInstance

protected

Definition at line 63 of file pcb_properties_panel.h.

Referenced by PCB_PROPERTIES_PANEL().

◆ 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 117 of file properties_panel.h.

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

◆ m_SuppressGridChangeEvents

int PROPERTIES_PANEL::m_SuppressGridChangeEvents

inherited

Definition at line 108 of file properties_panel.h.

Referenced by SUPPRESS_GRID_CHANGED_EVENTS::SUPPRESS_GRID_CHANGED_EVENTS(), SCH_PROPERTIES_PANEL::valueChanged(), valueChanged(), SCH_PROPERTIES_PANEL::valueChanging(), valueChanging(), and SUPPRESS_GRID_CHANGED_EVENTS::~SUPPRESS_GRID_CHANGED_EVENTS().

◆ m_unitEditorInstance

PG_UNIT_EDITOR* PCB_PROPERTIES_PANEL::m_unitEditorInstance

protected

Definition at line 61 of file pcb_properties_panel.h.

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

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

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PCB_PROPERTIES_PANEL()

◆ ~PCB_PROPERTIES_PANEL()

Member Function Documentation

◆ AfterCommit()

◆ createPGProperty()

◆ extractValueAndWritability()

◆ getItemValue()

◆ getPropertyFromEvent()

◆ GetPropertyGrid()

◆ onCharHook()

◆ OnLanguageChanged()

◆ onShow()

◆ Properties()

◆ PropertiesCount()

◆ rebuildProperties()

◆ RecalculateSplitterPos()

◆ SetSplitterProportion()

◆ SplitterProportion()

◆ UpdateData()

◆ updateLists()

◆ valueChanged()

◆ valueChanging()

Member Data Documentation

◆ m_caption

◆ m_checkboxEditorInstance

◆ m_displayed

◆ m_frame

◆ m_grid

◆ m_nets

◆ m_propMgr

◆ m_ratioEditorInstance

◆ m_splitter_key_proportion

◆ m_SuppressGridChangeEvents

◆ m_unitEditorInstance