#include <property.h>

Inheritance diagram for PROPERTY_ENUM< Owner, T, Base >:

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.

const wxPGChoices &	Choices () const override
	Return a limited set of possible values (e.g.

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

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.

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

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.

PROPERTY_VALIDATOR_FN	m_validator

Detailed Description

template<typename Owner, typename T, typename Base = Owner>
class PROPERTY_ENUM< Owner, T, Base >

Definition at line 548 of file property.h.

Member Typedef Documentation

◆ BASE_TYPE

template<typename Owner , typename T , typename Base = Owner>

using PROPERTY< Owner, T, Base >::BASE_TYPE = typename std::decay<T>::type

inherited

Definition at line 447 of file property.h.

Constructor & Destructor Documentation

◆ PROPERTY_ENUM() [1/2]

template<typename Owner , typename T , typename Base = Owner>

template<typename SetType , typename GetType >

PROPERTY_ENUM< Owner, T, Base >::PROPERTY_ENUM	(	const wxString &	aName,
		void(Base::*)(SetType)	aSetter,
		GetType(Base::*)()	aGetter,
		PROPERTY_DISPLAY	aDisplay = `PT_DEFAULT`
	)

inline

Definition at line 552 of file property.h.

References ENUM_MAP< T >::Instance(), and PROPERTY_ENUM< Owner, T, Base >::m_choices.

◆ PROPERTY_ENUM() [2/2]

template<typename Owner , typename T , typename Base = Owner>

template<typename SetType , typename GetType >

PROPERTY_ENUM< Owner, T, Base >::PROPERTY_ENUM	(	const wxString &	aName,
		void(Base::*)(SetType)	aSetter,
		GetType(Base::*)() const	aGetter,
		PROPERTY_DISPLAY	aDisplay = `PT_DEFAULT`,
		ORIGIN_TRANSFORMS::COORD_TYPES_T	aCoordType = `ORIGIN_TRANSFORMS::NOT_A_COORD`
	)

inline

Definition at line 569 of file property.h.

References ENUM_MAP< T >::Instance(), and PROPERTY_ENUM< Owner, T, Base >::m_choices.

Member Function Documentation

◆ Available()

bool PROPERTY_BASE::Available ( INSPECTABLE * aObject ) const

inlineinherited

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

template<typename Owner , typename T , typename Base = Owner>

size_t PROPERTY< Owner, T, Base >::BaseHash ( ) const

inlineoverridevirtualinherited

Return type-id of the Base class.

Implements PROPERTY_BASE.

Definition at line 480 of file property.h.

References PROPERTY< Owner, T, Base >::m_baseHash.

◆ Choices()

template<typename Owner , typename T , typename Base = Owner>

const wxPGChoices & PROPERTY_ENUM< Owner, T, Base >::Choices ( ) const

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

◆ CoordType()

ORIGIN_TRANSFORMS::COORD_TYPES_T PROPERTY_BASE::CoordType ( ) const

inlineinherited

Definition at line 293 of file property.h.

Referenced by PGPropertyFactory().

◆ Display()

PROPERTY_DISPLAY PROPERTY_BASE::Display ( ) const

inlineinherited

Definition at line 290 of file property.h.

Referenced by PGPropertyFactory().

◆ get()

template<typename T >

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

inlineprotectedinherited

Definition at line 391 of file property.h.

References T.

Referenced by INSPECTABLE::Get().

◆ getter()

template<typename Owner , typename T , typename Base = Owner>

wxAny PROPERTY_ENUM< Owner, T, Base >::getter ( const void * obj ) const

inlineoverridevirtual

Set method.

Reimplemented from PROPERTY< Owner, T, Base >.

Definition at line 607 of file property.h.

References res, and T.

◆ Group()

wxString PROPERTY_BASE::Group ( ) const

inlineinherited

Definition at line 328 of file property.h.

◆ HasChoices()

template<typename Owner , typename T , typename Base = Owner>

bool PROPERTY_ENUM< Owner, T, Base >::HasChoices ( ) const

inlineoverridevirtual

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

See also: PROPERTY_BASE::Choices()

Reimplemented from PROPERTY_BASE.

Definition at line 624 of file property.h.

References PROPERTY_ENUM< Owner, T, Base >::Choices().

◆ IsHiddenFromDesignEditors()

bool PROPERTY_BASE::IsHiddenFromDesignEditors ( ) const

inlineinherited

Definition at line 321 of file property.h.

◆ IsHiddenFromLibraryEditors()

bool PROPERTY_BASE::IsHiddenFromLibraryEditors ( ) const

inlineinherited

Definition at line 314 of file property.h.

◆ IsHiddenFromPropertiesManager()

bool PROPERTY_BASE::IsHiddenFromPropertiesManager ( ) const

inlineinherited

Definition at line 300 of file property.h.

Referenced by PROPERTIES_PANEL::extractValueAndWritability().

◆ IsHiddenFromRulesEditor()

bool PROPERTY_BASE::IsHiddenFromRulesEditor ( ) const

inlineinherited

Definition at line 307 of file property.h.

◆ Name()

const wxString & PROPERTY_BASE::Name ( ) const

inlineinherited

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
	)

inlinestaticinherited

Definition at line 342 of file property.h.

◆ OwnerHash()

template<typename Owner , typename T , typename Base = Owner>

size_t PROPERTY< Owner, T, Base >::OwnerHash ( ) const

inlineoverridevirtualinherited

Return type-id of the Owner class.

Implements PROPERTY_BASE.

Definition at line 475 of file property.h.

References PROPERTY< Owner, T, Base >::m_ownerHash.

◆ set()

template<typename T >

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

inlineprotectedinherited

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 )

inlineinherited

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

template<typename Owner , typename T , typename Base = Owner>

void PROPERTY_ENUM< Owner, T, Base >::SetChoices ( const wxPGChoices & aChoices )

inlineoverridevirtual

Set the possible values for for the property.

Reimplemented from PROPERTY_BASE.

Definition at line 619 of file property.h.

References PROPERTY_ENUM< Owner, T, Base >::m_choices.

◆ SetCoordType()

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

inlineinherited

Definition at line 294 of file property.h.

◆ SetDisplay()

PROPERTY_BASE & PROPERTY_BASE::SetDisplay ( PROPERTY_DISPLAY aDisplay )

inlineinherited

Definition at line 291 of file property.h.

◆ SetGroup()

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

inlineinherited

Definition at line 329 of file property.h.

Referenced by PROPERTY_MANAGER::AddProperty().

◆ SetIsHiddenFromDesignEditors()

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

inlineinherited

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 )

inlineinherited

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 )

inlineinherited

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 )

inlineinherited

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(), and PCB_SHAPE_DESC::PCB_SHAPE_DESC().

◆ setter()

template<typename Owner , typename T , typename Base = Owner>

void PROPERTY_ENUM< Owner, T, Base >::setter	(	void *	obj,
		wxAny &	v
	)

inlineoverridevirtual

Reimplemented from PROPERTY< Owner, T, Base >.

Definition at line 586 of file property.h.

References T.

◆ SetValidator()

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

inlineinherited

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 )

inlineinherited

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

template<typename Owner , typename T , typename Base = Owner>

size_t PROPERTY< Owner, T, Base >::TypeHash ( ) const

inlineoverridevirtualinherited

Return type-id of the property type.

Implements PROPERTY_BASE.

Definition at line 485 of file property.h.

References PROPERTY< Owner, T, Base >::m_typeHash.

◆ Validate()

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

inlineinherited

Definition at line 337 of file property.h.

◆ Writeable()

template<typename Owner , typename T , typename Base = Owner>

bool PROPERTY< Owner, T, Base >::Writeable ( INSPECTABLE * aObject ) const

inlineoverridevirtualinherited

Reimplemented from PROPERTY_BASE.

Definition at line 490 of file property.h.

References PROPERTY< Owner, T, Base >::m_setter, and PROPERTY_BASE::Writeable().

Member Data Documentation

◆ m_availFunc

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

privateinherited

Eval to determine if prop is available.

Definition at line 433 of file property.h.

◆ m_baseHash

template<typename Owner , typename T , typename Base = Owner>

const size_t PROPERTY< Owner, T, Base >::m_baseHash

protectedinherited

Property value type-id.

Definition at line 540 of file property.h.

Referenced by PROPERTY< Owner, T, Base >::BaseHash().

◆ m_choices

template<typename Owner , typename T , typename Base = Owner>

wxPGChoices PROPERTY_ENUM< Owner, T, Base >::m_choices

protected

Definition at line 630 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().

◆ m_coordType

ORIGIN_TRANSFORMS::COORD_TYPES_T PROPERTY_BASE::m_coordType

privateinherited

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

privateinherited

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

Definition at line 418 of file property.h.

◆ m_getter

template<typename Owner , typename T , typename Base = Owner>

std::unique_ptr<GETTER_BASE<Owner, T> > PROPERTY< Owner, T, Base >::m_getter

protectedinherited

Owner class type-id.

Definition at line 534 of file property.h.

◆ m_group

wxString PROPERTY_BASE::m_group

privateinherited

Optional group identifier.

Definition at line 431 of file property.h.

◆ m_hideFromDesignEditors

bool PROPERTY_BASE::m_hideFromDesignEditors

privateinherited

Definition at line 426 of file property.h.

◆ m_hideFromLibraryEditors

bool PROPERTY_BASE::m_hideFromLibraryEditors

privateinherited

Definition at line 424 of file property.h.

◆ m_hideFromPropertiesManager

bool PROPERTY_BASE::m_hideFromPropertiesManager

privateinherited

Definition at line 423 of file property.h.

◆ m_hideFromRulesEditor

bool PROPERTY_BASE::m_hideFromRulesEditor

privateinherited

Definition at line 428 of file property.h.

◆ m_name

const wxString PROPERTY_BASE::m_name

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

◆ m_ownerHash

template<typename Owner , typename T , typename Base = Owner>

const size_t PROPERTY< Owner, T, Base >::m_ownerHash

protectedinherited

Base class type-id.

Definition at line 537 of file property.h.

Referenced by PROPERTY< Owner, T, Base >::OwnerHash().

◆ m_setter

template<typename Owner , typename T , typename Base = Owner>

std::unique_ptr<SETTER_BASE<Owner, T> > PROPERTY< Owner, T, Base >::m_setter

protectedinherited

Get method.

Definition at line 531 of file property.h.

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

◆ m_typeHash

template<typename Owner , typename T , typename Base = Owner>

const size_t PROPERTY< Owner, T, Base >::m_typeHash

protectedinherited

Definition at line 543 of file property.h.

Referenced by PROPERTY< Owner, T, Base >::TypeHash().

◆ m_validator

PROPERTY_VALIDATOR_FN PROPERTY_BASE::m_validator

privateinherited

Definition at line 437 of file property.h.

◆ m_writeableFunc

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

privateinherited

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

◆ BASE_TYPE

Constructor & Destructor Documentation

◆ PROPERTY_ENUM() [1/2]

◆ PROPERTY_ENUM() [2/2]

Member Function Documentation

◆ Available()

◆ BaseHash()

◆ Choices()

◆ CoordType()

◆ Display()

◆ get()

◆ getter()

◆ Group()

◆ HasChoices()

◆ IsHiddenFromDesignEditors()

◆ IsHiddenFromLibraryEditors()

◆ IsHiddenFromPropertiesManager()

◆ IsHiddenFromRulesEditor()

◆ Name()

◆ NullValidator()

◆ OwnerHash()

◆ set()

◆ SetAvailableFunc()

◆ SetChoices()

◆ SetCoordType()

◆ SetDisplay()

◆ SetGroup()

◆ SetIsHiddenFromDesignEditors()

◆ SetIsHiddenFromLibraryEditors()

◆ SetIsHiddenFromPropertiesManager()

◆ SetIsHiddenFromRulesEditor()

◆ setter()

◆ SetValidator()

◆ SetWriteableFunc()

◆ TypeHash()

◆ Validate()

◆ Writeable()

Member Data Documentation

◆ m_availFunc

◆ m_baseHash

◆ m_choices

◆ m_coordType

◆ m_display

◆ m_getter

◆ m_group

◆ m_hideFromDesignEditors

◆ m_hideFromLibraryEditors

◆ m_hideFromPropertiesManager

◆ m_hideFromRulesEditor

◆ m_name

◆ m_ownerHash

◆ m_setter

◆ m_typeHash

◆ m_validator

◆ m_writeableFunc