A prefab template node contains information that is required to create node instances: the metaclass of the node, the (initial) property values of the node, information about the bindings and node components of the node, and the list of of child nodes. More...

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

Inheritance diagram for kanzi::PrefabTemplateNode:

[legend]

Public Types
typedef vector< BindingLoadInfo >	BindingContainer

typedef vector< PrefabTemplateNodeSharedPtr >	ChildContainer

typedef ChildContainer::const_iterator	ConstChildIterator

typedef set< NodeWeakPtr, owner_less< NodeWeakPtr > >	InstanceReferenceContainer

typedef vector< NodeComponentTemplateSharedPtr >	NodeComponentTemplateContainer

typedef unordered_set< PrefabTemplateNode * >	PlaceholderReferenceContainer

typedef vector< PropertyEntry >	PropertyContainer

typedef pair< AbstractPropertyType, Variant >	PropertyEntry

Public Types inherited from kanzi::PropertyObject
typedef PropertyStorageContainer::const_iterator	PropertyStorageConstIterator

typedef vector< PropertyStoragePtr >	PropertyStorageContainer

typedef PropertyStorageContainer::iterator	PropertyStorageIterator

typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStorage >	PropertyStoragePtr

typedef PropertyStorageContainer::reverse_iterator	PropertyStorageReverseIterator

Public Member Functions
void	addBinding (BindingLoadInfo createInfo)
	Adds a binding to the prefab template node. More...

void	addChild (PrefabTemplateNodeSharedPtr child)
	Adds a child for the prefab template node. More...

void	addProperty (AbstractPropertyType propertyType, const Variant &value)
	Adds a property value to the prefab template node. More...

void	addResourceDictionaryEntry (const ResourceID &resourceID, string_view resourceURL)
	Adds an entry to the resource dictionary of the prefab template node. More...

void	cleanupInstances ()
	Cleans up expired elements from instances. More...

const Metaclass *	getMetaclass () const
	Gets the metaclass of the prefab template node. More...

NodeSharedPtr	instantiate (NodeSharedPtr templateRoot)
	Creates a tree of nodes by instantiating a prefab template node and its children. More...

	PrefabTemplateNode (Domain *domain, string_view name)
	Constructor. More...

	~PrefabTemplateNode () override
	Destructor. More...

Public Member Functions inherited from kanzi::Resource
virtual unsigned int	getCPUMemoryUsage () const
	Function for getting the memory usage of a resource. More...

const string &	getName () const
	Gets the resource name. More...

const string &	getUrl () const
	Gets the resource URL. More...

bool	isKeepAlive () const
	Tells if the resource has keep alive flag set. More...

void	reload ()

void	reloadFromFile (string_view filePath)

void	reloadFromKzb (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)

void	setKeepAlive (bool keepAlive)
	Sets the keep alive flag. More...

void	setUrl (string_view url)
	Sets the resource URL. More...

	~Resource () override
	Destructor. More...

Public Member Functions inherited from kanzi::Object
AppliedStyleEntrySharedPtr	applyObjectStyle (kanzi::StyleSharedPtr style)
	Applies a style to an object. More...

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

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

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

MainLoopScheduler *	getMainLoopScheduler () const
	Returns the MainLoopScheduler instance of the associated Domain. More...

detail::MessageDispatcher *	getMessageDispatcher () const
	Returns the message dispatcher of the object. More...

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

ScriptingContextSharedPtr	getScriptingContext () const
	Gets the scripting context of the object. More...

	Object (Domain *domain)

void	setScriptingContext (ScriptingContextSharedPtr context)
	Sets the scripting context of the object. More...

void	unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)

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

	~Object () override

Public Member Functions inherited from kanzi::MetaObject
bool	isTypeOf (const Metaclass *objectType) const
	Determines if the type of this object is the given type or derived from it. More...

virtual	~MetaObject ()

Public Member Functions inherited from kanzi::PropertyObject
template<typename DataType >
void	addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)

template<typename DataType >
void	addPropertyModifierWithoutNotifyingHandlers (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
	Adds a property modifier without notifying handlers. More...

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

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

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

PropertyStorageContainer::iterator	beginPropertyStorage ()
	Returns the begin iterator to the internal property storage container. More...

PropertyStorageContainer::const_iterator	beginPropertyStorage () const
	Returns the begin iterator to the internal property storage container. More...

void	clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

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...

PropertyStorageContainer::iterator	endPropertyStorage ()
	Returns the end iterator to the internal property storage container. More...

PropertyStorageContainer::const_iterator	endPropertyStorage () const
	Returns the end iterator to the internal property storage container. More...

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

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 >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers, 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	getProperty (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property type. 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 >
size_t	getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const
	Gets number of current notification handlers for given property type. 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...

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

bool	isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const

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

	PropertyObject ()

void	removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties)
	Remove all KZB properties that are not included in a given set. More...

void	removeKzbProperties ()
	Remove all KZB properties. More...

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

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

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

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

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

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

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

void	setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

KZ_DEPRECATED void	validatePropertyModifiers (AbstractPropertyType propertyType)
	Validates property modifiers and notifies handlers. More...

void	validatePropertyModifiersAndNotifyHandlers (AbstractPropertyType propertyType)
	Validates property modifiers and notifies handlers. More...

virtual	~PropertyObject ()

Static Public Member Functions
static PrefabTemplateNodeSharedPtr	create (Domain domain, const Metaclass metaclass, string_view name)
	Creates a prefab template node that can be instantiated to create a node. More...

static PrefabTemplateNodeSharedPtr	createPlaceholder (Domain *domain, PrefabTemplateSharedPtr instantiatedPrefab, string_view name)
	Creates a prefab template node that can be instantiated to create an instance of another prefab 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...

Public Attributes
ChildContainer	children
	Child nodes. More...

InstanceReferenceContainer	instances
	Collection of node instances that have been created from this prefab template node. More...

BindingContainer	m_bindings
	Bindings to create on the instantiated node. More...

NodeComponentTemplateContainer	m_nodeComponentTemplates
	Node component templates from which node components are created for instantiated node. More...

PropertyContainer	m_properties
	Properties to write on the instantiated node. More...

ResourceDictionarySharedPtr	m_resourceDictionary
	Resource dictionary for the instantiated node. More...

PrefabTemplateSharedPtr	referencedPrefab
	Reference to another prefab template if the template node is a prefab placeholder. More...

PlaceholderReferenceContainer	referencingPlaceholders
	List of placeholders created to point to the prefab template that owns this prefab template node. More...

const Metaclass *	typeIdentifier
	The metaclass of the node. More...

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

Protected Member Functions inherited from kanzi::Resource
virtual unsigned int	getCPUMemoryUsageOverride () const

virtual void	reloadFromFileOverride (string_view filePath)

virtual void	reloadFromKzbOverride (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)

virtual void	reloadOverride ()

	Resource (Domain *domain, string_view name)
	Constructor. More...

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

void	onCopy (const Object &other)

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

	MetaObject ()

Protected Member Functions inherited from kanzi::PropertyObject
AbstractPropertyTypeDescriptor::ValueSourceEntry *	acquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Acquires a local value source entry that is free for the assignment of a value. More...

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

AbstractPropertyTypeDescriptor::NotificationStorage *	acquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)

PropertyStoragePtr	acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

template<typename DataType >
void	addPropertyModifierBase (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner, bool notify)
	Adds a property modifier entry to the property modifier stack and validates them. More...

void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, PropertyValuePrecedence precedence, void ownerPointer)
	Internally adds a property value source. More...

void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner owner)
	Internally adds a property value source. More...

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

PropertyStoragePtr	constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

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

AbstractPropertyTypeDescriptor::ModifierStorage *	findModifierStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::NotificationStorage *	findNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::PropertyStorage *	findPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
	Gets the property storage for given property type descriptor. More...

PropertyStoragePtr	findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
	Gets property storage intrusive pointer which you can use to hold a reference until the end of the operation. More...

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const
	Finds a property type descriptor by name and data type. More...

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names. More...

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names. More...

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

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

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

AbstractPropertyTypeDescriptor::ValueSource *	getTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
	Gets the top-level value source for a given property descriptor. More...

virtual void	notifyPropertyHandlers (PropertyStoragePtr &storagePtr, PropertyNotificationReason reason)
	Notifies all property handlers on a property storage. More...

void	onCopy (const PropertyObject &other)

void	removeLocalValue (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Removes a local value from the given property storage. More...

void	removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, void owner)
	Removes a property value source. More...

void	validatePropertyModifiers (PropertyStoragePtr &propertyStorage)
	Validates property modifiers without notifying handlers. More...

void	validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
	Validates property modifiers and notifies handlers. More...

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

Detailed Description

A prefab template node contains information that is required to create node instances: the metaclass of the node, the (initial) property values of the node, information about the bindings and node components of the node, and the list of of child nodes.

Typically prefab templates nodes are defined in Kanzi Studio and loaded from a kzb file as PrefabTemplate resources. A Prefab template contains a tree of prefab template nodes and can be used to instantiate a tree of nodes.

Note that nodes can be created also directly by using the create function in each Node class. You don't necessarily need to use PrefabTemplate or PrefabTemplateNode instances.

A prefab template node can represent either a normal node with a metaclass, or a placeholder that replaces itself with the root of another prefab template when instantiated. Prefab template nodes and their children should always form a simple tree structure. Creating a cycle with prefab placeholders is not allowed.

See also: PrefabTemplate

Member Typedef Documentation

typedef set<NodeWeakPtr, owner_less<NodeWeakPtr> > kanzi::PrefabTemplateNode::InstanceReferenceContainer

typedef unordered_set<PrefabTemplateNode*> kanzi::PrefabTemplateNode::PlaceholderReferenceContainer

typedef vector<PrefabTemplateNodeSharedPtr> kanzi::PrefabTemplateNode::ChildContainer

typedef ChildContainer::const_iterator kanzi::PrefabTemplateNode::ConstChildIterator

typedef vector<BindingLoadInfo> kanzi::PrefabTemplateNode::BindingContainer

typedef vector<NodeComponentTemplateSharedPtr> kanzi::PrefabTemplateNode::NodeComponentTemplateContainer

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

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

Constructor & Destructor Documentation

kanzi::PrefabTemplateNode::~PrefabTemplateNode ( )

override

Destructor.

kanzi::PrefabTemplateNode::PrefabTemplateNode	(	Domain *	domain,
		string_view	name
	)

explicit

Constructor.

Parameters

domain	The domain of the prefab template node.
name	The name of the prefab template node.

Member Function Documentation

static PrefabTemplateNodeSharedPtr kanzi::PrefabTemplateNode::create	(	Domain *	domain,
		const Metaclass *	metaclass,
		string_view	name
	)

static

Creates a prefab template node that can be instantiated to create a node.

Parameters

domain	The domain to use.
metaclass	The metaclass of the created node.
name	The name of the created node.

static PrefabTemplateNodeSharedPtr kanzi::PrefabTemplateNode::createPlaceholder	(	Domain *	domain,
		PrefabTemplateSharedPtr	instantiatedPrefab,
		string_view	name
	)

static

Creates a prefab template node that can be instantiated to create an instance of another prefab template.

Parameters

domain	The domain to use.
instantiatedPrefab	A reference to another prefab that will be instantiated in place of this prefab template node.
name	The name of the placeholder node. Overrides the name of the root node of the referenced prefab template.

NodeSharedPtr kanzi::PrefabTemplateNode::instantiate ( NodeSharedPtr templateRoot )

Creates a tree of nodes by instantiating a prefab template node and its children.

Parameters

templateRoot A Pointer to an existing node instance that will act as the template root for the instantiated node tree. Any ##Template bindings in the prefab resolve to this node. If the templateRoot is set to nullptr, the newly instantiated root node will act as the template root.

Returns: Pointer to the root node of the created node tree.

void kanzi::PrefabTemplateNode::addBinding ( BindingLoadInfo createInfo )

inline

Adds a binding to the prefab template node.

This binding will be added to the node on creation.

Parameters

createInfo Binding to add.

void kanzi::PrefabTemplateNode::addChild ( PrefabTemplateNodeSharedPtr child )

inline

Adds a child for the prefab template node.

Parameters

child Child prefab template node.

void kanzi::PrefabTemplateNode::addProperty	(	AbstractPropertyType	propertyType,
		const Variant &	value
	)

inline

Adds a property value to the prefab template node.

Parameters

propertyType	Property type to add.
value	Property value to add.

void kanzi::PrefabTemplateNode::addResourceDictionaryEntry	(	const ResourceID &	resourceID,
		string_view	resourceURL
	)

Adds an entry to the resource dictionary of the prefab template node.

If the prefab template node does not have a resource dictionary, this function creates the dictionary first.

Parameters

resourceID	The key of the dictionary entry.
resourceURL	The value of the dictionary entry.

const Metaclass* kanzi::PrefabTemplateNode::getMetaclass ( ) const

inline

Gets the metaclass of the prefab template node.

Returns: The metaclass of the prefab template node.

void kanzi::PrefabTemplateNode::cleanupInstances ( )

Cleans up expired elements from instances.

Only used when running inside Kanzi preview. Outside the Kanzi preview does not do anything.

Member Data Documentation

ChildContainer kanzi::PrefabTemplateNode::children

Child nodes.

const Metaclass* kanzi::PrefabTemplateNode::typeIdentifier

The metaclass of the node.

PrefabTemplateSharedPtr kanzi::PrefabTemplateNode::referencedPrefab

Reference to another prefab template if the template node is a prefab placeholder.

If the prefab template node is not a placeholder, it needs to have a typeIdentifier.

InstanceReferenceContainer kanzi::PrefabTemplateNode::instances

Collection of node instances that have been created from this prefab template node.

Only used when running inside Kanzi preview. Outside the Kanzi preview the container is left empty.

PlaceholderReferenceContainer kanzi::PrefabTemplateNode::referencingPlaceholders

List of placeholders created to point to the prefab template that owns this prefab template node.

Only used when running inside Kanzi preview. Outside the Kanzi preview the container is left empty.

PropertyContainer kanzi::PrefabTemplateNode::m_properties

Properties to write on the instantiated node.

BindingContainer kanzi::PrefabTemplateNode::m_bindings

Bindings to create on the instantiated node.

NodeComponentTemplateContainer kanzi::PrefabTemplateNode::m_nodeComponentTemplates

Node component templates from which node components are created for instantiated node.

ResourceDictionarySharedPtr kanzi::PrefabTemplateNode::m_resourceDictionary

Resource dictionary for the instantiated node.

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

kanzi/core.ui/template/prefab.hpp

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation