Kanzi  3.9.4
Kanzi Engine API
kanzi::PropertyType< Type, typename enable_if< is_enum< Type >::value >::type > Class Template Reference

Specialization for PropertyType for enums. See PropertyType. More...

#include <kanzi/core/property/property_type.hpp>

Classes

struct  Traits
 

Public Types

typedef Type DataType
 
typedef PropertyTypeDescriptor< int > Descriptor
 

Public Member Functions

Descriptorget () const
 
uint32_t getChangeFlags () const
 Gets the change flags for a property type. More...
 
PropertyDataType getDataType () const
 Gets the data type of a property type. More...
 
Traits::ReturnType getDefaultValue () const
 Gets the default value of a property type. More...
 
PropertyTypeEditorInfoSharedPtr getEditorInfo () const
 Gets the editor information of a property type. More...
 
const char * getName () const
 Gets the fully qualified name of a property type in the form "Class.PropertyType". More...
 
const char * getUnqualifiedName () const
 Gets the unqualified name of a property type in the form "PropertyType". More...
 
bool isInherited () const
 Returns whether a property type is inheritable. More...
 
 operator AbstractPropertyType () const
 
 PropertyType (FixedString name, Type defaultValue, uint32_t changeFlags, bool inheritable)
 
 PropertyType (MetadataGeneratedName name, Type defaultValue, uint32_t changeFlags, bool inheritable)
 
 PropertyType (FixedString name, Type defaultValue, uint32_t changeFlags, bool inheritable, PropertyTypeEditorInfoSharedPtr editorInfo)
 
 PropertyType (MetadataGeneratedName name, Type defaultValue, uint32_t changeFlags, bool inheritable, PropertyTypeEditorInfoSharedPtr editorInfo)
 
 ~PropertyType ()
 

Protected Member Functions

 PropertyType ()
 

Friends

class AbstractPropertyType
 
class DynamicPropertyType< Type >
 
class Node
 
class Object
 

Detailed Description

template<typename Type>
class kanzi::PropertyType< Type, typename enable_if< is_enum< Type >::value >::type >

Specialization for PropertyType for enums. See PropertyType.

Member Typedef Documentation

◆ DataType

template<typename Type >
typedef Type kanzi::PropertyType< Type, typename enable_if< is_enum< Type >::value >::type >::DataType

◆ Descriptor

template<typename Type >
typedef PropertyTypeDescriptor<int> kanzi::PropertyType< Type, typename enable_if< is_enum< Type >::value >::type >::Descriptor

Constructor & Destructor Documentation

◆ PropertyType() [1/5]

template<typename Type >
kanzi::PropertyType< Type, typename enable_if< is_enum< Type >::value >::type >::PropertyType ( FixedString  name,
Type  defaultValue,
uint32_t  changeFlags,
bool  inheritable 
)
inlineexplicit

◆ PropertyType() [2/5]

template<typename Type >
kanzi::PropertyType< Type, typename enable_if< is_enum< Type >::value >::type >::PropertyType ( MetadataGeneratedName  name,
Type  defaultValue,
uint32_t  changeFlags,
bool  inheritable 
)
inlineexplicit

◆ PropertyType() [3/5]

template<typename Type >
kanzi::PropertyType< Type, typename enable_if< is_enum< Type >::value >::type >::PropertyType ( FixedString  name,
Type  defaultValue,
uint32_t  changeFlags,
bool  inheritable,
PropertyTypeEditorInfoSharedPtr  editorInfo 
)
inlineexplicit

◆ PropertyType() [4/5]

template<typename Type >
kanzi::PropertyType< Type, typename enable_if< is_enum< Type >::value >::type >::PropertyType ( MetadataGeneratedName  name,
Type  defaultValue,
uint32_t  changeFlags,
bool  inheritable,
PropertyTypeEditorInfoSharedPtr  editorInfo 
)
inlineexplicit

◆ ~PropertyType()

template<typename Type >
kanzi::PropertyType< Type, typename enable_if< is_enum< Type >::value >::type >::~PropertyType ( )
inline

◆ PropertyType() [5/5]

template<typename Type >
kanzi::PropertyType< Type, typename enable_if< is_enum< Type >::value >::type >::PropertyType ( )
inlineexplicitprotected

Member Function Documentation

◆ operator AbstractPropertyType()

template<typename Type >
kanzi::PropertyType< Type, typename enable_if< is_enum< Type >::value >::type >::operator AbstractPropertyType ( ) const
inline

◆ getDefaultValue()

template<typename Type >
Traits::ReturnType kanzi::PropertyType< Type, typename enable_if< is_enum< Type >::value >::type >::getDefaultValue ( ) const
inline

Gets the default value of a property type.

When no other value is available, getProperty functions return the default value.

Returns
The default value of a property type.

◆ getName()

template<typename Type >
const char* kanzi::PropertyType< Type, typename enable_if< is_enum< Type >::value >::type >::getName ( ) const
inline

Gets the fully qualified name of a property type in the form "Class.PropertyType".

Returns
The fully qualified name of a property type.
See also
getUnqualifiedName()

◆ getUnqualifiedName()

template<typename Type >
const char* kanzi::PropertyType< Type, typename enable_if< is_enum< Type >::value >::type >::getUnqualifiedName ( ) const
inline

Gets the unqualified name of a property type in the form "PropertyType".

Returns
The unqualified name of a property type.
See also
getName()

◆ getDataType()

template<typename Type >
PropertyDataType kanzi::PropertyType< Type, typename enable_if< is_enum< Type >::value >::type >::getDataType ( ) const
inline

Gets the data type of a property type.

The data type of a property type defines the data representation type of each property value. For example, float.

Returns
The data type of a property type.

◆ isInherited()

template<typename Type >
bool kanzi::PropertyType< Type, typename enable_if< is_enum< Type >::value >::type >::isInherited ( ) const
inline

Returns whether a property type is inheritable.

Inheritable property types provide values to all descendant nodes.

Returns
If the property type is inheritable, true, otherwise false.

◆ getChangeFlags()

template<typename Type >
uint32_t kanzi::PropertyType< Type, typename enable_if< is_enum< Type >::value >::type >::getChangeFlags ( ) const
inline

Gets the change flags for a property type.

Change flags indicate whether a modification of property value invalidates a particular aspect of a node. For example, when you change the Node::HeightProperty or Node::WidthProperty in a node Kanzi recalculates the layout.

Returns
The change flags for a property type.

◆ getEditorInfo()

template<typename Type >
PropertyTypeEditorInfoSharedPtr kanzi::PropertyType< Type, typename enable_if< is_enum< Type >::value >::type >::getEditorInfo ( ) const
inline

Gets the editor information of a property type.

Returns
The editor information of a property type.

◆ get()

template<typename Type >
Descriptor* kanzi::PropertyType< Type, typename enable_if< is_enum< Type >::value >::type >::get ( ) const
inline

Friends And Related Function Documentation

◆ Object

template<typename Type >
friend class Object
friend

◆ Node

template<typename Type >
friend class Node
friend

◆ AbstractPropertyType

template<typename Type >
friend class AbstractPropertyType
friend

◆ DynamicPropertyType< Type >

template<typename Type >
friend class DynamicPropertyType< Type >
friend

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