Implementation of base List Box Item Container class for List Box. More...

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

Inheritance diagram for kanzi::ListBoxItemContainerImpl< TBaseClass, TDerivedClass, TItemLayoutClass >:

Public Types
using	ItemBaseType

using	ItemBaseTypeSharedPtr

using	ItemLayoutSharedPtr

Public Member Functions
void	attachItem (ItemBaseTypeSharedPtr item)
	Attaches a List Box item to the List Box Item Container.

void	detachItem ()
	Detaches current List Box item from the List Box Item Container.

auto	getItem () const
	Returns the List Box item that is attached to the List Box Item Container.

optional< size_t >	getItemIndex () const
	Returns the index of the item held by the List Box Item Container.

optional< size_t >	getPresenterIndex () const
	Returns a List Box Presenter item index.

bool	isSelected () const
	Returns the value of SelectedProperty.

void	setPresenterIndex (optional< size_t > itemIndex)
	Sets the List Box Presenter item index.

void	setSelected (bool value)
	Sets the value of SelectedProperty.

Public Member Functions inherited from kanzi::ClickConceptImpl< TBaseClass, TDerivedClass >
bool	isDoubleClickEnabled () const
	Gets the value of DoubleClickEnabledProperty.

void	setDoubleClickEnabled (bool value)
	Sets the value of DoubleClickEnabledProperty.

Protected Member Functions
void	initialize ()

	ListBoxItemContainerImpl (Domain *domain, string_view name)

void	onNodePropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) override

Protected Member Functions inherited from kanzi::ClickConceptImpl< TBaseClass, TDerivedClass >
	ClickConceptImpl (Domain *domain, string_view name)
	Constructor.

void	configureDoubleClick ()
	Configures a MultiClickManipulator for an ClickConcept-derived class based on the value of the DoubleClickEnabledProperty:

void	onAttached () override
	Overrides TBaseClass::onAttached().

void	onClicked (ClickManipulator::ClickMessageArguments &messageArguments)
	Handles click event.

void	onDetached () override
	Overrides TBaseClass::onDetached().

void	onMultiClicked (MultiClickManipulator::MultiClickMessageArguments &messageArguments)
	Handles multi-click event.

void	onNodePropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) override
	Overrides TBaseClass::onNodePropertyChanged().

Static Protected Member Functions
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Protected Attributes
BindingRuntimeHandle	m_focusOrderBinding

ItemBaseTypeSharedPtr	m_item

Protected Attributes inherited from kanzi::ClickConcept
ClickManipulatorSharedPtr	m_clickManipulator
	The ClickManipulator.

MultiClickManipulatorSharedPtr	m_multiClickManipulator
	Multi-Click manipulator.

Additional Inherited Members
Static Public Member Functions inherited from kanzi::ClickConceptImpl< TBaseClass, TDerivedClass >
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

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

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

Static Public Attributes inherited from kanzi::ClickConcept
static PropertyType< bool >	DoubleClickEnabledProperty
	Enables the double-click gesture for a node.

Static Public Attributes inherited from kanzi::ListBoxItemContainer
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

template<typename TBaseClass, typename TDerivedClass, typename TItemLayoutClass>
class kanzi::ListBoxItemContainerImpl< TBaseClass, TDerivedClass, TItemLayoutClass >

Implementation of base List Box Item Container class for List Box.

Template Parameters

TItemLayoutClass Type of the layout node that you use together with the "$layout" alias to set the placement of the List Box item inside the List Box Item Container prefab.

Member Typedef Documentation

◆ ItemBaseType

template<typename TBaseClass , typename TDerivedClass , typename TItemLayoutClass >

using kanzi::ListBoxItemContainerImpl< TBaseClass, TDerivedClass, TItemLayoutClass >::ItemBaseType

◆ ItemBaseTypeSharedPtr

template<typename TBaseClass , typename TDerivedClass , typename TItemLayoutClass >

using kanzi::ListBoxItemContainerImpl< TBaseClass, TDerivedClass, TItemLayoutClass >::ItemBaseTypeSharedPtr

◆ ItemLayoutSharedPtr

template<typename TBaseClass , typename TDerivedClass , typename TItemLayoutClass >

using kanzi::ListBoxItemContainerImpl< TBaseClass, TDerivedClass, TItemLayoutClass >::ItemLayoutSharedPtr

Constructor & Destructor Documentation

◆ ListBoxItemContainerImpl()

template<typename TBaseClass , typename TDerivedClass , typename TItemLayoutClass >

kanzi::ListBoxItemContainerImpl< TBaseClass, TDerivedClass, TItemLayoutClass >::ListBoxItemContainerImpl	(	Domain *	domain,
		string_view	name )

inlineexplicitprotected

Member Function Documentation

◆ getItemIndex()

template<typename TBaseClass , typename TDerivedClass , typename TItemLayoutClass >

optional< size_t > kanzi::ListBoxItemContainerImpl< TBaseClass, TDerivedClass, TItemLayoutClass >::getItemIndex ( ) const

inline

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

Returns: Returns the index of the item held by the List Box Item Container. If the List Box Item Container is not attached to the layout, returns nullopt.

◆ isSelected()

template<typename TBaseClass , typename TDerivedClass , typename TItemLayoutClass >

bool kanzi::ListBoxItemContainerImpl< TBaseClass, TDerivedClass, TItemLayoutClass >::isSelected ( ) const

inline

Returns the value of SelectedProperty.

Returns: True if a List Box item is selected.

See also: setSelected()

◆ setSelected()

template<typename TBaseClass , typename TDerivedClass , typename TItemLayoutClass >

void kanzi::ListBoxItemContainerImpl< TBaseClass, TDerivedClass, TItemLayoutClass >::setSelected ( bool value )

inline

Sets the value of SelectedProperty.

Parameters

value True if a List Box item is selected.

See also: isSelected()

◆ getPresenterIndex()

template<typename TBaseClass , typename TDerivedClass , typename TItemLayoutClass >

optional< size_t > kanzi::ListBoxItemContainerImpl< TBaseClass, TDerivedClass, TItemLayoutClass >::getPresenterIndex ( ) const

inline

Returns a List Box Presenter item index.

Returns: Returns a List Box Presenter item index of the List Box Item Container.

◆ setPresenterIndex()

template<typename TBaseClass , typename TDerivedClass , typename TItemLayoutClass >

void kanzi::ListBoxItemContainerImpl< TBaseClass, TDerivedClass, TItemLayoutClass >::setPresenterIndex ( optional< size_t > itemIndex )

inline

Sets the List Box Presenter item index.

Parameters

itemIndex Presenter item index to set for the List Box Item Container.

◆ attachItem()

template<typename TBaseClass , typename TDerivedClass , typename TItemLayoutClass >

void kanzi::ListBoxItemContainerImpl< TBaseClass, TDerivedClass, TItemLayoutClass >::attachItem ( ItemBaseTypeSharedPtr item )

inline

Attaches a List Box item to the List Box Item Container.

If the "$layout" alias is specified and it points to a Content Layout node, List Box Item Container adds the List Box item in that Content Layout node. Otherwise, List Box Item Container adds the List Box item as the last child of the List Box Item Container node.

Parameters

item	List Box item that is attached to the List Box Item Container.

Since: Kanzi 3.9.0

◆ detachItem()

template<typename TBaseClass , typename TDerivedClass , typename TItemLayoutClass >

void kanzi::ListBoxItemContainerImpl< TBaseClass, TDerivedClass, TItemLayoutClass >::detachItem ( )

inline

Detaches current List Box item from the List Box Item Container.

Since: Kanzi 3.9.0

◆ getItem()

template<typename TBaseClass , typename TDerivedClass , typename TItemLayoutClass >

auto kanzi::ListBoxItemContainerImpl< TBaseClass, TDerivedClass, TItemLayoutClass >::getItem ( ) const

inline

Returns the List Box item that is attached to the List Box Item Container.

Returns: List Box item that is attached to the List Box Item Container.

Since: Kanzi 3.9.0

◆ initialize()

template<typename TBaseClass , typename TDerivedClass , typename TItemLayoutClass >

void kanzi::ListBoxItemContainerImpl< TBaseClass, TDerivedClass, TItemLayoutClass >::initialize ( )

inlineprotected

◆ onNodePropertyChanged()

template<typename TBaseClass , typename TDerivedClass , typename TItemLayoutClass >

void kanzi::ListBoxItemContainerImpl< TBaseClass, TDerivedClass, TItemLayoutClass >::onNodePropertyChanged	(	AbstractPropertyType	propertyType,
		PropertyNotificationReason	reason )

inlineoverrideprotected

◆ makeEditorInfo()

template<typename TBaseClass , typename TDerivedClass , typename TItemLayoutClass >

static PropertyTypeEditorInfoSharedPtr kanzi::ListBoxItemContainerImpl< TBaseClass, TDerivedClass, TItemLayoutClass >::makeEditorInfo ( )

inlinestaticprotected

Member Data Documentation

◆ m_item

template<typename TBaseClass , typename TDerivedClass , typename TItemLayoutClass >

ItemBaseTypeSharedPtr kanzi::ListBoxItemContainerImpl< TBaseClass, TDerivedClass, TItemLayoutClass >::m_item

protected

◆ m_focusOrderBinding

template<typename TBaseClass , typename TDerivedClass , typename TItemLayoutClass >

BindingRuntimeHandle kanzi::ListBoxItemContainerImpl< TBaseClass, TDerivedClass, TItemLayoutClass >::m_focusOrderBinding

protected

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

kanzi/ui/node/list_box_item_container.hpp

Public Types

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ItemBaseType

◆ ItemBaseTypeSharedPtr

◆ ItemLayoutSharedPtr

Constructor & Destructor Documentation

◆ ListBoxItemContainerImpl()

Member Function Documentation

◆ getItemIndex()

◆ isSelected()

◆ setSelected()

◆ getPresenterIndex()

◆ setPresenterIndex()

◆ attachItem()

◆ detachItem()

◆ getItem()

◆ initialize()

◆ onNodePropertyChanged()

◆ makeEditorInfo()

Member Data Documentation

◆ m_item

◆ m_focusOrderBinding