Custom item definitions inherit from from a specialization of this template class, using the corresponding custom item type as the template parameter. More...
#include <CustomItemDefinition.h>
Inheritance diagram for smtk::attribute::CustomItemDefinition< ItemType >:
Collaboration diagram for smtk::attribute::CustomItemDefinition< ItemType >:
Public Types | |
| typedef std::shared_ptr< CustomItemDefinition > | Ptr |
Public Member Functions | |
| CustomItemDefinition (const std::string &myName) | |
| Item::Type | type () const override |
| ItemPtr | buildItem (Attribute *owningAttribute, int itemPosition) const override |
| ItemPtr | buildItem (Item *owningItem, int position, int subGroupPosition) const override |
 Public Member Functions inherited from smtk::attribute::CustomItemBaseDefinition | |
| smtkTypeMacro (CustomItemBaseDefinition) | |
| CustomItemBaseDefinition (const std::string &myName) | |
| virtual const CustomItemBaseDefinition & | operator>> (nlohmann::json &json) const =0 |
| virtual CustomItemBaseDefinition & | operator<< (const nlohmann::json &json)=0 |
| virtual const CustomItemBaseDefinition & | operator>> (pugi::xml_node &node) const =0 |
| virtual CustomItemBaseDefinition & | operator<< (const pugi::xml_node &node)=0 |
| Public Member Functions inherited from smtk::attribute::ItemDefinition | |
| smtkTypeMacroBase (smtk::attribute::ItemDefinition) | |
| const std::string & | name () const |
| const std::string & | label () const |
| void | setLabel (const std::string &newLabel) |
| int | version () const |
| void | setVersion (int myVersion) |
| bool | isOptional () const |
| void | setIsOptional (bool isOptionalValue) |
| bool | isEnabledByDefault () const |
| void | setIsEnabledByDefault (bool isEnabledByDefaultValue) |
| const smtk::attribute::Categories & | categories () const |
| Returns the categories (both explicitly assigned and inherited) associated to the Item Definition. More... | |
| smtk::attribute::Categories::Set & | localCategories () |
| Returns the categories::Set explicitly assigned to the Items Definition. | |
| const smtk::attribute::Categories::Set & | localCategories () const |
| void | setLocalCategories (const smtk::attribute::Categories::Set &catSet) |
| Sets the local categories. More... | |
| unsigned int | advanceLevel (int mode=0) const |
| unsigned int | localAdvanceLevel (int mode=0) const |
| void | setLocalAdvanceLevel (int mode, unsigned int level) |
| void | setLocalAdvanceLevel (unsigned int level) |
| void | unsetLocalAdvanceLevel (int mode=0) |
| bool | hasLocalAdvanceLevelInfo (int mode=0) const |
| const std::string & | detailedDescription () const |
| void | setDetailedDescription (const std::string &text) |
| const std::string & | briefDescription () const |
| void | setBriefDescription (const std::string &text) |
| const Tags & | tags () const |
| return the smtk::attribute::Tags associated with the Definition | |
| const shared_ptr< units::System > & | unitsSystem () const |
| Return the unitsSystem of the Definition. | |
| virtual smtk::attribute::ItemDefinitionPtr | createCopy (smtk::attribute::ItemDefinition::CopyInfo &info) const =0 |
| Categories::CombinationMode | categoryInheritanceMode () const |
| Determines how the Definition should combine its local category Set with the category constraints being inherited from it's owning Attribute or Item Definition. | |
| void | setCategoryInheritanceMode (Categories::CombinationMode mode) |
| Determines how the Definition should combine its local category Set with the category constraints being inherited from it's owning Attribute or Item Definition. | |
| const Tag * | tag (const std::string &name) const |
| Return a pointer to a smtk::attribute::Tag with a given name. If the Tag does not exist, return a null pointer. | |
| Tag * | tag (const std::string &name) |
| Return a pointer to a smtk::attribute::Tag with a given name. If the Tag does not exist, return a null pointer. | |
| bool | addTag (const Tag &tag) |
| Add/Remove a smtk::attribute::Tag from a Definition. | |
| bool | removeTag (const std::string &name) |
| Add/Remove a smtk::attribute::Tag from a Definition. | |
Additional Inherited Members | |
| Protected Member Functions inherited from smtk::attribute::ItemDefinition | |
| ItemDefinition (const std::string &myname) | |
| void | copyTo (ItemDefinitionPtr def) const |
| virtual void | applyCategories (const smtk::attribute::Categories::Stack &inheritedFromParent, smtk::attribute::Categories &inheritedToParent) |
| virtual void | applyAdvanceLevels (const unsigned int &readLevelFromParent, const unsigned int &writeLevelFromParent) |
| virtual void | setUnitsSystem (const shared_ptr< units::System > &unitsSystem) |
| Set the unitsSystem of the Definition. More... | |
| Protected Attributes inherited from smtk::attribute::ItemDefinition | |
| int | m_version |
| bool | m_isOptional |
| bool | m_isEnabledByDefault |
| std::string | m_label |
| attribute::Categories::Set | m_localCategories |
| attribute::Categories | m_categories |
| std::string | m_detailedDescription |
| std::string | m_briefDescription |
| bool | m_hasLocalAdvanceLevelInfo [2] |
| unsigned int | m_localAdvanceLevel [2] |
| unsigned int | m_advanceLevel [2] |
| attribute::Tags | m_tags |
| Categories::CombinationMode | m_combinationMode |
| std::shared_ptr< units::System > | m_unitsSystem |
Detailed Description
template<typename ItemType>
class smtk::attribute::CustomItemDefinition< ItemType >
Custom item definitions inherit from from a specialization of this template class, using the corresponding custom item type as the template parameter.
The documentation for this class was generated from the following file:
- /home/docs/checkouts/readthedocs.org/user_builds/smtk/checkouts/latest/smtk/attribute/CustomItemDefinition.h
