kanzi::ListBoxItemContainer Class Reference

Use the List Box Item Container prefab to create common functionality and decoration for all items in a List Box. More...

#include <kanzi/ui/node/list_box_item_container.hpp>

Inheritance diagram for kanzi::ListBoxItemContainer:

Static Public Member Functions
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Static Public Attributes
static PropertyType< int >	ItemIndexProperty
	Reports the index of the item held by the List Box Item Container.
static PropertyType< bool >	SelectedProperty
	Indicates whether a List Box item held by this List Box Item Container is selected.

Detailed Description

Use the List Box Item Container prefab to create common functionality and decoration for all items in a List Box.

Kanzi creates a List Box Item Container for each List Box item. To set the List Box Item Container prefab for the items in a List Box, use the ListBoxConcept::ItemContainerTemplateProperty property in that List Box.

List Box item placement

To set where Kanzi places each List Box item inside the List Box Item Container prefab:

1. In the List Box Item Container prefab create a Content Layout node.
2. In the resource dictionary of the List Box Item Container prefab create an alias.
3. Name the alias "$layout" and set it to point to the Content Layout node in the List Box Item Container prefab.

Kanzi now places the List Box item in the Content Layout node to which the alias points. If you do not specify the $layout alias that points to the Content Layout node in the List Box Item Container prefab, Kanzi places the List Box item as the last child of the List Box Item Container node.

Enabling the multi-click gesture

To enable the double-click gesture for all items in a List Box node, in the List Box Item Container prefab set the ClickConcept::DoubleClickEnabledProperty to true.

Member Function Documentation

makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::ListBoxItemContainer::makeEditorInfo ( )

static

Member Data Documentation

ItemIndexProperty

PropertyType<int> kanzi::ListBoxItemContainer::ItemIndexProperty

static

Reports the index of the item held by the List Box Item Container.

This property is read-only.

See also

ListBoxItemContainerImpl::getItemIndex()

SelectedProperty

PropertyType<bool> kanzi::ListBoxItemContainer::SelectedProperty

static

Indicates whether a List Box item held by this List Box Item Container is selected.

List Box sets the value of this property. The default value is false.

See also

ListBoxItemContainerImpl::setSelected(), ListBoxItemContainerImpl::isSelected()

---

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

• kanzi/ui/node/list_box_item_container.hpp