kanzi::ResourceDictionary Class Reference

Resource dictionary. More...

#include <kanzi/resource/resource_dictionary.hpp>

Inheritance diagram for kanzi::ResourceDictionary:

Public Types
typedef vector < ResourceDictionarySharedPtr >	DictionaryContainer
typedef DictionaryContainer::const_iterator	DictionaryConstIterator
typedef DictionaryContainer::const_reverse_iterator	DictionaryConstReverseIterator
typedef unordered_map < ResourceID, string >	URLMap
typedef URLMap::const_iterator	URLConstIterator
typedef unordered_map < ResourceID, ResourceSharedPtr >	ResourceMap
typedef ResourceMap::const_iterator	ResourceConstIterator
typedef vector< ResourceSharedPtr >	AnonymousResourceContainer
typedef AnonymousResourceContainer::const_iterator	AnonymousResourceConstIterator

Public Member Functions
	ResourceDictionary (Domain *domain, string_view name)
void	load (KzcInputStream *inputStream, const KzuBinaryFileInfo *fileInfo)
void	add (const ResourceID &key, string_view url)
void	remove (const ResourceID &key)
bool	contains (const ResourceID &key) const
optional< string >	find (const ResourceID &key) const
URLConstIterator	beginUrls () const
URLConstIterator	endUrls () const
AnonymousResourceConstIterator	beginAnonymousResources () const
AnonymousResourceConstIterator	endAnonymousResources () const
void	add (ResourceDictionarySharedPtr resourceDictionary)
void	addAnonymousResource (ResourceSharedPtr resource)
void	removeAnonymousResource (const Resource &resource)
size_t	getDictionaryCount () const
void	removeDictionary (size_t index)
DictionaryConstReverseIterator	crbeginDictionaries () const
DictionaryConstReverseIterator	crendDictionaries () const
ResourceSharedPtr	acquire (const ResourceID &key) const
template<typename Type >
shared_ptr< Type >	acquire (const ResourceID &key) const
ResourceSharedPtr	tryAcquire (const ResourceID &key) const
template<typename Type >
shared_ptr< Type >	tryAcquire (const ResourceID &key) const
void	merge (const ResourceDictionary &preferredDictionary)
ResourceDictionarySharedPtr	clone () const
Public Member Functions inherited from kanzi::Resource
KzcMemoryManager *	getMemoryManager () 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	finishLoadingOverride (const KzuResourceLoaderThreadContext *threadContext)
	Function for finishing the loading of the resource. More...
virtual void	unloadOverride ()
	Unload function for resource. More...
virtual kzUint	getCPUMemoryUsage () const
	Function for getting the memory usage of a resource. More...
void	setKZB (const KzuBinaryDirectory *binaryDirectory, kzString path)
void	setLoaded ()
kzString	getName () const
	Accessor. More...
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...
KzuResourceLoadingStrategy	getLoadingStrategy () const
void	setLoadingStrategy (KzuResourceLoadingStrategy loadingStrategy)
bool	getKeepAlive () 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 ()
Domain *	getDomain () const
	Returns the domain the object belongs to. More...
KzuPropertyManager *	getPropertyManager () const
	Returns the property manager of the object. More...
KzuTaskScheduler *	getTaskScheduler () const
	Returns the task scheduler of the object. More...
KzuMessageDispatcher *	getMessageDispatcher () const
	Returns the message dispatcher of the object. More...
ResourceManager *	getResourceManager () const
	Returns the resource manager of the object. More...
virtual const Metaclass *	getDynamicMetaclass () const
	Returns the metaclass of the dynamic type of the object. More...
bool	isTypeOf (const Metaclass *objectType) const
	Determines if the type of this object is the given type or derived from it. More...
template<typename DataType >
void	setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::DataType value)
	Sets the local value of a property. More...
void	setProperty (const PropertyType< ResourceID > &propertyType, ResourceSharedPtr value)
	Sets the local value of a resource id property with a resource pointer. More...
template<typename DataType >
DataType	getProperty (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property. More...
template<typename DataType >
bool	getProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::DataType &value) 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 >
void	setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::DataType value)
void	setAbstractProperty (AbstractPropertyType abstractPropertyType, ResourceSharedPtr value)
template<typename DataType >
DataType	getAbstractProperty (AbstractPropertyType abstractPropertyType) const
template<typename DataType >
bool	getAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::DataType &value) const
bool	hasValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value. More...
bool	hasLocalValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a local value set for the property. More...
void	removeLocalValue (AbstractPropertyType propertyType)
	Removes the local value associated with the property. More...
void	copyLocalValues (const Object &other)
	Copies all local values from another object. More...
virtual void	onPropertyChanged (AbstractPropertyType propertyType, KzuPropertyNotificationReason reason)
	Virtual function to handle property change notifications. More...
AppliedStyleEntry *	applyObjectStyle (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...

Static Public Member Functions
static ResourceDictionarySharedPtr	create (Domain *domain, string_view name)
Static Public Member Functions inherited from kanzi::Object
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class. More...
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info. More...

Static Protected Member Functions
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Additional Inherited Members
Protected Types inherited from kanzi::Object
typedef vector < AppliedStyleEntry * >	AppliedStyleContainer
	Applied style container. More...
Protected Member Functions inherited from kanzi::Resource
KzuResourceLoadState	getLoadState ()
	Access. More...
Protected Member Functions inherited from kanzi::Object
void	initialize ()
void	onCopy (const Object &other)
Protected Attributes inherited from kanzi::Object
AppliedStyleContainer	m_appliedStyles
	Listing of applied styles applied to this object. More...

Detailed Description

Resource dictionary.

Member Typedef Documentation

typedef vector<ResourceDictionarySharedPtr> kanzi::ResourceDictionary::DictionaryContainer

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

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

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

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

typedef unordered_map<ResourceID, ResourceSharedPtr> kanzi::ResourceDictionary::ResourceMap

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

typedef vector<ResourceSharedPtr> kanzi::ResourceDictionary::AnonymousResourceContainer

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

Constructor & Destructor Documentation

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

explicit

Member Function Documentation

void kanzi::ResourceDictionary::load	(	KzcInputStream *	inputStream,
		const KzuBinaryFileInfo *	fileInfo
	)

void kanzi::ResourceDictionary::add	(	const ResourceID &	key,
		string_view	url
	)

void kanzi::ResourceDictionary::remove

(

const ResourceID &

key

)

bool kanzi::ResourceDictionary::contains

(

const ResourceID &

key

)

const

optional<string> kanzi::ResourceDictionary::find

(

const ResourceID &

key

)

const

URLConstIterator kanzi::ResourceDictionary::beginUrls

(

)

const

URLConstIterator kanzi::ResourceDictionary::endUrls

(

)

const

AnonymousResourceConstIterator kanzi::ResourceDictionary::beginAnonymousResources

(

)

const

AnonymousResourceConstIterator kanzi::ResourceDictionary::endAnonymousResources

(

)

const

void kanzi::ResourceDictionary::add

(

ResourceDictionarySharedPtr

resourceDictionary

)

void kanzi::ResourceDictionary::addAnonymousResource

(

ResourceSharedPtr

resource

)

void kanzi::ResourceDictionary::removeAnonymousResource

(

const Resource &

resource

)

size_t kanzi::ResourceDictionary::getDictionaryCount

(

)

const

void kanzi::ResourceDictionary::removeDictionary

(

size_t

index

)

DictionaryConstReverseIterator kanzi::ResourceDictionary::crbeginDictionaries

(

)

const

DictionaryConstReverseIterator kanzi::ResourceDictionary::crendDictionaries

(

)

const

ResourceSharedPtr kanzi::ResourceDictionary::acquire

(

const ResourceID &

key

)

const

template<typename Type >

shared_ptr<Type> kanzi::ResourceDictionary::acquire ( const ResourceID &  key ) const

inline

ResourceSharedPtr kanzi::ResourceDictionary::tryAcquire

(

const ResourceID &

key

)

const

template<typename Type >

shared_ptr<Type> kanzi::ResourceDictionary::tryAcquire ( const ResourceID &  key ) const

inline

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

static

void kanzi::ResourceDictionary::merge

(

const ResourceDictionary &

preferredDictionary

)

ResourceDictionarySharedPtr kanzi::ResourceDictionary::clone

(

)

const

static PropertyTypeEditorInfoSharedPtr kanzi::ResourceDictionary::makeEditorInfo ( )

inlinestaticprotected

---

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

• kanzi/resource/resource_dictionary.hpp