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_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 |
Set method. More... | |
const wxPGChoices & | Choices () const override |
Return a limited set of possible values (e.g. More... | |
void | SetChoices (const wxPGChoices &aChoices) override |
Set the possible values for for the property. More... | |
bool | HasChoices () const override |
Return true if this PROPERTY has a limited set of possible values. More... | |
size_t | OwnerHash () const override |
Return type-id of the Owner class. More... | |
size_t | BaseHash () const override |
Return type-id of the Base class. More... | |
size_t | TypeHash () const override |
Return type-id of the property type. More... | |
bool | Writeable (INSPECTABLE *aObject) const override |
const wxString & | Name () const |
bool | Available (INSPECTABLE *aObject) const |
Return true if aObject offers this PROPERTY. More... | |
void | SetAvailableFunc (std::function< bool(INSPECTABLE *)> aFunc) |
Set a callback function to determine whether an object provides this property. More... | |
void | SetWriteableFunc (std::function< bool(INSPECTABLE *)> aFunc) |
PROPERTY_DISPLAY | Display () const |
ORIGIN_TRANSFORMS::COORD_TYPES_T | CoordType () const |
void | SetIsInternal (bool aIsInternal=true) |
bool | IsInternal () const |
void | SetIsDeprecated (bool aIsDeprecated=true) |
bool | IsDeprecated () const |
wxString | Group () const |
void | SetGroup (const wxString &aGroup) |
Protected Member Functions | |
template<typename T > | |
void | set (void *aObject, T aValue) |
template<typename T > | |
T | get (const void *aObject) const |
Protected Attributes | |
wxPGChoices | m_choices |
std::unique_ptr< SETTER_BASE< Owner, T > > | m_setter |
Get method. More... | |
std::unique_ptr< GETTER_BASE< Owner, T > > | m_getter |
Owner class type-id. More... | |
const size_t | m_ownerHash |
Base class type-id. More... | |
const size_t | m_baseHash |
Property value type-id. More... | |
const size_t | m_typeHash |
Private Attributes | |
const wxString | m_name |
const PROPERTY_DISPLAY | m_display |
const ORIGIN_TRANSFORMS::COORD_TYPES_T | m_coordType |
bool | m_isInternal |
Internal properties are hidden from the GUI but not from the rules editor autocomplete. More... | |
bool | m_isDeprecated |
Deprecated properties are hidden from the GUI and rules editor autocomplete. More... | |
wxString | m_group |
Optional group identifier. More... | |
std::function< bool(INSPECTABLE *)> | m_availFunc |
Eval to determine if prop is available. More... | |
std::function< bool(INSPECTABLE *)> | m_writeableFunc |
Eval to determine if prop is read-only. More... | |
Definition at line 446 of file property.h.
|
inherited |
Definition at line 356 of file property.h.
|
inline |
Definition at line 450 of file property.h.
References ENUM_MAP< T >::Instance(), and PROPERTY_ENUM< Owner, T, Base >::m_choices.
|
inline |
Definition at line 464 of file property.h.
References ENUM_MAP< T >::Instance(), and PROPERTY_ENUM< Owner, T, Base >::m_choices.
|
inlineinherited |
Return true if aObject offers this PROPERTY.
Definition at line 233 of file property.h.
Referenced by BOOST_AUTO_TEST_CASE(), and PROPERTY_MANAGER::IsAvailableFor().
|
inlineoverridevirtualinherited |
Return type-id of the Base class.
Implements PROPERTY_BASE.
Definition at line 383 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 506 of file property.h.
References ENUM_MAP< T >::Instance(), and PROPERTY_ENUM< Owner, T, Base >::m_choices.
Referenced by PROPERTY_ENUM< Owner, T, Base >::HasChoices().
|
inlineinherited |
Definition at line 276 of file property.h.
Referenced by PGPropertyFactory().
|
inlineinherited |
|
inlineprotectedinherited |
Definition at line 316 of file property.h.
Referenced by INSPECTABLE::Get().
|
inlineoverridevirtual |
Set method.
Reimplemented from PROPERTY< Owner, T, Owner >.
Definition at line 499 of file property.h.
References res.
|
inlineinherited |
Definition at line 284 of file property.h.
|
inlineoverridevirtual |
Return true if this PROPERTY has a limited set of possible values.
Reimplemented from PROPERTY_BASE.
Definition at line 516 of file property.h.
References PROPERTY_ENUM< Owner, T, Base >::Choices().
|
inlineinherited |
Definition at line 282 of file property.h.
|
inlineinherited |
Definition at line 279 of file property.h.
|
inlineinherited |
Definition at line 198 of file property.h.
Referenced by PROPERTY_MANAGER::AddProperty(), PCB_PROPERTIES_PANEL::createPGProperty(), PROPERTY_MANAGER::GetProperty(), PROPERTY_MANAGER::IsAvailableFor(), and PGPropertyFactory().
|
inlineoverridevirtualinherited |
Return type-id of the Owner class.
Implements PROPERTY_BASE.
Definition at line 378 of file property.h.
|
inlineprotectedinherited |
Definition at line 289 of file property.h.
References EDA_ANGLE_VARIANT_DATA::Angle().
Referenced by INSPECTABLE::Set().
|
inlineinherited |
Set a callback function to determine whether an object provides this property.
Definition at line 241 of file property.h.
|
inlineoverridevirtual |
Set the possible values for for the property.
Reimplemented from PROPERTY_BASE.
Definition at line 511 of file property.h.
References PROPERTY_ENUM< Owner, T, Base >::m_choices.
|
inlineinherited |
Definition at line 285 of file property.h.
Referenced by PROPERTY_MANAGER::AddProperty().
|
inlineinherited |
Definition at line 281 of file property.h.
|
inlineinherited |
Definition at line 278 of file property.h.
|
inlineoverridevirtual |
Reimplemented from PROPERTY< Owner, T, Owner >.
Definition at line 478 of file property.h.
|
inlineinherited |
Definition at line 251 of file property.h.
|
inlineoverridevirtualinherited |
Return type-id of the property type.
Implements PROPERTY_BASE.
Definition at line 388 of file property.h.
|
inlineoverridevirtualinherited |
Reimplemented from PROPERTY_BASE.
Definition at line 393 of file property.h.
|
privateinherited |
Eval to determine if prop is available.
Definition at line 344 of file property.h.
|
protectedinherited |
Property value type-id.
Definition at line 438 of file property.h.
|
protected |
Definition at line 522 of file property.h.
Referenced by PROPERTY_ENUM< Owner, T, Base >::Choices(), PROPERTY_ENUM< Owner, T, Base >::PROPERTY_ENUM(), and PROPERTY_ENUM< Owner, T, Base >::SetChoices().
|
privateinherited |
Definition at line 333 of file property.h.
|
privateinherited |
Definition at line 332 of file property.h.
|
protectedinherited |
Owner class type-id.
Definition at line 432 of file property.h.
|
privateinherited |
Optional group identifier.
Definition at line 342 of file property.h.
|
privateinherited |
Deprecated properties are hidden from the GUI and rules editor autocomplete.
Definition at line 339 of file property.h.
|
privateinherited |
Internal properties are hidden from the GUI but not from the rules editor autocomplete.
Definition at line 336 of file property.h.
|
privateinherited |
Definition at line 331 of file property.h.
|
protectedinherited |
Base class type-id.
Definition at line 435 of file property.h.
|
protectedinherited |
Get method.
Definition at line 429 of file property.h.
|
protectedinherited |
Definition at line 441 of file property.h.
|
privateinherited |
Eval to determine if prop is read-only.
Definition at line 346 of file property.h.