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

#include <footprint_wizard_properties_panel.h>

Inheritance diagram for FOOTPRINT_WIZARD_PROPERTIES_PANEL:
PROPERTIES_PANEL

Classes

struct  WIZARD_PARAM_INFO
 

Public Member Functions

 FOOTPRINT_WIZARD_PROPERTIES_PANEL (wxWindow *aParent, FOOTPRINT_WIZARD_FRAME *aFrame)
 
 ~FOOTPRINT_WIZARD_PROPERTIES_PANEL () override
 
void UpdateData () override
 
void RebuildParameters (FOOTPRINT_WIZARD *aWizard)
 
virtual void AfterCommit ()
 
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
 
wxPGProperty * createPGProperty (WIZARD_PARAMETER *aParam) const
 
void valueChanging (wxPropertyGridEvent &aEvent) override
 
void valueChanged (wxPropertyGridEvent &aEvent) override
 
wxString formatConstraintValue (const WIZARD_PARAMETER *aParam, int aValue) const
 
wxString formatConstraintValue (const WIZARD_PARAMETER *aParam, double aValue) const
 
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)
 
virtual bool isKeyEditable (const wxPGProperty *aPGProp) const
 
virtual bool isKeyNameInUse (const wxString &aName) const
 
virtual void onKeyRenamed (const wxString &aOldName, const wxString &aNewName)
 
virtual void onLabelEditBegin (wxPropertyGridEvent &aEvent)
 
virtual void onLabelEditEnding (wxPropertyGridEvent &aEvent)
 
virtual bool buildContextMenu (wxMenu &aMenu, wxPGProperty *aPGProp)
 
virtual void onNewItemLeftBlank (const wxString &aKey)
 
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.
 
virtual 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.
 
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
 

Static Protected Member Functions

static WIZARD_PARAMETERgetParamFromEvent (const wxPropertyGridEvent &aEvent)
 

Protected Attributes

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_BUTTONm_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.
 

Private Attributes

FOOTPRINT_WIZARD_FRAMEm_frame
 
std::vector< std::unique_ptr< WIZARD_PARAM_INFO > > m_paramInfos
 
PG_UNIT_EDITORm_unitEditorInstance
 
PG_CHECKBOX_EDITORm_checkboxEditorInstance
 
PG_RATIO_EDITORm_ratioEditorInstance
 

Detailed Description

Definition at line 36 of file footprint_wizard_properties_panel.h.

Constructor & Destructor Documentation

◆ FOOTPRINT_WIZARD_PROPERTIES_PANEL()

◆ ~FOOTPRINT_WIZARD_PROPERTIES_PANEL()

FOOTPRINT_WIZARD_PROPERTIES_PANEL::~FOOTPRINT_WIZARD_PROPERTIES_PANEL ( )
override

Definition at line 89 of file footprint_wizard_properties_panel.cpp.

References m_unitEditorInstance.

Member Function Documentation

◆ 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
aGroupKeyis the untranslated group name (e.g. _HKI( "Fields" )).
aTooltipis the tooltip text (translated by the caller).
aBitmapis the icon shown on the button.
aActionis invoked when the button is clicked.
aEnableFuncoptionally controls visibility (evaluated on each rebuild).
aForceCategoryoptionally 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()

virtual void PROPERTIES_PANEL::AfterCommit ( )
inlinevirtualinherited

Reimplemented in PCB_PROPERTIES_PANEL, and SCH_PROPERTIES_PANEL.

Definition at line 57 of file properties_panel.h.

◆ beginLabelEdit()

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

◆ buildContextMenu()

virtual bool PROPERTIES_PANEL::buildContextMenu ( wxMenu & aMenu,
wxPGProperty * aPGProp )
inlineprotectedvirtualinherited

Reimplemented in PCB_PROPERTIES_PANEL, and SCH_PROPERTIES_PANEL.

Definition at line 104 of file properties_panel.h.

Referenced by onRightClick().

◆ 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() [1/2]

wxPGProperty * FOOTPRINT_WIZARD_PROPERTIES_PANEL::createPGProperty ( const PROPERTY_BASE * aProperty) const
inlineoverrideprotectedvirtual

Implements PROPERTIES_PANEL.

Definition at line 47 of file footprint_wizard_properties_panel.h.

Referenced by RebuildParameters().

◆ createPGProperty() [2/2]

wxPGProperty * FOOTPRINT_WIZARD_PROPERTIES_PANEL::createPGProperty ( WIZARD_PARAMETER * aParam) const
protected

◆ 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
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 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().

◆ formatConstraintValue() [1/2]

wxString FOOTPRINT_WIZARD_PROPERTIES_PANEL::formatConstraintValue ( const WIZARD_PARAMETER * aParam,
double aValue ) const
protected

Definition at line 247 of file footprint_wizard_properties_panel.cpp.

References DEGREES_T, m_frame, and WIZARD_PARAMETER::type.

◆ formatConstraintValue() [2/2]

wxString FOOTPRINT_WIZARD_PROPERTIES_PANEL::formatConstraintValue ( const WIZARD_PARAMETER * aParam,
int aValue ) const
protected

Definition at line 228 of file footprint_wizard_properties_panel.cpp.

References AREA, DISTANCE, m_frame, TIME, and WIZARD_PARAMETER::type.

Referenced by valueChanging().

◆ getItemValue()

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

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

Returns
true if conversion succeeded

Reimplemented in PCB_PROPERTIES_PANEL, and SCH_PROPERTIES_PANEL.

Definition at line 526 of file properties_panel.cpp.

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

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

◆ getParamFromEvent()

WIZARD_PARAMETER * FOOTPRINT_WIZARD_PROPERTIES_PANEL::getParamFromEvent ( const wxPropertyGridEvent & aEvent)
staticprotected

Definition at line 222 of file footprint_wizard_properties_panel.cpp.

Referenced by valueChanged(), and valueChanging().

◆ GetPropertyGrid()

wxPropertyGrid * PROPERTIES_PANEL::GetPropertyGrid ( )
inlineinherited

Definition at line 59 of file properties_panel.h.

References m_grid.

◆ 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()

virtual bool PROPERTIES_PANEL::isKeyEditable ( const wxPGProperty * aPGProp) const
inlineprotectedvirtualinherited

Reimplemented in PCB_PROPERTIES_PANEL, and SCH_PROPERTIES_PANEL.

Definition at line 97 of file properties_panel.h.

Referenced by onLabelEditBegin(), and onLabelEditEnding().

◆ isKeyNameInUse()

virtual bool PROPERTIES_PANEL::isKeyNameInUse ( const wxString & aName) const
inlineprotectedvirtualinherited

Reimplemented in PCB_PROPERTIES_PANEL, and SCH_PROPERTIES_PANEL.

Definition at line 98 of file properties_panel.h.

Referenced by onLabelEditEnding(), and settlePendingLabelEdit().

◆ onCharHook()

void PROPERTIES_PANEL::onCharHook ( wxKeyEvent & aEvent)
protectedinherited

Definition at line 808 of file properties_panel.cpp.

References m_grid.

Referenced by PROPERTIES_PANEL().

◆ onKeyRenamed()

virtual void PROPERTIES_PANEL::onKeyRenamed ( const wxString & aOldName,
const wxString & aNewName )
inlineprotectedvirtualinherited

Reimplemented in PCB_PROPERTIES_PANEL, and SCH_PROPERTIES_PANEL.

Definition at line 99 of file properties_panel.h.

Referenced by onLabelEditEnding(), and settlePendingLabelEdit().

◆ 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

◆ OnLanguageChanged()

void PROPERTIES_PANEL::OnLanguageChanged ( wxCommandEvent & aEvent)
protectedvirtualinherited

◆ onNewItemLeftBlank()

virtual void PROPERTIES_PANEL::onNewItemLeftBlank ( const wxString & aKey)
inlineprotectedvirtualinherited

Reimplemented in PCB_PROPERTIES_PANEL, and SCH_PROPERTIES_PANEL.

Definition at line 105 of file properties_panel.h.

Referenced by onLabelEditEnding(), and settlePendingLabelEdit().

◆ 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.

◆ RebuildParameters()

◆ rebuildProperties()

◆ RecalculateSplitterPos()

void PROPERTIES_PANEL::RecalculateSplitterPos ( )
inherited

◆ 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

◆ 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 FOOTPRINT_WIZARD_PROPERTIES_PANEL::UpdateData ( )
overridevirtual

Implements PROPERTIES_PANEL.

Definition at line 96 of file footprint_wizard_properties_panel.cpp.

◆ valueChanged()

void FOOTPRINT_WIZARD_PROPERTIES_PANEL::valueChanged ( wxPropertyGridEvent & aEvent)
overrideprotectedvirtual

Reimplemented from PROPERTIES_PANEL.

Definition at line 344 of file footprint_wizard_properties_panel.cpp.

References getParamFromEvent(), and m_frame.

◆ valueChanging()

void FOOTPRINT_WIZARD_PROPERTIES_PANEL::valueChanging ( wxPropertyGridEvent & aEvent)
overrideprotectedvirtual

Member Data Documentation

◆ m_caption

wxStaticText* PROPERTIES_PANEL::m_caption
protectedinherited

◆ m_categoryButtons

std::vector<CATEGORY_BUTTON> PROPERTIES_PANEL::m_categoryButtons
protectedinherited

◆ m_checkboxEditorInstance

PG_CHECKBOX_EDITOR* FOOTPRINT_WIZARD_PROPERTIES_PANEL::m_checkboxEditorInstance
private

◆ m_contextMenuPropertyName

wxString PROPERTIES_PANEL::m_contextMenuPropertyName
protectedinherited

◆ m_displayed

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

◆ m_editingOriginalLabel

wxString PROPERTIES_PANEL::m_editingOriginalLabel
protectedinherited

Definition at line 177 of file properties_panel.h.

Referenced by onLabelEditBegin(), and onLabelEditEnding().

◆ m_frame

◆ m_grid

◆ m_paramInfos

std::vector<std::unique_ptr<WIZARD_PARAM_INFO> > FOOTPRINT_WIZARD_PROPERTIES_PANEL::m_paramInfos
private

Definition at line 64 of file footprint_wizard_properties_panel.h.

◆ m_pendingNewKey

wxString PROPERTIES_PANEL::m_pendingNewKey
protectedinherited

◆ m_ratioEditorInstance

PG_RATIO_EDITOR* FOOTPRINT_WIZARD_PROPERTIES_PANEL::m_ratioEditorInstance
private

◆ 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_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

◆ m_unitEditorInstance

PG_UNIT_EDITOR* FOOTPRINT_WIZARD_PROPERTIES_PANEL::m_unitEditorInstance
private

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