PROPERTY_BASE Class Reference

#include <property.h>

Inheritance diagram for PROPERTY_BASE:

Public Member Functions
	PROPERTY_BASE (const wxString &aName, PROPERTY_DISPLAY aDisplay=PT_DEFAULT, ORIGIN_TRANSFORMS::COORD_TYPES_T aCoordType=ORIGIN_TRANSFORMS::NOT_A_COORD)
	< Used to generate unique IDs. Must come up front so it's initialized before ctor.
virtual	~PROPERTY_BASE ()
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.
virtual bool	Writeable (INSPECTABLE *aObject) const
PROPERTY_BASE &	SetWriteableFunc (std::function< bool(INSPECTABLE *)> aFunc)
virtual size_t	OwnerHash () const =0
	Return type-id of the Owner class.
virtual size_t	BaseHash () const =0
	Return type-id of the Base class.
virtual size_t	TypeHash () const =0
	Return type-id of the property type.
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
template<typename T >
void	set (void *aObject, T aValue)
template<typename T >
T	get (const void *aObject) const

Private Member Functions
virtual void	setter (void *aObject, wxAny &aValue)=0
virtual wxAny	getter (const void *aObject) const =0

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.
PROPERTY_VALIDATOR_FN	m_validator

Friends
class	INSPECTABLE

Detailed Description

Definition at line 193 of file property.h.

Constructor & Destructor Documentation

PROPERTY_BASE()

PROPERTY_BASE::PROPERTY_BASE ( const wxString &  aName, PROPERTY_DISPLAY  aDisplay = PT_DEFAULT, ORIGIN_TRANSFORMS::COORD_TYPES_T  aCoordType = ORIGIN_TRANSFORMS::NOT_A_COORD  )

inline

< Used to generate unique IDs. Must come up front so it's initialized before ctor.

Definition at line 199 of file property.h.

~PROPERTY_BASE()

virtual PROPERTY_BASE::~PROPERTY_BASE ( )

inlinevirtual

Definition at line 214 of file property.h.

Member Function Documentation

Available()

bool PROPERTY_BASE::Available ( INSPECTABLE *  aObject ) const

inline

Return true if aObject offers this PROPERTY.

Definition at line 250 of file property.h.

Referenced by BOOST_AUTO_TEST_CASE(), and PROPERTY_MANAGER::IsAvailableFor().

BaseHash()

virtual size_t PROPERTY_BASE::BaseHash ( ) const

pure virtual

Return type-id of the Base class.

Implemented in PROPERTY< Owner, T, Base >, and PROPERTY< Owner, T, Owner >.

Referenced by PROPERTY_MANAGER::IsAvailableFor(), and PROPERTY_MANAGER::IsWriteableFor().

Choices()

virtual const wxPGChoices & PROPERTY_BASE::Choices ( ) const

inlinevirtual

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 224 of file property.h.

References empty().

Referenced by BOOST_AUTO_TEST_CASE(), PCB_PROPERTIES_PANEL::createPGProperty(), and PGPropertyFactory().

CoordType()

ORIGIN_TRANSFORMS::COORD_TYPES_T PROPERTY_BASE::CoordType ( ) const

inline

Definition at line 293 of file property.h.

Referenced by PGPropertyFactory().

Display()

PROPERTY_DISPLAY PROPERTY_BASE::Display ( ) const

inline

Definition at line 290 of file property.h.

Referenced by PGPropertyFactory().

get()

template<typename T >

T PROPERTY_BASE::get ( const void *  aObject ) const

inlineprotected

Definition at line 391 of file property.h.

References T.

Referenced by INSPECTABLE::Get().

getter()

virtual wxAny PROPERTY_BASE::getter ( const void *  aObject ) const

privatepure virtual

Implemented in PROPERTY< Owner, T, Base >, PROPERTY< Owner, T, Owner >, and PROPERTY_ENUM< Owner, T, Base >.

Referenced by INSPECTABLE::Get().

Group()

wxString PROPERTY_BASE::Group ( ) const

inline

Definition at line 328 of file property.h.

HasChoices()

virtual bool PROPERTY_BASE::HasChoices ( ) const

inlinevirtual

Return true if this PROPERTY has a limited set of possible values.

See also

PROPERTY_BASE::Choices()

Reimplemented in PROPERTY_ENUM< Owner, T, Base >.

Definition at line 242 of file property.h.

Referenced by BOOST_AUTO_TEST_CASE(), PCB_PROPERTIES_PANEL::createPGProperty(), PCBEXPR_UCODE::CreateVarRef(), PROPERTIES_PANEL::getItemValue(), and PGPropertyFactory().

IsHiddenFromDesignEditors()

bool PROPERTY_BASE::IsHiddenFromDesignEditors ( ) const

inline

Definition at line 321 of file property.h.

IsHiddenFromLibraryEditors()

bool PROPERTY_BASE::IsHiddenFromLibraryEditors ( ) const

inline

Definition at line 314 of file property.h.

IsHiddenFromPropertiesManager()

bool PROPERTY_BASE::IsHiddenFromPropertiesManager ( ) const

inline

Definition at line 300 of file property.h.

Referenced by PROPERTIES_PANEL::extractValueAndWritability().

IsHiddenFromRulesEditor()

bool PROPERTY_BASE::IsHiddenFromRulesEditor ( ) const

inline

Definition at line 307 of file property.h.

Name()

const wxString & PROPERTY_BASE::Name ( ) const

inline

Definition at line 218 of file property.h.

Referenced by PROPERTY_MANAGER::AddProperty(), PCB_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().

NullValidator()

static VALIDATOR_RESULT PROPERTY_BASE::NullValidator ( const wxAny &&  aValue, EDA_ITEM *  aItem  )

inlinestatic

Definition at line 342 of file property.h.

OwnerHash()

virtual size_t PROPERTY_BASE::OwnerHash ( ) const

pure virtual

Return type-id of the Owner class.

Implemented in PROPERTY< Owner, T, Base >, and PROPERTY< Owner, T, Owner >.

Referenced by PROPERTY_MANAGER::AddProperty(), INSPECTABLE::Get(), PROPERTY_MANAGER::ReplaceProperty(), and INSPECTABLE::Set().

set()

template<typename T >

void PROPERTY_BASE::set ( void *  aObject, T  aValue  )

inlineprotected

Definition at line 349 of file property.h.

References EDA_ANGLE_VARIANT_DATA::Angle(), COLOR4D_VARIANT_DATA::Color(), STD_OPTIONAL_INT_VARIANT_DATA::Value(), and STD_OPTIONAL_DOUBLE_VARIANT_DATA::Value().

Referenced by INSPECTABLE::Set().

SetAvailableFunc()

PROPERTY_BASE & PROPERTY_BASE::SetAvailableFunc ( std::function< bool(INSPECTABLE *)>  aFunc )

inline

Set a callback function to determine whether an object provides this property.

Definition at line 258 of file property.h.

Referenced by BOARD_ITEM_DESC::BOARD_ITEM_DESC(), DIMENSION_DESC::DIMENSION_DESC(), EDA_SHAPE_DESC::EDA_SHAPE_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_LINE_DESC::SCH_LINE_DESC(), SCH_PIN_DESC::SCH_PIN_DESC(), SCH_SYMBOL_DESC::SCH_SYMBOL_DESC(), and ZONE_DESC::ZONE_DESC().

SetChoices()

virtual void PROPERTY_BASE::SetChoices ( const wxPGChoices &  aChoices )

inlinevirtual

Set the possible values for for the property.

Reimplemented in PROPERTY_ENUM< Owner, T, Base >.

Definition at line 233 of file property.h.

Referenced by SCH_PROPERTIES_PANEL::updateFontList(), and PCB_PROPERTIES_PANEL::updateLists().

SetCoordType()

PROPERTY_BASE & PROPERTY_BASE::SetCoordType ( ORIGIN_TRANSFORMS::COORD_TYPES_T  aType )

inline

Definition at line 294 of file property.h.

SetDisplay()

PROPERTY_BASE & PROPERTY_BASE::SetDisplay ( PROPERTY_DISPLAY  aDisplay )

inline

Definition at line 291 of file property.h.

SetGroup()

PROPERTY_BASE & PROPERTY_BASE::SetGroup ( const wxString &  aGroup )

inline

Definition at line 329 of file property.h.

Referenced by PROPERTY_MANAGER::AddProperty().

SetIsHiddenFromDesignEditors()

PROPERTY_BASE & PROPERTY_BASE::SetIsHiddenFromDesignEditors ( bool  aIsHidden = true )

inline

Definition at line 322 of file property.h.

Referenced by SCH_ITEM_DESC::SCH_ITEM_DESC().

SetIsHiddenFromLibraryEditors()

PROPERTY_BASE & PROPERTY_BASE::SetIsHiddenFromLibraryEditors ( bool  aIsHidden = true )

inline

Definition at line 315 of file property.h.

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

SetIsHiddenFromPropertiesManager()

PROPERTY_BASE & PROPERTY_BASE::SetIsHiddenFromPropertiesManager ( bool  aHide = true )

inline

Definition at line 301 of file property.h.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), BOARD_ITEM_DESC::BOARD_ITEM_DESC(), EDA_ITEM_DESC::EDA_ITEM_DESC(), and PCB_FIELD_DESC::PCB_FIELD_DESC().

SetIsHiddenFromRulesEditor()

PROPERTY_BASE & PROPERTY_BASE::SetIsHiddenFromRulesEditor ( bool  aHide = true )

inline

Definition at line 308 of file property.h.

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

setter()

virtual void PROPERTY_BASE::setter ( void *  aObject, wxAny &  aValue  )

privatepure virtual

Implemented in PROPERTY< Owner, T, Base >, PROPERTY< Owner, T, Owner >, and PROPERTY_ENUM< Owner, T, Base >.

Referenced by INSPECTABLE::Set().

SetValidator()

PROPERTY_BASE & PROPERTY_BASE::SetValidator ( PROPERTY_VALIDATOR_FN &&  aValidator )

inline

Definition at line 331 of file property.h.

Referenced by PAD_DESC::PAD_DESC(), and ZONE_DESC::ZONE_DESC().

SetWriteableFunc()

PROPERTY_BASE & PROPERTY_BASE::SetWriteableFunc ( std::function< bool(INSPECTABLE *)>  aFunc )

inline

Definition at line 269 of file property.h.

Referenced by DIMENSION_DESC::DIMENSION_DESC(), PAD_DESC::PAD_DESC(), SCH_PIN_DESC::SCH_PIN_DESC(), and ZONE_DESC::ZONE_DESC().

TypeHash()

virtual size_t PROPERTY_BASE::TypeHash ( ) const

pure virtual

Return type-id of the property type.

Implemented in PROPERTY< Owner, T, Base >, and PROPERTY< Owner, T, Owner >.

Referenced by PCB_PROPERTIES_PANEL::createPGProperty(), PCBEXPR_UCODE::CreateVarRef(), and PGPropertyFactory().

Validate()

VALIDATOR_RESULT PROPERTY_BASE::Validate ( const wxAny &&  aValue, EDA_ITEM *  aItem  )

inline

Definition at line 337 of file property.h.

Writeable()

virtual bool PROPERTY_BASE::Writeable ( INSPECTABLE *  aObject ) const

inlinevirtual

Reimplemented in PROPERTY< Owner, T, Base >, and PROPERTY< Owner, T, Owner >.

Definition at line 264 of file property.h.

Referenced by PROPERTY_MANAGER::IsWriteableFor(), and PROPERTY< Owner, T, Base >::Writeable().

Friends And Related Function Documentation

INSPECTABLE

friend class INSPECTABLE

friend

Definition at line 439 of file property.h.

Member Data Documentation

m_availFunc

std::function<bool(INSPECTABLE*)> PROPERTY_BASE::m_availFunc

private

Eval to determine if prop is available.

Definition at line 433 of file property.h.

m_coordType

ORIGIN_TRANSFORMS::COORD_TYPES_T PROPERTY_BASE::m_coordType

private

The coordinate type controls how distances are mapped to the user coordinate system.

Definition at line 421 of file property.h.

m_display

PROPERTY_DISPLAY PROPERTY_BASE::m_display

private

The display style controls how properties are edited in the properties manager GUI.

Definition at line 418 of file property.h.

m_group

wxString PROPERTY_BASE::m_group

private

Optional group identifier.

Definition at line 431 of file property.h.

m_hideFromDesignEditors

bool PROPERTY_BASE::m_hideFromDesignEditors

private

Definition at line 426 of file property.h.

m_hideFromLibraryEditors

bool PROPERTY_BASE::m_hideFromLibraryEditors

private

Definition at line 424 of file property.h.

m_hideFromPropertiesManager

bool PROPERTY_BASE::m_hideFromPropertiesManager

private

Definition at line 423 of file property.h.

m_hideFromRulesEditor

bool PROPERTY_BASE::m_hideFromRulesEditor

private

Definition at line 428 of file property.h.

m_name

const wxString PROPERTY_BASE::m_name

private

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 415 of file property.h.

m_validator

PROPERTY_VALIDATOR_FN PROPERTY_BASE::m_validator

private

Definition at line 437 of file property.h.

m_writeableFunc

std::function<bool(INSPECTABLE*)> PROPERTY_BASE::m_writeableFunc

private

Eval to determine if prop is read-only.

Definition at line 435 of file property.h.

---

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

• property.h