Kanzi  3.9.4
Kanzi Engine API
kanzi::ListBoxConcept Class Referenceabstract

Properties and messages for list boxes. More...

#include <kanzi/ui/node/concept/list_box.hpp>

Inheritance diagram for kanzi::ListBoxConcept:
[legend]

Classes

class  ItemHiddenMessageArguments
 Message arguments for the messages about item hiding in a List Box node. More...
 
class  ItemMessageArguments
 Base class for item-related message arguments. More...
 
class  ItemSelectedMessageArguments
 Message arguments for the messages about the item selected event in a List Box node. More...
 
class  ItemVisibleMessageArguments
 Message arguments for the messages about the new visible item in a List Box node. More...
 

Public Types

enum  SelectionBehavior { SelectionBehaviorNone, SelectionBehaviorBringToCenter }
 Behaviors for the List Box when an item in the List Box is selected. More...
 

Public Member Functions

virtual void notifyItemAdded (size_t index)=0
 Virtual functions for notifying item changes to list. More...
 
virtual void notifyItemCountChanged ()=0
 
virtual void notifyItemRemoved (size_t index)=0
 
virtual void notifyItemReplaced (size_t index)=0
 
- Public Member Functions inherited from kanzi::ContentItemCollectionModel
virtual bool addContentItem (NodeSharedPtr abstractItem)=0
 
virtual NodeSharedPtr getContentItem (size_t index)=0
 
virtual size_t getContentItemCount ()=0
 
virtual void removeAllContentItems ()=0
 
virtual bool removeContentItem (NodeSharedPtr abstractItem)=0
 
virtual ~ContentItemCollectionModel ()
 

Static Public Member Functions

static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 

Static Public Attributes

static MessageType< ItemHiddenMessageArgumentsItemHiddenMessage
 List Box node dispatches this message whenever the List Box hides one of its items. More...
 
static MessageType< ItemSelectedMessageArgumentsItemSelectedMessage
 List Box node dispatches this message whenever an item in the List Box is selected. More...
 
static MessageType< ItemVisibleMessageArgumentsItemVisibleMessage
 List Box node dispatches this message whenever the List Box brings one of its items visible. More...
 
Properties
static PropertyType< int > ItemCountProperty
 Reports the number of items in a List Box, including virtual items. More...
 
static PropertyType< int > KeepAliveItemCountProperty
 Sets the size of the buffer for invisible List Box items. More...
 
static PropertyType< ListBoxConcept::SelectionBehaviorSelectionBehaviorProperty
 Sets how a List Box node behaves when the user selects an item. 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< 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< ResourceSharedPtrItemTemplateProperty
 Sets the prefab template to use for the List Box items. More...
 
static PropertyType< ResourceSharedPtrItemContainerTemplateProperty
 Sets the ListBoxItemContainer prefab that sets the appearance and behavior of the 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...
 

Detailed Description

Properties and messages for list boxes.

See also
For general documentation about list boxes, see ListBoxConceptImpl.

Member Enumeration Documentation

◆ SelectionBehavior

Behaviors for the List Box when an item in the List Box is selected.

Enumerator
SelectionBehaviorNone 

When the selection changes, List Box does not change item positions in the list box area.

SelectionBehaviorBringToCenter 

List Box brings selected item to the center of the list box area.

Member Function Documentation

◆ notifyItemAdded()

◆ notifyItemRemoved()

◆ notifyItemReplaced()

◆ notifyItemCountChanged()

◆ makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::ListBoxConcept::makeEditorInfo ( )
static

Member Data Documentation

◆ ItemCountProperty

PropertyType<int> kanzi::ListBoxConcept::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> kanzi::ListBoxConcept::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> kanzi::ListBoxConcept::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> kanzi::ListBoxConcept::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> kanzi::ListBoxConcept::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> kanzi::ListBoxConcept::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> kanzi::ListBoxConcept::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> kanzi::ListBoxConcept::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()

◆ ItemSelectedMessage

MessageType<ItemSelectedMessageArguments> kanzi::ListBoxConcept::ItemSelectedMessage
static

List Box node dispatches this message whenever an item in the List Box is selected.

This message type contains the selected item index and previously selected item index.

◆ ItemVisibleMessage

MessageType<ItemVisibleMessageArguments> kanzi::ListBoxConcept::ItemVisibleMessage
static

List Box node dispatches this message whenever the List Box brings one of its items visible.

This message type contains the item index and the pointer to the visible item.

◆ ItemHiddenMessage

MessageType<ItemHiddenMessageArguments> kanzi::ListBoxConcept::ItemHiddenMessage
static

List Box node dispatches this message whenever the List Box hides one of its items.

This message type contains the item index and the pointer to the hidden item.


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