Defines interface for Item Generators that create List Box Items for ListBox. More...

#include <user/ui/components/listbox/kzu_item_container_generator_common.h>
#include <system/kzs_types.h>
#include <system/debug/kzs_error.h>
#include <system/kzs_header.h>

Data Structures
struct	KzuItemGeneratorInterface
	Main interface of Item Generator. More...

struct	KzuItemGenerator
	Base class for item generators that create and govern list box items as needed. More...

Typedefs
typedef kzsError(*	KzuItemGeneratorInitializeFunction )(struct KzuItemGenerator *generator)
	Function type to initialize the item generator. More...

typedef kzsError(*	KzuItemGeneratorUninitializeFunction )(struct KzuItemGenerator *generator)
	Function type to uninitialize the item generator. More...

typedef kzsError(*	KzuItemGeneratorAttachFunction )(struct KzuItemGenerator generator, const struct KzuObjectNode objectNode)
	Function type to attache the Item Generator. More...

typedef kzsError(*	KzuItemGeneratorDetachFunction )(struct KzuItemGenerator generator, const struct KzuObjectNode objectNode)
	Function type to detache the Item Generator. More...

typedef kzsError(*	KzuItemGeneratorCreateItemFunction )(struct KzuItemGenerator generator, kzString name, struct KzuObjectNode *out_item)
	Function type to output an empty item container for an object. More...

typedef kzsError(*	KzuItemGeneratorDeleteItemFunction )(struct KzuItemGenerator generator, struct KzuObjectNode item)
	Function type to delete an item container returned by createItem. More...

typedef kzsError(*	KzuItemGeneratorGetContainerSizeFunction )(struct KzuItemGenerator generator, const struct KzcVector3 objectSize, struct KzcVector3 *out_size)
	Function type to get size of an item container that would be created for an object of the given size. More...

typedef kzsError(*	KzuItemGeneratorGetObjectFunction )(struct KzuItemGenerator generator, struct KzuObjectNode item, struct KzuObjectNode **out_object)
	Function type to get the object attached to the list box item. More...

typedef kzsError(*	KzuItemGeneratorAttachObjectFunction )(struct KzuItemGenerator generator, struct KzuObjectNode item, struct KzuObjectNode *object)
	Function type to attache an object to the list box item. More...

typedef kzsError(*	KzuItemGeneratorDetachObjectFunction )(struct KzuItemGenerator generator, struct KzuObjectNode item)
	Function type to detache the object contained by the list box item. More...

Functions
kzsError	kzuItemGeneratorCreate_protected (const struct KzcMemoryManager memoryManager, struct KzuUIDomain uiDomain, const struct KzuItemGeneratorInterface interface, struct KzuItemGenerator generator)
	Creates an item generator. More...

kzsError	kzuItemGeneratorDelete (struct KzuItemGenerator *generator)
	Destroys item generator. More...

struct KzuUIDomain *	kzuItemGeneratorGetUIDomain_protected (const struct KzuItemGenerator *generator)
	Gets the project assigned to the object generator. More...

struct KzcMemoryManager *	kzuItemGeneratorGetMemoryManager_protected (const struct KzuItemGenerator *generator)
	Gets the memory manager used by the object generator. More...

kzsError	kzuItemGeneratorInitialize (struct KzuItemGenerator *generator)
	Initializes the item generator. More...

kzsError	kzuItemGeneratorUninitialize (struct KzuItemGenerator *generator)
	Uninitializes the item generator. More...

kzsError	kzuItemGeneratorAttach (struct KzuItemGenerator generator, const struct KzuObjectNode objectNode)
	Attaches the Object Generator. More...

kzsError	kzuItemGeneratorDetach (struct KzuItemGenerator generator, const struct KzuObjectNode objectNode)
	Detaches the Object Generator. More...

kzsError	kzuItemGeneratorCreateItem (struct KzuItemGenerator generator, kzString name, struct KzuObjectNode *out_item)
	Outputs an empty item container for an object. More...

kzsError	kzuItemGeneratorDeleteItem (struct KzuItemGenerator generator, struct KzuObjectNode item)
	Deletes an item container returned by kzuItemGeneratorCreateItem. More...

kzsError	kzuItemGeneratorGetContainerSize (struct KzuItemGenerator generator, const struct KzcVector3 objectSize, struct KzcVector3 *out_size)
	Gets size of an item container that would be created for an object of the given size. More...

kzsError	kzuItemGeneratorGetObject (struct KzuItemGenerator generator, struct KzuObjectNode item, struct KzuObjectNode **out_object)
	Gets the object attached to the list box item. More...

kzsError	kzuItemGeneratorAttachObject (struct KzuItemGenerator generator, struct KzuObjectNode item, struct KzuObjectNode *object)
	Attaches the object to the list box item. More...

kzsError	kzuItemGeneratorDetachObject (struct KzuItemGenerator generator, struct KzuObjectNode item)
	Detaches the object attached to the list box item. More...

Detailed Description

Defines interface for Item Generators that create List Box Items for ListBox.

Typedef Documentation

typedef kzsError(* KzuItemGeneratorInitializeFunction)(struct KzuItemGenerator *generator)

Function type to initialize the item generator.

typedef kzsError(* KzuItemGeneratorUninitializeFunction)(struct KzuItemGenerator *generator)

Function type to uninitialize the item generator.

typedef kzsError(* KzuItemGeneratorAttachFunction)(struct KzuItemGenerator *generator, const struct KzuObjectNode *objectNode)

Function type to attache the Item Generator.

typedef kzsError(* KzuItemGeneratorDetachFunction)(struct KzuItemGenerator *generator, const struct KzuObjectNode *objectNode)

Function type to detache the Item Generator.

typedef kzsError(* KzuItemGeneratorCreateItemFunction)(struct KzuItemGenerator *generator, kzString name, struct KzuObjectNode **out_item)

Function type to output an empty item container for an object.

typedef kzsError(* KzuItemGeneratorDeleteItemFunction)(struct KzuItemGenerator *generator, struct KzuObjectNode *item)

Function type to delete an item container returned by createItem.

typedef kzsError(* KzuItemGeneratorGetContainerSizeFunction)(struct KzuItemGenerator *generator, const struct KzcVector3 *objectSize, struct KzcVector3 *out_size)

Function type to get size of an item container that would be created for an object of the given size.

typedef kzsError(* KzuItemGeneratorGetObjectFunction)(struct KzuItemGenerator *generator, struct KzuObjectNode *item, struct KzuObjectNode **out_object)

Function type to get the object attached to the list box item.

typedef kzsError(* KzuItemGeneratorAttachObjectFunction)(struct KzuItemGenerator *generator, struct KzuObjectNode *item, struct KzuObjectNode *object)

Function type to attache an object to the list box item.

typedef kzsError(* KzuItemGeneratorDetachObjectFunction)(struct KzuItemGenerator *generator, struct KzuObjectNode *item)

Function type to detache the object contained by the list box item.

Function Documentation

kzsError kzuItemGeneratorCreate_protected	(	const struct KzcMemoryManager *	memoryManager,
		struct KzuUIDomain *	uiDomain,
		const struct KzuItemGeneratorInterface *	interface,
		struct KzuItemGenerator *	generator
	)

Creates an item generator.

kzsError kzuItemGeneratorDelete ( struct KzuItemGenerator * generator)

Destroys item generator.

struct KzuUIDomain* kzuItemGeneratorGetUIDomain_protected ( const struct KzuItemGenerator * generator)

Gets the project assigned to the object generator.

struct KzcMemoryManager* kzuItemGeneratorGetMemoryManager_protected ( const struct KzuItemGenerator * generator)

Gets the memory manager used by the object generator.

kzsError kzuItemGeneratorInitialize ( struct KzuItemGenerator * generator)

Initializes the item generator.

kzsError kzuItemGeneratorUninitialize ( struct KzuItemGenerator * generator)

Uninitializes the item generator.

kzsError kzuItemGeneratorAttach	(	struct KzuItemGenerator *	generator,
		const struct KzuObjectNode *	objectNode
	)

Attaches the Object Generator.

kzsError kzuItemGeneratorDetach	(	struct KzuItemGenerator *	generator,
		const struct KzuObjectNode *	objectNode
	)

Detaches the Object Generator.

kzsError kzuItemGeneratorCreateItem	(	struct KzuItemGenerator *	generator,
		kzString	name,
		struct KzuObjectNode **	out_item
	)

Outputs an empty item container for an object.

kzsError kzuItemGeneratorDeleteItem	(	struct KzuItemGenerator *	generator,
		struct KzuObjectNode *	item
	)

Deletes an item container returned by kzuItemGeneratorCreateItem.

kzsError kzuItemGeneratorGetContainerSize	(	struct KzuItemGenerator *	generator,
		const struct KzcVector3 *	objectSize,
		struct KzcVector3 *	out_size
	)

Gets size of an item container that would be created for an object of the given size.

kzsError kzuItemGeneratorGetObject	(	struct KzuItemGenerator *	generator,
		struct KzuObjectNode *	item,
		struct KzuObjectNode **	out_object
	)

Gets the object attached to the list box item.

kzsError kzuItemGeneratorAttachObject	(	struct KzuItemGenerator *	generator,
		struct KzuObjectNode *	item,
		struct KzuObjectNode *	object
	)

Attaches the object to the list box item.

kzsError kzuItemGeneratorDetachObject	(	struct KzuItemGenerator *	generator,
		struct KzuObjectNode *	item
	)

Detaches the object attached to the list box item.

Data Structures

Typedefs

Functions

Detailed Description

Typedef Documentation

Function Documentation