Style applying properties, node components and bindings to nodes. More...

#include <kanzi/core.ui/style/style.hpp>

Inheritance diagram for kanzi::Style:

Classes
struct	BindingInfo
	Stored info for a binding. More...

Public Types
typedef vector< BindingInfo >	BindingContainer

typedef BindingContainer::const_iterator	BindingIterator

typedef vector< NodeComponentTemplateSharedPtr >	NodeComponentTemplateContainer

typedef NodeComponentTemplateContainer::const_iterator	NodeComponentTemplateIterator

typedef vector< Node * >	NodeContainer

typedef NodeContainer::const_iterator	NodeIterator

typedef NodeContainer::reverse_iterator	NodeReverseIterator

typedef vector< Object * >	ObjectContainer

typedef ObjectContainer::const_iterator	ObjectIterator

typedef ObjectContainer::reverse_iterator	ObjectReverseIterator

typedef PropertyContainer::const_iterator	PropertyConstIterator

typedef vector< PropertyPair >	PropertyContainer

typedef pair< AbstractPropertyType, Variant >	PropertyPair

typedef unordered_map< AbstractPropertyType, AbstractPropertyTypeDescriptor::ValueSource * >	ValueSourceContainer

typedef ValueSourceContainer::const_iterator	ValueSourceIterator

typedef pair< AbstractPropertyType, AbstractPropertyTypeDescriptor::ValueSource * >	ValueSourcePair

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
BindingIterator	beginBindings () const
	Gets an iterator to the beginning of container of bindings of a style.

NodeComponentTemplateIterator	beginNodeComponentTemplates () const
	Gets an iterator to the beginning of container of node component templates of a style.

ValueSourceIterator	beginProperties ()
	Gets an iterator to the beginning of container of properties of a style.

BindingIterator	endBindings () const
	Gets an iterator to the end of the container of bindings of a style.

NodeComponentTemplateIterator	endNodeComponentTemplates () const
	Gets an iterator to the end of the container of node component templates of a style.

ValueSourceIterator	endProperties ()
	Gets an iterator to the end of container of properties of a style.

StyleSharedPtr	getParent ()
	Gets the parent style for this style.

PropertyValuePrecedence	getPrecedence () const
	Gets the property value precedence the style should use.

AbstractPropertyTypeDescriptor::ValueSource *	getValueSource (AbstractPropertyType propertyType)
	Gets value source for a property type.

void	setPrecedence (PropertyValuePrecedence precedence)
	Sets style properties precedence.

	~Style () override

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

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

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

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

void	reload ()

void	reloadFromFile (string_view filePath)

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

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

void	setUrl (string_view url)
	Sets the resource URL.

	~Resource () override
	Destructor.

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

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

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

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

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

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

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

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

	Object (Domain *domain)

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

void	unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)

void	unapplyObjectStyles ()
	Unapplies and removes all applied styles.

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

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.

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, AbstractPropertyTypeDescriptor::ValueSourceOwner owner)

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

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

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

void	clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

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

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

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

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

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.

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.

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

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

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

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

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

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

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

bool	isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const

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

	PropertyObject ()

void	removeKzbProperties ()
	Remove all KZB properties.

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

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.

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.

void	setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

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

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

virtual	~PropertyObject ()

Static Public Member Functions
static void	apply (AppliedStyleEntrySharedPtr appliedStyleEntry, Node *node)
	Applies a style to a node.

static void	apply (AppliedStyleEntrySharedPtr appliedStyleEntry, Object *object)
	Applies a style to a generic object.

static void	applyAll (Node *node)
	Applies all styles to a node.

static Style *	copy (const Style *sourceStyle)
	Copy a style.

static StyleSharedPtr	create (Domain domain, string_view name, StyleSharedPtr parentStyle, const Metaclass objectType, const PropertyContainer &properties, const BindingContainer &bindings, const NodeComponentTemplateContainer &nodeComponentTemplates)

static Style *	createEmpty (Domain *domain, string_view name)
	Create an empty style.

static StyleSharedPtr	createWithValueModifiers (Domain domain, string_view name, StyleSharedPtr parentStyle, const Metaclass objectType, const PropertyContainer &properties, const BindingContainer &bindings, const NodeComponentTemplateContainer &nodeComponentTemplates)

static StyleSharedPtr	loadFromKZB (Domain *domain, string_view name, KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)
	Loads a style dictionary from a file.

static void	unapply (AppliedStyleEntrySharedPtr appliedStyleEntry, Node *node)
	Unapplies a style from a node.

static void	unapply (AppliedStyleEntrySharedPtr appliedStyleEntry, Object *object)
	Unapplies a style from a generic object.

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

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

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

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

Protected Member Functions
void	addValueSourcesToObject (AppliedStyleEntry &appliedStyleEntry, Object &object) const
	Sets value sources to an object.

void	cleanup ()
	Empties contents of a style.

void	copyParentProperties ()
	Copies parent style properties.

void	createValueSources (const PropertyContainer &properties)
	Extracts property metadata for a style.

void	removeValueSourcesFromObject (AppliedStyleEntry &appliedStyleEntry, Object &object) const
	Removes value sources from an object.

	Style (Domain *domain, string_view name)

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.

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.

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.

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

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

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

PropertyStoragePtr	constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

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

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.

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

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

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

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

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.

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

void	onCopy (const PropertyObject &other)

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

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

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

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

Static Protected Member Functions
static bool	applyTypedStyle (Node &target, const Node &scope)

static bool	applyTypedStyle (Node &target, const ResourceDictionary &dictionary)

static void	copyBindings (const BindingContainer &source, BindingContainer &target)
	Copies bindings from one array to another.

static Style *	createInternal (Domain domain, string_view name, StyleSharedPtr parentStyle, optional< const Metaclass > objectType, const PropertyContainer &properties, const ValueSourceContainer *hashProperties, const BindingContainer &bindings, const NodeComponentTemplateContainer &nodeComponents, bool useValueModifiers)
	Internal create function.

Protected Attributes
BindingContainer	m_bindings
	Bindings of this style.

NodeComponentTemplateContainer	m_nodeComponentTemplates
	Node component templates of this style.

optional< const Metaclass * >	m_objectType
	Object type this style applies to, nullptr if the style applies to any type, or nullopt if there is no target type.

StyleSharedPtr	m_parent
	Parent style.

PropertyValuePrecedence	m_precedence
	Property precedence of this style.

bool	m_useValueModifiers
	Does this style apply value modifiers or value sources.

ValueSourceContainer	m_valueSources
	Property values of this style. <KzuPropertyType, void* (value source)>.

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

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

Detailed Description

Style applying properties, node components and bindings to nodes.

Member Typedef Documentation

◆ NodeComponentTemplateContainer

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

◆ NodeComponentTemplateIterator

typedef NodeComponentTemplateContainer::const_iterator kanzi::Style::NodeComponentTemplateIterator

◆ BindingContainer

typedef vector<BindingInfo> kanzi::Style::BindingContainer

◆ BindingIterator

typedef BindingContainer::const_iterator kanzi::Style::BindingIterator

◆ NodeContainer

typedef vector<Node*> kanzi::Style::NodeContainer

◆ NodeIterator

typedef NodeContainer::const_iterator kanzi::Style::NodeIterator

◆ NodeReverseIterator

typedef NodeContainer::reverse_iterator kanzi::Style::NodeReverseIterator

◆ ObjectContainer

typedef vector<Object*> kanzi::Style::ObjectContainer

◆ ObjectIterator

typedef ObjectContainer::const_iterator kanzi::Style::ObjectIterator

◆ ObjectReverseIterator

typedef ObjectContainer::reverse_iterator kanzi::Style::ObjectReverseIterator

◆ ValueSourceContainer

typedef unordered_map<AbstractPropertyType, AbstractPropertyTypeDescriptor::ValueSource*> kanzi::Style::ValueSourceContainer

◆ ValueSourceIterator

typedef ValueSourceContainer::const_iterator kanzi::Style::ValueSourceIterator

◆ ValueSourcePair

typedef pair<AbstractPropertyType, AbstractPropertyTypeDescriptor::ValueSource*> kanzi::Style::ValueSourcePair

◆ PropertyPair

typedef pair<AbstractPropertyType, Variant> kanzi::Style::PropertyPair

◆ PropertyContainer

typedef vector<PropertyPair> kanzi::Style::PropertyContainer

◆ PropertyConstIterator

typedef PropertyContainer::const_iterator kanzi::Style::PropertyConstIterator

Constructor & Destructor Documentation

◆ ~Style()

kanzi::Style::~Style ( )

override

◆ Style()

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

protected

Member Function Documentation

◆ create()

static StyleSharedPtr kanzi::Style::create	(	Domain *	domain,
		string_view	name,
		StyleSharedPtr	parentStyle,
		const Metaclass *	objectType,
		const PropertyContainer &	properties,
		const BindingContainer &	bindings,
		const NodeComponentTemplateContainer &	nodeComponentTemplates )

static

◆ createWithValueModifiers()

static StyleSharedPtr kanzi::Style::createWithValueModifiers	(	Domain *	domain,
		string_view	name,
		StyleSharedPtr	parentStyle,
		const Metaclass *	objectType,
		const PropertyContainer &	properties,
		const BindingContainer &	bindings,
		const NodeComponentTemplateContainer &	nodeComponentTemplates )

static

◆ createEmpty()

static Style * kanzi::Style::createEmpty	(	Domain *	domain,
		string_view	name )

static

Create an empty style.

◆ copy()

static Style * kanzi::Style::copy ( const Style * sourceStyle )

static

Copy a style.

◆ loadFromKZB()

static StyleSharedPtr kanzi::Style::loadFromKZB	(	Domain *	domain,
		string_view	name,
		KzbFile &	kzbFile,
		ReadOnlyMemoryFile &	file,
		KzbMemoryParser &	parser )

static

Loads a style dictionary from a file.

Used internally by Kanzi Engine.

Parameters

domain	Domain
name	Name
kzbFile	KZB file where to load from.
file	Style file inside the KZB file where to load from.
parser	Parser pointing to the beginning of the file.

◆ beginProperties()

ValueSourceIterator kanzi::Style::beginProperties ( )

Gets an iterator to the beginning of container of properties of a style.

Returns: Iterator to the beginning of container of properties of a style.

◆ endProperties()

ValueSourceIterator kanzi::Style::endProperties ( )

Gets an iterator to the end of container of properties of a style.

Returns: Iterator to the end of container of properties of a style.

◆ getPrecedence()

PropertyValuePrecedence kanzi::Style::getPrecedence ( ) const

inline

Gets the property value precedence the style should use.

Generally this value should be PropertyValuePrecedenceStyle.

Returns: Precedence for the style.

◆ getParent()

StyleSharedPtr kanzi::Style::getParent ( )

inline

Gets the parent style for this style.

Returns: Parent style or nullptr if there is none.

◆ getValueSource()

AbstractPropertyTypeDescriptor::ValueSource * kanzi::Style::getValueSource ( AbstractPropertyType propertyType )

Gets value source for a property type.

◆ beginBindings()

BindingIterator kanzi::Style::beginBindings ( ) const

Gets an iterator to the beginning of container of bindings of a style.

Returns: Const iterator to the beginning of container of bindings of a style.

◆ endBindings()

BindingIterator kanzi::Style::endBindings ( ) const

Gets an iterator to the end of the container of bindings of a style.

Returns: Const iterator to the end of the container of bindings of a style.

◆ beginNodeComponentTemplates()

NodeComponentTemplateIterator kanzi::Style::beginNodeComponentTemplates ( ) const

Gets an iterator to the beginning of container of node component templates of a style.

Returns: Const iterator to the beginning of container of node component templates of a style.

◆ endNodeComponentTemplates()

NodeComponentTemplateIterator kanzi::Style::endNodeComponentTemplates ( ) const

Gets an iterator to the end of the container of node component templates of a style.

Returns: Const iterator to the end of the container of node component templates of a style.

◆ apply() [1/2]

static void kanzi::Style::apply	(	AppliedStyleEntrySharedPtr	appliedStyleEntry,
		Node *	node )

static

Applies a style to a node.

◆ unapply() [1/2]

static void kanzi::Style::unapply	(	AppliedStyleEntrySharedPtr	appliedStyleEntry,
		Node *	node )

static

Unapplies a style from a node.

◆ applyAll()

static void kanzi::Style::applyAll ( Node * node )

static

Applies all styles to a node.

◆ apply() [2/2]

static void kanzi::Style::apply	(	AppliedStyleEntrySharedPtr	appliedStyleEntry,
		Object *	object )

static

Applies a style to a generic object.

◆ unapply() [2/2]

static void kanzi::Style::unapply	(	AppliedStyleEntrySharedPtr	appliedStyleEntry,
		Object *	object )

static

Unapplies a style from a generic object.

◆ setPrecedence()

void kanzi::Style::setPrecedence ( PropertyValuePrecedence precedence )

Sets style properties precedence.

◆ applyTypedStyle() [1/2]

static bool kanzi::Style::applyTypedStyle	(	Node &	target,
		const ResourceDictionary &	dictionary )

staticprotected

◆ applyTypedStyle() [2/2]

static bool kanzi::Style::applyTypedStyle	(	Node &	target,
		const Node &	scope )

staticprotected

◆ copyBindings()

static void kanzi::Style::copyBindings	(	const BindingContainer &	source,
		BindingContainer &	target )

staticprotected

Copies bindings from one array to another.

◆ copyParentProperties()

void kanzi::Style::copyParentProperties ( )

protected

Copies parent style properties.

◆ createValueSources()

void kanzi::Style::createValueSources ( const PropertyContainer & properties )

protected

Extracts property metadata for a style.

◆ createInternal()

static Style * kanzi::Style::createInternal	(	Domain *	domain,
		string_view	name,
		StyleSharedPtr	parentStyle,
		optional< const Metaclass * >	objectType,
		const PropertyContainer &	properties,
		const ValueSourceContainer *	hashProperties,
		const BindingContainer &	bindings,
		const NodeComponentTemplateContainer &	nodeComponents,
		bool	useValueModifiers )

staticprotected

Internal create function.

◆ addValueSourcesToObject()

void kanzi::Style::addValueSourcesToObject	(	AppliedStyleEntry &	appliedStyleEntry,
		Object &	object ) const

protected

Sets value sources to an object.

Parameters

appliedStyleEntry	Applied style entry to use.
object	Target object.

◆ removeValueSourcesFromObject()

void kanzi::Style::removeValueSourcesFromObject	(	AppliedStyleEntry &	appliedStyleEntry,
		Object &	object ) const

protected

Removes value sources from an object.

Parameters

appliedStyleEntry	Applied style entry to use.
object	Target object.

◆ cleanup()

void kanzi::Style::cleanup ( )

protected

Empties contents of a style.

Member Data Documentation

◆ m_parent

StyleSharedPtr kanzi::Style::m_parent

protected

Parent style.

◆ m_objectType

optional<const Metaclass*> kanzi::Style::m_objectType

protected

Object type this style applies to, nullptr if the style applies to any type, or nullopt if there is no target type.

◆ m_useValueModifiers

bool kanzi::Style::m_useValueModifiers

protected

Does this style apply value modifiers or value sources.

◆ m_precedence

PropertyValuePrecedence kanzi::Style::m_precedence

protected

Property precedence of this style.

◆ m_valueSources

ValueSourceContainer kanzi::Style::m_valueSources

protected

Property values of this style. <KzuPropertyType, void* (value source)>.

◆ m_bindings

BindingContainer kanzi::Style::m_bindings

protected

Bindings of this style.

◆ m_nodeComponentTemplates

NodeComponentTemplateContainer kanzi::Style::m_nodeComponentTemplates

protected

Node component templates of this style.

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

kanzi/core.ui/style/style.hpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ NodeComponentTemplateContainer

◆ NodeComponentTemplateIterator

◆ BindingContainer

◆ BindingIterator

◆ NodeContainer

◆ NodeIterator

◆ NodeReverseIterator

◆ ObjectContainer

◆ ObjectIterator

◆ ObjectReverseIterator

◆ ValueSourceContainer

◆ ValueSourceIterator

◆ ValueSourcePair

◆ PropertyPair

◆ PropertyContainer

◆ PropertyConstIterator

Constructor & Destructor Documentation

◆ ~Style()

◆ Style()

Member Function Documentation

◆ create()

◆ createWithValueModifiers()

◆ createEmpty()

◆ copy()

◆ loadFromKZB()

◆ beginProperties()

◆ endProperties()

◆ getPrecedence()

◆ getParent()

◆ getValueSource()

◆ beginBindings()

◆ endBindings()

◆ beginNodeComponentTemplates()

◆ endNodeComponentTemplates()

◆ apply() [1/2]

◆ unapply() [1/2]

◆ applyAll()

◆ apply() [2/2]

◆ unapply() [2/2]

◆ setPrecedence()

◆ applyTypedStyle() [1/2]

◆ applyTypedStyle() [2/2]

◆ copyBindings()

◆ copyParentProperties()

◆ createValueSources()

◆ createInternal()

◆ addValueSourcesToObject()

◆ removeValueSourcesFromObject()

◆ cleanup()

Member Data Documentation

◆ m_parent

◆ m_objectType

◆ m_useValueModifiers

◆ m_precedence

◆ m_valueSources

◆ m_bindings

◆ m_nodeComponentTemplates