KiCad PCB EDA Suite
Loading...
Searching...
No Matches
PCB_PROPERTIES_PANEL Class Reference

#include <pcb_properties_panel.h>

Inheritance diagram for PCB_PROPERTIES_PANEL:
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
 
void OnLanguageChanged ()
 

Protected Member Functions

wxPGProperty * createPGProperty (const PROPERTY_BASE *aProperty) const override
 
PROPERTY_BASEgetPropertyFromEvent (const wxPropertyGridEvent &aEvent) const
 
void valueChanging (wxPropertyGridEvent &aEvent) override
 
void valueChanged (wxPropertyGridEvent &aEvent) override
 Regenerates caches storing layer and net names. More...
 
void updateLists (const BOARD *aBoard)
 
virtual void rebuildProperties (const SELECTION &aSelection)
 Generates the property grid for a given selection of items. More...
 
void onCharHook (wxKeyEvent &aEvent)
 
void onShow (wxShowEvent &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. More...
 
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. More...
 

Protected Attributes

PCB_BASE_EDIT_FRAMEm_frame
 
PROPERTY_MANAGERm_propMgr
 
PG_UNIT_EDITORm_unitEditorInstance
 
PG_CHECKBOX_EDITORm_checkboxEditorInstance
 
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) More...
 

Detailed Description

Definition at line 35 of file pcb_properties_panel.h.

Constructor & Destructor Documentation

◆ PCB_PROPERTIES_PANEL()

◆ ~PCB_PROPERTIES_PANEL()

PCB_PROPERTIES_PANEL::~PCB_PROPERTIES_PANEL ( )
virtual

Definition at line 82 of file pcb_properties_panel.cpp.

References m_unitEditorInstance, and PG_UNIT_EDITOR::UpdateFrame().

Member Function Documentation

◆ AfterCommit()

void PCB_PROPERTIES_PANEL::AfterCommit ( )
overridevirtual

◆ createPGProperty()

◆ extractValueAndWritability()

bool PROPERTIES_PANEL::extractValueAndWritability ( const SELECTION aSelection,
PROPERTY_BASE aProperty,
wxVariant &  aValue,
bool &  aWritable 
)
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
aSelectionis a set of EDA_ITEMs to process
aPropertyis the property to look up
aValuewill be filled with the value common to the selection, or null if different
aWritablewill 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 344 of file properties_panel.cpp.

References PROPERTIES_PANEL::getItemValue(), EDA_BASE_FRAME::GetOriginTransforms(), UNITS_PROVIDER::GetUserUnits(), PROPERTY_MANAGER::Instance(), PROPERTY_MANAGER::IsAvailableFor(), PROPERTIES_PANEL::m_frame, PROPERTY_MANAGER::SetTransforms(), PROPERTY_MANAGER::SetUnits(), TYPE_HASH, and PROPERTY_BASE::Writeable().

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

References INSPECTABLE::Get(), and PROPERTY_BASE::HasChoices().

Referenced by PROPERTIES_PANEL::extractValueAndWritability().

◆ getPropertyFromEvent()

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

◆ GetPropertyGrid()

wxPropertyGrid * PROPERTIES_PANEL::GetPropertyGrid ( )
inlineinherited

Definition at line 52 of file properties_panel.h.

References PROPERTIES_PANEL::m_grid.

◆ onCharHook()

void PROPERTIES_PANEL::onCharHook ( wxKeyEvent &  aEvent)
protectedinherited

Definition at line 399 of file properties_panel.cpp.

References PROPERTIES_PANEL::m_grid.

Referenced by PROPERTIES_PANEL::PROPERTIES_PANEL().

◆ OnLanguageChanged()

void PROPERTIES_PANEL::OnLanguageChanged ( )
inherited

Definition at line 137 of file properties_panel.cpp.

References PROPERTIES_PANEL::UpdateData().

Referenced by PCB_EDIT_FRAME::ShowChangedLanguage().

◆ onShow()

void PROPERTIES_PANEL::onShow ( wxShowEvent &  aEvent)
protectedinherited

Definition at line 392 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 62 of file properties_panel.h.

References PROPERTIES_PANEL::m_displayed.

◆ PropertiesCount()

int PROPERTIES_PANEL::PropertiesCount ( ) const
inlineinherited

Definition at line 57 of file properties_panel.h.

References PROPERTIES_PANEL::m_displayed.

◆ rebuildProperties()

◆ RecalculateSplitterPos()

◆ SetSplitterProportion()

void PROPERTIES_PANEL::SetSplitterProportion ( float  aProportion)
inherited

◆ SplitterProportion()

float PROPERTIES_PANEL::SplitterProportion ( ) const
inlineinherited

◆ UpdateData()

void PCB_PROPERTIES_PANEL::UpdateData ( )
overridevirtual

◆ updateLists()

◆ valueChanged()

void PCB_PROPERTIES_PANEL::valueChanged ( wxPropertyGridEvent &  aEvent)
overrideprotectedvirtual

◆ valueChanging()

void PCB_PROPERTIES_PANEL::valueChanging ( wxPropertyGridEvent &  aEvent)
overrideprotectedvirtual

Member Data Documentation

◆ m_caption

wxStaticText* PROPERTIES_PANEL::m_caption
protectedinherited

◆ m_checkboxEditorInstance

PG_CHECKBOX_EDITOR* PCB_PROPERTIES_PANEL::m_checkboxEditorInstance
protected

Definition at line 60 of file pcb_properties_panel.h.

Referenced by PCB_PROPERTIES_PANEL().

◆ m_displayed

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

◆ m_frame

◆ m_grid

◆ m_nets

wxPGChoices PCB_PROPERTIES_PANEL::m_nets
protected

Definition at line 62 of file pcb_properties_panel.h.

◆ m_propMgr

PROPERTY_MANAGER& PCB_PROPERTIES_PANEL::m_propMgr
protected

Definition at line 58 of file pcb_properties_panel.h.

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

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

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

◆ m_unitEditorInstance

PG_UNIT_EDITOR* PCB_PROPERTIES_PANEL::m_unitEditorInstance
protected

Definition at line 59 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: