kanzi::ResourceDictionarySelector Class Reference

A resource dictionary selector is a type of a resource dictionary that redirects resource queries to its only nested dictionary. More...

#include <kanzi/core.ui/resource/resource_dictionary_selector.hpp>

Inheritance diagram for kanzi::ResourceDictionarySelector:
kanzi::ResourceDictionary kanzi::Resource kanzi::Object kanzi::MetaObject kanzi::PropertyObject

Public Member Functions

bool selectDictionary (string_view dictionaryUrl)
 Selects a dictionary given an URL. More...
 
ResourceDictionarySharedPtr getSelectedDictionary () const
 Returns the currently selected dictionary. More...
 
void setSelectedDictionary (ResourceDictionarySharedPtr dictionary)
 Sets the currently selected dictionary. More...
 
- Public Member Functions inherited from kanzi::ResourceDictionary
void add (const ResourceID &key, string_view url)
 Adds a resource ID to a resource URL mapping to the resource dictionary. More...
 
void add (const ResourceID &key, ResourceSharedPtr resource)
 Adds a resource ID to a resource pointer mapping to the resource dictionary. More...
 
void remove (const ResourceID &key)
 Removes a resource ID mapping from the resource dictionary. More...
 
bool contains (const ResourceID &key) const
 Tells whether the resource dictionary contains a mapping for the resource ID you pass to the function. More...
 
optional< string > find (const ResourceID &key) const
 Resolves the mapping from the resource ID you pass to the function to the URL of the resource. More...
 
URLConstIterator beginUrls () const
 Returns an iterator pointing to the first element of the URL mappings container. More...
 
URLConstIterator endUrls () const
 Returns an iterator pointing to the element following the last element of the URL mappings container. More...
 
AnonymousResourceConstIterator beginAnonymousResources () const
 Returns an iterator pointing to the first element of the anonymous resources container. More...
 
AnonymousResourceConstIterator endAnonymousResources () const
 Returns an iterator pointing to the element following the last element of the anonymous resources container. More...
 
void addAnonymousResource (ResourceSharedPtr resource)
 Adds an anonymous resource to the resource dictionary. More...
 
void removeAnonymousResource (const Resource &resource)
 Removes an anonymous resource from the resource dictionary. More...
 
void add (ResourceDictionarySharedPtr resourceDictionary)
 Adds a nested resource dictionary to the resource dictionary. More...
 
size_t getDictionaryCount () const
 Gets the number of nested resource dictionaries in the resource dictionary. More...
 
void removeDictionary (size_t index)
 Removes a nested resource dictionary from the resource dictionary. More...
 
DictionaryConstReverseIterator crbeginDictionaries () const
 Returns a reverse iterator to the first element of the reversed nested resource dictionary container. More...
 
DictionaryConstReverseIterator crendDictionaries () const
 Returns a reverse iterator to the element following the last element of the reversed nested resource dictionary container. More...
 
ResourceDictionarySharedPtr findDictionary (string_view name) const
 Searches for a nested dictionary with the specified name and returns a pointer to it. More...
 
ResourceSharedPtr findStoredResource (const ResourceID &key) const
 Find explicitly stored resource pointer from the dictionary. More...
 
ResourceSharedPtr acquire (const ResourceID &key) const
 Gets from the resource dictionary the resource with the resource ID you pass to the function. More...
 
template<typename Type >
shared_ptr< Type > acquire (const ResourceID &key) const
 Gets from the resource dictionary the resource with the resource ID you pass to the function and casts the resource to the type you specify. More...
 
ResourceSharedPtr tryAcquire (const ResourceID &key) const
 Gets from the resource dictionary the resource with the resource ID you pass to the function. More...
 
template<typename Type >
shared_ptr< Type > tryAcquire (const ResourceID &key) const
 Gets from the resource dictionary the resource with the resource ID you pass to the function and casts the resource to the type you specify. More...
 
ResourceManager::AcquireTaskSharedPtr acquireAsync (const ResourceID &key, ResourceManager::AsyncAcquireFinishedCallback func) const
 Acquire resource asynchronously. More...
 
void merge (const ResourceDictionary &preferredDictionary)
 Modifies this resource dictionary by copying into this resource dictionary the contents of the resource dictionary you pass to the function. More...
 
ResourceDictionarySharedPtr clone () const
 Duplicates a resource dictionary. More...
 
void load (KzcInputStream *inputStream, const KzuBinaryFileInfo *fileInfo)
 Loads a resource dictionary from input stream. More...
 
- Public Member Functions inherited from kanzi::Resource
KzcMemoryManagergetMemoryManager () const
 
 Resource (Domain *domain, string_view name)
 
virtual ~Resource ()
 
virtual void loadFromKZB (const KzuResourceLoaderThreadContext *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 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...
 
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 ResourceDictionarySelectorSharedPtr create (Domain *domain, string_view name)
 Creates a resource dictionary selector. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
static ResourceDictionarySelectorSharedPtr loadFromKZB (Domain *domain, string_view name, KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)
 Loads a resource dictionary selector from a file. More...
 
- Static Public Member Functions inherited from kanzi::ResourceDictionary
static ResourceDictionarySharedPtr create (Domain *domain, string_view name)
 Creates a resource dictionary. More...
 
static ResourceDictionarySharedPtr loadFromKZB (Domain *domain, string_view name, KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)
 Loads a resource dictionary from a file. 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...
 

Static Public Attributes

static PropertyType< ResourceSharedPtrSelectedDictionaryProperty
 SelectedDictionary property. More...
 

Protected Member Functions

 ResourceDictionarySelector (Domain *domain, string_view name)
 Constructor. More...
 
virtual void onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) KZ_OVERRIDE
 Implements Object::onPropertyChanged. More...
 
virtual optional< string > findOverride (const ResourceID &key) const KZ_OVERRIDE
 ResourceDictionary::findOverride() implementation. More...
 
virtual ResourceSharedPtr acquireOverride (const ResourceID &key) const KZ_OVERRIDE
 Implements ResourceDictionary::acquireOverride. More...
 
virtual ResourceSharedPtr tryAcquireOverride (const ResourceID &key) const KZ_OVERRIDE
 Implements ResourceDictionary::tryAcquireOverride. More...
 
virtual ResourceManager::AcquireTaskSharedPtr acquireAsyncOverride (const ResourceID &key, ResourceManager::AsyncAcquireFinishedCallback func) const KZ_OVERRIDE
 ResourceDictionary::acquireAsyncOverride() implementation. More...
 
virtual ResourceDictionarySharedPtr cloneOverride () const KZ_OVERRIDE
 Implements ResourceDictionary::cloneOverride. More...
 
- Protected Member Functions inherited from kanzi::ResourceDictionary
void loadFromKZB (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)
 Loads a resource dictionary from a file. More...
 
 ResourceDictionary (Domain *domain, string_view name)
 Constructor. 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)
 

Additional Inherited Members

- Public Types inherited from kanzi::ResourceDictionary
typedef vector< ResourceDictionarySharedPtrDictionaryContainer
 The type used for container of nested resource dictionaries. More...
 
typedef DictionaryContainer::const_iterator DictionaryConstIterator
 The type used for iterators of nested resource dictionary containers. More...
 
typedef DictionaryContainer::const_reverse_iterator DictionaryConstReverseIterator
 The type used for reverse iterators of nested resource dictionary containers. More...
 
typedef unordered_map< ResourceID, string > URLMap
 The type used for mapping resource IDs to URLs. More...
 
typedef URLMap::const_iterator URLConstIterator
 The type used for iterators of the mapping of resource IDs to URLs. More...
 
typedef unordered_map< ResourceID, ResourceSharedPtrResourceMap
 The type used for mapping resource IDs to resources. More...
 
typedef ResourceMap::const_iterator ResourceConstIterator
 The type used for iterators of the mapping of resource IDs to resources. More...
 
typedef vector< ResourceSharedPtrAnonymousResourceContainer
 The type used for the container of anonymous resources. More...
 
typedef AnonymousResourceContainer::const_iterator AnonymousResourceConstIterator
 The type used for iterators of the anonymous resource container. More...
 
- 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
 
- Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntry * > AppliedStyleContainer
 Applied style container. More...
 
- Static Protected Member Functions inherited from kanzi::ResourceDictionary
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- Protected Attributes inherited from kanzi::Object
AppliedStyleContainer m_appliedStyles
 Listing of applied styles applied to this object. More...
 

Detailed Description

A resource dictionary selector is a type of a resource dictionary that redirects resource queries to its only nested dictionary.

This type of dictionary is used internally by Screen to implement switching of locales and themes in theme groups. You can use Screen::setLocale to set the current locale and Screen::activateTheme to activate a theme in a theme group.

Constructor & Destructor Documentation

kanzi::ResourceDictionarySelector::ResourceDictionarySelector ( Domain domain,
string_view  name 
)
explicitprotected

Constructor.

Parameters
domainThe domain to which the resource dictionary selector belongs.
nameThe name of the resource dictionary selector.

Member Function Documentation

static ResourceDictionarySelectorSharedPtr kanzi::ResourceDictionarySelector::create ( Domain domain,
string_view  name 
)
static

Creates a resource dictionary selector.

Parameters
domainThe domain to which the resource dictionary selector belongs.
nameThe name of the resource dictionary selector.
Returns
The pointer to the resource dictionary selector.
bool kanzi::ResourceDictionarySelector::selectDictionary ( string_view  dictionaryUrl)

Selects a dictionary given an URL.

Resource dictionary selector loads the dictionary and will redirect all resource queries to it. The selected dictionary doesn't change if the resource dictionary selector cannot load the new dictionary.

Parameters
dictionaryUrlThe URL to load the dictionary from.
Returns
True if the dictionary was successfully loaded, false otherwise.
ResourceDictionarySharedPtr kanzi::ResourceDictionarySelector::getSelectedDictionary ( ) const
inline

Returns the currently selected dictionary.

Returns
The currently selected dictionary or null if no dictionary is selected.
void kanzi::ResourceDictionarySelector::setSelectedDictionary ( ResourceDictionarySharedPtr  dictionary)
inline

Sets the currently selected dictionary.

static PropertyTypeEditorInfoSharedPtr kanzi::ResourceDictionarySelector::makeEditorInfo ( )
static
static ResourceDictionarySelectorSharedPtr kanzi::ResourceDictionarySelector::loadFromKZB ( Domain domain,
string_view  name,
KzbFile kzbFile,
ReadOnlyMemoryFile file,
KzbMemoryParser parser 
)
static

Loads a resource dictionary selector from a file.

Used internally by Kanzi Engine.

Parameters
domainDomain
nameName
kzbFileKZB file where to load from.
fileResource Dictionary selector file inside the KZB file where to load from.
parserParser pointing to the beginning of the file.
virtual void kanzi::ResourceDictionarySelector::onPropertyChanged ( AbstractPropertyType  propertyType,
PropertyNotificationReason  reason 
)
protectedvirtual

Implements Object::onPropertyChanged.

Reimplemented from kanzi::PropertyObject.

virtual optional<string> kanzi::ResourceDictionarySelector::findOverride ( const ResourceID key) const
protectedvirtual
virtual ResourceSharedPtr kanzi::ResourceDictionarySelector::acquireOverride ( const ResourceID key) const
protectedvirtual
virtual ResourceSharedPtr kanzi::ResourceDictionarySelector::tryAcquireOverride ( const ResourceID key) const
protectedvirtual
virtual ResourceManager::AcquireTaskSharedPtr kanzi::ResourceDictionarySelector::acquireAsyncOverride ( const ResourceID key,
ResourceManager::AsyncAcquireFinishedCallback  func 
) const
protectedvirtual
virtual ResourceDictionarySharedPtr kanzi::ResourceDictionarySelector::cloneOverride ( ) const
protectedvirtual

Member Data Documentation

PropertyType<ResourceSharedPtr> kanzi::ResourceDictionarySelector::SelectedDictionaryProperty
static

SelectedDictionary property.

The default value is ResourceSharedPtr().

See also
setSelectedDictionary(), getSelectedDictionary()

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