|
KiCad PCB EDA Suite
|
Public Member Functions | |
| SCH_SHEET_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. | |
| const wxString & | Name () const |
| const wxString & | HelpString () const |
| PROPERTY_BASE & | SetHelpString (const wxString &aHelpString) |
| Set untranslated help text, marked with _HKI for translation extraction. | |
| virtual const wxPGChoices & | Choices () const |
| Return a limited set of possible values (e.g. | |
| virtual void | TranslateChoices () |
| 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) |
| virtual bool | IgnoreValue () const |
| virtual bool | Writeable (INSPECTABLE *aObject) const |
| 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) |
| 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 | |
| template<typename T> | |
| void | set (void *aObject, T aValue) |
| template<typename T> | |
| T | get (const void *aObject) const |
Private Member Functions | |
| void | setter (void *obj, wxAny &v) override |
| wxAny | getter (const void *obj) const override |
Private Attributes | |
| wxString | m_name |
| 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 |
| PROPERTY_VALIDATOR_FN | m_validator |
Definition at line 56 of file sch_sheet.cpp.
|
inline |
Definition at line 59 of file sch_sheet.cpp.
References _HKI, m_name, PROPERTY_BASE::PROPERTY_BASE(), and PROPERTY_BASE::SetGroup().
|
inlineinherited |
Return true if aObject offers this PROPERTY.
Definition at line 267 of file property.h.
References INSPECTABLE, and m_availFunc.
Referenced by BOOST_AUTO_TEST_CASE(), and PROPERTY_MANAGER::IsAvailableFor().
|
inlineoverridevirtual |
Return type-id of the Base class.
Implements PROPERTY_BASE.
Definition at line 67 of file sch_sheet.cpp.
References TYPE_HASH.
|
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 239 of file property.h.
References empty().
Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), PCB_PROPERTIES_PANEL::createPGProperty(), PGPropertyFactory(), and KICAD_DIFF::WxAnyToDiffValue().
|
inlineinherited |
Definition at line 329 of file property.h.
References m_coordType.
Referenced by PGPropertyFactory().
|
inlineinherited |
Definition at line 326 of file property.h.
References m_display.
Referenced by DIALOG_FIND_BY_PROPERTIES::formatValueForExpression(), and PGPropertyFactory().
Definition at line 442 of file property.h.
Referenced by INSPECTABLE::Get(), and INSPECTABLE::Get().
|
inlineinherited |
Definition at line 281 of file property.h.
References INSPECTABLE, and m_choicesFunc.
Referenced by PROPERTIES_PANEL::extractValueAndWritability(), and INSPECTABLE::Set().
|
inlineoverrideprivatevirtual |
Implements PROPERTY_BASE.
Definition at line 96 of file sch_sheet.cpp.
References SCHEMATIC::CurrentSheet(), SCHEMATIC::GetCurrentVariant(), SCH_SHEET::GetField(), SCH_FIELD::GetText(), m_name, SCH_ITEM::Schematic(), and text.
|
inlineinherited |
Definition at line 377 of file property.h.
References m_group.
Referenced by PCB_PROPERTIES_PANEL::buildContextMenu(), SCH_PROPERTIES_PANEL::buildContextMenu(), PCB_PROPERTIES_PANEL::isKeyEditable(), and SCH_PROPERTIES_PANEL::isKeyEditable().
|
inlinevirtualinherited |
Return true if this PROPERTY has a limited set of possible values.
Reimplemented in PROPERTY_ENUM< Owner, T, Base >.
Definition at line 259 of file property.h.
References m_choicesFunc.
Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), PCBEXPR_VAR_REF::ClassifyProperty(), PCB_PROPERTIES_PANEL::createPGProperty(), DIALOG_FIND_BY_PROPERTIES::formatValueForExpression(), PROPERTIES_PANEL::getItemValue(), KiWxAnyEquals(), PGPropertyFactory(), and KICAD_DIFF::WxAnyToDiffValue().
|
inlineinherited |
Definition at line 223 of file property.h.
References m_helpString.
Referenced by PL_PROPERTIES_PANEL::createPGProperty(), and PGPropertyFactory().
|
inlinevirtualinherited |
Reimplemented in DUMMY_PROPERTY< Owner, T, Base >.
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 370 of file property.h.
References m_copyable.
Referenced by plan().
|
inlineinherited |
Definition at line 357 of file property.h.
References m_hideFromDesignEditors.
|
inlineinherited |
Definition at line 350 of file property.h.
References m_hideFromLibraryEditors.
|
inlineinherited |
Definition at line 336 of file property.h.
References m_hideFromPropertiesManager.
Referenced by plan().
|
inlineinherited |
Definition at line 343 of file property.h.
References m_hideFromRulesEditor.
|
inlineinherited |
Definition at line 221 of file property.h.
References m_name.
Referenced by PROPERTY_MANAGER::AddProperty(), BOOST_AUTO_TEST_CASE(), MATCH_PROPERTIES_CATALOG::Copy(), PCB_PROPERTIES_PANEL::createPGProperty(), PL_PROPERTIES_PANEL::createPGProperty(), SCH_PROPERTIES_PANEL::createPGProperty(), KICAD_DIFF::DiffItemProperties(), GENERATOR_TOOL::GENERATOR_TOOL(), PROPERTY_MANAGER::GetCommonDynamicProperties(), PCB_PROPERTIES_PANEL::getItemValue(), PROPERTIES_PANEL::getItemValue(), SCH_PROPERTIES_PANEL::getItemValue(), PROPERTY_MANAGER::GetProperty(), DIALOG_FIND_BY_PROPERTIES::getVariantAwareValue(), PROPERTY_MANAGER::IsAvailableFor(), PCB_PROPERTIES_PANEL::isKeyEditable(), SCH_PROPERTIES_PANEL::isKeyEditable(), PROPERTY_MANAGER::IsWriteableFor(), PGPropertyFactory(), SCHEMATIC::SCHEMATIC(), and SCH_SYMBOL::SyncOtherUnits().
|
inlinestaticinherited |
Definition at line 391 of file property.h.
|
inlineoverridevirtual |
Return type-id of the Owner class.
Implements PROPERTY_BASE.
Definition at line 66 of file sch_sheet.cpp.
References TYPE_HASH.
Definition at line 398 of file property.h.
References EDA_ANGLE_VARIANT_DATA::Angle(), COLOR4D_VARIANT_DATA::Color(), getter(), STD_OPTIONAL_DOUBLE_VARIANT_DATA::OptValue(), STD_OPTIONAL_INT_VARIANT_DATA::OptValue(), setter(), and T.
Referenced by INSPECTABLE::Set(), INSPECTABLE::Set(), and INSPECTABLE::Set().
|
inlineinherited |
Set a callback function to determine whether an object provides this property.
Definition at line 275 of file property.h.
References INSPECTABLE, m_availFunc, and PROPERTY_BASE().
Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), BOARD_ITEM_DESC::BOARD_ITEM_DESC(), CLASS_D_DESC::CLASS_D_DESC(), DIMENSION_DESC::DIMENSION_DESC(), EDA_SHAPE_DESC::EDA_SHAPE_DESC(), EDA_TEXT_DESC::EDA_TEXT_DESC(), FOOTPRINT_DESC::FOOTPRINT_DESC(), LIB_SYMBOL_DESC::LIB_SYMBOL_DESC(), PAD_DESC::PAD_DESC(), PCB_BARCODE_DESC::PCB_BARCODE_DESC(), PCB_GRIDITEM_DESC::PCB_GRIDITEM_DESC(), PCB_SHAPE_DESC::PCB_SHAPE_DESC(), PCB_TUNING_PATTERN_DESC::PCB_TUNING_PATTERN_DESC(), PCB_VIA_STACK_DESC::PCB_VIA_STACK_DESC(), PCB_VIA_STITCH_DESC::PCB_VIA_STITCH_DESC(), PL_PROPERTIES_DESC::PL_PROPERTIES_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(), SCH_SYMBOL_PIN_MAP_NAME_PROPERTY::SCH_SYMBOL_PIN_MAP_NAME_PROPERTY(), TRACK_VIA_DESC::TRACK_VIA_DESC(), and ZONE_DESC::ZONE_DESC().
|
inlinevirtualinherited |
Set the possible values for for the property.
Reimplemented in PROPERTY_ENUM< Owner, T, Base >.
Definition at line 250 of file property.h.
Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), FOOTPRINT_DESC::FOOTPRINT_DESC(), and PCB_TUNING_PATTERN_DESC::PCB_TUNING_PATTERN_DESC().
|
inlineinherited |
Definition at line 289 of file property.h.
References INSPECTABLE, m_choicesFunc, and PROPERTY_BASE().
Referenced by EDA_TEXT_DESC::EDA_TEXT_DESC(), LIB_SYMBOL_DESC::LIB_SYMBOL_DESC(), PAD_DESC::PAD_DESC(), PL_PROPERTIES_DESC::PL_PROPERTIES_DESC(), SCH_ITEM_DESC::SCH_ITEM_DESC(), SCH_SYMBOL_DESC::SCH_SYMBOL_DESC(), SCH_SYMBOL_PIN_MAP_MODE_PROPERTY::SCH_SYMBOL_PIN_MAP_MODE_PROPERTY(), and SCH_SYMBOL_PIN_MAP_NAME_PROPERTY::SCH_SYMBOL_PIN_MAP_NAME_PROPERTY().
|
inlineinherited |
Definition at line 330 of file property.h.
References m_coordType, and PROPERTY_BASE().
|
inlineinherited |
Definition at line 327 of file property.h.
References m_display, and PROPERTY_BASE().
|
inlineinherited |
Definition at line 378 of file property.h.
References m_group, and PROPERTY_BASE().
Referenced by PROPERTY_MANAGER::AddProperty(), EDA_CUSTOM_PROPERTY::EDA_CUSTOM_PROPERTY(), PCB_FOOTPRINT_FIELD_PROPERTY::PCB_FOOTPRINT_FIELD_PROPERTY(), SCH_SHEET_FIELD_PROPERTY::SCH_SHEET_FIELD_PROPERTY(), SCH_SYMBOL_FIELD_PROPERTY::SCH_SYMBOL_FIELD_PROPERTY(), SCH_SYMBOL_PIN_MAP_ENTRY_PROPERTY::SCH_SYMBOL_PIN_MAP_ENTRY_PROPERTY(), SCH_SYMBOL_PIN_MAP_FOOTPRINT_PROPERTY::SCH_SYMBOL_PIN_MAP_FOOTPRINT_PROPERTY(), SCH_SYMBOL_PIN_MAP_MODE_PROPERTY::SCH_SYMBOL_PIN_MAP_MODE_PROPERTY(), and SCH_SYMBOL_PIN_MAP_NAME_PROPERTY::SCH_SYMBOL_PIN_MAP_NAME_PROPERTY().
|
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.
References m_helpString, and PROPERTY_BASE().
Referenced by PL_PROPERTIES_DESC::PL_PROPERTIES_DESC().
|
inlineinherited |
Definition at line 371 of file property.h.
References m_copyable, and PROPERTY_BASE().
Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), BOARD_ITEM_DESC::BOARD_ITEM_DESC(), DIMENSION_DESC::DIMENSION_DESC(), EDA_SHAPE_DESC::EDA_SHAPE_DESC(), EDA_TEXT_DESC::EDA_TEXT_DESC(), FOOTPRINT_DESC::FOOTPRINT_DESC(), PAD_DESC::PAD_DESC(), PCB_BARCODE_DESC::PCB_BARCODE_DESC(), PCB_REFERENCE_IMAGE_DESC::PCB_REFERENCE_IMAGE_DESC(), PCB_SHAPE_DESC::PCB_SHAPE_DESC(), PCB_TABLE_DESC::PCB_TABLE_DESC(), PCB_TARGET_DESC::PCB_TARGET_DESC(), PCB_TEXT_DESC::PCB_TEXT_DESC(), PCB_TEXTBOX_DESC::PCB_TEXTBOX_DESC(), TRACK_VIA_DESC::TRACK_VIA_DESC(), and ZONE_DESC::ZONE_DESC().
|
inlineinherited |
Definition at line 358 of file property.h.
References m_hideFromDesignEditors, and PROPERTY_BASE().
Referenced by SCH_ITEM_DESC::SCH_ITEM_DESC().
|
inlineinherited |
Definition at line 351 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(), PCB_FIELD_DESC::PCB_FIELD_DESC(), and SCH_ITEM_DESC::SCH_ITEM_DESC().
|
inlineinherited |
Definition at line 337 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().
|
inlineinherited |
Definition at line 344 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().
|
inlineoverrideprivatevirtual |
Implements PROPERTY_BASE.
Definition at line 71 of file sch_sheet.cpp.
References SCH_SHEET::AddField(), SCHEMATIC::CurrentSheet(), SCHEMATIC::GetCurrentVariant(), SCH_SHEET::GetField(), m_name, SCH_ITEM::Schematic(), SCH_FIELD::SetText(), and SHEET_USER.
|
inlineinherited |
Definition at line 380 of file property.h.
References m_validator, and PROPERTY_BASE().
Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), DIMENSION_DESC::DIMENSION_DESC(), EDA_SHAPE_DESC::EDA_SHAPE_DESC(), PAD_DESC::PAD_DESC(), PL_PROPERTIES_DESC::PL_PROPERTIES_DESC(), SCH_SHEET_DESC::SCH_SHEET_DESC(), TRACK_VIA_DESC::TRACK_VIA_DESC(), and ZONE_DESC::ZONE_DESC().
|
inlineinherited |
Definition at line 305 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().
|
inlinevirtualinherited |
Reimplemented in PROPERTY_ENUM< Owner, T, Base >.
Definition at line 245 of file property.h.
|
inlineoverridevirtual |
Return type-id of the property type.
Implements PROPERTY_BASE.
Definition at line 68 of file sch_sheet.cpp.
References TYPE_HASH.
|
inlineinherited |
Definition at line 386 of file property.h.
References m_validator.
Referenced by BOOST_AUTO_TEST_CASE(), and BOOST_AUTO_TEST_CASE().
|
inlinevirtualinherited |
Reimplemented in PROPERTY< Owner, T, Base >, PROPERTY< Owner, T, Owner >, SCH_SYMBOL_PIN_MAP_ENTRY_PROPERTY, and SCH_SYMBOL_PIN_MAP_FOOTPRINT_PROPERTY.
Definition at line 300 of file property.h.
References INSPECTABLE, and m_writeableFunc.
Referenced by KICAD_DIFF::ApplyPropertyResolutions(), BOOST_AUTO_TEST_CASE(), PROPERTY_MANAGER::IsWriteableFor(), and PROPERTY< Owner, T, Base >::Writeable().
|
privateinherited |
Eval to determine if prop is available.
Definition at line 493 of file property.h.
Referenced by Available(), PROPERTY_BASE(), and SetAvailableFunc().
|
privateinherited |
Definition at line 497 of file property.h.
Referenced by GetChoices(), HasChoices(), and SetChoicesFunc().
|
privateinherited |
The coordinate type controls how distances are mapped to the user coordinate system.
Definition at line 480 of file property.h.
Referenced by CoordType(), PROPERTY_BASE(), and SetCoordType().
|
privateinherited |
Definition at line 488 of file property.h.
Referenced by IsCopyable(), PROPERTY_BASE(), and SetIsCopyable().
|
privateinherited |
The display style controls how properties are edited in the properties manager GUI.
Definition at line 477 of file property.h.
Referenced by Display(), PROPERTY_BASE(), and SetDisplay().
|
privateinherited |
Optional group identifier.
Definition at line 491 of file property.h.
Referenced by Group(), and SetGroup().
|
privateinherited |
Optional help text, translated when the property grid control is created.
Definition at line 474 of file property.h.
Referenced by HelpString(), and SetHelpString().
|
privateinherited |
Definition at line 485 of file property.h.
Referenced by IsHiddenFromDesignEditors(), PROPERTY_BASE(), and SetIsHiddenFromDesignEditors().
|
privateinherited |
Definition at line 483 of file property.h.
Referenced by IsHiddenFromLibraryEditors(), PROPERTY_BASE(), and SetIsHiddenFromLibraryEditors().
|
privateinherited |
Definition at line 482 of file property.h.
Referenced by IsHiddenFromPropertiesManager(), PROPERTY_BASE(), and SetIsHiddenFromPropertiesManager().
|
privateinherited |
Definition at line 487 of file property.h.
Referenced by IsHiddenFromRulesEditor(), PROPERTY_BASE(), and SetIsHiddenFromRulesEditor().
|
private |
Definition at line 124 of file sch_sheet.cpp.
Referenced by getter(), SCH_SHEET_FIELD_PROPERTY(), and setter().
|
privateinherited |
Definition at line 499 of file property.h.
Referenced by SetValidator(), and Validate().
|
privateinherited |
Eval to determine if prop is read-only.
Definition at line 495 of file property.h.
Referenced by SetWriteableFunc(), and Writeable().