NodeComponentTemplate is the base class for all node component templates. More...

#include <kanzi/core.ui/template/node_component_template.hpp>

Inheritance diagram for kanzi::NodeComponentTemplate:

Public Types
typedef pair< AbstractPropertyType, Variant >	PropertyEntry
	Type for property value. More...

typedef vector< PropertyEntry >	PropertyContainer
	Container type for property values. More...

typedef PropertyContainer::const_iterator	ConstPropertyIterator
	Iterator type for container of property values. More...

Public Types inherited from kanzi::PropertyObject
typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStorage >	PropertyStoragePtr

typedef vector< PropertyStoragePtr >	PropertyStorageContainer

typedef PropertyStorageContainer::iterator	PropertyStorageIterator

typedef PropertyStorageContainer::const_iterator	PropertyStorageConstIterator

typedef PropertyStorageContainer::reverse_iterator	PropertyStorageReverseIterator

Public Member Functions
virtual	~NodeComponentTemplate ()
	Destructor. More...

NodeComponentSharedPtr	instantiate ()
	Instantiates node component from the node component template. More...

virtual void	load (KzcInputStream inputStream, const KzuBinaryFileInfo file)
	Loads node component template data from KZB. More...

virtual void	load (KzbFile &kzbFile, KzbMemoryParser &parser)
	Loads node component template data from KZB. More...

void	addPropertyValue (AbstractPropertyType propertyType, Variant value)
	Adds a property to set when instantiating the template. More...

ConstPropertyIterator	beginProperties () const
	Gets iterator to the beginning of properties container of the template. More...

ConstPropertyIterator	endProperties () const
	Gets iterator to the end of properties container of the template. More...

Public Member Functions inherited from kanzi::Object
	Object (Domain *domain)

virtual	~Object ()

Domain *	getDomain () const
	Returns the domain the object belongs to. More...

KzuTaskScheduler *	getTaskScheduler () const
	Returns the task scheduler of the object. More...

KzuMessageDispatcher *	getMessageDispatcher () const
	Returns the message dispatcher of the object. More...

ResourceManager *	getResourceManager () const
	Returns the resource manager of the object. More...

virtual const Metaclass *	getDynamicMetaclass () const KZ_OVERRIDE
	Returns the metaclass of the dynamic type of the object. More...

AppliedStyleEntrySharedPtr	applyObjectStyle (kanzi::StyleSharedPtr style)
	Applies a style to an object. More...

void	unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)

void	applyObjectStyles ()
	Apply all styles for an object node. More...

void	unapplyObjectStyles ()
	Unapplies and removes all applied styles. More...

Public Member Functions inherited from kanzi::MetaObject
virtual	~MetaObject ()

bool	isTypeOf (const Metaclass *objectType) const
	Determines if the type of this object is the given type or derived from it. More...

Public Member Functions inherited from kanzi::PropertyObject
	PropertyObject ()

virtual	~PropertyObject ()

template<typename DataType >
void	setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
	Sets the local value of a property. More...

void	removeKzbProperties ()

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getProperty (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property. More...

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalProperty (const PropertyType< DataType > &propertyType) const
	Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. More...

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers. More...

template<typename DataType >
void	setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractProperty (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const

void	setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

bool	isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const

void	clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

bool	hasValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value. More...

bool	hasBaseValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value, disregarding modifiers. More...

bool	hasLocalValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a local value set for the property. More...

bool	hasNonClassValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a value of any precedence higher than class default value set for the property. More...

void	removeLocalValue (AbstractPropertyType propertyType)
	Removes the local value associated with the property. More...

void	copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
	Copies local value of single property from another object. More...

void	copyLocalValues (const PropertyObject &other)
	Copies all local values from another object. More...

virtual void	onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason)
	Virtual function to handle property change notifications. More...

template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, PropertyValuePrecedence precedence, void owner)

template<typename DataType >
void	removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, void owner)

template<typename DataType >
void	addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)

template<typename DataType >
void	removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)

void	validatePropertyModifiers (AbstractPropertyType propertyType)

template<typename DataType >
void	addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)

template<typename DataType >
void	removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)

template<typename DataType >
size_t	getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType)
	Gets number of current notification handlers for given property type. More...

Static Public Member Functions
static NodeComponentTemplateSharedPtr	create (Domain domain, string_view name, const Metaclass metaclass)
	Creates instance of node component template. More...

Static Public Member Functions inherited from kanzi::Object
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class. More...

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info. More...

Static Public Member Functions inherited from kanzi::MetaObject
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class. More...

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info. More...

Protected Member Functions
	NodeComponentTemplate (Domain domain, string_view name, const Metaclass nodeComponentMetaclass)
	Constructor. More...

virtual void	onInstantiate (NodeComponent &nodeComponent)
	Initializes instantiated node component. More...

void	copyProperties (NodeComponent &component) const
	Copies properties from the node component template to specified node component. More...

Protected Member Functions inherited from kanzi::Object
void	initialize ()

void	onCopy (const Object &other)

Protected Member Functions inherited from kanzi::MetaObject
	MetaObject ()

void	initialize ()

Protected Member Functions inherited from kanzi::PropertyObject
void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, PropertyValuePrecedence precedence, void owner)

void	removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, void owner)

AbstractPropertyTypeDescriptor::ValueSourceEntry *	getTopValueSourceEntry (AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage) const

AbstractPropertyTypeDescriptor::ValueSourceEntry *	getTopValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSourceEntry *	findLocalValueSourceEntry (AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

AbstractPropertyTypeDescriptor::ValueSourceEntry *	constructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

AbstractPropertyTypeDescriptor::ValueSourceEntry *	acquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)

AbstractPropertyTypeDescriptor::PropertyStorage *	findPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const

PropertyStoragePtr	findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
	Gets property storage intrusive pointer that can be used to hold a reference until end of operation. More...

PropertyStoragePtr	constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

PropertyStoragePtr	acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::ModifierStorage *	acquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

AbstractPropertyTypeDescriptor::ModifierStorage *	findModifierStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::NotificationStorage *	acquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::NotificationStorage *	findNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType)

void	validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)

void	copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
	Copy local value from property storage. More...

PropertyStorageContainer::iterator	beginPropertyStorage ()

PropertyStorageContainer::iterator	endPropertyStorage ()

virtual void	notifyPropertyHandlers (PropertyStoragePtr &propertyStorage, PropertyNotificationReason reason)

void	onCopy (const PropertyObject &other)

Additional Inherited Members
Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtr >	AppliedStyleContainer
	Applied style container. More...

Protected Attributes inherited from kanzi::Object
AppliedStyleContainer	m_appliedStyles
	Listing of applied styles applied to this object. More...

Detailed Description

NodeComponentTemplate is the base class for all node component templates.

Node component template contains data and logic for instantiating node components of specific type.

Member Typedef Documentation

typedef pair<AbstractPropertyType, Variant> kanzi::NodeComponentTemplate::PropertyEntry

Type for property value.

typedef vector<PropertyEntry> kanzi::NodeComponentTemplate::PropertyContainer

Container type for property values.

typedef PropertyContainer::const_iterator kanzi::NodeComponentTemplate::ConstPropertyIterator

Iterator type for container of property values.

Constructor & Destructor Documentation

virtual kanzi::NodeComponentTemplate::~NodeComponentTemplate ( )

virtual

Destructor.

kanzi::NodeComponentTemplate::NodeComponentTemplate	(	Domain *	domain,
		string_view	name,
		const Metaclass *	nodeComponentMetaclass
	)

explicitprotected

Constructor.

Parameters

domain	Domain.
name	Name to use for instantiated node components.
nodeComponentMetaclass	Metaclass from which node component is created.

Member Function Documentation

static NodeComponentTemplateSharedPtr kanzi::NodeComponentTemplate::create	(	Domain *	domain,
		string_view	name,
		const Metaclass *	metaclass
	)

static

Creates instance of node component template.

Parameters

domain	Domain.
name	Name to assign to every instanced node component.
metaclass	Metaclass to create node components from.

Returns: Node component template.

NodeComponentSharedPtr kanzi::NodeComponentTemplate::instantiate ( )

Instantiates node component from the node component template.

Returns: Instanced node component.

virtual void kanzi::NodeComponentTemplate::load	(	KzcInputStream *	inputStream,
		const KzuBinaryFileInfo *	file
	)

virtual

Loads node component template data from KZB.

Subclasses of NodeComponentTemplate can override this function to load type-specific data. In this case overriden function should call load() of base class before loading type-specific data.

Parameters

domain	Domain.
inputStream	Input stream to load node component template from.
file	File in KZB to load node component template from.

Returns: Loaded node component template.

Reimplemented in kanzi::TriggerTemplate.

virtual void kanzi::NodeComponentTemplate::load	(	KzbFile &	kzbFile,
		KzbMemoryParser &	parser
	)

virtual

Loads node component template data from KZB.

Subclasses of NodeComponentTemplate can override this function to load type-specific data. In this case overriden function should call load() of base class before loading type-specific data.

Parameters

domain	Domain.
kzbFile	KZB to load node component template from.
parser	Parser to parse node component template data.

Returns: Loaded node component template.

Reimplemented in kanzi::TriggerTemplate.

void kanzi::NodeComponentTemplate::addPropertyValue	(	AbstractPropertyType	propertyType,
		Variant	value
	)

inline

Adds a property to set when instantiating the template.

Parameters

propertyType	Property type.
value	Property value.

ConstPropertyIterator kanzi::NodeComponentTemplate::beginProperties ( ) const

inline

Gets iterator to the beginning of properties container of the template.

Returns: Const iterator to the beginning of properties container.

ConstPropertyIterator kanzi::NodeComponentTemplate::endProperties ( ) const

inline

Gets iterator to the end of properties container of the template.

Returns: Const iterator to the end of properties container.

virtual void kanzi::NodeComponentTemplate::onInstantiate ( NodeComponent & nodeComponent )

protectedvirtual

Initializes instantiated node component.

Subclasses of NodeComponentTemplate can override this function to implemented additional initialization logic for node components of specific type. Overriden function should call onInstantiate() of base class before performing custom initialization logic.

Parameters

nodeComponent Node component to copy data to.

Reimplemented in kanzi::TriggerTemplate.

void kanzi::NodeComponentTemplate::copyProperties ( NodeComponent & component ) const

protected

Copies properties from the node component template to specified node component.

Parameters

component Node component to copy properties to.

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

kanzi/core.ui/template/node_component_template.hpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation