Property manager. More...

#include <kanzi/platform/platform.hpp>
#include <kanzi/platform/memory.hpp>
#include <system/kzs_types.h>
#include <system/debug/kzs_error.h>

Namespaces
	kanzi

Functions
KANZI_API kzsError	kzuPropertyResourceIDValueSourceCreate (const struct KzuPropertyManager propertyManager, kzString value, struct KzuPropertyResourceIDValueSource *out_valueSource)
	Create a ResourceID value source. More...

KANZI_API kzsError	kzuPropertyResourceIDValueSourceDelete (struct KzuPropertyResourceIDValueSource *valueSource)
	Delete a ResourceID value source. More...

KANZI_API kzsError	kzuPropertyResourceIDValueSourceClone (const struct KzuPropertyManager propertyManager, const struct KzuPropertyResourceIDValueSource valueSource, struct KzuPropertyResourceIDValueSource **out_newValueSource)
	Copy a resourceID value source. More...

KANZI_API kzsError	kzuPropertyResourceIDValueSourceCopy (struct KzuPropertyResourceIDValueSource target, const struct KzuPropertyResourceIDValueSource source)
	Copy a resourceID value source. More...

KANZI_API kzsError	kzuPropertyResourceIDValueSourceSetValue (struct KzuPropertyResourceIDValueSource *valueSource, kzString value)
	Set a resourceID value source. More...

KANZI_API kzString	kzuPropertyResourceIDValueSourceGetValue (const struct KzuPropertyResourceIDValueSource *valueSource)
	Get a resourceID value source. More...

KANZI_API kzsError	kzuPropertyManagerSetResourceID (const struct KzuPropertyManager propertyManager, const void object, const struct KzuPropertyType *propertyType, kzString value)
	Set a property of propertyType associated with an object. More...

KANZI_API void	kzuPropertyManagerSetResourceIDResource (const KzuPropertyManager propertyManager, const void object, const KzuPropertyType *propertyType, kanzi::ResourceSharedPtr resource)
	Set a property of propertyType associated with an object. More...

KANZI_API kzBool	kzuPropertyManagerGetResourceID (const struct KzuPropertyManager propertyManager, const void object, const struct KzuPropertyType propertyType, kzString out_value)
	Get the value of a property of propertyType associated with an object. More...

KANZI_API kzBool	kzuPropertyManagerGetResourceIDResource (const KzuPropertyManager propertyManager, const void object, const KzuPropertyType propertyType, kanzi::ResourceSharedPtr out_resource)
	Get the value of a property of propertyType associated with an object. More...

KANZI_API kzString	kzuPropertyManagerGetResourceIDDefault (const struct KzuPropertyManager propertyManager, const void object, const struct KzuPropertyType *propertyType)
	Get a property of propertyType associated with an object and return the default value from the property type if not found. More...

KANZI_API kanzi::ResourceSharedPtr	kzuPropertyManagerGetResourceIDResourceDefault (const KzuPropertyManager propertyManager, const void object, const KzuPropertyType *propertyType)
	Get a property of propertyType associated with an object and return the default value from the property type if not found. More...

KANZI_API kzsError	kzuObjectNodeSetResourceIDProperty (const kanzi::Node objectNode, const struct KzuPropertyType propertyType, kzString value)
	Set a property on an object node. More...

KANZI_API void	kzuObjectNodeSetResourceIDResourceProperty (const kanzi::Node objectNode, const KzuPropertyType propertyType, kanzi::ResourceSharedPtr resource)
	Set a property on an object node. More...

KANZI_API kzBool	kzuObjectNodeGetResourceIDProperty (const kanzi::Node objectNode, const struct KzuPropertyType propertyType, kzString *out_value)
	Get the value of a property of propertyType associated with an object node. More...

KANZI_API kzBool	kzuObjectNodeGetResourceIDResourceProperty (const kanzi::Node objectNode, const KzuPropertyType propertyType, kanzi::ResourceSharedPtr *out_resource)
	Get the value of a property of propertyType associated with an object node. More...

KANZI_API kzString	kzuObjectNodeGetResourceIDPropertyDefault (const kanzi::Node objectNode, const struct KzuPropertyType propertyType)
	Get the value of a property associated with an object node. More...

KANZI_API kanzi::ResourceSharedPtr	kzuObjectNodeGetResourceIDResourcePropertyDefault (const kanzi::Node objectNode, const KzuPropertyType propertyType)
	Get the value of a property associated with an object node. More...

Detailed Description

Property manager.

Function Documentation

KANZI_API kzsError kzuPropertyResourceIDValueSourceCreate	(	const struct KzuPropertyManager *	propertyManager,
		kzString	value,
		struct KzuPropertyResourceIDValueSource **	out_valueSource
	)

Create a ResourceID value source.

KANZI_API kzsError kzuPropertyResourceIDValueSourceDelete ( struct KzuPropertyResourceIDValueSource * valueSource )

Delete a ResourceID value source.

KANZI_API kzsError kzuPropertyResourceIDValueSourceClone	(	const struct KzuPropertyManager *	propertyManager,
		const struct KzuPropertyResourceIDValueSource *	valueSource,
		struct KzuPropertyResourceIDValueSource **	out_newValueSource
	)

Copy a resourceID value source.

KANZI_API kzsError kzuPropertyResourceIDValueSourceCopy	(	struct KzuPropertyResourceIDValueSource *	target,
		const struct KzuPropertyResourceIDValueSource *	source
	)

Copy a resourceID value source.

KANZI_API kzsError kzuPropertyResourceIDValueSourceSetValue	(	struct KzuPropertyResourceIDValueSource *	valueSource,
		kzString	value
	)

Set a resourceID value source.

KANZI_API kzString kzuPropertyResourceIDValueSourceGetValue ( const struct KzuPropertyResourceIDValueSource * valueSource )

Get a resourceID value source.

KANZI_API kzsError kzuPropertyManagerSetResourceID	(	const struct KzuPropertyManager *	propertyManager,
		const void *	object,
		const struct KzuPropertyType *	propertyType,
		kzString	value
	)

Set a property of propertyType associated with an object.

KANZI_API void kzuPropertyManagerSetResourceIDResource	(	const KzuPropertyManager *	propertyManager,
		const void *	object,
		const KzuPropertyType *	propertyType,
		kanzi::ResourceSharedPtr	resource
	)

Set a property of propertyType associated with an object.

KANZI_API kzBool kzuPropertyManagerGetResourceID	(	const struct KzuPropertyManager *	propertyManager,
		const void *	object,
		const struct KzuPropertyType *	propertyType,
		kzString *	out_value
	)

Get the value of a property of propertyType associated with an object.

Returns KZ_TRUE if the property is found and KZ_FALSE otherwise. The return value is calculated based on the following steps:

The value associated with the object is returned.
If the property is not associated with the object, the property groups associated with the object are queried: 2.1 Property groups associated with the object are queried in the reverse order than they were added.
If the property can not be deduced, the output value is not modified and KZ_FALSE is returned.

KANZI_API kzBool kzuPropertyManagerGetResourceIDResource	(	const KzuPropertyManager *	propertyManager,
		const void *	object,
		const KzuPropertyType *	propertyType,
		kanzi::ResourceSharedPtr *	out_resource
	)

Get the value of a property of propertyType associated with an object.

Returns KZ_TRUE if the property is found and KZ_FALSE otherwise. The return value is calculated based on the following steps:

The value associated with the object is returned.
If the property is not associated with the object, the property groups associated with the object are queried: 2.1 Property groups associated with the object are queried in the reverse order than they were added.
If the property can not be deduced, the output value is not modified and KZ_FALSE is returned.

KANZI_API kzString kzuPropertyManagerGetResourceIDDefault	(	const struct KzuPropertyManager *	propertyManager,
		const void *	object,
		const struct KzuPropertyType *	propertyType
	)

Get a property of propertyType associated with an object and return the default value from the property type if not found.

If the property value can be deduced with kzuPropertyManagerGetResourceID then that value is returned. If the property can not be deduced, the default value from the property type is returned.

KANZI_API kanzi::ResourceSharedPtr kzuPropertyManagerGetResourceIDResourceDefault	(	const KzuPropertyManager *	propertyManager,
		const void *	object,
		const KzuPropertyType *	propertyType
	)

Get a property of propertyType associated with an object and return the default value from the property type if not found.

If the property value can be deduced with kzuPropertyManagerGetResourceID then that value is returned. If the property can not be deduced, the default value from the property type is returned.

KANZI_API kzsError kzuObjectNodeSetResourceIDProperty	(	const kanzi::Node *	objectNode,
		const struct KzuPropertyType *	propertyType,
		kzString	value
	)

Set a property on an object node.

KANZI_API void kzuObjectNodeSetResourceIDResourceProperty	(	const kanzi::Node *	objectNode,
		const KzuPropertyType *	propertyType,
		kanzi::ResourceSharedPtr	resource
	)

Set a property on an object node.

KANZI_API kzBool kzuObjectNodeGetResourceIDProperty	(	const kanzi::Node *	objectNode,
		const struct KzuPropertyType *	propertyType,
		kzString *	out_value
	)

Get the value of a property of propertyType associated with an object node.

Returns KZ_TRUE if the property is found and KZ_FALSE otherwise. The return value is calculated based on the following steps:

kzuPropertyManagerGetResourceID is used for getting the property value.
If the property value can not be deduced from the object node, the same query is performed for the parent of the current object node.
If the property is not found until the root is reached, the output value is not modified and KZ_FALSE is returned.

KANZI_API kzBool kzuObjectNodeGetResourceIDResourceProperty	(	const kanzi::Node *	objectNode,
		const KzuPropertyType *	propertyType,
		kanzi::ResourceSharedPtr *	out_resource
	)

Get the value of a property of propertyType associated with an object node.

Returns KZ_TRUE if the property is found and KZ_FALSE otherwise. The return value is calculated based on the following steps:

kzuPropertyManagerGetResourceIDResource is used for getting the property value.
If the property value can not be deduced from the object node, the same query is performed for the parent of the current object node.
If the property is not found until the root is reached, the output value is not modified and KZ_FALSE is returned.

KANZI_API kzString kzuObjectNodeGetResourceIDPropertyDefault	(	const kanzi::Node *	objectNode,
		const struct KzuPropertyType *	propertyType
	)

Get the value of a property associated with an object node.

Behaves like kzuObjectNodeGetResourceIDProperty, but if the property value can not be deduced, the default value from the property type is returned.

KANZI_API kanzi::ResourceSharedPtr kzuObjectNodeGetResourceIDResourcePropertyDefault	(	const kanzi::Node *	objectNode,
		const KzuPropertyType *	propertyType
	)

Get the value of a property associated with an object node.

Behaves like kzuObjectNodeGetResourceIDResourceProperty, but if the property value can not be deduced, the default value from the property type is returned.

Namespaces

Functions

Detailed Description

Function Documentation