Kanzi  3.9.5
Kanzi Engine API
kanzi::PropertyTypeEditorInfo::AttributeDictionary Struct Reference

#include <kanzi/core/metadata/editor_metadata.hpp>

Public Types

typedef Dictionary::const_iterator AttributeIterator
 

Public Member Functions

AttributeIterator begin () const
 
AttributeIterator end () const
 
AttributeIterator find (const string &key) const
 
string & operator[] (const string &key)
 

Public Attributes

string category
 Category name used in Kanzi Studio. More...
 
string defaultValue
 Default value for the property. More...
 
string displayName
 Friendly display name used in Kanzi Studio. More...
 
string editor
 Editor type used in Kanzi Studio. More...
 
string helpHeading
 Help heading used in Kanzi Studio. More...
 
string host
 Host definition that defines object types for which Kanzi Studio suggests the property. More...
 
string legacyName
 The property's old name. More...
 
string listenable
 Whether Kanzi Studio shows the message as a trigger. More...
 
string lowerBound
 Lowest value the property can have. More...
 
string sendable
 Whether Kanzi Studio shows the message as an action. More...
 
string sortingIndex
 Position of the property within its property category in Kanzi Studio. More...
 
string step
 Amount by which the property value changes when a Kanzi Studio user edits it. More...
 
string studioVisibility
 Whether the property or message is available in Kanzi Studio. More...
 
string tooltip
 Tooltip used in Kanzi Studio. More...
 
string upperBound
 Highest value the property can have. More...
 
string valueProvider
 Value provider used in Kanzi Studio. More...
 

Member Typedef Documentation

◆ AttributeIterator

Member Function Documentation

◆ begin()

AttributeIterator kanzi::PropertyTypeEditorInfo::AttributeDictionary::begin ( ) const
inline

◆ end()

AttributeIterator kanzi::PropertyTypeEditorInfo::AttributeDictionary::end ( ) const
inline

◆ operator[]()

string& kanzi::PropertyTypeEditorInfo::AttributeDictionary::operator[] ( const string &  key)
inline

◆ find()

AttributeIterator kanzi::PropertyTypeEditorInfo::AttributeDictionary::find ( const string &  key) const
inline

Member Data Documentation

◆ displayName

string kanzi::PropertyTypeEditorInfo::AttributeDictionary::displayName

Friendly display name used in Kanzi Studio.

◆ tooltip

string kanzi::PropertyTypeEditorInfo::AttributeDictionary::tooltip

Tooltip used in Kanzi Studio.

◆ category

string kanzi::PropertyTypeEditorInfo::AttributeDictionary::category

Category name used in Kanzi Studio.

◆ helpHeading

string kanzi::PropertyTypeEditorInfo::AttributeDictionary::helpHeading

Help heading used in Kanzi Studio.

◆ valueProvider

string kanzi::PropertyTypeEditorInfo::AttributeDictionary::valueProvider

Value provider used in Kanzi Studio.

◆ host

string kanzi::PropertyTypeEditorInfo::AttributeDictionary::host

Host definition that defines object types for which Kanzi Studio suggests the property.

◆ editor

string kanzi::PropertyTypeEditorInfo::AttributeDictionary::editor

Editor type used in Kanzi Studio.

◆ defaultValue

string kanzi::PropertyTypeEditorInfo::AttributeDictionary::defaultValue

Default value for the property.

◆ lowerBound

string kanzi::PropertyTypeEditorInfo::AttributeDictionary::lowerBound

Lowest value the property can have.

◆ upperBound

string kanzi::PropertyTypeEditorInfo::AttributeDictionary::upperBound

Highest value the property can have.

◆ step

string kanzi::PropertyTypeEditorInfo::AttributeDictionary::step

Amount by which the property value changes when a Kanzi Studio user edits it.

◆ sendable

string kanzi::PropertyTypeEditorInfo::AttributeDictionary::sendable

Whether Kanzi Studio shows the message as an action.

◆ listenable

string kanzi::PropertyTypeEditorInfo::AttributeDictionary::listenable

Whether Kanzi Studio shows the message as a trigger.

◆ studioVisibility

string kanzi::PropertyTypeEditorInfo::AttributeDictionary::studioVisibility

Whether the property or message is available in Kanzi Studio.

◆ legacyName

string kanzi::PropertyTypeEditorInfo::AttributeDictionary::legacyName

The property's old name.

◆ sortingIndex

string kanzi::PropertyTypeEditorInfo::AttributeDictionary::sortingIndex

Position of the property within its property category in Kanzi Studio.


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