kzu_style.h File Reference

Style. More...

#include <user/properties/kzu_property_manager.h>
#include <user/resource/kzu_resource_common.h>
#include <user/scene_graph/kzu_object_common.h>
#include <core/util/collection/kzc_dynamic_array.h>
#include <core/util/collection/kzc_hash_map.h>
#include <system/kzs_types.h>
#include <system/debug/kzs_error.h>
#include <system/kzs_header.h>

Functions
kzsError	kzuStyleCreateEmpty (struct KzuResourceManager *resourceManager, struct KzuPropertyManager *propertyManager, kzString name, struct KzuStyle **out_style)
	Create an empty style. More...
kzsError	kzuStyleCreate (struct KzuResourceManager *resourceManager, struct KzuPropertyManager *propertyManager, kzString name, struct KzuStyle *parentStyle, KzuObjectType objectType, const void *properties, const struct KzcDynamicArray *bindings, const struct KzcDynamicArray *triggers, struct KzuStyle **out_style)
	Create a style. More...
kzsError	kzuStyleCopy (struct KzuResourceManager *resourceManager, const struct KzuStyle *sourceStyle, struct KzuStyle **out_style)
	Copy a style. More...
kzsError	kzuStyleLoadFromKZB (struct KzuStyle *style, struct KzcInputStream *inputStream, const struct KzuBinaryFileInfo *file)
	Load a style from kzb. More...
struct KzuPropertyManager *	kzuStyleGetPropertyManager (const struct KzuStyle *style)
	Get the property manager of a style. More...
struct KzcHashMapIterator	kzuStyleGetProperties (const struct KzuStyle *style)
	Get the properties of a style. More...
void *	kzuStyleGetValueSource (const struct KzuStyle *style, const struct KzuPropertyType *propertyType)
	Get value source for a property type. More...
kzsError	kzuStyleApply (struct KzuObjectNodeAppliedStyleEntry *appliedStyleEntry, struct KzuObjectNode *objectNode)
	Apply a style. More...
kzsError	kzuStyleUnapply (const struct KzuObjectNodeAppliedStyleEntry *appliedStyleEntry, const struct KzuObjectNode *objectNode)
	Unapply a style. More...
kzsError	kzuStyleApplyAll (struct KzuObjectNode *applyObjectNode)
	Apply all styles to an object node. More...
struct KzuResource *	kzuStyleToResource (const struct KzuStyle *style)
	Converts style to resource. More...
struct KzuStyle *	kzuStyleFromResource (const struct KzuResource *resource)
	Converts style from resource. More...
struct KzuStyle *	kzuStyleCastFromResource (const struct KzuResource *resource)
	Casts style from resource, KZ_NULL if invalid type. More...
kzBool	kzuResourceIsStyle (const struct KzuResource *resource)
	Returns if given resource is style. More...
struct KzcDynamicArrayIterator	kzuStyleGetBindings (const struct KzuStyle *style)
	Gets bindings of style. More...
struct KzcDynamicArrayIterator	kzuStyleGetTriggers (const struct KzuStyle *style)
	Gets triggers of style. More...
void	kzuStyleSetPrecedence (struct KzuStyle *style, enum KzuPropertyValuePrecedence precedence)
	Set style properties precedence. More...
void	kzuStyleSetUIDomain (struct KzuStyle *style, const struct KzuUIDomain *uiDomain)
	Set UI domain to style. More...

Variables
const KzuResourceType	KZU_RESOURCE_TYPE_STYLE
	Resource type identifier for style. More...

Detailed Description

Style.

Copyright 2008-2019 by Rightware. All rights reserved.

Function Documentation

kzsError kzuStyleCreateEmpty	(	struct KzuResourceManager *	resourceManager,
		struct KzuPropertyManager *	propertyManager,
		kzString	name,
		struct KzuStyle **	out_style
	)

Create an empty style.

kzsError kzuStyleCreate	(	struct KzuResourceManager *	resourceManager,
		struct KzuPropertyManager *	propertyManager,
		kzString	name,
		struct KzuStyle *	parentStyle,
		KzuObjectType	objectType,
		const void *	properties,
		const struct KzcDynamicArray *	bindings,
		const struct KzcDynamicArray *	triggers,
		struct KzuStyle **	out_style
	)

Create a style.

kzsError kzuStyleCopy	(	struct KzuResourceManager *	resourceManager,
		const struct KzuStyle *	sourceStyle,
		struct KzuStyle **	out_style
	)

Copy a style.

kzsError kzuStyleLoadFromKZB	(	struct KzuStyle *	style,
		struct KzcInputStream *	inputStream,
		const struct KzuBinaryFileInfo *	file
	)

Load a style from kzb.

struct KzuPropertyManager* kzuStyleGetPropertyManager

(

const struct KzuStyle *

style)

Get the property manager of a style.

struct KzcHashMapIterator kzuStyleGetProperties

(

const struct KzuStyle *

style)

Get the properties of a style.

void* kzuStyleGetValueSource	(	const struct KzuStyle *	style,
		const struct KzuPropertyType *	propertyType
	)

Get value source for a property type.

kzsError kzuStyleApply	(	struct KzuObjectNodeAppliedStyleEntry *	appliedStyleEntry,
		struct KzuObjectNode *	objectNode
	)

Apply a style.

kzsError kzuStyleUnapply	(	const struct KzuObjectNodeAppliedStyleEntry *	appliedStyleEntry,
		const struct KzuObjectNode *	objectNode
	)

Unapply a style.

kzsError kzuStyleApplyAll

(

struct KzuObjectNode *

applyObjectNode)

Apply all styles to an object node.

struct KzuResource* kzuStyleToResource

(

const struct KzuStyle *

style)

Converts style to resource.

struct KzuStyle* kzuStyleFromResource

(

const struct KzuResource *

resource)

Converts style from resource.

struct KzuStyle* kzuStyleCastFromResource

(

const struct KzuResource *

resource)

Casts style from resource, KZ_NULL if invalid type.

kzBool kzuResourceIsStyle

(

const struct KzuResource *

resource)

Returns if given resource is style.

struct KzcDynamicArrayIterator kzuStyleGetBindings

(

const struct KzuStyle *

style)

Gets bindings of style.

struct KzcDynamicArrayIterator kzuStyleGetTriggers

(

const struct KzuStyle *

style)

Gets triggers of style.

void kzuStyleSetPrecedence	(	struct KzuStyle *	style,
		enum KzuPropertyValuePrecedence	precedence
	)

Set style properties precedence.

void kzuStyleSetUIDomain	(	struct KzuStyle *	style,
		const struct KzuUIDomain *	uiDomain
	)

Set UI domain to style.

Variable Documentation

const KzuResourceType KZU_RESOURCE_TYPE_STYLE

Resource type identifier for style.