kzu_ui_list_box_item.h File Reference

User interface component List Box Item. More...

#include <user/scene_graph/kzu_object_common.h>
#include <system/kzs_types.h>
#include <system/debug/kzs_error.h>
#include <system/wrappers/kzs_math.h>
#include <system/kzs_header.h>

Macros
#define	KZU_UI_LIST_BOX_ITEM_NO_PRESENTER_INDEX
	Unitialized value for list box item presenter index. More...

Functions
kzsError	kzuUiListBoxItemCreate (const struct KzcMemoryManager *memoryManager, kzString name, struct KzuUIDomain *uiDomain, struct KzuUiListBoxItem **out_listBoxItem)
	Creates a raw list box item with default settings. More...
kzsError	kzuUiListBoxItemRegisterToFactory (const struct KzuFactory *factory)
	Registers component type to factory. More...
struct KzuUiComponentNode *	kzuUiListBoxItemToUiComponentNode (const struct KzuUiListBoxItem *listBoxItem)
	Casts to UiComponentNode. More...
struct KzuUiListBoxItem *	kzuUiListBoxItemFromUiComponentNode (const struct KzuUiComponentNode *component)
	Casts to UiListBoxItem. More...
void	kzuUiListBoxItemSetPresenterIndex (struct KzuUiListBoxItem *listBoxItem, kzUint presenterIndex)
	Sets the index of the item for the presenter. More...
kzUint	kzuUiListBoxItemGetPresenterIndex (const struct KzuUiListBoxItem *listBoxItem)
	Returns the index set for the presenter. More...

Variables
const KzuObjectType	KZU_OBJECT_TYPE_UI_LIST_BOX_ITEM
	Object type for list box item. More...

Detailed Description

User interface component List Box Item.

KzuUiListBoxItem is a container for a list box element. It stores an index to the KzuPresenter for the element. Normally the KzuItemGenerator of a KzuUiListBox creates KzuUiListBoxItems on request.

See Also

kzu_item_generator.h, kzu_presenter.h.

Copyright 2008-2019 by Rightware. All rights reserved.

Macro Definition Documentation

#define KZU_UI_LIST_BOX_ITEM_NO_PRESENTER_INDEX

Unitialized value for list box item presenter index.

Function Documentation

kzsError kzuUiListBoxItemCreate	(	const struct KzcMemoryManager *	memoryManager,
		kzString	name,
		struct KzuUIDomain *	uiDomain,
		struct KzuUiListBoxItem **	out_listBoxItem
	)

Creates a raw list box item with default settings.

kzsError kzuUiListBoxItemRegisterToFactory

(

const struct KzuFactory *

factory)

Registers component type to factory.

struct KzuUiComponentNode* kzuUiListBoxItemToUiComponentNode

(

const struct KzuUiListBoxItem *

listBoxItem)

Casts to UiComponentNode.

struct KzuUiListBoxItem* kzuUiListBoxItemFromUiComponentNode

(

const struct KzuUiComponentNode *

component)

Casts to UiListBoxItem.

void kzuUiListBoxItemSetPresenterIndex	(	struct KzuUiListBoxItem *	listBoxItem,
		kzUint	presenterIndex
	)

Sets the index of the item for the presenter.

kzUint kzuUiListBoxItemGetPresenterIndex

(

const struct KzuUiListBoxItem *

listBoxItem)

Returns the index set for the presenter.

Variable Documentation

const KzuObjectType KZU_OBJECT_TYPE_UI_LIST_BOX_ITEM

Object type for list box item.