Property manager. More...

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

Namespaces
	kanzi

Functions
KANZI_API kzsError	kzuPropertyBoolValueSourceCreate (const struct KzuPropertyManager propertyManager, kzBool value, struct KzuPropertyBoolValueSource *out_valueSource)
	Create a bool value source. More...

KANZI_API kzsError	kzuPropertyBoolValueSourceDelete (struct KzuPropertyBoolValueSource *valueSource)
	Delete a bool value source. More...

KANZI_API kzsError	kzuPropertyBoolValueSourceClone (const struct KzuPropertyManager propertyManager, const struct KzuPropertyBoolValueSource valueSource, struct KzuPropertyBoolValueSource **out_newValueSource)
	Copy a bool value source. More...

KANZI_API kzsError	kzuPropertyBoolValueSourceCopy (struct KzuPropertyBoolValueSource target, const struct KzuPropertyBoolValueSource source)
	Copy a bool value source. More...

KANZI_API kzsError	kzuPropertyBoolValueSourceSetValue (struct KzuPropertyBoolValueSource *valueSource, kzBool value)
	Set a bool value source. More...

KANZI_API kzBool	kzuPropertyBoolValueSourceGetValue (const struct KzuPropertyBoolValueSource *valueSource)
	Get a bool value source. More...

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

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

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

KANZI_API kzBool	kzuPropertyManagerGetBoolDefault (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 kzsError	kzuObjectNodeSetBoolProperty (const kanzi::Node objectNode, const struct KzuPropertyType propertyType, kzBool value)
	Set a property on an object node. More...

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

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

Detailed Description

Property manager.

Function Documentation

KANZI_API kzsError kzuPropertyBoolValueSourceCreate	(	const struct KzuPropertyManager *	propertyManager,
		kzBool	value,
		struct KzuPropertyBoolValueSource **	out_valueSource
	)

Create a bool value source.

KANZI_API kzsError kzuPropertyBoolValueSourceDelete ( struct KzuPropertyBoolValueSource * valueSource )

Delete a bool value source.

KANZI_API kzsError kzuPropertyBoolValueSourceClone	(	const struct KzuPropertyManager *	propertyManager,
		const struct KzuPropertyBoolValueSource *	valueSource,
		struct KzuPropertyBoolValueSource **	out_newValueSource
	)

Copy a bool value source.

KANZI_API kzsError kzuPropertyBoolValueSourceCopy	(	struct KzuPropertyBoolValueSource *	target,
		const struct KzuPropertyBoolValueSource *	source
	)

Copy a bool value source.

KANZI_API kzsError kzuPropertyBoolValueSourceSetValue	(	struct KzuPropertyBoolValueSource *	valueSource,
		kzBool	value
	)

Set a bool value source.

KANZI_API kzBool kzuPropertyBoolValueSourceGetValue ( const struct KzuPropertyBoolValueSource * valueSource )

Get a bool value source.

KANZI_API kzsError kzuPropertyManagerSetBool	(	const struct KzuPropertyManager *	propertyManager,
		const void *	object,
		const struct KzuPropertyType *	propertyType,
		kzBool	value
	)

Set a property of propertyType associated with an object.

KANZI_API kzBool kzuPropertyManagerGetBool	(	const struct KzuPropertyManager *	propertyManager,
		const void *	object,
		const struct KzuPropertyType *	propertyType,
		kzBool *	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 kzuPropertyManagerGetBaseBool	(	const struct KzuPropertyManager *	propertyManager,
		const void *	object,
		const struct KzuPropertyType *	propertyType,
		kzBool *	out_value
	)

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

Returns KZ_TRUE if the property is found and KZ_FALSE otherwise.

KANZI_API kzBool kzuPropertyManagerGetBoolDefault	(	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 kzuPropertyManagerGetBool then that value is returned. If the property can not be deduced, the default value from the property type is returned.

KANZI_API kzsError kzuObjectNodeSetBoolProperty	(	const kanzi::Node *	objectNode,
		const struct KzuPropertyType *	propertyType,
		kzBool	value
	)

Set a property on an object node.

KANZI_API kzBool kzuObjectNodeGetBoolProperty	(	const kanzi::Node *	objectNode,
		const struct KzuPropertyType *	propertyType,
		kzBool *	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:

kzuPropertyManagerGetBool 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 kzuObjectNodeGetBoolPropertyDefault	(	const kanzi::Node *	objectNode,
		const struct KzuPropertyType *	propertyType
	)

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

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

Namespaces

Functions

Detailed Description

Function Documentation