Kanzi  3.9.7
Kanzi Engine API
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:
[legend]

Public Member Functions

ResourceDictionarySharedPtr getSelectedDictionary () const
 Returns the currently selected dictionary. More...
 
bool selectDictionary (string_view dictionaryUrl)
 Selects a dictionary given an URL. More...
 
void setSelectedDictionary (ResourceDictionarySharedPtr dictionary)
 Sets the currently selected dictionary. More...
 
- Public Member Functions inherited from kanzi::ResourceDictionary
ResourceSharedPtr acquire (const ResourceID &key) const
 Gets from the resource dictionary the resource with the resource ID that 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...
 
ResourceManager::AcquireTaskSharedPtr acquireAsync (const ResourceID &key, ResourceManager::AsyncAcquireFinishedCallback func) const
 Asynchronously acquires a resource. More...
 
void add (const ResourceID &key, string_view url)
 Adds a resource ID to a resource URL mapping to a resource dictionary. More...
 
void add (const ResourceID &key, ResourceSharedPtr resource)
 Adds a resource ID to a resource pointer mapping to a resource dictionary. More...
 
void add (ResourceDictionarySharedPtr resourceDictionary)
 Adds a nested resource dictionary to a resource dictionary. More...
 
void addAnonymousResource (ResourceSharedPtr resource)
 Adds an anonymous resource to a resource dictionary. More...
 
AnonymousResourceConstIterator beginAnonymousResources () const
 Returns an iterator pointing to the first element of the anonymous resources container. More...
 
URLConstIterator beginUrls () const
 Returns an iterator pointing to the first element of the URL mappings container. More...
 
ResourceDictionarySharedPtr clone () const
 Duplicates a resource dictionary. More...
 
bool contains (const ResourceID &key) const
 Returns whether a resource dictionary contains a mapping for the resource ID that you pass to the function. 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...
 
AnonymousResourceConstIterator endAnonymousResources () const
 Returns an iterator pointing to the element following the last element of the anonymous resources container. More...
 
URLConstIterator endUrls () const
 Returns an iterator pointing to the element following the last element of the URL mappings container. More...
 
optional< string > find (const ResourceID &key) const
 Resolves the mapping from the resource ID that you pass to the function to the URL of the resource. 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
 Finds an explicitly stored resource pointer from a dictionary. More...
 
size_t getDictionaryCount () const
 Gets the number of nested resource dictionaries in a resource dictionary. More...
 
void merge (const ResourceDictionary &preferredDictionary)
 Copies into this resource dictionary the contents of the resource dictionary that you pass to the function. More...
 
void remove (const ResourceID &key)
 Removes a resource ID mapping from a resource dictionary. More...
 
void removeAnonymousResource (const Resource &resource)
 Removes an anonymous resource from the resource dictionary. More...
 
void removeDictionary (size_t index)
 Removes a nested resource dictionary from a resource dictionary. 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...
 
- 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
 
 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 ResourceDictionarySelectorSharedPtr create (Domain *domain, string_view name)
 Creates a resource dictionary selector. More...
 
static ResourceDictionarySelectorSharedPtr loadFromKZB (Domain *domain, string_view name, KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)
 Loads a resource dictionary selector from a file. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- 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

Properties
static PropertyType< ResourceSharedPtrSelectedDictionaryProperty
 SelectedDictionary property. More...
 

Protected Member Functions

ResourceManager::AcquireTaskSharedPtr acquireAsyncOverride (const ResourceID &key, ResourceManager::AsyncAcquireFinishedCallback func) const override
 ResourceDictionary::acquireAsyncOverride() implementation. More...
 
ResourceSharedPtr acquireOverride (const ResourceID &key) const override
 Implements ResourceDictionary::acquireOverride. More...
 
ResourceDictionarySharedPtr cloneOverride () const override
 Implements ResourceDictionary::cloneOverride. More...
 
optional< string > findOverride (const ResourceID &key) const override
 ResourceDictionary::findOverride() implementation. More...
 
void onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) override
 Implements Object::onPropertyChanged. More...
 
 ResourceDictionarySelector (Domain *domain, string_view name)
 Constructor. More...
 
ResourceSharedPtr tryAcquireOverride (const ResourceID &key) const override
 Implements ResourceDictionary::tryAcquireOverride. More...
 
- Protected Member Functions inherited from kanzi::ResourceDictionary
unsigned int getCPUMemoryUsageOverride () const override
 Resource::getCPUMemoryUsageOverride() implementation. More...
 
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 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...
 

Additional Inherited Members

- Public Types inherited from kanzi::ResourceDictionary
typedef AnonymousResourceContainer::const_iterator AnonymousResourceConstIterator
 The type used for iterators of the anonymous resource container. More...
 
typedef vector< ResourceSharedPtrAnonymousResourceContainer
 The type used for the container of anonymous resources. 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 vector< ResourceDictionarySharedPtrDictionaryContainer
 The type used for container of nested resource dictionaries. More...
 
typedef ResourceMap::const_iterator ResourceConstIterator
 The type used for iterators of the mapping of resource IDs to resources. More...
 
typedef unordered_map< ResourceID, ResourceSharedPtrResourceMap
 The type used for mapping resource IDs to resources. More...
 
typedef URLMap::const_iterator URLConstIterator
 The type used for iterators of the mapping of resource IDs to URLs. More...
 
typedef unordered_map< ResourceID, string > URLMap
 The type used for mapping resource IDs to URLs. More...
 
- 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
 
- Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtrAppliedStyleContainer
 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.
void kanzi::ResourceDictionarySelector::onPropertyChanged ( AbstractPropertyType  propertyType,
PropertyNotificationReason  reason 
)
overrideprotectedvirtual

Implements Object::onPropertyChanged.

Reimplemented from kanzi::PropertyObject.

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

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: