KiCad PCB EDA Suite
|
#include <property.h>
Public Types | |
using | BASE_TYPE = typename std::decay<T>::type |
Public Member Functions | |
template<typename SetType, typename GetType> | |
PROPERTY (const wxString &aName, void(Base::*aSetter)(SetType), GetType(Base::*aGetter)(), PROPERTY_DISPLAY aDisplay=PT_DEFAULT, ORIGIN_TRANSFORMS::COORD_TYPES_T aCoordType=ORIGIN_TRANSFORMS::NOT_A_COORD) | |
template<typename SetType, typename GetType> | |
PROPERTY (const wxString &aName, void(Base::*aSetter)(SetType), GetType(Base::*aGetter)() const, PROPERTY_DISPLAY aDisplay=PT_DEFAULT, ORIGIN_TRANSFORMS::COORD_TYPES_T aCoordType=ORIGIN_TRANSFORMS::NOT_A_COORD) | |
size_t | OwnerHash () const override |
Return type-id of the Owner class. | |
size_t | BaseHash () const override |
Return type-id of the Base class. | |
size_t | TypeHash () const override |
Return type-id of the property type. | |
bool | Writeable (INSPECTABLE *aObject) const override |
const wxString & | Name () const |
virtual const wxPGChoices & | Choices () const |
Return a limited set of possible values (e.g. | |
virtual void | SetChoices (const wxPGChoices &aChoices) |
Set the possible values for for the property. | |
virtual bool | HasChoices () const |
Return true if this PROPERTY has a limited set of possible values. | |
bool | Available (INSPECTABLE *aObject) const |
Return true if aObject offers this PROPERTY. | |
PROPERTY_BASE & | SetAvailableFunc (std::function< bool(INSPECTABLE *)> aFunc) |
Set a callback function to determine whether an object provides this property. | |
wxPGChoices | GetChoices (INSPECTABLE *aObject) const |
PROPERTY_BASE & | SetChoicesFunc (std::function< wxPGChoices(INSPECTABLE *)> aFunc) |
PROPERTY_BASE & | SetWriteableFunc (std::function< bool(INSPECTABLE *)> aFunc) |
PROPERTY_DISPLAY | Display () const |
PROPERTY_BASE & | SetDisplay (PROPERTY_DISPLAY aDisplay) |
ORIGIN_TRANSFORMS::COORD_TYPES_T | CoordType () const |
PROPERTY_BASE & | SetCoordType (ORIGIN_TRANSFORMS::COORD_TYPES_T aType) |
bool | IsHiddenFromPropertiesManager () const |
PROPERTY_BASE & | SetIsHiddenFromPropertiesManager (bool aHide=true) |
bool | IsHiddenFromRulesEditor () const |
PROPERTY_BASE & | SetIsHiddenFromRulesEditor (bool aHide=true) |
bool | IsHiddenFromLibraryEditors () const |
PROPERTY_BASE & | SetIsHiddenFromLibraryEditors (bool aIsHidden=true) |
bool | IsHiddenFromDesignEditors () const |
PROPERTY_BASE & | SetIsHiddenFromDesignEditors (bool aIsHidden=true) |
wxString | Group () const |
PROPERTY_BASE & | SetGroup (const wxString &aGroup) |
PROPERTY_BASE & | SetValidator (PROPERTY_VALIDATOR_FN &&aValidator) |
VALIDATOR_RESULT | Validate (const wxAny &&aValue, EDA_ITEM *aItem) |
Static Public Member Functions | |
static VALIDATOR_RESULT | NullValidator (const wxAny &&aValue, EDA_ITEM *aItem) |
Protected Member Functions | |
PROPERTY (const wxString &aName, SETTER_BASE< Owner, T > *s, GETTER_BASE< Owner, T > *g, PROPERTY_DISPLAY aDisplay, ORIGIN_TRANSFORMS::COORD_TYPES_T aCoordType) | |
virtual | ~PROPERTY () |
virtual void | setter (void *obj, wxAny &v) override |
virtual wxAny | getter (const void *obj) const override |
Set method. | |
template<typename T> | |
void | set (void *aObject, T aValue) |
template<typename T> | |
T | get (const void *aObject) const |
Protected Attributes | |
std::unique_ptr< SETTER_BASE< Owner, T > > | m_setter |
Get method. | |
std::unique_ptr< GETTER_BASE< Owner, T > > | m_getter |
Owner class type-id. | |
const size_t | m_ownerHash |
Base class type-id. | |
const size_t | m_baseHash |
Property value type-id. | |
const size_t | m_typeHash |
Private Attributes | |
const wxString | m_name |
Permanent identifier for this property. | |
PROPERTY_DISPLAY | m_display |
The display style controls how properties are edited in the properties manager GUI. | |
ORIGIN_TRANSFORMS::COORD_TYPES_T | m_coordType |
The coordinate type controls how distances are mapped to the user coordinate system. | |
bool | m_hideFromPropertiesManager |
bool | m_hideFromLibraryEditors |
bool | m_hideFromDesignEditors |
bool | m_hideFromRulesEditor |
wxString | m_group |
Optional group identifier. | |
std::function< bool(INSPECTABLE *)> | m_availFunc |
Eval to determine if prop is available. | |
std::function< bool(INSPECTABLE *)> | m_writeableFunc |
Eval to determine if prop is read-only. | |
std::function< wxPGChoices(INSPECTABLE *)> | m_choicesFunc |
PROPERTY_VALIDATOR_FN | m_validator |
Definition at line 461 of file property.h.
using PROPERTY< Owner, T, Base >::BASE_TYPE = typename std::decay<T>::type |
Definition at line 464 of file property.h.
|
inline |
Definition at line 467 of file property.h.
References ORIGIN_TRANSFORMS::NOT_A_COORD, PROPERTY(), PT_DEFAULT, and T.
Referenced by PROPERTY(), and PROPERTY().
|
inline |
Definition at line 480 of file property.h.
References ORIGIN_TRANSFORMS::NOT_A_COORD, PROPERTY(), PT_DEFAULT, and T.
|
inlineprotected |
Definition at line 513 of file property.h.
References m_baseHash, m_getter, m_ownerHash, m_setter, m_typeHash, PROPERTY_BASE::PROPERTY_BASE(), and TYPE_HASH.
|
inlineprotectedvirtual |
Definition at line 526 of file property.h.
|
inlineinherited |
Return true if aObject offers this PROPERTY.
Definition at line 251 of file property.h.
References INSPECTABLE, and m_availFunc.
Referenced by BOOST_AUTO_TEST_CASE(), and PROPERTY_MANAGER::IsAvailableFor().
|
inlineoverridevirtual |
Return type-id of the Base class.
Implements PROPERTY_BASE.
Definition at line 497 of file property.h.
References m_baseHash.
|
inlinevirtualinherited |
Return a limited set of possible values (e.g.
enum). Check with HasChoices() if a particular PROPERTY provides such set.
Reimplemented in PROPERTY_ENUM< Owner, T, Base >.
Definition at line 225 of file property.h.
References empty().
Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), PCB_PROPERTIES_PANEL::createPGProperty(), and PGPropertyFactory().
|
inlineinherited |
Definition at line 308 of file property.h.
References m_coordType.
Referenced by PGPropertyFactory().
|
inlineinherited |
Definition at line 406 of file property.h.
Referenced by INSPECTABLE::Get(), and INSPECTABLE::Get().
|
inlineinherited |
Definition at line 265 of file property.h.
References INSPECTABLE, and m_choicesFunc.
Referenced by PROPERTIES_PANEL::extractValueAndWritability(), and INSPECTABLE::Set().
|
inlineoverrideprotectedvirtual |
Set method.
Implements PROPERTY_BASE.
Reimplemented in PROPERTY_ENUM< Owner, T, Base >.
Definition at line 541 of file property.h.
References res.
|
inlineinherited |
Definition at line 343 of file property.h.
References m_group.
|
inlinevirtualinherited |
Return true if this PROPERTY has a limited set of possible values.
Reimplemented in PROPERTY_ENUM< Owner, T, Base >.
Definition at line 243 of file property.h.
References m_choicesFunc.
Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), PCB_PROPERTIES_PANEL::createPGProperty(), PCBEXPR_UCODE::CreateVarRef(), PROPERTIES_PANEL::getItemValue(), and PGPropertyFactory().
|
inlineinherited |
Definition at line 336 of file property.h.
References m_hideFromDesignEditors.
|
inlineinherited |
Definition at line 329 of file property.h.
References m_hideFromLibraryEditors.
|
inlineinherited |
Definition at line 315 of file property.h.
References m_hideFromPropertiesManager.
|
inlineinherited |
Definition at line 322 of file property.h.
References m_hideFromRulesEditor.
|
inlineinherited |
Definition at line 219 of file property.h.
References m_name.
Referenced by PROPERTY_MANAGER::AddProperty(), PCB_PROPERTIES_PANEL::createPGProperty(), SCH_PROPERTIES_PANEL::createPGProperty(), GENERATOR_TOOL::GENERATOR_TOOL(), PROPERTIES_PANEL::getItemValue(), PROPERTY_MANAGER::GetProperty(), PROPERTY_MANAGER::IsAvailableFor(), PROPERTY_MANAGER::IsWriteableFor(), PGPropertyFactory(), SCHEMATIC::SCHEMATIC(), and SCH_SYMBOL::SyncOtherUnits().
|
inlinestaticinherited |
Definition at line 357 of file property.h.
|
inlineoverridevirtual |
Return type-id of the Owner class.
Implements PROPERTY_BASE.
Definition at line 492 of file property.h.
References m_ownerHash.
Definition at line 364 of file property.h.
References EDA_ANGLE_VARIANT_DATA::Angle(), COLOR4D_VARIANT_DATA::Color(), getter(), setter(), T, STD_OPTIONAL_DOUBLE_VARIANT_DATA::Value(), and STD_OPTIONAL_INT_VARIANT_DATA::Value().
Referenced by INSPECTABLE::Set(), INSPECTABLE::Set(), and INSPECTABLE::Set().
|
inlineinherited |
Set a callback function to determine whether an object provides this property.
Definition at line 259 of file property.h.
References INSPECTABLE, m_availFunc, and PROPERTY_BASE().
Referenced by BOARD_ITEM_DESC::BOARD_ITEM_DESC(), DIMENSION_DESC::DIMENSION_DESC(), EDA_SHAPE_DESC::EDA_SHAPE_DESC(), EDA_TEXT_DESC::EDA_TEXT_DESC(), PAD_DESC::PAD_DESC(), PCB_SHAPE_DESC::PCB_SHAPE_DESC(), PCB_TUNING_PATTERN_DESC::PCB_TUNING_PATTERN_DESC(), SCH_ITEM_DESC::SCH_ITEM_DESC(), SCH_LABEL_DESC::SCH_LABEL_DESC(), SCH_LINE_DESC::SCH_LINE_DESC(), SCH_PIN_DESC::SCH_PIN_DESC(), SCH_SHAPE_DESC::SCH_SHAPE_DESC(), SCH_SYMBOL_DESC::SCH_SYMBOL_DESC(), TRACK_VIA_DESC::TRACK_VIA_DESC(), and ZONE_DESC::ZONE_DESC().
|
inlinevirtualinherited |
Set the possible values for for the property.
Reimplemented in PROPERTY_ENUM< Owner, T, Base >.
Definition at line 234 of file property.h.
|
inlineinherited |
Definition at line 273 of file property.h.
References INSPECTABLE, m_choicesFunc, and PROPERTY_BASE().
Referenced by EDA_TEXT_DESC::EDA_TEXT_DESC(), PAD_DESC::PAD_DESC(), SCH_ITEM_DESC::SCH_ITEM_DESC(), and SCH_SYMBOL_DESC::SCH_SYMBOL_DESC().
|
inlineinherited |
Definition at line 309 of file property.h.
References m_coordType, and PROPERTY_BASE().
|
inlineinherited |
Definition at line 306 of file property.h.
References m_display, and PROPERTY_BASE().
|
inlineinherited |
Definition at line 344 of file property.h.
References m_group, and PROPERTY_BASE().
Referenced by PROPERTY_MANAGER::AddProperty().
|
inlineinherited |
Definition at line 337 of file property.h.
References m_hideFromDesignEditors, and PROPERTY_BASE().
Referenced by SCH_ITEM_DESC::SCH_ITEM_DESC().
|
inlineinherited |
Definition at line 330 of file property.h.
References m_hideFromLibraryEditors, and PROPERTY_BASE().
Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), BOARD_ITEM_DESC::BOARD_ITEM_DESC(), FOOTPRINT_DESC::FOOTPRINT_DESC(), PAD_DESC::PAD_DESC(), and PCB_FIELD_DESC::PCB_FIELD_DESC().
|
inlineinherited |
Definition at line 316 of file property.h.
References m_hideFromPropertiesManager, and PROPERTY_BASE().
Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), BOARD_ITEM_DESC::BOARD_ITEM_DESC(), EDA_ITEM_DESC::EDA_ITEM_DESC(), PCB_FIELD_DESC::PCB_FIELD_DESC(), and ZONE_DESC::ZONE_DESC().
|
inlineinherited |
Definition at line 323 of file property.h.
References m_hideFromRulesEditor, and PROPERTY_BASE().
Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), EDA_SHAPE_DESC::EDA_SHAPE_DESC(), EDA_TEXT_DESC::EDA_TEXT_DESC(), PCB_SHAPE_DESC::PCB_SHAPE_DESC(), and SCH_TABLECELL_DESC::SCH_TABLECELL_DESC().
|
inlineoverrideprotectedvirtual |
Implements PROPERTY_BASE.
Reimplemented in PROPERTY_ENUM< Owner, T, Base >.
Definition at line 528 of file property.h.
References m_setter.
|
inlineinherited |
Definition at line 346 of file property.h.
References m_validator, and PROPERTY_BASE().
Referenced by EDA_SHAPE_DESC::EDA_SHAPE_DESC(), PAD_DESC::PAD_DESC(), SCH_SHEET_DESC::SCH_SHEET_DESC(), and ZONE_DESC::ZONE_DESC().
|
inlineinherited |
Definition at line 284 of file property.h.
References INSPECTABLE, m_writeableFunc, and PROPERTY_BASE().
Referenced by DIMENSION_DESC::DIMENSION_DESC(), PAD_DESC::PAD_DESC(), SCH_PIN_DESC::SCH_PIN_DESC(), and ZONE_DESC::ZONE_DESC().
|
inlineoverridevirtual |
Return type-id of the property type.
Implements PROPERTY_BASE.
Definition at line 502 of file property.h.
References m_typeHash.
|
inlineinherited |
Definition at line 352 of file property.h.
References m_validator.
Referenced by BOOST_AUTO_TEST_CASE().
|
inlineoverridevirtual |
Reimplemented from PROPERTY_BASE.
Definition at line 507 of file property.h.
References PROPERTY_BASE::INSPECTABLE, m_setter, and PROPERTY_BASE::Writeable().
|
privateinherited |
Eval to determine if prop is available.
Definition at line 448 of file property.h.
Referenced by Available(), PROPERTY_BASE(), and SetAvailableFunc().
|
protected |
Property value type-id.
Definition at line 558 of file property.h.
Referenced by BaseHash(), and PROPERTY().
|
privateinherited |
Definition at line 452 of file property.h.
Referenced by GetChoices(), HasChoices(), and SetChoicesFunc().
|
privateinherited |
The coordinate type controls how distances are mapped to the user coordinate system.
Definition at line 436 of file property.h.
Referenced by CoordType(), PROPERTY_BASE(), and SetCoordType().
|
privateinherited |
The display style controls how properties are edited in the properties manager GUI.
Definition at line 433 of file property.h.
Referenced by Display(), PROPERTY_BASE(), and SetDisplay().
|
protected |
Owner class type-id.
Definition at line 552 of file property.h.
Referenced by PROPERTY_ENUM< Owner, T, Base >::getter(), and PROPERTY().
|
privateinherited |
Optional group identifier.
Definition at line 446 of file property.h.
Referenced by Group(), and SetGroup().
|
privateinherited |
Definition at line 441 of file property.h.
Referenced by IsHiddenFromDesignEditors(), PROPERTY_BASE(), and SetIsHiddenFromDesignEditors().
|
privateinherited |
Definition at line 439 of file property.h.
Referenced by IsHiddenFromLibraryEditors(), PROPERTY_BASE(), and SetIsHiddenFromLibraryEditors().
|
privateinherited |
Definition at line 438 of file property.h.
Referenced by IsHiddenFromPropertiesManager(), PROPERTY_BASE(), and SetIsHiddenFromPropertiesManager().
|
privateinherited |
Definition at line 443 of file property.h.
Referenced by IsHiddenFromRulesEditor(), PROPERTY_BASE(), and SetIsHiddenFromRulesEditor().
|
privateinherited |
Permanent identifier for this property.
Property names are an API contract; changing them after release will impact the Custom DRC Rules system as well as the automatic API binding system. Never rename properties; instead deprecate them and hide them from the GUI.
Definition at line 430 of file property.h.
Referenced by Name(), and PROPERTY_BASE().
|
protected |
Base class type-id.
Definition at line 555 of file property.h.
Referenced by OwnerHash(), and PROPERTY().
|
protected |
Get method.
Definition at line 549 of file property.h.
Referenced by PROPERTY(), setter(), PROPERTY_ENUM< Owner, T, Base >::setter(), and Writeable().
|
protected |
Definition at line 561 of file property.h.
Referenced by PROPERTY(), and TypeHash().
|
privateinherited |
Definition at line 454 of file property.h.
Referenced by SetValidator(), and Validate().
|
privateinherited |
Eval to determine if prop is read-only.
Definition at line 450 of file property.h.
Referenced by SetWriteableFunc(), and Writeable().