Inheritance diagram for PCB_FOOTPRINT_FIELD_PROPERTY:

Public Member Functions
	PCB_FOOTPRINT_FIELD_PROPERTY (const wxString &aName)

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

void	setter (void *obj, wxAny &v) override

wxAny	getter (const void *obj) 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
template<typename T>
void	set (void *aObject, T aValue)

template<typename T>
T	get (const void *aObject) const

Private Attributes
wxString	m_name

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

Detailed Description

Definition at line 53 of file pcb_properties_panel.cpp.

Constructor & Destructor Documentation

◆ PCB_FOOTPRINT_FIELD_PROPERTY()

PCB_FOOTPRINT_FIELD_PROPERTY::PCB_FOOTPRINT_FIELD_PROPERTY ( const wxString & aName )

inline

Definition at line 56 of file pcb_properties_panel.cpp.

References m_name, and PROPERTY_BASE::PROPERTY_BASE().

Member Function Documentation

◆ Available()

bool PROPERTY_BASE::Available ( INSPECTABLE * aObject ) const

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

◆ BaseHash()

size_t PCB_FOOTPRINT_FIELD_PROPERTY::BaseHash ( ) const

inlineoverridevirtual

Return type-id of the Base class.

Implements PROPERTY_BASE.

Definition at line 63 of file pcb_properties_panel.cpp.

References TYPE_HASH.

◆ Choices()

virtual const wxPGChoices & PROPERTY_BASE::Choices ( ) const

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

◆ CoordType()

ORIGIN_TRANSFORMS::COORD_TYPES_T PROPERTY_BASE::CoordType ( ) const

inlineinherited

Definition at line 308 of file property.h.

References m_coordType.

Referenced by PGPropertyFactory().

◆ Display()

PROPERTY_DISPLAY PROPERTY_BASE::Display ( ) const

inlineinherited

Definition at line 305 of file property.h.

References m_display.

Referenced by PGPropertyFactory().

◆ get()

template<typename T>

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

inlineprotectedinherited

Definition at line 406 of file property.h.

References getter(), and T.

Referenced by INSPECTABLE::Get(), and INSPECTABLE::Get().

◆ GetChoices()

wxPGChoices PROPERTY_BASE::GetChoices ( INSPECTABLE * aObject ) const

inlineinherited

Definition at line 265 of file property.h.

References INSPECTABLE, and m_choicesFunc.

Referenced by PROPERTIES_PANEL::extractValueAndWritability(), and INSPECTABLE::Set().

◆ getter()

wxAny PCB_FOOTPRINT_FIELD_PROPERTY::getter ( const void * obj ) const

inlineoverridevirtual

Implements PROPERTY_BASE.

Definition at line 93 of file pcb_properties_panel.cpp.

References FOOTPRINT::GetField(), EDA_TEXT::GetText(), m_name, and MISSING_FIELD_SENTINEL.

◆ Group()

wxString PROPERTY_BASE::Group ( ) const

inlineinherited

Definition at line 343 of file property.h.

References m_group.

◆ HasChoices()

virtual bool PROPERTY_BASE::HasChoices ( ) const

inlinevirtualinherited

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

◆ IsHiddenFromDesignEditors()

bool PROPERTY_BASE::IsHiddenFromDesignEditors ( ) const

inlineinherited

Definition at line 336 of file property.h.

References m_hideFromDesignEditors.

◆ IsHiddenFromLibraryEditors()

bool PROPERTY_BASE::IsHiddenFromLibraryEditors ( ) const

inlineinherited

Definition at line 329 of file property.h.

References m_hideFromLibraryEditors.

◆ IsHiddenFromPropertiesManager()

bool PROPERTY_BASE::IsHiddenFromPropertiesManager ( ) const

inlineinherited

Definition at line 315 of file property.h.

References m_hideFromPropertiesManager.

◆ IsHiddenFromRulesEditor()

bool PROPERTY_BASE::IsHiddenFromRulesEditor ( ) const

inlineinherited

Definition at line 322 of file property.h.

References m_hideFromRulesEditor.

◆ Name()

const wxString & PROPERTY_BASE::Name ( ) const

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

◆ NullValidator()

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

inlinestaticinherited

Definition at line 357 of file property.h.

◆ OwnerHash()

size_t PCB_FOOTPRINT_FIELD_PROPERTY::OwnerHash ( ) const

inlineoverridevirtual

Return type-id of the Owner class.

Implements PROPERTY_BASE.

Definition at line 62 of file pcb_properties_panel.cpp.

References TYPE_HASH.

◆ set()

template<typename T>

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

inlineprotectedinherited

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

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

◆ SetChoices()

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

inlinevirtualinherited

Set the possible values for for the property.

Reimplemented in PROPERTY_ENUM< Owner, T, Base >.

Definition at line 234 of file property.h.

◆ SetChoicesFunc()

PROPERTY_BASE & PROPERTY_BASE::SetChoicesFunc ( std::function< wxPGChoices(INSPECTABLE *)> aFunc )

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

◆ SetCoordType()

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

inlineinherited

Definition at line 309 of file property.h.

References m_coordType, and PROPERTY_BASE().

◆ SetDisplay()

PROPERTY_BASE & PROPERTY_BASE::SetDisplay ( PROPERTY_DISPLAY aDisplay )

inlineinherited

Definition at line 306 of file property.h.

References m_display, and PROPERTY_BASE().

◆ SetGroup()

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

inlineinherited

Definition at line 344 of file property.h.

References m_group, and PROPERTY_BASE().

Referenced by PROPERTY_MANAGER::AddProperty().

◆ SetIsHiddenFromDesignEditors()

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

inlineinherited

Definition at line 337 of file property.h.

References m_hideFromDesignEditors, and PROPERTY_BASE().

Referenced by SCH_ITEM_DESC::SCH_ITEM_DESC().

◆ SetIsHiddenFromLibraryEditors()

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

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

◆ SetIsHiddenFromPropertiesManager()

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

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

◆ SetIsHiddenFromRulesEditor()

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

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

◆ setter()

void PCB_FOOTPRINT_FIELD_PROPERTY::setter	(	void *	obj,
		wxAny &	v )

inlineoverridevirtual

Implements PROPERTY_BASE.

Definition at line 71 of file pcb_properties_panel.cpp.

References FOOTPRINT::Add(), FOOTPRINT::GetField(), m_name, EDA_TEXT::SetText(), and USER.

◆ SetValidator()

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

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

◆ SetWriteableFunc()

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

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

◆ TypeHash()

size_t PCB_FOOTPRINT_FIELD_PROPERTY::TypeHash ( ) const

inlineoverridevirtual

Return type-id of the property type.

Implements PROPERTY_BASE.

Definition at line 64 of file pcb_properties_panel.cpp.

References TYPE_HASH.

◆ Validate()

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

inlineinherited

Definition at line 352 of file property.h.

References m_validator.

Referenced by BOOST_AUTO_TEST_CASE().

◆ Writeable()

bool PCB_FOOTPRINT_FIELD_PROPERTY::Writeable ( INSPECTABLE * aObject ) const

inlineoverridevirtual

Reimplemented from PROPERTY_BASE.

Definition at line 66 of file pcb_properties_panel.cpp.

References PROPERTY_BASE::INSPECTABLE, 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 448 of file property.h.

Referenced by Available(), PROPERTY_BASE(), and SetAvailableFunc().

◆ m_choicesFunc

std::function<wxPGChoices(INSPECTABLE*)> PROPERTY_BASE::m_choicesFunc

privateinherited

Definition at line 452 of file property.h.

Referenced by GetChoices(), HasChoices(), and SetChoicesFunc().

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

Referenced by CoordType(), PROPERTY_BASE(), and SetCoordType().

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

Referenced by Display(), PROPERTY_BASE(), and SetDisplay().

◆ m_group

wxString PROPERTY_BASE::m_group

privateinherited

Optional group identifier.

Definition at line 446 of file property.h.

Referenced by Group(), and SetGroup().

◆ m_hideFromDesignEditors

bool PROPERTY_BASE::m_hideFromDesignEditors

privateinherited

Definition at line 441 of file property.h.

Referenced by IsHiddenFromDesignEditors(), PROPERTY_BASE(), and SetIsHiddenFromDesignEditors().

◆ m_hideFromLibraryEditors

bool PROPERTY_BASE::m_hideFromLibraryEditors

privateinherited

Definition at line 439 of file property.h.

Referenced by IsHiddenFromLibraryEditors(), PROPERTY_BASE(), and SetIsHiddenFromLibraryEditors().

◆ m_hideFromPropertiesManager

bool PROPERTY_BASE::m_hideFromPropertiesManager

privateinherited

Definition at line 438 of file property.h.

Referenced by IsHiddenFromPropertiesManager(), PROPERTY_BASE(), and SetIsHiddenFromPropertiesManager().

◆ m_hideFromRulesEditor

bool PROPERTY_BASE::m_hideFromRulesEditor

privateinherited

Definition at line 443 of file property.h.

Referenced by IsHiddenFromRulesEditor(), PROPERTY_BASE(), and SetIsHiddenFromRulesEditor().

◆ m_name

wxString PCB_FOOTPRINT_FIELD_PROPERTY::m_name

private

Definition at line 105 of file pcb_properties_panel.cpp.

Referenced by getter(), PCB_FOOTPRINT_FIELD_PROPERTY(), and setter().

◆ m_validator

PROPERTY_VALIDATOR_FN PROPERTY_BASE::m_validator

privateinherited

Definition at line 454 of file property.h.

Referenced by SetValidator(), and Validate().

◆ m_writeableFunc

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

privateinherited

Eval to determine if prop is read-only.

Definition at line 450 of file property.h.

Referenced by SetWriteableFunc(), and Writeable().

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

pcb_properties_panel.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PCB_FOOTPRINT_FIELD_PROPERTY()

Member Function Documentation

◆ Available()

◆ BaseHash()

◆ Choices()

◆ CoordType()

◆ Display()

◆ get()

◆ GetChoices()

◆ getter()

◆ Group()

◆ HasChoices()

◆ IsHiddenFromDesignEditors()

◆ IsHiddenFromLibraryEditors()

◆ IsHiddenFromPropertiesManager()

◆ IsHiddenFromRulesEditor()

◆ Name()

◆ NullValidator()

◆ OwnerHash()

◆ set()

◆ SetAvailableFunc()

◆ SetChoices()

◆ SetChoicesFunc()

◆ SetCoordType()

◆ SetDisplay()

◆ SetGroup()

◆ SetIsHiddenFromDesignEditors()

◆ SetIsHiddenFromLibraryEditors()

◆ SetIsHiddenFromPropertiesManager()

◆ SetIsHiddenFromRulesEditor()

◆ setter()

◆ SetValidator()

◆ SetWriteableFunc()

◆ TypeHash()

◆ Validate()

◆ Writeable()

Member Data Documentation

◆ m_availFunc

◆ m_choicesFunc

◆ m_coordType

◆ m_display

◆ m_group

◆ m_hideFromDesignEditors

◆ m_hideFromLibraryEditors

◆ m_hideFromPropertiesManager

◆ m_hideFromRulesEditor

◆ m_name

◆ m_validator

◆ m_writeableFunc