|
KiCad PCB EDA Suite
|
#include <property.h>
Public Types | |
| using | BASE_TYPE |
Public Member Functions | |
| template<typename SetType, typename GetType> | |
| PROPERTY_ENUM (const wxString &aName, void(Base::*aSetter)(SetType), GetType(Base::*aGetter)(), PROPERTY_DISPLAY aDisplay=PT_DEFAULT) | |
| template<typename SetType, typename GetType> | |
| PROPERTY_ENUM (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) | |
| void | setter (void *obj, wxAny &v) override |
| wxAny | getter (const void *obj) const override |
| const wxPGChoices & | Choices () const override |
| Return a limited set of possible values (e.g. | |
| void | TranslateChoices () override |
| void | SetChoices (const wxPGChoices &aChoices) override |
| Set the possible values for for the property. | |
| bool | HasChoices () const override |
| Return true if this PROPERTY has a limited set of possible values. | |
| 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 |
| const wxString & | HelpString () const |
| PROPERTY_BASE & | SetHelpString (const wxString &aHelpString) |
| Set untranslated help text, marked with _HKI for translation extraction. | |
| 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) |
| virtual bool | IgnoreValue () const |
| PROPERTY_BASE & | SetWriteableFunc (std::function< bool(INSPECTABLE *)> aFunc) |
| bool | IsIndeterminate (INSPECTABLE *aObject) const |
| Return true if aObject holds several values for this property, so it has no single value to show. | |
| PROPERTY_BASE & | SetIndeterminateFunc (std::function< bool(INSPECTABLE *)> aFunc) |
| Set a callback function to determine whether an object's value for this property is mixed. | |
| 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) |
| bool | IsCopyable () const |
| True for a property that says how an item looks, not what or where it is. | |
| PROPERTY_BASE & | SetIsCopyable (bool aIsCopyable=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 | |
| void | set (void *aObject, T aValue) |
| T | get (const void *aObject) const |
Protected Attributes | |
| bool | m_choicesFromENUM_MAP |
| wxPGChoices | m_choices |
| std::unique_ptr< SETTER_BASE< Owner, T > > | m_setter |
| Set method. | |
| std::unique_ptr< GETTER_BASE< Owner, T > > | m_getter |
| Get method. | |
| const size_t | m_ownerHash |
| Owner class type-id. | |
| const size_t | m_baseHash |
| Base class type-id. | |
| const size_t | m_typeHash |
| Property value type-id. | |
Private Attributes | |
| const wxString | m_name |
| Permanent identifier for this property. | |
| wxString | m_helpString |
| Optional help text, translated when the property grid control is created. | |
| 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 |
| bool | m_copyable |
| 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 |
| std::function< bool(INSPECTABLE *)> | m_indeterminateFunc |
| Eval to determine if the value is mixed. | |
| PROPERTY_VALIDATOR_FN | m_validator |
Definition at line 659 of file property.h.
Definition at line 528 of file property.h.
|
inline |
Definition at line 663 of file property.h.
References ENUM_MAP< T >::Instance(), m_choices, m_choicesFromENUM_MAP, PROPERTY< Owner, T, Owner >::PROPERTY(), PT_DEFAULT, and T.
|
inline |
Definition at line 682 of file property.h.
References ENUM_MAP< T >::Instance(), m_choices, m_choicesFromENUM_MAP, ORIGIN_TRANSFORMS::NOT_A_COORD, PROPERTY< Owner, T, Owner >::PROPERTY(), PT_DEFAULT, and T.
|
inlineinherited |
Return true if aObject offers this PROPERTY.
Definition at line 267 of file property.h.
Return type-id of the Base class.
Implements PROPERTY_BASE.
Definition at line 561 of file property.h.
|
inlineoverridevirtual |
Return a limited set of possible values (e.g.
enum). Check with HasChoices() if a particular PROPERTY provides such set.
Reimplemented from PROPERTY_BASE.
Definition at line 729 of file property.h.
References ENUM_MAP< T >::Instance(), and m_choices.
Referenced by HasChoices().
|
inlineinherited |
Definition at line 346 of file property.h.
|
inlineinherited |
Definition at line 343 of file property.h.
|
inlineprotectedinherited |
Definition at line 459 of file property.h.
|
inlineinherited |
Definition at line 281 of file property.h.
|
inlineoverridevirtual |
Reimplemented from PROPERTY< Owner, T, Owner >.
Definition at line 722 of file property.h.
References PROPERTY< Owner, T, Base >::m_getter, res, and T.
|
inlineinherited |
Definition at line 394 of file property.h.
|
inlineoverridevirtual |
Return true if this PROPERTY has a limited set of possible values.
Reimplemented from PROPERTY_BASE.
Definition at line 753 of file property.h.
References Choices().
|
inlineinherited |
Definition at line 223 of file property.h.
|
inlinevirtualinherited |
Definition at line 295 of file property.h.
|
inlineinherited |
True for a property that says how an item looks, not what or where it is.
Opt-in. The safe answer for anything unexamined is no. Identity, position, size and connectivity stay off. Copying those between items would move or rewire them.
Definition at line 387 of file property.h.
|
inlineinherited |
Definition at line 374 of file property.h.
|
inlineinherited |
Definition at line 367 of file property.h.
|
inlineinherited |
Definition at line 353 of file property.h.
|
inlineinherited |
Definition at line 360 of file property.h.
|
inlineinherited |
Return true if aObject holds several values for this property, so it has no single value to show.
Definition at line 314 of file property.h.
|
inlineinherited |
Definition at line 221 of file property.h.
|
inlinestaticinherited |
Definition at line 408 of file property.h.
Return type-id of the Owner class.
Implements PROPERTY_BASE.
Definition at line 556 of file property.h.
|
inlineprotectedinherited |
Definition at line 415 of file property.h.
|
inlineinherited |
Set a callback function to determine whether an object provides this property.
Definition at line 275 of file property.h.
|
inlineoverridevirtual |
Set the possible values for for the property.
Reimplemented from PROPERTY_BASE.
Definition at line 747 of file property.h.
References m_choices, and m_choicesFromENUM_MAP.
|
inlineinherited |
Definition at line 289 of file property.h.
|
inlineinherited |
Definition at line 347 of file property.h.
|
inlineinherited |
Definition at line 344 of file property.h.
|
inlineinherited |
Definition at line 395 of file property.h.
|
inlineinherited |
Set untranslated help text, marked with _HKI for translation extraction.
An empty string makes the property grid use the property name as its help text.
Definition at line 229 of file property.h.
|
inlineinherited |
Set a callback function to determine whether an object's value for this property is mixed.
Definition at line 322 of file property.h.
|
inlineinherited |
Definition at line 388 of file property.h.
|
inlineinherited |
Definition at line 375 of file property.h.
|
inlineinherited |
Definition at line 368 of file property.h.
|
inlineinherited |
Definition at line 354 of file property.h.
|
inlineinherited |
Definition at line 361 of file property.h.
|
inlineoverridevirtual |
Reimplemented from PROPERTY< Owner, T, Owner >.
Definition at line 701 of file property.h.
References PROPERTY< Owner, T, Base >::m_setter, and T.
|
inlineinherited |
Definition at line 397 of file property.h.
|
inlineinherited |
Definition at line 305 of file property.h.
|
inlineoverridevirtual |
Reimplemented from PROPERTY_BASE.
Definition at line 734 of file property.h.
References ENUM_MAP< T >::Instance(), m_choices, and m_choicesFromENUM_MAP.
Return type-id of the property type.
Implements PROPERTY_BASE.
Definition at line 566 of file property.h.
|
inlineinherited |
Definition at line 403 of file property.h.
|
inlineoverridevirtualinherited |
Reimplemented from PROPERTY_BASE.
Definition at line 571 of file property.h.
|
privateinherited |
Eval to determine if prop is available.
Definition at line 510 of file property.h.
Base class type-id.
Definition at line 622 of file property.h.
|
protected |
Definition at line 760 of file property.h.
Referenced by Choices(), PROPERTY_ENUM(), PROPERTY_ENUM(), SetChoices(), and TranslateChoices().
|
protected |
Definition at line 759 of file property.h.
Referenced by PROPERTY_ENUM(), PROPERTY_ENUM(), SetChoices(), and TranslateChoices().
|
privateinherited |
Definition at line 514 of file property.h.
|
privateinherited |
The coordinate type controls how distances are mapped to the user coordinate system.
Definition at line 497 of file property.h.
|
privateinherited |
Definition at line 505 of file property.h.
|
privateinherited |
The display style controls how properties are edited in the properties manager GUI.
Definition at line 494 of file property.h.
|
protectedinherited |
Get method.
Definition at line 616 of file property.h.
|
privateinherited |
Optional group identifier.
Definition at line 508 of file property.h.
|
privateinherited |
Optional help text, translated when the property grid control is created.
Definition at line 491 of file property.h.
|
privateinherited |
Definition at line 502 of file property.h.
|
privateinherited |
Definition at line 500 of file property.h.
|
privateinherited |
Definition at line 499 of file property.h.
|
privateinherited |
Definition at line 504 of file property.h.
|
privateinherited |
Eval to determine if the value is mixed.
Definition at line 516 of file property.h.
|
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 488 of file property.h.
Owner class type-id.
Definition at line 619 of file property.h.
|
protectedinherited |
Set method.
Definition at line 613 of file property.h.
Property value type-id.
Definition at line 625 of file property.h.
|
privateinherited |
Definition at line 518 of file property.h.
|
privateinherited |
Eval to determine if prop is read-only.
Definition at line 512 of file property.h.