ListBoxConceptImpl provides the common base implementation for the List Box nodes, such as GridListBox2D, GridListBox3D, and TrajectoryListBox3D. More...

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

Inheritance diagram for kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >:

[legend]

Public Types
typedef shared_ptr< DefaultListBoxItemGenerator< ItemGeneratorClass > >	DefaultItemGeneratorSharedPtr

typedef ListBoxTraits::TItemClass	ItemClass

typedef ListBoxTraits::TItemContainerClass	ItemContainerClass

typedef ListBoxTraits::TItemContainerGeneratorClass	ItemContainerGeneratorClass

typedef shared_ptr< ItemContainerGeneratorClass >	ItemContainerGeneratorSharedPtr

typedef shared_ptr< ItemContainerClass >	ItemContainerSharedPtr

typedef ListBoxTraits::TItemGeneratorClass	ItemGeneratorClass

typedef shared_ptr< ItemGeneratorClass >	ItemGeneratorSharedPtr

typedef shared_ptr< ItemClass >	ItemSharedPtr

typedef TBaseClass::LayoutVectorType	LayoutVectorType

typedef ListBoxTraits::TPresenterClass	PresenterClass

typedef shared_ptr< PresenterClass >	PresenterSharedPtr

Public Types inherited from kanzi::ListBoxConcept
enum	SelectionBehavior { SelectionBehaviorNone, SelectionBehaviorBringToCenter }
	Behaviors for the List Box when an item in the List Box is selected. More...

Public Member Functions
bool	addContentItem (NodeSharedPtr abstractItem) override

void	addItem (ItemSharedPtr item)
	Adds an item at the end of a List Box when using the default object generator. More...

void	arrangeOverride (LayoutVectorType actualSize) override

void	bringItemCenter (size_t itemIndex, bool smooth)
	Requests the List Box to bring the item in the passed itemIndex to the center of the list box area. More...

void	enableKeyNavigation (bool enabled)
	Enables directional key navigation on the List Box. More...

optional< pair< size_t, size_t > >	getAliveRange ()
	Returns the range of list items that are alive. More...

NodeSharedPtr	getContentItem (size_t index) override

size_t	getContentItemCount () override

ItemSharedPtr	getItem (size_t index)
	Gets the item at the given index in a List Box. More...

string	getItemContainerGeneratorTypeName () const
	Gets the value of ItemContainerGeneratorTypeNameProperty. More...

PrefabTemplateSharedPtr	getItemContainerTemplate () const
	Gets the value of ItemContainerTemplateProperty. More...

size_t	getItemCount () const
	Returns the value of the ItemCountProperty. More...

string	getItemGeneratorTypeName () const
	Gets the value of ItemGeneratorTypeNameProperty. More...

optional< size_t >	getItemIndex (ItemSharedPtr item)
	Returns the index of the given item. If the item does not exist, returns empty. More...

LayoutVectorType	getItemSize (size_t index)
	Returns the size of the item at the given index. More...

PrefabTemplateSharedPtr	getItemTemplate () const
	Gets the value of ItemTemplateProperty. More...

int	getKeepAliveItemCount () const
	Gets the value of KeepAliveItemCountProperty. More...

PresenterSharedPtr	getPresenter () const

int	getSelectedItemIndex () const
	Gets the value of SelectedItemIndexProperty. More...

SelectionBehavior	getSelectionBehavior () const
	Gets the value of SelectionBehavior. More...

void	insertItem (size_t index, ItemSharedPtr item)
	Inserts an item at the given index in a List Box when using the default object generator. More...

bool	isEmpty ()
	Indicates whether a List Box has no items. More...

LayoutVectorType	measureOverride (LayoutVectorType availableSize) override

void	notifyItemAdded (size_t index) override
	Virtual functions for notifying item changes to list. More...

void	notifyItemContainerChanged ()

void	notifyItemCountChanged () override

void	notifyItemRemoved (size_t index) override

void	notifyItemReplaced (size_t index) override

void	removeAllContentItems () override

void	removeAllItems ()
	Removes all items from a List Box when using the default object generator. More...

bool	removeContentItem (NodeSharedPtr abstractItem) override

void	removeItem (size_t index)
	Removes the item at the given index from a List Box when using the default object generator. More...

void	removeLastItem ()
	Removes the last item from a List Box when using the default object generator. More...

void	replaceItem (size_t index, ItemSharedPtr item)
	Replaces the item at the given index in a List Box when using the default object generator. More...

void	selectItem (optional< size_t > itemIndex)
	Requests the List Box to select the item at the given index. More...

void	setItemContainerGenerator (ItemContainerGeneratorSharedPtr itemContainerGenerator)
	Sets the list box item container generator. More...

void	setItemContainerGeneratorTypeName (string_view value)
	Sets the value of ItemContainerGeneratorTypeNameProperty. More...

void	setItemContainerTemplate (PrefabTemplateSharedPtr value)
	Sets the value of ItemContainerTemplateProperty. More...

void	setItemGenerator (ItemGeneratorSharedPtr itemGenerator)
	Sets the list box item generator. More...

void	setItemGeneratorTypeName (string_view value)
	Sets the value of ItemGeneratorTypeNameProperty. More...

void	setItemTemplate (PrefabTemplateSharedPtr value)
	Sets the value of ItemTemplateProperty. More...

void	setKeepAliveItemCount (int value)
	Sets the value of KeepAliveItemCountProperty. More...

void	setSelectedItemIndex (int value)
	Sets the value of SelectedItemIndexProperty. More...

void	setSelectionBehavior (SelectionBehavior value)
	Sets the value of SelectionBehavior. More...

void	updateVisibleRange (size_t beginIndex, size_t itemCount)
	Requests items from the item generator. More...

void	updateVisibleRange (size_t beginIndex, size_t itemCount, bool sendMessages)

void	updateVisibleRangeQuiet (size_t beginIndex, size_t itemCount)
	Requests items from the item generator. More...

Public Member Functions inherited from kanzi::ContentItemCollectionModel
virtual	~ContentItemCollectionModel ()

Static Public Member Functions
static Vector2	doMeasure (Node2D &node)

static Vector3	doMeasure (Node3D &node)

Static Public Member Functions inherited from kanzi::ListBoxConcept
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Protected Member Functions
void	applySelectionBehavior (size_t itemIndex, bool smooth)
	Applies selection behavior to the selected item. More...

void	assignItemContainerGenerator (ItemContainerGeneratorSharedPtr itemContainerGenerator)
	Assigns list box item container generator to list box. More...

void	assignItemGenerator (ItemGeneratorSharedPtr itemGenerator)
	Assigns list box item generator to list box. More...

void	initialize (PresenterSharedPtr presenter)

	ListBoxConceptImpl (Domain *domain, string_view name)

bool	listBoxContainsKeyFocus () const
	Returns whether the key focus is on the List Box node or on one of the list items. More...

void	onAttached () override
	Node::onAttached() implementation. More...

void	onClicked (ClickManipulator::ClickMessageArguments &messageArguments)
	Handles ClickManipulator::ClickMessage. More...

void	onDetached () override
	Node::onDetached() implementation. More...

void	onFocusGained (FocusManager::PostFocusMessageArguments &messageArguments)
	Handles FocusManager::FocusGainedMessage. More...

void	onNodePropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) override
	Node::onNodePropertyChanged() implementation. More...

void	setItemContainerGeneratorByProperty ()
	Creates and assigns item container generator by ItemGeneratorTypeName property value. More...

void	setItemGeneratorByProperty ()
	Creates and assigns item generator by ItemGeneratorTypeName property value. More...

void	synchronizeFocusAndSelection (Node &selectedItemContainer)
	ListBoxConcept uses this function to update the focus in the List Box to the selected item. More...

void	synchronizeItemCountProperty ()
	Updates the ItemCountProperty. More...

void	synchronizeSelectedItemIndexProperty ()
	Updates the SelectedItemIndexProperty after the List Box internally changes the selected item index. More...

void	tryMoveFocusToListBox ()
	Tries to move focus to List Box node itself. More...

void	updateFocusScopeInfo (FocusScopePtr &nodeScopeInfo) override
	Overrides Node::updateFocusScopeInfo(). More...

void	updateGenerators (ItemGeneratorSharedPtr itemGenerator, ItemContainerGeneratorSharedPtr itemContainerGenerator)
	Replaces item and item container generators with new objects. Updates items and layout accordingly. More...

	~ListBoxConceptImpl () override

Static Protected Member Functions
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Additional Inherited Members
Static Public Attributes inherited from kanzi::ListBoxConcept
static MessageType< ItemHiddenMessageArguments >	ItemHiddenMessage
	List Box node dispatches this message whenever the List Box hides one of its items. More...

static MessageType< ItemSelectedMessageArguments >	ItemSelectedMessage
	List Box node dispatches this message whenever an item in the List Box is selected. More...

static MessageType< ItemVisibleMessageArguments >	ItemVisibleMessage
	List Box node dispatches this message whenever the List Box brings one of its items visible. More...

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::SelectionBehavior >	SelectionBehaviorProperty
	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< ResourceSharedPtr >	ItemTemplateProperty
	Sets the prefab template to use for the List Box items. More...

static PropertyType< ResourceSharedPtr >	ItemContainerTemplateProperty
	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

template<typename TBaseClass, typename TDerivedClass, typename ListBoxTraits>
class kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >

ListBoxConceptImpl provides the common base implementation for the List Box nodes, such as GridListBox2D, GridListBox3D, and TrajectoryListBox3D.

Use the List Box nodes to create lists of selectable items. For example, use the List Box nodes to create contact lists, playlists in a media player, or car settings lists.

A List Box node provides an invisible hit testable area that listens to input and reacts when the user pans the area to browse the list. When the user browses the list, the List Box moves the items so that new items become visible and old items disappear. How this happens depends on the specific List Box.

Item generator

A List Box node gets its items from an item generator. By default, the List Box uses the DefaultListBoxItemGenerator that only stores the items that are added to it. To create dynamic content for a List Box, replace the item generator with a custom implementation.

Item container

A List Box node wraps its items in container nodes that are created by an item container generator. The default item generator creates invisible nodes that do nothing.

Enabling a List Box node to handle the key focus and key input

To enable a List Box node to handle the key focus and key input:

In the List Box node, attach the FocusManager::FocusScopeTypeProperty.
Create for the List Box a custom ListBoxItemContainer prefab template.
In the root node of the ListBoxItemContainer:
- Attach the FocusManager::FocusScopeTypeProperty and set it to FocusScopeType::Group or FocusScopeType::Fence.
- Make sure that the Node::FocusableProperty is not set to true.
In any descendant nodes of the ListBoxItemContainer or in any nodes in the list item, attach the Node::FocusableProperty and set it to true.

This way, you enable these nodes to gain the key focus and react to key input.

Kanzi now synchronizes the key focus and item selection in the List Box:

If the key focus of the application is in the List Box and a focusable list item in that List Box gets selected, Kanzi transfers the key focus to that item. Note that a virtualized list item is not focusable.
When the key focus moves to another list item, that item gets selected.

The synchronization works only when both the List Box and the List Box Item Container are focus scopes.

To set a List Box to not handle key focus and key input, in that List Box and its List Box Item Container, remove the FocusManager::FocusScopeTypeProperty.

See also: FocusManager

Disabling a List Box node

Disabled List Box nodes do not respond to input. When Kanzi disables a List Box node, it cancels the ongoing gestures and preserves the position of that List Box node.

To disable a List Box node, set the Node::EnabledProperty to false.

To visually indicate the disabled state of a List Box node, create a state manager and use the Node::EffectivelyEnabledProperty as its controller property.

Member Typedef Documentation

template<typename TBaseClass, typename TDerivedClass, typename ListBoxTraits>

typedef ListBoxTraits::TItemClass kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::ItemClass

template<typename TBaseClass, typename TDerivedClass, typename ListBoxTraits>

typedef ListBoxTraits::TItemContainerClass kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::ItemContainerClass

template<typename TBaseClass, typename TDerivedClass, typename ListBoxTraits>

typedef ListBoxTraits::TPresenterClass kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::PresenterClass

template<typename TBaseClass, typename TDerivedClass, typename ListBoxTraits>

typedef ListBoxTraits::TItemGeneratorClass kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::ItemGeneratorClass

template<typename TBaseClass, typename TDerivedClass, typename ListBoxTraits>

typedef ListBoxTraits::TItemContainerGeneratorClass kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::ItemContainerGeneratorClass

template<typename TBaseClass, typename TDerivedClass, typename ListBoxTraits>

typedef TBaseClass::LayoutVectorType kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::LayoutVectorType

template<typename TBaseClass, typename TDerivedClass, typename ListBoxTraits>

typedef shared_ptr<ItemClass> kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::ItemSharedPtr

template<typename TBaseClass, typename TDerivedClass, typename ListBoxTraits>

typedef shared_ptr<ItemContainerClass> kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::ItemContainerSharedPtr

template<typename TBaseClass, typename TDerivedClass, typename ListBoxTraits>

typedef shared_ptr<DefaultListBoxItemGenerator<ItemGeneratorClass> > kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::DefaultItemGeneratorSharedPtr

template<typename TBaseClass, typename TDerivedClass, typename ListBoxTraits>

typedef shared_ptr<ItemGeneratorClass> kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::ItemGeneratorSharedPtr

template<typename TBaseClass, typename TDerivedClass, typename ListBoxTraits>

typedef shared_ptr<ItemContainerGeneratorClass> kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::ItemContainerGeneratorSharedPtr

template<typename TBaseClass, typename TDerivedClass, typename ListBoxTraits>

typedef shared_ptr<PresenterClass> kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::PresenterSharedPtr

Constructor & Destructor Documentation

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::ListBoxConceptImpl	(	Domain *	domain,
		string_view	name
	)

explicitprotected

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::~ListBoxConceptImpl ( )

overrideprotected

Member Function Documentation

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

bool kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::addContentItem ( NodeSharedPtr abstractItem )

overridevirtual

Implements kanzi::ContentItemCollectionModel.

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

bool kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::removeContentItem ( NodeSharedPtr abstractItem )

overridevirtual

Implements kanzi::ContentItemCollectionModel.

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

void kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::removeAllContentItems ( )

overridevirtual

Implements kanzi::ContentItemCollectionModel.

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

size_t kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::getContentItemCount ( )

overridevirtual

Implements kanzi::ContentItemCollectionModel.

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

NodeSharedPtr kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::getContentItem ( size_t index )

overridevirtual

Implements kanzi::ContentItemCollectionModel.

template<typename TBaseClass, typename TDerivedClass, typename ListBoxTraits>

PresenterSharedPtr kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::getPresenter ( ) const

inline

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

optional< pair< size_t, size_t > > kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::getAliveRange ( )

Returns the range of list items that are alive.

By using virtualization a List Box node keeps alive and in memory only the items that are visible and the number of items that you set with the KeepAliveItemCountProperty. The returned pair contains the index of the first item and the number of items. If there are no alive items in the List Box, returns (0, 0). If there are no items in the List Box, returns nullopt.

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

bool kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::isEmpty ( )

Indicates whether a List Box has no items.

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::LayoutVectorType kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::getItemSize ( size_t index )

Returns the size of the item at the given index.

If it is not possible to determine the size without first acquiring the item, returns an unbound layout value.

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

optional< size_t > kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::getItemIndex ( ItemSharedPtr item )

Returns the index of the given item. If the item does not exist, returns empty.

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::ItemSharedPtr kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::getItem ( size_t index )

Gets the item at the given index in a List Box.

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

void kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::insertItem	(	size_t	index,
		ItemSharedPtr	item
	)

Inserts an item at the given index in a List Box when using the default object generator.

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

void kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::removeItem ( size_t index )

Removes the item at the given index from a List Box when using the default object generator.

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

void kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::replaceItem	(	size_t	index,
		ItemSharedPtr	item
	)

Replaces the item at the given index in a List Box when using the default object generator.

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

void kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::addItem ( ItemSharedPtr item )

Adds an item at the end of a List Box when using the default object generator.

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

void kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::removeLastItem ( )

Removes the last item from a List Box when using the default object generator.

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

void kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::removeAllItems ( )

Removes all items from a List Box when using the default object generator.

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

void kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::selectItem ( optional< size_t > itemIndex )

Requests the List Box to select the item at the given index.

Parameters

itemIndex The index of the selected item. To clear the selection, set to empty.

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

void kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::enableKeyNavigation ( bool enabled )

Enables directional key navigation on the List Box.

Parameters

enabled To enable key navigation, pass true. To disable key navigation, pass false.

Since: Kanzi 3.9.1

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

void kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::notifyItemAdded ( size_t index )

overridevirtual

Virtual functions for notifying item changes to list.

Implements kanzi::ListBoxConcept.

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

void kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::notifyItemRemoved ( size_t index )

overridevirtual

Implements kanzi::ListBoxConcept.

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

void kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::notifyItemReplaced ( size_t index )

overridevirtual

Implements kanzi::ListBoxConcept.

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

void kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::notifyItemCountChanged ( )

overridevirtual

Implements kanzi::ListBoxConcept.

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

void kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::notifyItemContainerChanged ( )

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

Vector2 kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::doMeasure ( Node2D & node )

static

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

Vector3 kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::doMeasure ( Node3D & node )

static

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::LayoutVectorType kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::measureOverride ( LayoutVectorType availableSize )

override

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

void kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::arrangeOverride ( LayoutVectorType actualSize )

override

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

void kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::updateVisibleRangeQuiet	(	size_t	beginIndex,
		size_t	itemCount
	)

Requests items from the item generator.

Called by the presenter when new items are displayed or old items hidden.

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

void kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::updateVisibleRange	(	size_t	beginIndex,
		size_t	itemCount
	)

Requests items from the item generator.

Called by the presenter when new items are displayed or old items hidden. Sends messages about hidden and revealed items.

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

void kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::updateVisibleRange	(	size_t	beginIndex,
		size_t	itemCount,
		bool	sendMessages
	)

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

void kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::bringItemCenter	(	size_t	itemIndex,
		bool	smooth
	)

Requests the List Box to bring the item in the passed itemIndex to the center of the list box area.

Parameters

itemIndex	The index of the focused item.
smooth	To animate the movement of the target item to the center of the list box area, set to true. To move the target item to the center of the list box area immediately, set to false.

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

size_t kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::getItemCount ( ) const

Returns the value of the ItemCountProperty.

Returns: The number of items in the List Box, including virtual items.

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

int kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::getKeepAliveItemCount ( ) const

Gets the value of KeepAliveItemCountProperty.

See also: getKeepAliveItemCount()

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

void kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::setKeepAliveItemCount ( int value )

Sets the value of KeepAliveItemCountProperty.

See also: setKeepAliveItemCount()

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

int kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::getSelectedItemIndex ( ) const

Gets the value of SelectedItemIndexProperty.

See also: setSelectedItemIndex()

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

void kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::setSelectedItemIndex ( int value )

Sets the value of SelectedItemIndexProperty.

See also: getSelectedItemIndex()

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

ListBoxConcept::SelectionBehavior kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::getSelectionBehavior ( ) const

Gets the value of SelectionBehavior.

See also: setSelectionBehavior()

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

void kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::setSelectionBehavior ( SelectionBehavior value )

Sets the value of SelectionBehavior.

See also: getSelectionBehavior()

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

string kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::getItemGeneratorTypeName ( ) const

Gets the value of ItemGeneratorTypeNameProperty.

See also: setItemGeneratorTypeName()

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

void kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::setItemGeneratorTypeName ( string_view value )

Sets the value of ItemGeneratorTypeNameProperty.

See also: getItemGeneratorTypeName()

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

string kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::getItemContainerGeneratorTypeName ( ) const

Gets the value of ItemContainerGeneratorTypeNameProperty.

See also: getItemContainerGeneratorTypeName()

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

void kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::setItemContainerGeneratorTypeName ( string_view value )

Sets the value of ItemContainerGeneratorTypeNameProperty.

See also: setItemContainerGeneratorTypeName()

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

PrefabTemplateSharedPtr kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::getItemTemplate ( ) const

Gets the value of ItemTemplateProperty.

See also: getItemTemplate()

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

void kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::setItemTemplate ( PrefabTemplateSharedPtr value )

Sets the value of ItemTemplateProperty.

See also: setItemTemplate()

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

PrefabTemplateSharedPtr kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::getItemContainerTemplate ( ) const

Gets the value of ItemContainerTemplateProperty.

See also: getItemContainerTemplate()

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

void kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::setItemContainerTemplate ( PrefabTemplateSharedPtr value )

Sets the value of ItemContainerTemplateProperty.

See also: setItemContainerTemplate()

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

void kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::setItemGenerator ( ItemGeneratorSharedPtr itemGenerator )

Sets the list box item generator.

Parameters

itemGenerator New item generator.

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

void kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::setItemContainerGenerator ( ItemContainerGeneratorSharedPtr itemContainerGenerator )

Sets the list box item container generator.

Parameters

itemContainerGenerator New item container generator.

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

void kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::initialize ( PresenterSharedPtr presenter )

protected

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

void kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::onClicked ( ClickManipulator::ClickMessageArguments & messageArguments )

protected

Handles ClickManipulator::ClickMessage.

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

void kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::onFocusGained ( FocusManager::PostFocusMessageArguments & messageArguments )

protected

Handles FocusManager::FocusGainedMessage.

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

void kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::onAttached ( )

overrideprotected

Node::onAttached() implementation.

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

void kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::onDetached ( )

overrideprotected

Node::onDetached() implementation.

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

void kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::onNodePropertyChanged	(	AbstractPropertyType	propertyType,
		PropertyNotificationReason	reason
	)

overrideprotected

Node::onNodePropertyChanged() implementation.

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

void kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::applySelectionBehavior	(	size_t	itemIndex,
		bool	smooth
	)

protected

Applies selection behavior to the selected item.

Parameters

itemIndex	The index of the item to which you want to apply selection behavior.
smooth	For a List Box whose SelectionBehaviorProperty is set to ListBoxConcept::SelectionBehaviorBringToCenter, this parameter determines whether to animate the movement of the selected item to the center of the List Box area. To bring the item to the center immediately, pass false.

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

void kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::assignItemGenerator ( ItemGeneratorSharedPtr itemGenerator )

protected

Assigns list box item generator to list box.

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

void kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::setItemGeneratorByProperty ( )

protected

Creates and assigns item generator by ItemGeneratorTypeName property value.

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

void kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::assignItemContainerGenerator ( ItemContainerGeneratorSharedPtr itemContainerGenerator )

protected

Assigns list box item container generator to list box.

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

void kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::setItemContainerGeneratorByProperty ( )

protected

Creates and assigns item container generator by ItemGeneratorTypeName property value.

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

void kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::updateGenerators	(	ItemGeneratorSharedPtr	itemGenerator,
		ItemContainerGeneratorSharedPtr	itemContainerGenerator
	)

protected

Replaces item and item container generators with new objects. Updates items and layout accordingly.

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

void kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::synchronizeSelectedItemIndexProperty ( )

protected

Updates the SelectedItemIndexProperty after the List Box internally changes the selected item index.

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

void kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::synchronizeItemCountProperty ( )

protected

Updates the ItemCountProperty.

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

void kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::synchronizeFocusAndSelection ( Node & selectedItemContainer )

protected

ListBoxConcept uses this function to update the focus in the List Box to the selected item.

When the item selection changes while the List Box contains the focus:

If the selected item contains a node that can receive the focus, that node gets the focus.
If the selected item does not contain focusable nodes, the List Box gets the focus.

When the item selection changes while the List Box does not contain the focus, Kanzi sets the selected item as the focus node in the List Box. This way, when the user navigates the focus to the List Box, the selected item gets the focus.

Parameters

selectedItemContainer Item container of the selected List Box item.

Since: Kanzi 3.9.7

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

bool kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::listBoxContainsKeyFocus ( ) const

protected

Returns whether the key focus is on the List Box node or on one of the list items.

Returns: If the key focus is on the List Box or on one of the list items, true, otherwise false.

Since: Kanzi 3.9.7

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

void kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::tryMoveFocusToListBox ( )

protected

Tries to move focus to List Box node itself.

Since: Kanzi 3.9.7

template<typename TBaseClass , typename TDerivedClass , typename ListBoxTraits >

void kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::updateFocusScopeInfo ( FocusScopePtr & nodeScopeInfo )

overrideprotected

Overrides Node::updateFocusScopeInfo().

template<typename TBaseClass, typename TDerivedClass, typename ListBoxTraits>

static PropertyTypeEditorInfoSharedPtr kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >::makeEditorInfo ( )

inlinestaticprotected

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

kanzi/ui/node/concept/list_box.hpp
kanzi/ui/node/concept/list_box_concept_impl.hpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

template<typename TBaseClass, typename TDerivedClass, typename ListBoxTraits> class kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >

Item generator

Item container

Enabling a List Box node to handle the key focus and key input

Disabling a List Box node

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

template<typename TBaseClass, typename TDerivedClass, typename ListBoxTraits>
class kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, ListBoxTraits >