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

Inheritance diagram for kanzi::PrefabTemplateNode:

Public Types
typedef set< NodeWeakPtr, owner_less< NodeWeakPtr > >	InstanceReferenceContainer

typedef unordered_set< PrefabTemplateNode * >	PlaceholderReferenceContainer

typedef vector< PrefabTemplateNodeSharedPtr >	ChildContainer

typedef ChildContainer::const_iterator	ConstChildIterator

typedef vector< BindingSharedPtr >	BindingContainer

typedef vector< NodeComponentTemplateSharedPtr >	NodeComponentTemplateContainer

typedef pair< AbstractPropertyType, Variant >	PropertyEntry

typedef vector< PropertyEntry >	PropertyContainer

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
	PrefabTemplateNode (Domain *domain, string_view name)
	Constructor. More...

virtual	~PrefabTemplateNode () KZ_OVERRIDE
	Destructor. More...

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

BindingSharedPtr	createResourceBinding (const Variant &variant, AbstractPropertyType propertyType) const
	Create prefab-style binding. More...

void	addBinding (BindingSharedPtr binding)
	Add binding. More...

void	addProperty (AbstractPropertyType propertyType, const Variant &variant)
	Add property. More...

bool	isRoot () const
	Tell if this prefab template node is the root of a prefab template node tree. More...

void	setRoot (bool enabled)
	Set the node as being a root of prefab template node tree. More...

Public Member Functions inherited from kanzi::Resource
KzcMemoryManager *	getMemoryManager () const

	Resource (Domain *domain, string_view name)

virtual	~Resource ()

virtual void	loadFromKZB (const ResourceLoaderThreadContext threadContext, KzcInputStream inputStream, const KzuBinaryFileInfo *file)
	Function for loading the resource from .KZB. More...

virtual void	unloadOverride ()
	Unload function for resource. Releases all CPU memory taken by the resource except the resource loader. More...

virtual unsigned int	getCPUMemoryUsage () const
	Function for getting the memory usage of a resource. More...

void	setKZB (const KzuBinaryDirectory *binaryDirectory, string_view path)
	Set the binary directory and path of the resource. More...

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

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

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

void	setNotLoaded ()

bool	isFromKZB () const

void	reload ()

void	reloadFromKzb (KzcInputStream inputStream, const KzuBinaryFileInfo file)

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

void	reloadFromFile (string_view filePath)

void	load ()

void	unload ()

bool	isLoaded () const

void	kzuResourceLoad_private (const ResourceLoaderThreadContext *threadContext)
	Private function for kzuResourceLoad() with specified thread context. More...

void	kzuResourceFinishLoading_private (const ResourceLoaderThreadContext *threadContext)
	Private function for finishing the loading of the resource. More...

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

void	setKeepAlive (bool keepAlive)
	Sets the keep alive flag. 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...

Public Attributes
ChildContainer	children
	Child nodes. More...

string	name
	Name. More...

const Metaclass *	typeIdentifier
	Type identifier of the node. More...

InstanceReferenceContainer	instances
	Instances created from this prefab template node. More...

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

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

PropertyContainer	m_properties
	Properties to write on the instantiated 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...

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

string	m_host
	Host name property, if the instantiated node is a screen. More...

bool	m_isRoot
	Is this node the root of a prefab template node tree? More...

Additional Inherited Members
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 Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtr >	AppliedStyleContainer
	Applied style container. More...

Protected Member Functions inherited from kanzi::Resource
virtual void	reloadOverride ()

virtual void	reloadFromKzbOverride (KzcInputStream inputStream, const KzuBinaryFileInfo file)

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

virtual void	reloadFromFileOverride (string_view filePath)

virtual unsigned int	getCPUMemoryUsageOverride () const

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)

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::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 &propertyStorage)
	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)

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

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<BindingSharedPtr> 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	(	Domain *	domain,
		string_view	name
	)

explicit

Constructor.

virtual kanzi::PrefabTemplateNode::~PrefabTemplateNode ( )

virtual

Destructor.

Member Function Documentation

void kanzi::PrefabTemplateNode::cleanupInstances ( )

Clean up expired elements from instances.

BindingSharedPtr kanzi::PrefabTemplateNode::createResourceBinding	(	const Variant &	variant,
		AbstractPropertyType	propertyType
	)		const

Create prefab-style binding.

void kanzi::PrefabTemplateNode::addBinding ( BindingSharedPtr binding )

inline

Add binding.

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

inline

Add property.

Parameters

propertyType	Property type to add.
value	Value to add.

bool kanzi::PrefabTemplateNode::isRoot ( ) const

inline

Tell if this prefab template node is the root of a prefab template node tree.

void kanzi::PrefabTemplateNode::setRoot ( bool enabled )

inline

Set the node as being a root of prefab template node tree.

Member Data Documentation

ChildContainer kanzi::PrefabTemplateNode::children

Child nodes.

string kanzi::PrefabTemplateNode::name

Name.

const Metaclass* kanzi::PrefabTemplateNode::typeIdentifier

Type identifier of the node.

InstanceReferenceContainer kanzi::PrefabTemplateNode::instances

Instances created from this prefab template node.

PrefabTemplateSharedPtr kanzi::PrefabTemplateNode::referencedPrefab

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

PlaceholderReferenceContainer kanzi::PrefabTemplateNode::referencingPlaceholders

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

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.

string kanzi::PrefabTemplateNode::m_host

Host name property, if the instantiated node is a screen.

bool kanzi::PrefabTemplateNode::m_isRoot

Is this node the root of a prefab template node tree?

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

kanzi/core.ui/template/prefab.hpp

Public Types

Public Member Functions

Public Attributes

Additional Inherited Members

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation