kanzi::AbstractPropertyType Class Reference

AbstractPropertyType is a homogeneous property type handle. More...

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

Public Member Functions
	operator bool_type () const
AbstractPropertyTypeDescriptor *	get () const
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...
PropertyDataType	getDataType () const
	Gets the data type of a property type. More...
bool	isInherited () const
	Returns whether a property type is inheritable. More...
uint32_t	getChangeFlags () const
	Gets the change flags for a property type. More...
PropertyTypeEditorInfoSharedPtr	getEditorInfo () const
	Gets the editor information of a property type. More...
	AbstractPropertyType ()
	AbstractPropertyType (AbstractPropertyTypeDescriptor *descriptor)
	AbstractPropertyType (string_view name)

Friends
bool	operator== (const AbstractPropertyType &left, const AbstractPropertyType &right)
bool	operator!= (const AbstractPropertyType &left, const AbstractPropertyType &right)
bool	operator< (const AbstractPropertyType &left, const AbstractPropertyType &right)
bool	operator> (const AbstractPropertyType &left, const AbstractPropertyType &right)

Detailed Description

AbstractPropertyType is a homogeneous property type handle.

AbstractPropertyType can be used to operate on property types when the actual property type and its data type are unknown or irrelevant. To set or get property values a DynamicPropertyType with corresponding data type must be constructed from an AbstractPropertyType.

Constructor & Destructor Documentation

kanzi::AbstractPropertyType::AbstractPropertyType ( )

inlineexplicit

kanzi::AbstractPropertyType::AbstractPropertyType ( AbstractPropertyTypeDescriptor *  descriptor )

inlineexplicit

kanzi::AbstractPropertyType::AbstractPropertyType ( string_view  name )

inlineexplicit

Member Function Documentation

kanzi::AbstractPropertyType::operator bool_type ( ) const

inline

AbstractPropertyTypeDescriptor* kanzi::AbstractPropertyType::get ( ) const

inline

const char* kanzi::AbstractPropertyType::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()

const char* kanzi::AbstractPropertyType::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()

PropertyDataType kanzi::AbstractPropertyType::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.

bool kanzi::AbstractPropertyType::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.

uint32_t kanzi::AbstractPropertyType::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.

PropertyTypeEditorInfoSharedPtr kanzi::AbstractPropertyType::getEditorInfo ( ) const

inline

Gets the editor information of a property type.

Returns

The editor information of a property type.

Friends And Related Function Documentation

bool operator== ( const AbstractPropertyType &  left, const AbstractPropertyType &  right  )

friend

bool operator!= ( const AbstractPropertyType &  left, const AbstractPropertyType &  right  )

friend

bool operator< ( const AbstractPropertyType &  left, const AbstractPropertyType &  right  )

friend

bool operator> ( const AbstractPropertyType &  left, const AbstractPropertyType &  right  )

friend

---

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

• kanzi/core/property/abstract_property_type.hpp