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:
kanzi::Resource kanzi::Object kanzi::MetaObject kanzi::PropertyObject

Public Types

typedef vector< NodeComponentTemplateSharedPtrNodeComponentTemplateContainer
 
typedef NodeComponentTemplateContainer::const_iterator NodeComponentTemplateIterator
 
typedef vector< BindingSharedPtrBindingContainer
 
typedef BindingContainer::const_iterator BindingIterator
 
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 unordered_map< AbstractPropertyType, AbstractPropertyTypeDescriptor::ValueSource * > ValueSourceContainer
 
typedef ValueSourceContainer::const_iterator ValueSourceIterator
 
typedef pair< AbstractPropertyType, AbstractPropertyTypeDescriptor::ValueSource * > ValueSourcePair
 
typedef pair< AbstractPropertyType, VariantPropertyPair
 
typedef vector< PropertyPairPropertyContainer
 
typedef PropertyContainer::const_iterator PropertyConstIterator
 
- Public Types inherited from kanzi::PropertyObject
typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStoragePropertyStoragePtr
 
typedef vector< PropertyStoragePtrPropertyStorageContainer
 
typedef PropertyStorageContainer::iterator PropertyStorageIterator
 
typedef PropertyStorageContainer::const_iterator PropertyStorageConstIterator
 
typedef PropertyStorageContainer::reverse_iterator PropertyStorageReverseIterator
 

Public Member Functions

virtual ~Style () KZ_OVERRIDE
 
virtual void loadFromKZB (const KzuResourceLoaderThreadContext *threadContext, KzcInputStream *inputStream, const KzuBinaryFileInfo *file) KZ_OVERRIDE
 Load a style from kzb. More...
 
ValueSourceIterator getPropertiesBegin ()
 Get the properties of a style. More...
 
ValueSourceIterator getPropertiesEnd ()
 
PropertyValuePrecedence getPrecedence () const
 
AbstractPropertyTypeDescriptor::ValueSourcegetValueSource (AbstractPropertyType propertyType)
 Get value source for a property type. More...
 
void setPrecedence (PropertyValuePrecedence precedence)
 Set style properties precedence. More...
 
- Public Member Functions inherited from kanzi::Resource
KzcMemoryManagergetMemoryManager () const
 
 Resource (Domain *domain, string_view name)
 
virtual ~Resource ()
 
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 KzuResourceLoaderThreadContext *threadContext)
 Private function for kzuResourceLoad() with specified thread context. More...
 
void kzuResourceFinishLoading_private (const KzuResourceLoaderThreadContext *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 ()
 
DomaingetDomain () const
 Returns the domain the object belongs to. More...
 
KzuTaskSchedulergetTaskScheduler () const
 Returns the task scheduler of the object. More...
 
KzuMessageDispatchergetMessageDispatcher () const
 Returns the message dispatcher of the object. More...
 
ResourceManagergetResourceManager () const
 Returns the resource manager of the object. More...
 
virtual const MetaclassgetDynamicMetaclass () const KZ_OVERRIDE
 Returns the metaclass of the dynamic type of the object. More...
 
AppliedStyleEntryapplyObjectStyle (kanzi::StyleSharedPtr style)
 Applies a style to an object. More...
 
void unapplyObjectStyle (AppliedStyleEntry *appliedStyleEntry)
 
void applyObjectStyles ()
 Apply all styles for an object node. More...
 
void unapplyObjectStyles ()
 Unapplies and removes all applied styles. More...
 
- Public Member Functions inherited from kanzi::MetaObject
virtual ~MetaObject ()
 
bool isTypeOf (const Metaclass *objectType) const
 Determines if the type of this object is the given type or derived from it. More...
 
- Public Member Functions inherited from kanzi::PropertyObject
 PropertyObject ()
 
virtual ~PropertyObject ()
 
template<typename DataType >
void setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
 Sets the local value of a property. More...
 
void removeKzbProperties ()
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getProperty (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property. More...
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalProperty (const PropertyType< DataType > &propertyType) const
 Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. More...
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getPropertyBase (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property disregarding modifiers. More...
 
template<typename DataType >
void setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
void setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
bool isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const
 
void clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
bool hasValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value. More...
 
bool hasBaseValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value, disregarding modifiers. More...
 
bool hasLocalValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a local value set for the property. More...
 
bool hasNonClassValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a value of any precedence higher than class default value set for the property. More...
 
void removeLocalValue (AbstractPropertyType propertyType)
 Removes the local value associated with the property. More...
 
void copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
 Copies local value of single property from another object. More...
 
void copyLocalValues (const PropertyObject &other)
 Copies all local values from another object. More...
 
virtual void onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason)
 Virtual function to handle property change notifications. More...
 
template<typename DataType >
void addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, void *owner)
 
template<typename DataType >
void removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *owner)
 
template<typename DataType >
void addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 
template<typename DataType >
void removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 
void validatePropertyModifiers (AbstractPropertyType propertyType)
 
template<typename DataType >
void addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
 
template<typename DataType >
void removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
 
template<typename DataType >
size_t getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType)
 Gets number of current notification handlers for given property type. More...
 

Static Public Member Functions

static StyleSharedPtr create (Domain *domain, string_view name, StyleSharedPtr parentStyle, const Metaclass *objectType, const PropertyContainer &properties, const BindingContainer &bindings, const NodeComponentTemplateContainer &nodeComponentTemplates)
 
static StyleSharedPtr createWithValueModifiers (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 Stylecopy (const Style *sourceStyle)
 Copy a style. More...
 
static StyleSharedPtr loadFromKZB (Domain *domain, string_view name, KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)
 Loads a style dictionary from a file. More...
 
static void apply (AppliedStyleEntry *appliedStyleEntry, Node *objectNode)
 Apply a style. More...
 
static void unapply (AppliedStyleEntry *appliedStyleEntry, Node *objectNode)
 Unapply a style. More...
 
static void applyAll (Node *applyObjectNode)
 Apply all styles to an object node. More...
 
static void apply (AppliedStyleEntry *appliedStyleEntry, Object *object)
 Apply a style (generic). More...
 
static void unapply (AppliedStyleEntry *appliedStyleEntry, Object *object)
 Unapply a style (generic). 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

 Style (Domain *domain, string_view name)
 
void copyParentProperties ()
 Copies parent style properties. More...
 
void createValueSources (const PropertyContainer &properties)
 Extracts property metadata for a style. More...
 
void cleanup ()
 Empties contents of a style. 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::ValueSourceEntrygetTopValueSourceEntry (AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage) const
 
AbstractPropertyTypeDescriptor::ValueSourceEntrygetTopValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourceEntryfindLocalValueSourceEntry (AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
AbstractPropertyTypeDescriptor::ValueSourceEntryconstructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
AbstractPropertyTypeDescriptor::ValueSourceEntryacquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::PropertyStoragefindPropertyStorage (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::ModifierStorageacquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::ModifierStoragefindModifierStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::NotificationStorageacquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::NotificationStoragefindNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByUnqualifiedNameAndDataType (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)
 

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

StyleSharedPtr m_parent
 Parent 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...
 
bool m_useValueModifiers
 Does this style apply value modifiers or value sources. More...
 
PropertyValuePrecedence m_precedence
 Property precedence of this style. More...
 
ValueSourceContainer m_valueSources
 Property values of this style. More...
 
BindingContainer m_bindings
 Bindings of this style . More...
 
NodeComponentTemplateContainer m_nodeComponentTemplates
 Node component templates of this style. 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< AppliedStyleEntry * > AppliedStyleContainer
 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

virtual kanzi::Style::~Style ( )
virtual
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.

virtual void kanzi::Style::loadFromKZB ( const KzuResourceLoaderThreadContext threadContext,
KzcInputStream inputStream,
const KzuBinaryFileInfo file 
)
virtual

Load a style from kzb.

Reimplemented from kanzi::Resource.

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::getPropertiesBegin ( )

Get the properties of a style.

ValueSourceIterator kanzi::Style::getPropertiesEnd ( )
PropertyValuePrecedence kanzi::Style::getPrecedence ( ) const
inline
AbstractPropertyTypeDescriptor::ValueSource* kanzi::Style::getValueSource ( AbstractPropertyType  propertyType)

Get value source for a property type.

static void kanzi::Style::apply ( AppliedStyleEntry appliedStyleEntry,
Node objectNode 
)
static

Apply a style.

static void kanzi::Style::unapply ( AppliedStyleEntry appliedStyleEntry,
Node objectNode 
)
static

Unapply a style.

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

Apply all styles to an object node.

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

Apply a style (generic).

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

Unapply a style (generic).

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

Set 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::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: