kzu_property_manager_bool.h File Reference

Property manager. More...

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

Functions
kzsError	kzuPropertyBoolValueSourceCreate (const struct KzuPropertyManager *propertyManager, kzBool value, struct KzuPropertyBoolValueSource **out_valueSource)
	Create a bool value source. More...
kzsError	kzuPropertyBoolValueSourceDelete (struct KzuPropertyBoolValueSource *valueSource)
	Delete a bool value source. More...
kzsError	kzuPropertyBoolValueSourceClone (const struct KzuPropertyManager *propertyManager, const struct KzuPropertyBoolValueSource *valueSource, struct KzuPropertyBoolValueSource **out_newValueSource)
	Copy a bool value source. More...
kzsError	kzuPropertyBoolValueSourceCopy (struct KzuPropertyBoolValueSource *target, const struct KzuPropertyBoolValueSource *source)
	Copy a bool value source. More...
kzsError	kzuPropertyBoolValueSourceSetValue (struct KzuPropertyBoolValueSource *valueSource, kzBool value)
	Set a bool value source. More...
kzBool	kzuPropertyBoolValueSourceGetValue (const struct KzuPropertyBoolValueSource *valueSource)
	Get a bool value source. More...
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...
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...
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...
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...
kzsError	kzuObjectNodeSetBoolProperty (const struct KzuObjectNode *objectNode, const struct KzuPropertyType *propertyType, kzBool value)
	Set a property on an object node. More...
kzBool	kzuObjectNodeGetBoolProperty (const struct KzuObjectNode *objectNode, const struct KzuPropertyType *propertyType, kzBool *out_value)
	Get the value of a property of propertyType associated with an object node. More...
kzBool	kzuObjectNodeGetBoolPropertyDefault (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 kzuPropertyBoolValueSourceCreate	(	const struct KzuPropertyManager *	propertyManager,
		kzBool	value,
		struct KzuPropertyBoolValueSource **	out_valueSource
	)

Create a bool value source.

kzsError kzuPropertyBoolValueSourceDelete

(

struct KzuPropertyBoolValueSource *

valueSource)

Delete a bool value source.

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

Copy a bool value source.

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

Copy a bool value source.

kzsError kzuPropertyBoolValueSourceSetValue	(	struct KzuPropertyBoolValueSource *	valueSource,
		kzBool	value
	)

Set a bool value source.

kzBool kzuPropertyBoolValueSourceGetValue

(

const struct KzuPropertyBoolValueSource *

valueSource)

Get a bool value source.

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

Set a property of propertyType associated with an object.

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:

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.

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.

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.

kzsError kzuObjectNodeSetBoolProperty	(	const struct KzuObjectNode *	objectNode,
		const struct KzuPropertyType *	propertyType,
		kzBool	value
	)

Set a property on an object node.

kzBool kzuObjectNodeGetBoolProperty	(	const struct KzuObjectNode *	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:

1. kzuPropertyManagerGetBool 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.

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