|
Kanzi Graphics Engine
|
|
Kanzi Graphics Engine
|
Base functions for List box component. More...
#include <user/ui/kzu_ui_component_base.h>#include <system/kzs_types.h>#include <system/debug/kzs_error.h>#include <system/kzs_header.h>Data Structures | |
| struct | KzuUiListBox |
| List box. More... | |
Typedefs | |
| typedef kzBool(* | KzuUiListBoxItemFilterFunction )(struct KzuObjectNode *objectNode, void *userData) |
| Filter function that returns KZ_TRUE if a child object of the list box should be interpreted as a list box item. More... | |
Functions | |
| void | kzuUiListBoxReset_protected (struct KzuUiListBox *listBox) |
| Resets members of list box to their state at construction. More... | |
| kzsError | kzuUiListBoxAddChildrenAsItems_protected (struct KzuUiListBox *listBox, KzuUiListBoxItemFilterFunction filterFunction, void *userData) |
| Adds children of a list box as items of the list box if the object generator supports the list interface. More... | |
| kzsError | kzuUiListBoxUndoAddChildrenAsItems_protected (const struct KzuUiListBox *listBox) |
| Moves list box items of a list box back as its children. More... | |
| kzsError | kzuUiListBoxBindChildProperty_protected (struct KzuObjectNode *childObject, kzString relativePathToListBox, const struct KzuPropertyType *sourceProperty, const struct KzuPropertyType *targetProperty) |
| Binds a given source property in the list box to the given target property in the given list box child object. More... | |
| kzsError | kzuUiListBoxUpdateVisibleRange_protected (struct KzuUiListBox *listBox, kzUint beginIndex, kzUint itemCount) |
| Sets the items in the given range to be visible items and hides all others. More... | |
| kzsError | kzuUiListBoxUpdateVisibleRangeQuiet_protected (struct KzuUiListBox *listBox, kzUint beginIndex, kzUint itemCount) |
| Same as kzuUiListBoxUpdateVisibleRange_protected but does not send messages. More... | |
| kzsError | kzuUiListBoxUpdateTotalItemCount_protected (struct KzuUiListBox *listBox) |
| Updates list box's total item count. More... | |
| KZ_CALLBACK kzsError | kzuUiListBoxInitialize_protected (struct KzuObjectNode *objectNode) |
| Initializes a list box. More... | |
| KZ_CALLBACK kzsError | kzuUiListBoxUninitialize_protected (struct KzuObjectNode *objectNode) |
| Uninitializes a list box. More... | |
| KZ_CALLBACK kzsError | kzuUiListBoxOnAttached_protected (struct KzuObjectNode *objectNode) |
| List box on attached implementation. More... | |
| KZ_CALLBACK kzsError | kzuUiListBoxOnDetached_protected (struct KzuObjectNode *objectNode) |
| List box on detached implementation. More... | |
| KZ_CALLBACK kzsError | kzuUiListBoxMeasure_protected (struct KzuUiComponentNode *componentNode, struct KzcVector3 *out_coreDesiredSize) |
| Measures a list box. More... | |
| KZ_CALLBACK kzsError | kzuUiListBoxArrange_protected (struct KzuUiComponentNode *componentNode) |
| Arranges a list box. More... | |
| kzsError | kzuUiListBoxFactoryCreateCustom_protected (const struct KzcMemoryManager *memoryManager, kzString name, struct KzuUIDomain *uiDomain, const struct KzuUiComponentNodeClass *componentNodeClass, struct KzuUiListBox **out_listBox) |
| Creates a list box with the given component node class. More... | |
Base functions for List box component.
Copyright 2008-2019 by Rightware. All rights reserved.
| typedef kzBool(* KzuUiListBoxItemFilterFunction)(struct KzuObjectNode *objectNode, void *userData) |
Filter function that returns KZ_TRUE if a child object of the list box should be interpreted as a list box item.
| void kzuUiListBoxReset_protected | ( | struct KzuUiListBox * | listBox) |
Resets members of list box to their state at construction.
| kzsError kzuUiListBoxAddChildrenAsItems_protected | ( | struct KzuUiListBox * | listBox, |
| KzuUiListBoxItemFilterFunction | filterFunction, | ||
| void * | userData | ||
| ) |
Adds children of a list box as items of the list box if the object generator supports the list interface.
| kzsError kzuUiListBoxUndoAddChildrenAsItems_protected | ( | const struct KzuUiListBox * | listBox) |
Moves list box items of a list box back as its children.
| kzsError kzuUiListBoxBindChildProperty_protected | ( | struct KzuObjectNode * | childObject, |
| kzString | relativePathToListBox, | ||
| const struct KzuPropertyType * | sourceProperty, | ||
| const struct KzuPropertyType * | targetProperty | ||
| ) |
Binds a given source property in the list box to the given target property in the given list box child object.
| kzsError kzuUiListBoxUpdateVisibleRange_protected | ( | struct KzuUiListBox * | listBox, |
| kzUint | beginIndex, | ||
| kzUint | itemCount | ||
| ) |
Sets the items in the given range to be visible items and hides all others.
If beginIndex + itemCount is at least the total number of items, the range is interpreted to be looping past the end.
It is an error to try to display the same item twice.
Send messages about items entering or leaving the range.
| kzsError kzuUiListBoxUpdateVisibleRangeQuiet_protected | ( | struct KzuUiListBox * | listBox, |
| kzUint | beginIndex, | ||
| kzUint | itemCount | ||
| ) |
Same as kzuUiListBoxUpdateVisibleRange_protected but does not send messages.
| kzsError kzuUiListBoxUpdateTotalItemCount_protected | ( | struct KzuUiListBox * | listBox) |
Updates list box's total item count.
| KZ_CALLBACK kzsError kzuUiListBoxInitialize_protected | ( | struct KzuObjectNode * | objectNode) |
Initializes a list box.
| KZ_CALLBACK kzsError kzuUiListBoxUninitialize_protected | ( | struct KzuObjectNode * | objectNode) |
Uninitializes a list box.
| KZ_CALLBACK kzsError kzuUiListBoxOnAttached_protected | ( | struct KzuObjectNode * | objectNode) |
List box on attached implementation.
| KZ_CALLBACK kzsError kzuUiListBoxOnDetached_protected | ( | struct KzuObjectNode * | objectNode) |
List box on detached implementation.
| KZ_CALLBACK kzsError kzuUiListBoxMeasure_protected | ( | struct KzuUiComponentNode * | componentNode, |
| struct KzcVector3 * | out_coreDesiredSize | ||
| ) |
Measures a list box.
| KZ_CALLBACK kzsError kzuUiListBoxArrange_protected | ( | struct KzuUiComponentNode * | componentNode) |
Arranges a list box.
| kzsError kzuUiListBoxFactoryCreateCustom_protected | ( | const struct KzcMemoryManager * | memoryManager, |
| kzString | name, | ||
| struct KzuUIDomain * | uiDomain, | ||
| const struct KzuUiComponentNodeClass * | componentNodeClass, | ||
| struct KzuUiListBox ** | out_listBox | ||
| ) |
Creates a list box with the given component node class.
1.8.4