kzu_property_manager_string.h File Reference

Property manager. More...

#include <system/kzs_types.h>
#include <system/debug/kzs_error.h>
#include <system/kzs_header.h>

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

Detailed Description

Property manager.

Copyright 2008-2019 by Rightware. All rights reserved.

Function Documentation

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

Create a string value source.

kzsError kzuPropertyStringValueSourceDelete

(

struct KzuPropertyStringValueSource *

valueSource)

Delete a string value source.

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

Copy a string value source.

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

Copy a string value source.

kzsError kzuPropertyStringValueSourceSetValue	(	struct KzuPropertyStringValueSource *	valueSource,
		kzString	value
	)

Set a string value source.

kzString kzuPropertyStringValueSourceGetValue

(

const struct KzuPropertyStringValueSource *

valueSource)

Get a string value source.

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

Set a property of propertyType associated with an object.

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.

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.

kzsError kzuObjectNodeSetStringProperty	(	const struct KzuObjectNode *	objectNode,
		const struct KzuPropertyType *	propertyType,
		kzString	value
	)

Set a property on an object node.

kzBool kzuObjectNodeGetStringProperty	(	const struct KzuObjectNode *	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.

kzString kzuObjectNodeGetStringPropertyDefault	(	const struct KzuObjectNode *	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.