Main virtual interface of Object Generator. More...

#include <kzu_object_generator.h>

Data Fields
struct KzuObjectGeneratorListInterface *	listInterface
	Optional list interface for modifying content of the object generator. More...

KzuObjectGeneratorInitializeFunction	initialize
	Initializes the Object Generator. More...

KzuObjectGeneratorUninitializeFunction	uninitialize
	Uninitializes the Object Generator. More...

KzuObjectGeneratorAttachFunction	attach
	Attaches the Object Generator. More...

KzuObjectGeneratorDetachFunction	detach
	Detaches the Object Generator. More...

KzuObjectGeneratorGetObjectFunction	getObject
	Gets an object that should be displayed at the given index. More...

KzuObjectGeneratorFreeObjectFunction	freeObject
	Frees an object that has been returned from getObject. More...

KzuObjectGeneratorGetObjectIndexFunction	getObjectIndex
	Gets index of an object that has been returned from getObject, or KZU_UI_LIST_BOX_NO_ITEM if the object does not exist. More...

KzuObjectGeneratorGetObjectSizeFunction	getObjectSize
	Gets exact size of the object that should be displayed at the given index. More...

KzuObjectGeneratorGetCountFunction	getCount
	Gets the number of objects known by the object generator. More...

KzuObjectGeneratorItemReplacedFunction	itemReplaced
	Notify list box about a replaced item. More...

KzuObjectGeneratorItemRemovedFunction	itemRemoved
	Notify list box about a removed item. More...

KzuObjectGeneratorItemAddedFunction	itemAdded
	Notify list box about an added item. More...

Detailed Description

Main virtual interface of Object Generator.

Field Documentation

struct KzuObjectGeneratorListInterface* KzuObjectGeneratorInterface::listInterface

Optional list interface for modifying content of the object generator.

Can be KZU_OBJECT_GENERATOR_NO_LIST_INTERFACE.

KzuObjectGeneratorInitializeFunction KzuObjectGeneratorInterface::initialize

Initializes the Object Generator.

KzuObjectGeneratorUninitializeFunction KzuObjectGeneratorInterface::uninitialize

Uninitializes the Object Generator.

KzuObjectGeneratorAttachFunction KzuObjectGeneratorInterface::attach

Attaches the Object Generator.

KzuObjectGeneratorDetachFunction KzuObjectGeneratorInterface::detach

Detaches the Object Generator.

KzuObjectGeneratorGetObjectFunction KzuObjectGeneratorInterface::getObject

Gets an object that should be displayed at the given index.

If the object has already been created and not freed afterwards, returns the object from cache.

KzuObjectGeneratorFreeObjectFunction KzuObjectGeneratorInterface::freeObject

Frees an object that has been returned from getObject.

KzuObjectGeneratorGetObjectIndexFunction KzuObjectGeneratorInterface::getObjectIndex

Gets index of an object that has been returned from getObject, or KZU_UI_LIST_BOX_NO_ITEM if the object does not exist.

KzuObjectGeneratorGetObjectSizeFunction KzuObjectGeneratorInterface::getObjectSize

Gets exact size of the object that should be displayed at the given index.

This size will be used unless the list box is provided an object prototype. Caching the sizes may be a good idea.

KzuObjectGeneratorGetCountFunction KzuObjectGeneratorInterface::getCount

Gets the number of objects known by the object generator.

Last index can be calculated as 'count' - 1.

KzuObjectGeneratorItemReplacedFunction KzuObjectGeneratorInterface::itemReplaced

Notify list box about a replaced item.

KzuObjectGeneratorItemRemovedFunction KzuObjectGeneratorInterface::itemRemoved

Notify list box about a removed item.

KzuObjectGeneratorItemAddedFunction KzuObjectGeneratorInterface::itemAdded

Notify list box about an added item.

The documentation for this struct was generated from the following file: