list_box_properties.h File Reference

Variables
static PropertyType< string >	ItemContainerGeneratorTypeNameProperty
	Sets the name of the item container generator type to use to provide item containers dynamically for a List Box node. More...
static PropertyType< ResourceSharedPtr >	ItemContainerTemplateProperty
	Sets the ListBoxItemContainer prefab that sets the appearance and behavior of the List Box items. More...
static PropertyType< int >	ItemCountProperty
	Reports the number of items in a List Box, including virtual items. More...
static PropertyType< string >	ItemGeneratorTypeNameProperty
	Sets the name of the item generator type to use to provide items dynamically for a List Box node. More...
static PropertyType< ResourceSharedPtr >	ItemTemplateProperty
	Sets the prefab template to use for the List Box items. More...
static PropertyType< int >	KeepAliveItemCountProperty
	Sets the size of the buffer for invisible List Box items. More...
static PropertyType< int >	SelectedItemIndexProperty
	Sets and reports the index of the item that is currently selected in a List Box node. More...
static PropertyType< ListBoxConcept::SelectionBehavior >	SelectionBehaviorProperty
	Sets how a List Box node behaves when the user selects an item. More...

Variable Documentation

ItemCountProperty

PropertyType<int> ItemCountProperty

static

Reports the number of items in a List Box, including virtual items.

This property is read-only.

The default value is 0.

See also

ListBoxConceptImpl::getItemCount()

KeepAliveItemCountProperty

PropertyType<int> KeepAliveItemCountProperty

static

Sets the size of the buffer for invisible List Box items.

Kanzi returns to the item generator those invisible items that do not fit in the buffer.

The default value is 20000000.

See also

ListBoxConceptImpl::setKeepAliveItemCount(), ListBoxConceptImpl::getKeepAliveItemCount()

SelectionBehaviorProperty

PropertyType<ListBoxConcept::SelectionBehavior> SelectionBehaviorProperty

static

Sets how a List Box node behaves when the user selects an item.

ListBoxConcept::SelectionBehaviorBringToCenter sets the List Box to bring an item to the center of the List Box area when the user selects that item.

The default value is ListBoxConcept::SelectionBehaviorNone.

See also

ListBoxConceptImpl::setSelectionBehavior(), ListBoxConceptImpl::getSelectionBehavior()

ItemGeneratorTypeNameProperty

PropertyType<string> ItemGeneratorTypeNameProperty

static

Sets the name of the item generator type to use to provide items dynamically for a List Box node.

The default value is "".

See also

ListBoxConceptImpl::setItemGeneratorTypeName(), ListBoxConceptImpl::getItemGeneratorTypeName()

ItemContainerGeneratorTypeNameProperty

PropertyType<string> ItemContainerGeneratorTypeNameProperty

static

Sets the name of the item container generator type to use to provide item containers dynamically for a List Box node.

The default value is "".

See also

ListBoxConceptImpl::setItemContainerGeneratorTypeName(), ListBoxConceptImpl::getItemContainerGeneratorTypeName()

ItemTemplateProperty

PropertyType<ResourceSharedPtr> ItemTemplateProperty

static

Sets the prefab template to use for the List Box items.

The default value is ResourceSharedPtr().

See also

ListBoxConceptImpl::setItemTemplate(), ListBoxConceptImpl::getItemTemplate()

ItemContainerTemplateProperty

PropertyType<ResourceSharedPtr> ItemContainerTemplateProperty

static

Sets the ListBoxItemContainer prefab that sets the appearance and behavior of the List Box items.

The default value is ResourceSharedPtr().

See also

ListBoxConceptImpl::setItemContainerTemplate(), ListBoxConceptImpl::getItemContainerTemplate()

SelectedItemIndexProperty

PropertyType<int> SelectedItemIndexProperty

static

Sets and reports the index of the item that is currently selected in a List Box node.

A List Box node updates this property when the user browses that List Box node. By setting the value of this property to the index of the item that you want to select in a List Box, you can select that item.

Kanzi overrides any value source binding that targets this property.

The default value is -1.

See also

ListBoxConceptImpl::setSelectedItemIndex(), ListBoxConceptImpl::getSelectedItemIndex()