kanzi::ResourceDictionary Class Reference

A resource dictionary is a container that maps resource IDs to resources. More...

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

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

Public Types

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
 

Public Member Functions

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...
 
virtual optional< string > findOverride (const ResourceID &key) const
 Implementation for find(). 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 ResourceLoaderThreadContext *threadContext, KzcInputStream *inputStream, const KzuBinaryFileInfo *file)
 Function for loading the resource from .KZB. More...
 
virtual void unloadOverride ()
 Unload function for resource. Releases all CPU memory taken by the resource except the resource loader. More...
 
virtual unsigned int getCPUMemoryUsage () const
 Function for getting the memory usage of a resource. More...
 
void setKZB (const KzuBinaryDirectory *binaryDirectory, string_view path)
 Set the binary directory and path of the resource. More...
 
const string & getName () const
 Gets the resource name. More...
 
const string & getUrl () const
 Gets the resource URL. More...
 
void setUrl (string_view url)
 Sets the resource URL. More...
 
void setNotLoaded ()
 
bool isFromKZB () const
 
void reload ()
 
void reloadFromKzb (KzcInputStream *inputStream, const KzuBinaryFileInfo *file)
 
void reloadFromKzb (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)
 
void reloadFromFile (string_view filePath)
 
void load ()
 
void unload ()
 
bool isLoaded () const
 
void kzuResourceLoad_private (const ResourceLoaderThreadContext *threadContext)
 Private function for kzuResourceLoad() with specified thread context. More...
 
void kzuResourceFinishLoading_private (const ResourceLoaderThreadContext *threadContext)
 Private function for finishing the loading of the resource. More...
 
bool isKeepAlive () const
 Tells if the resource has keep alive flag set. More...
 
void setKeepAlive (bool keepAlive)
 Sets the keep alive flag. More...
 
- Public Member Functions inherited from kanzi::Object
 Object (Domain *domain)
 
virtual ~Object ()
 
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...
 
AppliedStyleEntrySharedPtr applyObjectStyle (kanzi::StyleSharedPtr style)
 Applies a style to an object. More...
 
void unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)
 
void applyObjectStyles ()
 Apply all styles for an object node. More...
 
void unapplyObjectStyles ()
 Unapplies and removes all applied styles. More...
 
- Public Member Functions inherited from kanzi::MetaObject
virtual ~MetaObject ()
 
bool isTypeOf (const Metaclass *objectType) const
 Determines if the type of this object is the given type or derived from it. More...
 
- Public Member Functions inherited from kanzi::PropertyObject
 PropertyObject ()
 
virtual ~PropertyObject ()
 
template<typename DataType >
void setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
 Sets the local value of a property. More...
 
void removeKzbProperties ()
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getProperty (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property. More...
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalProperty (const PropertyType< DataType > &propertyType) const
 Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. More...
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getPropertyBase (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property disregarding modifiers. More...
 
template<typename DataType >
void setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
void setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
bool isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const
 
void clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
bool hasValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value. More...
 
bool hasBaseValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value, disregarding modifiers. More...
 
bool hasLocalValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a local value set for the property. More...
 
bool hasNonClassValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a value of any precedence higher than class default value set for the property. More...
 
void removeLocalValue (AbstractPropertyType propertyType)
 Removes the local value associated with the property. More...
 
void copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
 Copies local value of single property from another object. More...
 
void copyLocalValues (const PropertyObject &other)
 Copies all local values from another object. More...
 
virtual void onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason)
 Virtual function to handle property change notifications. More...
 
template<typename DataType >
void addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, void *owner)
 
template<typename DataType >
void removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *owner)
 
template<typename DataType >
void addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 
template<typename DataType >
void removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 
void validatePropertyModifiers (AbstractPropertyType propertyType)
 
template<typename DataType >
void addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
 
template<typename DataType >
void removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
 
template<typename DataType >
size_t getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType)
 Gets number of current notification handlers for given property type. More...
 

Static Public Member Functions

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

Protected Member Functions

void loadFromKZB (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)
 Loads a resource dictionary from a file. More...
 
 ResourceDictionary (Domain *domain, string_view name)
 Constructor. More...
 
virtual ResourceSharedPtr acquireOverride (const ResourceID &key) const
 Implements resource lookup described in acquire. More...
 
virtual ResourceSharedPtr tryAcquireOverride (const ResourceID &key) const
 Implements resource lookup described in tryAcquire. More...
 
virtual ResourceManager::AcquireTaskSharedPtr acquireAsyncOverride (const ResourceID &key, ResourceManager::AsyncAcquireFinishedCallback func) const
 Implements asynchronous resource acquire described in #acquireResourceAsync. More...
 
virtual ResourceDictionarySharedPtr cloneOverride () const
 Implements cloning of the object in clone. 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 PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 

Additional Inherited Members

- Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtrAppliedStyleContainer
 Applied style container. More...
 
- Protected Attributes inherited from kanzi::Object
AppliedStyleContainer m_appliedStyles
 Listing of applied styles applied to this object. More...
 

Detailed Description

A resource dictionary is a container that maps resource IDs to resources.

A node can refer to resources by setting resource IDs to resource ID properties. You can set a resource dictionary to the node or to any of its parent nodes to define which resources the node will use. You can use resource dictionary to group similar resources to logical entities like themes or locales, and change a resource dictionary of a node to change multiple resources at the same time.

You can use Node::acquireResource to get the resource from the resource dictionary of a node or from the resource dictionaries of its parent nodes.

A resource dictionary can map resource IDs to resources in these ways: 1) Resource ID can map directly to a resource pointer. 2) Resource ID can map indirectly to a resource with a resource URL. Use acquire and tryAcquire functions to get a mapped resource regardless of the way how a resource ID is mapped to a resource.

You can store nested resource dictionaries in a resource dictionary. When you are getting a resource from a resource dictionary and the resource dictionary cannot find the resource ID you specify, the resource dictionary looks for the resource ID recursively in the nested resource dictionaries.

In a resource dictionary you can store resources without mapping a resource ID to them. In Kanzi Engine such resources are called anonymous resources. You can get anonymous resources with beginAnonymousResources and endAnonymousResources.

Examples

To create a resource dictionary:

// Create a resource dictionary.
ResourceDictionarySharedPtr dictionary = ResourceDictionary::create(domain, "Dictionary");

To add content to a resource dictionary:

// Add resources to a resource dictionary.
dictionary->add(ResourceID("red icon"), texture);
dictionary->add(ResourceID("blue icon"), "kzb://my_project/Textures/Blue Icon");

To get resources from a resource dictionary:

// Acquire resources from a resource dictionary.
ResourceSharedPtr redIcon = dictionary->acquire(ResourceID("red icon"));
ResourceSharedPtr blueIcon = dictionary->acquire(ResourceID("blue icon"));

To change the resource dictionary of a node:

// Change the resource dictionary of a node.
node->setResourceDictionary(dictionary);

To extend the existing resource dictionary of a node:

// Extend the existing resource dictionary of a node with a nested resource dictionary.
node->addResourceDictionary(dictionary);

Member Typedef Documentation

The type used for container of nested resource dictionaries.

typedef DictionaryContainer::const_iterator kanzi::ResourceDictionary::DictionaryConstIterator

The type used for iterators of nested resource dictionary containers.

typedef DictionaryContainer::const_reverse_iterator kanzi::ResourceDictionary::DictionaryConstReverseIterator

The type used for reverse iterators of nested resource dictionary containers.

typedef unordered_map<ResourceID, string> kanzi::ResourceDictionary::URLMap

The type used for mapping resource IDs to URLs.

typedef URLMap::const_iterator kanzi::ResourceDictionary::URLConstIterator

The type used for iterators of the mapping of resource IDs to URLs.

The type used for mapping resource IDs to resources.

typedef ResourceMap::const_iterator kanzi::ResourceDictionary::ResourceConstIterator

The type used for iterators of the mapping of resource IDs to resources.

The type used for the container of anonymous resources.

typedef AnonymousResourceContainer::const_iterator kanzi::ResourceDictionary::AnonymousResourceConstIterator

The type used for iterators of the anonymous resource container.

Constructor & Destructor Documentation

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

Constructor.

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

Member Function Documentation

static ResourceDictionarySharedPtr kanzi::ResourceDictionary::create ( Domain domain,
string_view  name 
)
static

Creates a resource dictionary.

Parameters
domainThe domain to which the resource dictionary belongs.
nameThe name of the resource dictionary.
Returns
The pointer to the resource dictionary.
void kanzi::ResourceDictionary::add ( const ResourceID key,
string_view  url 
)

Adds a resource ID to a resource URL mapping to the resource dictionary.

Parameters
keyThe resource id.
urlThe URL pointing to the resource.
void kanzi::ResourceDictionary::add ( const ResourceID key,
ResourceSharedPtr  resource 
)

Adds a resource ID to a resource pointer mapping to the resource dictionary.

Parameters
keyThe resource id.
resourceThe resource pointer.
void kanzi::ResourceDictionary::remove ( const ResourceID key)

Removes a resource ID mapping from the resource dictionary.

Parameters
keyThe resource ID you want to remove.
bool kanzi::ResourceDictionary::contains ( const ResourceID key) const

Tells whether the resource dictionary contains a mapping for the resource ID you pass to the function.

Parameters
keyThe resource ID for which you want to check whether there is a mapping in the resource dictionary.
Returns
True if the resource dictionary or a nested resource dictionary contains a mapping for the resource ID you passed to the function.
optional<string> kanzi::ResourceDictionary::find ( const ResourceID key) const

Resolves the mapping from the resource ID you pass to the function to the URL of the resource.

This function ignores the direct resource ID to resource mappings.

Parameters
keyThe resource ID of the resource for which you want to get the URL.
Returns
The resource URL if the resource dictionary or a nested resource dictionary contains a resource ID you passed. Otherwise returns nullopt.
virtual optional<string> kanzi::ResourceDictionary::findOverride ( const ResourceID key) const
virtual

Implementation for find().

Reimplemented in kanzi::ResourceDictionarySelector.

URLConstIterator kanzi::ResourceDictionary::beginUrls ( ) const

Returns an iterator pointing to the first element of the URL mappings container.

Returns
An iterator pointing to the first element of the container.
URLConstIterator kanzi::ResourceDictionary::endUrls ( ) const

Returns an iterator pointing to the element following the last element of the URL mappings container.

Returns
An iterator pointing to the element following the last element of the URL mappings container.
AnonymousResourceConstIterator kanzi::ResourceDictionary::beginAnonymousResources ( ) const

Returns an iterator pointing to the first element of the anonymous resources container.

Returns
An iterator pointing to the first element of the anonymous resources container.
AnonymousResourceConstIterator kanzi::ResourceDictionary::endAnonymousResources ( ) const

Returns an iterator pointing to the element following the last element of the anonymous resources container.

Returns
An iterator pointing to the element following the last element of the anonymous resources container.
void kanzi::ResourceDictionary::addAnonymousResource ( ResourceSharedPtr  resource)

Adds an anonymous resource to the resource dictionary.

Parameters
resourceThe anonymous resource you want to add to the resource dictionary.
void kanzi::ResourceDictionary::removeAnonymousResource ( const Resource resource)

Removes an anonymous resource from the resource dictionary.

Parameters
resourceThe anonymous resource you want to remove from the resource dictionary. If the resource does not exist in the resource dictionary, the function does not do anything.
void kanzi::ResourceDictionary::add ( ResourceDictionarySharedPtr  resourceDictionary)

Adds a nested resource dictionary to the resource dictionary.

Since only a pointer to the nested resource dictionary is stored, the same resource dictionary can be added as a nested resource dictionary to multiple dictionaries. Note that it is forbidden to form cycles with the nested resource dictionaries.

Parameters
resourceDictionaryThe nested resource dictionary you want to add to the resource dictionary.
size_t kanzi::ResourceDictionary::getDictionaryCount ( ) const

Gets the number of nested resource dictionaries in the resource dictionary.

Returns
The number of nested resource dictionaries in the resource dictionary.
void kanzi::ResourceDictionary::removeDictionary ( size_t  index)

Removes a nested resource dictionary from the resource dictionary.

Parameters
indexThe index of the nested resource dictionary you want to remove.
DictionaryConstReverseIterator kanzi::ResourceDictionary::crbeginDictionaries ( ) const

Returns a reverse iterator to the first element of the reversed nested resource dictionary container.

It corresponds to the last element of the non-reversed container.

Returns
A reverse iterator to the first element of the reversed nested resource dictionary container.
DictionaryConstReverseIterator kanzi::ResourceDictionary::crendDictionaries ( ) const

Returns a reverse iterator to the element following the last element of the reversed nested resource dictionary container.

It corresponds to the element preceding the first element of the non-reversed container.

Returns
A reverse iterator to the element following the last element of the reversed nested resource dictionary container.
ResourceDictionarySharedPtr kanzi::ResourceDictionary::findDictionary ( string_view  name) const

Searches for a nested dictionary with the specified name and returns a pointer to it.

Parameters
nameThe name of the dictionary to find.
Returns
A child dictionary with the specified name, null otherwise.
ResourceSharedPtr kanzi::ResourceDictionary::findStoredResource ( const ResourceID key) const

Find explicitly stored resource pointer from the dictionary.

Does not try to acquire from resource manager, use acquire() if necessary.

ResourceSharedPtr kanzi::ResourceDictionary::acquire ( const ResourceID key) const

Gets from the resource dictionary the resource with the resource ID you pass to the function.

Any resource URL mappings are forwarded to ResourceManager::acquireResource. Classes that derive from ResourceDictionary can override the behavior of acquire by implementing acquireOverride.

Parameters
keyThe resource ID of the resource you want to get.
Returns
The resource to which the resource ID is mapped.
  • If the resource ID is mapped to a resource pointer, the function returns the resource pointer.
  • If the resource ID is mapped to a resource URL, the function uses the URL to query the resource from ResourceManager::acquireResource.
  • If the resource dictionary has nested resource dictionaries, the function forwards the query to the nested dictionaries: the last nested resource dictionary is searched first, and the first nested resource dictionary is searched last.
  • If the resource ID is not mapped to anything in this resource dictionary or any of the nested dictionaries, the function returns nullptr.
template<typename Type >
shared_ptr<Type> kanzi::ResourceDictionary::acquire ( const ResourceID key) const
inline

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.

See also
acquire
ResourceSharedPtr kanzi::ResourceDictionary::tryAcquire ( const ResourceID key) const

Gets from the resource dictionary the resource with the resource ID you pass to the function.

Any resource URL mappings are forwarded to ResourceManager::tryAcquireResource. Classes that derive from ResourceDictionary can override the behavior of tryAcquire by implementing tryAcquireOverride.

Parameters
keyThe resource ID of the resource you want to get.
Returns
The resource to which the resource ID is mapped.
  • If the resource ID is mapped to a resource pointer, the function returns the resource pointer.
  • If the resource ID is mapped to a resource URL, the function uses the URL to query the resource from ResourceManager::tryAcquireResource.
  • If the resource dictionary has nested resource dictionaries, the function forwards the query to the nested dictionaries: the last nested resource dictionary is searched first, and the first nested resource dictionary is searched last.
  • If the resource ID is not mapped to anything in this resource dictionary or any of the nested dictionaries, the function returns nullptr.
template<typename Type >
shared_ptr<Type> kanzi::ResourceDictionary::tryAcquire ( const ResourceID key) const
inline

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.

See also
tryAcquire
ResourceManager::AcquireTaskSharedPtr kanzi::ResourceDictionary::acquireAsync ( const ResourceID key,
ResourceManager::AsyncAcquireFinishedCallback  func 
) const

Acquire resource asynchronously.

If no resource URL mapping is found, an asynchronous task is not launched. Even if no asynchronous task is launched, the callback is not executed until the next time when callbacks would be executed normally.

Parameters
keyThe resource ID of the resource you want to get.
funcCallback to execute when loading is complete.
Returns
Async task launched.
void kanzi::ResourceDictionary::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.

Adds resource ID mappings, pointers to nested resource directories, and anonymous resources from the given resource directory to this resource directory. If there are duplicate values for the resource id mappings, prefers the values in the resource directory passed to the function.

Parameters
preferredDictionaryThe resource dictionary to which you want to merge this resource dictionary.
ResourceDictionarySharedPtr kanzi::ResourceDictionary::clone ( ) const

Duplicates a resource dictionary.

When you duplicate a resource dictionary which contains nested resource dictionaries, copies the pointers to the nested resource dictionaries but not the contents of the nested resource dictionaries (i.e. creates a shallow copy). Class that derive from ResourceDictionary must override the cloning implementation in cloneOverride.

Returns
The pointer to the duplicated resource dictionary.
void kanzi::ResourceDictionary::load ( KzcInputStream inputStream,
const KzuBinaryFileInfo fileInfo 
)

Loads a resource dictionary from input stream.

Used internally by Kanzi Engine.

Parameters
inputStreamInput stream where the resource dictionary is loaded from.
fileInfoThe descriptor for the file where the resource dictionary is loaded from.
static ResourceDictionarySharedPtr kanzi::ResourceDictionary::loadFromKZB ( Domain domain,
string_view  name,
KzbFile kzbFile,
ReadOnlyMemoryFile file,
KzbMemoryParser parser 
)
static

Loads a resource dictionary from a file.

Used internally by Kanzi Engine.

Parameters
domainDomain
nameName
kzbFileKZB file where to load from.
fileResource Dictionary file inside the KZB file where to load from.
parserParser pointing to the beginning of the file.
void kanzi::ResourceDictionary::loadFromKZB ( KzbFile kzbFile,
ReadOnlyMemoryFile file,
KzbMemoryParser parser 
)
protected

Loads a resource dictionary from a file.

Used internally by Kanzi Engine.

Parameters
kzbFileKZB file where to load from.
fileResource Dictionary file inside the KZB file where to load from.
parserParser pointing to the beginning of the file.
virtual ResourceSharedPtr kanzi::ResourceDictionary::acquireOverride ( const ResourceID key) const
protectedvirtual

Implements resource lookup described in acquire.

Reimplemented in kanzi::ResourceDictionarySelector.

virtual ResourceSharedPtr kanzi::ResourceDictionary::tryAcquireOverride ( const ResourceID key) const
protectedvirtual

Implements resource lookup described in tryAcquire.

Reimplemented in kanzi::ResourceDictionarySelector.

virtual ResourceManager::AcquireTaskSharedPtr kanzi::ResourceDictionary::acquireAsyncOverride ( const ResourceID key,
ResourceManager::AsyncAcquireFinishedCallback  func 
) const
protectedvirtual

Implements asynchronous resource acquire described in #acquireResourceAsync.

Reimplemented in kanzi::ResourceDictionarySelector.

virtual ResourceDictionarySharedPtr kanzi::ResourceDictionary::cloneOverride ( ) const
protectedvirtual

Implements cloning of the object in clone.

Reimplemented in kanzi::ResourceDictionarySelector.

static PropertyTypeEditorInfoSharedPtr kanzi::ResourceDictionary::makeEditorInfo ( )
inlinestaticprotected

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