Kanzi  3.9.7
Kanzi Engine API
kanzi::Style Class Reference

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

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

Inheritance diagram for kanzi::Style:
[legend]

Classes

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

Public Types

typedef vector< BindingInfoBindingContainer
 
typedef BindingContainer::const_iterator BindingIterator
 
typedef vector< NodeComponentTemplateSharedPtrNodeComponentTemplateContainer
 
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< PropertyPairPropertyContainer
 
typedef pair< AbstractPropertyType, VariantPropertyPair
 
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< PropertyStoragePtrPropertyStorageContainer
 
typedef PropertyStorageContainer::iterator PropertyStorageIterator
 
typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStoragePropertyStoragePtr
 
typedef PropertyStorageContainer::reverse_iterator PropertyStorageReverseIterator
 

Public Member Functions

BindingIterator beginBindings () const
 Gets an iterator to the beginning of container of bindings of a style. More...
 
NodeComponentTemplateIterator beginNodeComponentTemplates () const
 Gets an iterator to the beginning of container of node component templates of a style. More...
 
ValueSourceIterator beginProperties ()
 Gets an iterator to the beginning of container of properties of a style. More...
 
BindingIterator endBindings () const
 Gets an iterator to the end of the container of bindings of a style. More...
 
NodeComponentTemplateIterator endNodeComponentTemplates () const
 Gets an iterator to the end of the container of node component templates of a style. More...
 
ValueSourceIterator endProperties ()
 Gets an iterator to the end of container of properties of a style. More...
 
StyleSharedPtr getParent ()
 Gets the parent style for this style. More...
 
PropertyValuePrecedence getPrecedence () const
 Gets the property value precedence the style should use. More...
 
AbstractPropertyTypeDescriptor::ValueSourcegetValueSource (AbstractPropertyType propertyType)
 Gets value source for a property type. More...
 
void setPrecedence (PropertyValuePrecedence precedence)
 Sets style properties precedence. More...
 
 ~Style () override
 
- 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...
 
DomaingetDomain () const
 Returns the domain the object belongs to. More...
 
const MetaclassgetDynamicMetaclass () const override
 Returns the metaclass of the dynamic type of the object. More...
 
MainLoopSchedulergetMainLoopScheduler () const
 Returns the MainLoopScheduler instance of the associated Domain. More...
 
detail::MessageDispatcher * getMessageDispatcher () const
 Returns the message dispatcher of the object. More...
 
ResourceManagergetResourceManager () 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 void apply (AppliedStyleEntrySharedPtr appliedStyleEntry, Node *node)
 Applies a style to a node. More...
 
static void apply (AppliedStyleEntrySharedPtr appliedStyleEntry, Object *object)
 Applies a style to a generic object. More...
 
static void applyAll (Node *node)
 Applies all styles to a node. More...
 
static Stylecopy (const Style *sourceStyle)
 Copy a style. More...
 
static StyleSharedPtr create (Domain *domain, string_view name, StyleSharedPtr parentStyle, const Metaclass *objectType, const PropertyContainer &properties, const BindingContainer &bindings, const NodeComponentTemplateContainer &nodeComponentTemplates)
 
static StylecreateEmpty (Domain *domain, string_view name)
 Create an empty style. More...
 
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. More...
 
static void unapply (AppliedStyleEntrySharedPtr appliedStyleEntry, Node *node)
 Unapplies a style from a node. More...
 
static void unapply (AppliedStyleEntrySharedPtr appliedStyleEntry, Object *object)
 Unapplies a style from a generic object. More...
 
- Static Public Member Functions inherited from kanzi::Object
static const MetaclassgetStaticMetaclass ()
 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 MetaclassgetStaticMetaclass ()
 Returns the metaclass of Object class. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Default implementation that returns empty editor info. More...
 

Protected Member Functions

void addValueSourcesToObject (AppliedStyleEntry &appliedStyleEntry, Object &object) const
 Sets value sources to an object. More...
 
void cleanup ()
 Empties contents of a style. More...
 
void copyParentProperties ()
 Copies parent style properties. More...
 
void createValueSources (const PropertyContainer &properties)
 Extracts property metadata for a style. More...
 
void removeValueSourcesFromObject (AppliedStyleEntry &appliedStyleEntry, Object &object) const
 Removes value sources from an object. More...
 
 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. 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::ValueSourceEntryacquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
 Acquires a local value source entry that is free for the assignment of a value. More...
 
AbstractPropertyTypeDescriptor::ModifierStorageacquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
AbstractPropertyTypeDescriptor::NotificationStorageacquireNotificationStorage (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::ValueSourceEntryconstructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
PropertyStoragePtr constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
void copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
 Copy local value from property storage. More...
 
AbstractPropertyTypeDescriptor::ModifierStoragefindModifierStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::NotificationStoragefindNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::PropertyStoragefindPropertyStorage (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...
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const
 Finds a property type descriptor by name and data type. More...
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const
 Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names. More...
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const
 Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names. More...
 
AbstractPropertyTypeDescriptor::ValueSourcegetClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetTopValueSource (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...
 

Static Protected Member Functions

static bool applyTypedStyle (Node &target, const ResourceDictionary &dictionary)
 
static bool applyTypedStyle (Node &target, const Node &scope)
 
static void copyBindings (const BindingContainer &source, BindingContainer &target)
 Copies bindings from one array to another. More...
 
static StylecreateInternal (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. More...
 

Protected Attributes

BindingContainer m_bindings
 Bindings of this style. More...
 
NodeComponentTemplateContainer m_nodeComponentTemplates
 Node component templates of this style. More...
 
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. More...
 
StyleSharedPtr m_parent
 Parent style. More...
 
PropertyValuePrecedence m_precedence
 Property precedence of this style. More...
 
bool m_useValueModifiers
 Does this style apply value modifiers or value sources. More...
 
ValueSourceContainer m_valueSources
 Property values of this style. <KzuPropertyType, void* (value source)>. More...
 
- Protected Attributes inherited from kanzi::Object
AppliedStyleContainer m_appliedStyles
 Listing of applied styles applied to this object. More...
 

Additional Inherited Members

- Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtrAppliedStyleContainer
 Applied style container. More...
 

Detailed Description

Style applying properties, node components and bindings to nodes.

Member Typedef Documentation

typedef NodeComponentTemplateContainer::const_iterator kanzi::Style::NodeComponentTemplateIterator
typedef BindingContainer::const_iterator kanzi::Style::BindingIterator
typedef NodeContainer::const_iterator kanzi::Style::NodeIterator
typedef NodeContainer::reverse_iterator kanzi::Style::NodeReverseIterator
typedef ObjectContainer::const_iterator kanzi::Style::ObjectIterator
typedef ObjectContainer::reverse_iterator kanzi::Style::ObjectReverseIterator
typedef ValueSourceContainer::const_iterator kanzi::Style::ValueSourceIterator
typedef PropertyContainer::const_iterator kanzi::Style::PropertyConstIterator

Constructor & Destructor Documentation

kanzi::Style::~Style ( )
override
kanzi::Style::Style ( Domain domain,
string_view  name 
)
protected

Member Function Documentation

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
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
static Style* kanzi::Style::createEmpty ( Domain domain,
string_view  name 
)
static

Create an empty style.

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

Copy a style.

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
domainDomain
nameName
kzbFileKZB file where to load from.
fileStyle file inside the KZB file where to load from.
parserParser pointing to the beginning of the file.
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.
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.
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.
StyleSharedPtr kanzi::Style::getParent ( )
inline

Gets the parent style for this style.

Returns
Parent style or nullptr if there is none.
AbstractPropertyTypeDescriptor::ValueSource* kanzi::Style::getValueSource ( AbstractPropertyType  propertyType)

Gets value source for a property type.

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.
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.
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.
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.
static void kanzi::Style::apply ( AppliedStyleEntrySharedPtr  appliedStyleEntry,
Node node 
)
static

Applies a style to a node.

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

Unapplies a style from a node.

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

Applies all styles to a node.

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

Applies a style to a generic object.

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

Unapplies a style from a generic object.

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

Sets style properties precedence.

static bool kanzi::Style::applyTypedStyle ( Node target,
const ResourceDictionary dictionary 
)
staticprotected
static bool kanzi::Style::applyTypedStyle ( Node target,
const Node scope 
)
staticprotected
static void kanzi::Style::copyBindings ( const BindingContainer source,
BindingContainer target 
)
staticprotected

Copies bindings from one array to another.

void kanzi::Style::copyParentProperties ( )
protected

Copies parent style properties.

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

Extracts property metadata for a style.

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.

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

Sets value sources to an object.

Parameters
appliedStyleEntryApplied style entry to use.
objectTarget object.
void kanzi::Style::removeValueSourcesFromObject ( AppliedStyleEntry appliedStyleEntry,
Object object 
) const
protected

Removes value sources from an object.

Parameters
appliedStyleEntryApplied style entry to use.
objectTarget object.
void kanzi::Style::cleanup ( )
protected

Empties contents of a style.

Member Data Documentation

StyleSharedPtr kanzi::Style::m_parent
protected

Parent style.

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.

bool kanzi::Style::m_useValueModifiers
protected

Does this style apply value modifiers or value sources.

PropertyValuePrecedence kanzi::Style::m_precedence
protected

Property precedence of this style.

ValueSourceContainer kanzi::Style::m_valueSources
protected

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

BindingContainer kanzi::Style::m_bindings
protected

Bindings of this style.

NodeComponentTemplateContainer kanzi::Style::m_nodeComponentTemplates
protected

Node component templates of this style.


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