kzu_property_manager_string.h File Reference

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	kzuPropertyStringValueSourceCreate (const struct KzuPropertyManager *propertyManager, kzString value, struct KzuPropertyStringValueSource **out_valueSource)
	Create a string value source. More...
KANZI_API kzsError	kzuPropertyStringValueSourceDelete (struct KzuPropertyStringValueSource *valueSource)
	Delete a string value source. More...
KANZI_API kzsError	kzuPropertyStringValueSourceClone (const struct KzuPropertyManager *propertyManager, const struct KzuPropertyStringValueSource *valueSource, struct KzuPropertyStringValueSource **out_newValueSource)
	Copy a string value source. More...
KANZI_API kzsError	kzuPropertyStringValueSourceCopy (struct KzuPropertyStringValueSource *target, const struct KzuPropertyStringValueSource *source)
	Copy a string value source. More...
KANZI_API kzsError	kzuPropertyStringValueSourceSetValue (struct KzuPropertyStringValueSource *valueSource, kzString value)
	Set a string value source. More...
KANZI_API kzString	kzuPropertyStringValueSourceGetValue (const struct KzuPropertyStringValueSource *valueSource)
	Get a string value source. More...
KANZI_API kzsError	kzuPropertyManagerSetString (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 kzBool	kzuPropertyManagerGetString (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 kzString	kzuPropertyManagerGetStringDefault (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	kzuObjectNodeSetStringProperty (const kanzi::Node *objectNode, const struct KzuPropertyType *propertyType, kzString value)
	Set a property on an object node. More...
KANZI_API kzBool	kzuObjectNodeGetStringProperty (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 kzString	kzuObjectNodeGetStringPropertyDefault (const kanzi::Node *objectNode, const struct KzuPropertyType *propertyType)
	Get the value of a property associated with an object node. More...

Detailed Description

Property manager.

Copyright 2008-2020 by Rightware. All rights reserved.

Function Documentation

KANZI_API kzsError kzuPropertyStringValueSourceCreate	(	const struct KzuPropertyManager *	propertyManager,
		kzString	value,
		struct KzuPropertyStringValueSource **	out_valueSource
	)

Create a string value source.

KANZI_API kzsError kzuPropertyStringValueSourceDelete

(

struct KzuPropertyStringValueSource *

valueSource

)

Delete a string value source.

KANZI_API kzsError kzuPropertyStringValueSourceClone	(	const struct KzuPropertyManager *	propertyManager,
		const struct KzuPropertyStringValueSource *	valueSource,
		struct KzuPropertyStringValueSource **	out_newValueSource
	)

Copy a string value source.

KANZI_API kzsError kzuPropertyStringValueSourceCopy	(	struct KzuPropertyStringValueSource *	target,
		const struct KzuPropertyStringValueSource *	source
	)

Copy a string value source.

KANZI_API kzsError kzuPropertyStringValueSourceSetValue	(	struct KzuPropertyStringValueSource *	valueSource,
		kzString	value
	)

Set a string value source.

KANZI_API kzString kzuPropertyStringValueSourceGetValue

(

const struct KzuPropertyStringValueSource *

valueSource

)

Get a string value source.

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

Set a property of propertyType associated with an object.

KANZI_API kzBool kzuPropertyManagerGetString	(	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:

1. The value associated with the object is returned.
2. 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.
3. If the property can not be deduced, the output value is not modified and KZ_FALSE is returned.

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

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

Set a property on an object node.

KANZI_API kzBool kzuObjectNodeGetStringProperty	(	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:

1. kzuPropertyManagerGetString is used for getting the property value.
2. 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.
3. 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 kzuObjectNodeGetStringPropertyDefault	(	const kanzi::Node *	objectNode,
		const struct KzuPropertyType *	propertyType
	)

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

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