kanzi::ListBoxConcept Class Referenceabstract

Properties and messages for list boxes. More...

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

Inheritance diagram for kanzi::ListBoxConcept:
kanzi::ContentItemCollectionModel kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits > kanzi::ListBoxConceptImpl< Node2D, GridListBox2D, GridListBox2DTraits > kanzi::ListBoxConceptImpl< Node3D, GridListBox3D, GridListBox3DTraits > kanzi::ListBoxConceptImpl< Node3D, TrajectoryListBox3D, TrajectoryListBox3DTraits > kanzi::GridListBox2D kanzi::GridListBox3D kanzi::TrajectoryListBox3D

Classes

class  ItemHiddenMessageArguments
 Represents message arguments of ItemHidden message. More...
 
class  ItemMessageArguments
 Represents base class for item-related message arguments. More...
 
class  ItemSelectedMessageArguments
 Represents message arguments of ItemSelected message. More...
 
class  ItemVisibleMessageArguments
 Represents message arguments of ItemVisible message. More...
 
class  ScrolledMessageArguments
 Scrolled message, sent when list box is scrolling. More...
 
class  ScrollFinishedMessageArguments
 ScrollFinished message, sent when list box scroll ends. More...
 
class  ScrollMessageArguments
 Base class for scroll-related message arguments. More...
 
class  ScrollStartedMessageArguments
 ScrollStarted message, sent when list box scroll starts. More...
 
class  TargetChangedMessageArguments
 Represents message arguments of TargetChanged message. More...
 

Public Types

enum  SelectionBehavior { SelectionBehaviorNone, SelectionBehaviorBringToCenter }
 Behaviors for 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 notifyItemRemoved (size_t index)=0
 
virtual void notifyItemReplaced (size_t index)=0
 
virtual void notifyItemCountChanged ()=0
 
- Public Member Functions inherited from kanzi::ContentItemCollectionModel
virtual ~ContentItemCollectionModel ()
 
virtual bool addContentItem (NodeSharedPtr abstractItem)=0
 
virtual bool removeContentItem (NodeSharedPtr abstractItem)=0
 
virtual void removeAllContentItems ()=0
 
virtual size_t getContentItemCount ()=0
 
virtual NodeSharedPtr getContentItem (size_t index)=0
 

Static Public Member Functions

static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 

Static Public Attributes

static MessageType< ItemSelectedMessageArgumentsItemSelectedMessage
 ItemSelected message type. More...
 
static MessageType< ItemVisibleMessageArgumentsItemVisibleMessage
 ItemVisible message type. More...
 
static MessageType< ItemHiddenMessageArgumentsItemHiddenMessage
 ItemHidden message type. More...
 
static MessageType< TargetChangedMessageArgumentsTargetChangedMessage
 TargetChanged message type. More...
 
static MessageType< ScrolledMessageArgumentsScrolledMessage
 Scrolled message type. More...
 
static MessageType< ScrollStartedMessageArgumentsScrollStartedMessage
 Scroll Started message type. More...
 
static MessageType< ScrollFinishedMessageArgumentsScrollFinishedMessage
 Scroll Finished message type. More...
 
Properties
static PropertyType< int > KeepAliveItemCountProperty
 KeepAliveItemCount property. More...
 
static PropertyType< ListBoxConcept::SelectionBehaviorSelectionBehaviorProperty
 SelectionBehavior property. More...
 
static PropertyType< string > ItemGeneratorTypeNameProperty
 ItemGeneratorTypeName property. More...
 
static PropertyType< string > ItemContainerGeneratorTypeNameProperty
 ItemContainerGeneratorTypeName property. More...
 
static PropertyType< ResourceSharedPtrItemTemplateProperty
 ItemTemplate property. More...
 
static PropertyType< ResourceSharedPtrItemContainerTemplateProperty
 ItemContainerTemplate property. More...
 
static PropertyType< int > SelectedItemIndexProperty
 SelectedItemIndex property. More...
 

Detailed Description

Properties and messages for list boxes.

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

Member Enumeration Documentation

Behaviors for list box when an item in the list box is selected.

Enumerator
SelectionBehaviorNone 

Does not change scroll position when selection changes.

SelectionBehaviorBringToCenter 

Centers the item when selected.

Member Function Documentation

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

Member Data Documentation

PropertyType<int> kanzi::ListBoxConcept::KeepAliveItemCountProperty
static

KeepAliveItemCount property.

The default value is 20000000.

See also
setKeepAliveItemCount(), getKeepAliveItemCount()
PropertyType<ListBoxConcept::SelectionBehavior> kanzi::ListBoxConcept::SelectionBehaviorProperty
static

SelectionBehavior property.

The default value is ListBoxConcept::SelectionBehaviorNone.

See also
setSelectionBehavior(), getSelectionBehavior()
PropertyType<string> kanzi::ListBoxConcept::ItemGeneratorTypeNameProperty
static

ItemGeneratorTypeName property.

The default value is "".

See also
setItemGeneratorTypeName(), getItemGeneratorTypeName()
PropertyType<string> kanzi::ListBoxConcept::ItemContainerGeneratorTypeNameProperty
static

ItemContainerGeneratorTypeName property.

The default value is "".

See also
setItemContainerGeneratorTypeName(), getItemContainerGeneratorTypeName()
PropertyType<ResourceSharedPtr> kanzi::ListBoxConcept::ItemTemplateProperty
static

ItemTemplate property.

The default value is ResourceSharedPtr().

See also
setItemTemplate(), getItemTemplate()
PropertyType<ResourceSharedPtr> kanzi::ListBoxConcept::ItemContainerTemplateProperty
static

ItemContainerTemplate property.

The default value is ResourceSharedPtr().

See also
setItemContainerTemplate(), getItemContainerTemplate()
PropertyType<int> kanzi::ListBoxConcept::SelectedItemIndexProperty
static

SelectedItemIndex property.

Index of selected list box item. The default value is -1.

See also
setSelectedItemIndex(), getSelectedItemIndex()
MessageType<ItemSelectedMessageArguments> kanzi::ListBoxConcept::ItemSelectedMessage
static

ItemSelected message type.

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

ItemVisible message type.

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

ItemHidden message type.

MessageType<TargetChangedMessageArguments> kanzi::ListBoxConcept::TargetChangedMessage
static

TargetChanged message type.

MessageType<ScrolledMessageArguments> kanzi::ListBoxConcept::ScrolledMessage
static

Scrolled message type.

MessageType<ScrollStartedMessageArguments> kanzi::ListBoxConcept::ScrollStartedMessage
static

Scroll Started message type.

MessageType<ScrollFinishedMessageArguments> kanzi::ListBoxConcept::ScrollFinishedMessage
static

Scroll Finished message type.


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