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

Inheritance diagram for kanzi::ListBoxGridPresenter< TFinalClass, TLayout, TItemClass, TScrollView >:

Public Types
using	BaseClass

using	ItemSharedPtr

using	LayoutSharedPtr

using	ListBoxGridPresenterType

using	ScrollViewSharedPtr

Public Member Functions
void	addToLayout (ItemSharedPtr listBoxItem)

Vector2	bringItemCenter (size_t selection) const

void	bringItemCenter (size_t selection, bool smooth) const

Vector2	deduceSkippedOffset () const
	Calculates how much offset is being skipped by skipping non-visible items.

void	enableKeyNavigation (bool enabled)
	Enables directional key navigation on the Grid Presenter.

unsigned int	getColumnCount () const
	Gets the number of columns that are currently displayed.

ItemSharedPtr	getItem (size_t presenterIndex) const

unsigned int	getRowCount () const
	Gets the number of rows that are currently displayed.

void	getScrollBounds (float out_scrollMinimumX, float out_scrollMaximumX, float out_scrollMinimumY, float out_scrollMaximumY) const

void	initialize (TFinalClass *listBox, LayoutSharedPtr layout)

bool	isEffectivelyLooping () const

bool	isStateChanged ()
	Checks whether the layout state of the presenter has changed.

	ListBoxGridPresenter ()

void	notifyItemAdded (size_t)
	Invalidates layout if an item is added.

void	notifyItemContainerChanged ()
	Invalidates layout if the item container is changed.

void	notifyItemRemoved (size_t)
	Invalidates layout if an item is removed.

void	notifyItemReplaced (size_t)
	Invalidates layout if an item is replaced.

void	removeFromLayout (ItemSharedPtr listBoxItem)

void	scrollPage (ScrollViewConcept::ScrollPage direction)
	Sets scroll delta to one page and starts scrolling to that direction.

void	scrollToDirection (ScrollViewConcept::ScrollDirection direction)
	Sets scroll delta to one item and starts scrolling to that direction.

void	scrollToEdge (ScrollViewConcept::ScrollEdge direction)
	Sets scroll target to content edge and starts scrolling to that direction.

void	setScroll (Vector2 scroll)

void	snap (Vector2 position, Vector2, bool, Vector2 out_position, int out_itemIndex)

void	tryMoveFocusInDirection (ListBoxConcept::FocusMoveTarget target, bool fallback=false)
	Tries to move the focus to the next or previous item in a Grid List Box node.

void	tryMoveFocusToEdge (ListBoxConcept::FocusMoveTarget target, bool fallback=false)
	Tries to move the focus to the first or last item in a Grid List Box node.

void	tryMoveFocusToPage (ListBoxConcept::FocusMoveTarget target, bool fallback=false)
	Tries to move the focus by one page in a Grid List Box node.

void	update ()

void	updateOffsetProperties ()
	Calculates the values of the Node::VisibleAmountInParentProperty and GridListBoxConcept::CalculatedOffsetProperty properties for items in the Grid List Box.

void	updateRenderTransform (Vector2 scroll)
	Updates scroll transform of layout.

void	updateScrollViewBounds ()

Public Member Functions inherited from kanzi::ListBoxScrollPresenterConceptImpl< ListBoxGridPresenter< TFinalClass, TLayout, TItemClass, TScrollView >, TFinalClass, TScrollView >
ScrollViewSharedPtr	getScrollView () const
	Returns the Scroll View that the presenter uses.

void	initialize (TFinalClass *listBox)
	ListBoxScrollPresenterConceptImpl specific initialization.

	ListBoxScrollPresenterConceptImpl ()=default
	Constructor.

Static Public Member Functions
static void	doRemeasure (Node2D &node)

static void	doRemeasure (Node3D &node)

static void	doUpdateRenderTransform (Node2D &node, Vector2 scroll)

static void	doUpdateRenderTransform (Node3D &node, Vector2 scroll)

Additional Inherited Members
Protected Member Functions inherited from kanzi::ListBoxScrollPresenterConceptImpl< ListBoxGridPresenter< TFinalClass, TLayout, TItemClass, TScrollView >, TFinalClass, TScrollView >
void	onClickBegin (ClickManipulator::ClickBeginMessageArguments &messageArguments)
	Handles ClickManipulator::onClickBeginMessage.

void	onItemSelected (ListBoxConcept::ItemSelectedMessageArguments &messageArguments)
	Handles ListBoxConcept::ItemSelectedMessage.

void	onScrolled (ScrollViewConcept::ScrolledMessageArguments &messageArguments)
	Handles ScrollViewClass::ScrolledMessage.

void	onScrollFinished (ScrollViewConcept::ScrollFinishedMessageArguments &messageArguments)
	Handles ScrollViewClass::ScrollFinishedMessage.

void	onScrollStarted (ScrollViewConcept::ScrollStartedMessageArguments &messageArguments)
	Handles ScrollViewClass::ScrollStartedMessage.

void	onSnapRequested (ScrollViewConcept::SnapRequestMessageArguments &messageArguments)
	Handles ScrollViewClass::SnapRequestMessage.

void	onUserScrollFinished (ScrollViewConcept::UserScrollFinishedMessageArguments &messageArguments)
	Handles ScrollViewClass::UserScrollFinishedMessage.

void	onUserScrollStarted (ScrollViewConcept::UserScrollStartedMessageArguments &messageArguments)
	Handles ScrollViewClass::UserScrollStartedMessage.

void	scrollToTargetItem (size_t itemIndex, Vector2 scrollPosition, bool smooth) const
	Requests Scroll View to scroll to target item position.

void	sendListBoxTargetChangedMessage (size_t targetItem) const
	Sends ListBoxScrollPresenterConcept::TargetChangedMessage message to List Box.

void	sendScrollViewSetScrollMessage (const Vector2 &scrollPosition) const
	Sends ScrollViewConcept::SetScrollMessage message to Scroll View.

void	sendScrollViewSetScrollTargetMessage (const Vector2 &scrollTarget) const
	Sends ScrollViewConcept::SetScrollTargetMessage message to Scroll View.

Protected Attributes inherited from kanzi::ListBoxScrollPresenterConceptImpl< ListBoxGridPresenter< TFinalClass, TLayout, TItemClass, TScrollView >, TFinalClass, TScrollView >
TFinalClass *	m_listBox
	List Box that owns this presenter.

Member Typedef Documentation

◆ ListBoxGridPresenterType

template<typename TFinalClass , typename TLayout , typename TItemClass , typename TScrollView >

using kanzi::ListBoxGridPresenter< TFinalClass, TLayout, TItemClass, TScrollView >::ListBoxGridPresenterType

◆ BaseClass

template<typename TFinalClass , typename TLayout , typename TItemClass , typename TScrollView >

using kanzi::ListBoxGridPresenter< TFinalClass, TLayout, TItemClass, TScrollView >::BaseClass

◆ LayoutSharedPtr

template<typename TFinalClass , typename TLayout , typename TItemClass , typename TScrollView >

using kanzi::ListBoxGridPresenter< TFinalClass, TLayout, TItemClass, TScrollView >::LayoutSharedPtr

◆ ItemSharedPtr

template<typename TFinalClass , typename TLayout , typename TItemClass , typename TScrollView >

using kanzi::ListBoxGridPresenter< TFinalClass, TLayout, TItemClass, TScrollView >::ItemSharedPtr

◆ ScrollViewSharedPtr

template<typename TFinalClass , typename TLayout , typename TItemClass , typename TScrollView >

using kanzi::ListBoxGridPresenter< TFinalClass, TLayout, TItemClass, TScrollView >::ScrollViewSharedPtr

Constructor & Destructor Documentation

◆ ListBoxGridPresenter()

template<typename TFinalClass , typename TLayout , typename TItemClass , typename TScrollView >

kanzi::ListBoxGridPresenter< TFinalClass, TLayout, TItemClass, TScrollView >::ListBoxGridPresenter ( )

inlineexplicit

Member Function Documentation

◆ initialize()

template<typename TFinalClass , typename TLayout , typename TItemClass , typename TScrollView >

void kanzi::ListBoxGridPresenter< TFinalClass, TLayout, TItemClass, TScrollView >::initialize	(	TFinalClass *	listBox,
		LayoutSharedPtr	layout )

inline

◆ isEffectivelyLooping()

template<typename TFinalClass , typename TLayout , typename TItemClass , typename TScrollView >

bool kanzi::ListBoxGridPresenter< TFinalClass, TLayout, TItemClass, TScrollView >::isEffectivelyLooping ( ) const

inline

◆ enableKeyNavigation()

template<typename TFinalClass , typename TLayout , typename TItemClass , typename TScrollView >

void kanzi::ListBoxGridPresenter< TFinalClass, TLayout, TItemClass, TScrollView >::enableKeyNavigation ( bool enabled )

inline

Enables directional key navigation on the Grid Presenter.

Parameters

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

Since: Kanzi 3.9.1

◆ scrollToDirection()

template<typename TFinalClass , typename TLayout , typename TItemClass , typename TScrollView >

void kanzi::ListBoxGridPresenter< TFinalClass, TLayout, TItemClass, TScrollView >::scrollToDirection ( ScrollViewConcept::ScrollDirection direction )

inline

Sets scroll delta to one item and starts scrolling to that direction.

Parameters

direction Scroll direction.

◆ scrollPage()

template<typename TFinalClass , typename TLayout , typename TItemClass , typename TScrollView >

void kanzi::ListBoxGridPresenter< TFinalClass, TLayout, TItemClass, TScrollView >::scrollPage ( ScrollViewConcept::ScrollPage direction )

inline

Sets scroll delta to one page and starts scrolling to that direction.

Parameters

direction Scroll direction.

◆ scrollToEdge()

template<typename TFinalClass , typename TLayout , typename TItemClass , typename TScrollView >

void kanzi::ListBoxGridPresenter< TFinalClass, TLayout, TItemClass, TScrollView >::scrollToEdge ( ScrollViewConcept::ScrollEdge direction )

inline

Sets scroll target to content edge and starts scrolling to that direction.

Parameters

direction Scroll direction.

◆ tryMoveFocusInDirection()

template<typename TFinalClass , typename TLayout , typename TItemClass , typename TScrollView >

void kanzi::ListBoxGridPresenter< TFinalClass, TLayout, TItemClass, TScrollView >::tryMoveFocusInDirection	(	ListBoxConcept::FocusMoveTarget	target,
		bool	fallback = false )

inline

Tries to move the focus to the next or previous item in a Grid List Box node.

Parameters

target	Where to move the focus: ListBoxConcept::FocusMoveTarget::NextItem moves the focus to the next focusable item. ListBoxConcept::FocusMoveTarget::PreviousItem moves the focus to the previous focusable item.
fallback	Whether to set the focus to the List Box node when there is no focusable list item in the target.

Since: Kanzi 4.0.0

◆ tryMoveFocusToPage()

template<typename TFinalClass , typename TLayout , typename TItemClass , typename TScrollView >

void kanzi::ListBoxGridPresenter< TFinalClass, TLayout, TItemClass, TScrollView >::tryMoveFocusToPage	(	ListBoxConcept::FocusMoveTarget	target,
		bool	fallback = false )

inline

Tries to move the focus by one page in a Grid List Box node.

Parameters

target	Where to move the focus: ListBoxConcept::FocusMoveTarget::NextPage moves the focus forward by one page. ListBoxConcept::FocusMoveTarget::PreviousPage moves the focus backward by one page.
fallback	Whether to set the focus to the List Box node when there is no focusable list item in the target.

Since: Kanzi 4.0.0

◆ tryMoveFocusToEdge()

template<typename TFinalClass , typename TLayout , typename TItemClass , typename TScrollView >

void kanzi::ListBoxGridPresenter< TFinalClass, TLayout, TItemClass, TScrollView >::tryMoveFocusToEdge	(	ListBoxConcept::FocusMoveTarget	target,
		bool	fallback = false )

inline

Tries to move the focus to the first or last item in a Grid List Box node.

Parameters

target	Where to move the focus: ListBoxConcept::FocusMoveTarget::FirstItem moves the focus to the first focusable item. ListBoxConcept::FocusMoveTarget::LastItem moves the focus to the last focusable item.
fallback	Whether to set the focus to the List Box node when there is no focusable list item in the target.

Since: Kanzi 4.0.0

◆ notifyItemAdded()

template<typename TFinalClass , typename TLayout , typename TItemClass , typename TScrollView >

void kanzi::ListBoxGridPresenter< TFinalClass, TLayout, TItemClass, TScrollView >::notifyItemAdded ( size_t )

inline

Invalidates layout if an item is added.

◆ notifyItemRemoved()

template<typename TFinalClass , typename TLayout , typename TItemClass , typename TScrollView >

void kanzi::ListBoxGridPresenter< TFinalClass, TLayout, TItemClass, TScrollView >::notifyItemRemoved ( size_t )

inline

Invalidates layout if an item is removed.

◆ notifyItemReplaced()

template<typename TFinalClass , typename TLayout , typename TItemClass , typename TScrollView >

void kanzi::ListBoxGridPresenter< TFinalClass, TLayout, TItemClass, TScrollView >::notifyItemReplaced ( size_t )

inline

Invalidates layout if an item is replaced.

◆ notifyItemContainerChanged()

template<typename TFinalClass , typename TLayout , typename TItemClass , typename TScrollView >

void kanzi::ListBoxGridPresenter< TFinalClass, TLayout, TItemClass, TScrollView >::notifyItemContainerChanged ( )

inline

Invalidates layout if the item container is changed.

◆ doRemeasure() [1/2]

template<typename TFinalClass , typename TLayout , typename TItemClass , typename TScrollView >

static void kanzi::ListBoxGridPresenter< TFinalClass, TLayout, TItemClass, TScrollView >::doRemeasure ( Node3D & node )

inlinestatic

◆ doRemeasure() [2/2]

template<typename TFinalClass , typename TLayout , typename TItemClass , typename TScrollView >

static void kanzi::ListBoxGridPresenter< TFinalClass, TLayout, TItemClass, TScrollView >::doRemeasure ( Node2D & node )

inlinestatic

◆ update()

template<typename TFinalClass , typename TLayout , typename TItemClass , typename TScrollView >

void kanzi::ListBoxGridPresenter< TFinalClass, TLayout, TItemClass, TScrollView >::update ( )

inline

◆ updateScrollViewBounds()

template<typename TFinalClass , typename TLayout , typename TItemClass , typename TScrollView >

void kanzi::ListBoxGridPresenter< TFinalClass, TLayout, TItemClass, TScrollView >::updateScrollViewBounds ( )

inline

◆ updateOffsetProperties()

template<typename TFinalClass , typename TLayout , typename TItemClass , typename TScrollView >

void kanzi::ListBoxGridPresenter< TFinalClass, TLayout, TItemClass, TScrollView >::updateOffsetProperties ( )

inline

Calculates the values of the Node::VisibleAmountInParentProperty and GridListBoxConcept::CalculatedOffsetProperty properties for items in the Grid List Box.

◆ isStateChanged()

template<typename TFinalClass , typename TLayout , typename TItemClass , typename TScrollView >

bool kanzi::ListBoxGridPresenter< TFinalClass, TLayout, TItemClass, TScrollView >::isStateChanged ( )

inline

Checks whether the layout state of the presenter has changed.

If the layout state of the presenter has changed, returns KZ_TRUE.

◆ getScrollBounds()

template<typename TFinalClass , typename TLayout , typename TItemClass , typename TScrollView >

void kanzi::ListBoxGridPresenter< TFinalClass, TLayout, TItemClass, TScrollView >::getScrollBounds	(	float *	out_scrollMinimumX,
		float *	out_scrollMaximumX,
		float *	out_scrollMinimumY,
		float *	out_scrollMaximumY ) const

inline

◆ deduceSkippedOffset()

template<typename TFinalClass , typename TLayout , typename TItemClass , typename TScrollView >

Vector2 kanzi::ListBoxGridPresenter< TFinalClass, TLayout, TItemClass, TScrollView >::deduceSkippedOffset ( ) const

inline

Calculates how much offset is being skipped by skipping non-visible items.

◆ doUpdateRenderTransform() [1/2]

template<typename TFinalClass , typename TLayout , typename TItemClass , typename TScrollView >

static void kanzi::ListBoxGridPresenter< TFinalClass, TLayout, TItemClass, TScrollView >::doUpdateRenderTransform	(	Node3D &	node,
		Vector2	scroll )

inlinestatic

◆ doUpdateRenderTransform() [2/2]

template<typename TFinalClass , typename TLayout , typename TItemClass , typename TScrollView >

static void kanzi::ListBoxGridPresenter< TFinalClass, TLayout, TItemClass, TScrollView >::doUpdateRenderTransform	(	Node2D &	node,
		Vector2	scroll )

inlinestatic

◆ updateRenderTransform()

template<typename TFinalClass , typename TLayout , typename TItemClass , typename TScrollView >

void kanzi::ListBoxGridPresenter< TFinalClass, TLayout, TItemClass, TScrollView >::updateRenderTransform ( Vector2 scroll )

inline

Updates scroll transform of layout.

◆ getItem()

template<typename TFinalClass , typename TLayout , typename TItemClass , typename TScrollView >

ItemSharedPtr kanzi::ListBoxGridPresenter< TFinalClass, TLayout, TItemClass, TScrollView >::getItem ( size_t presenterIndex ) const

inline

◆ addToLayout()

template<typename TFinalClass , typename TLayout , typename TItemClass , typename TScrollView >

void kanzi::ListBoxGridPresenter< TFinalClass, TLayout, TItemClass, TScrollView >::addToLayout ( ItemSharedPtr listBoxItem )

inline

◆ removeFromLayout()

template<typename TFinalClass , typename TLayout , typename TItemClass , typename TScrollView >

void kanzi::ListBoxGridPresenter< TFinalClass, TLayout, TItemClass, TScrollView >::removeFromLayout ( ItemSharedPtr listBoxItem )

inline

◆ snap()

template<typename TFinalClass , typename TLayout , typename TItemClass , typename TScrollView >

void kanzi::ListBoxGridPresenter< TFinalClass, TLayout, TItemClass, TScrollView >::snap	(	Vector2	position,
		Vector2	,
		bool	,
		Vector2 *	out_position,
		int *	out_itemIndex )

inline

◆ setScroll()

template<typename TFinalClass , typename TLayout , typename TItemClass , typename TScrollView >

void kanzi::ListBoxGridPresenter< TFinalClass, TLayout, TItemClass, TScrollView >::setScroll ( Vector2 scroll )

inline

◆ bringItemCenter() [1/2]

template<typename TFinalClass , typename TLayout , typename TItemClass , typename TScrollView >

Vector2 kanzi::ListBoxGridPresenter< TFinalClass, TLayout, TItemClass, TScrollView >::bringItemCenter ( size_t selection ) const

inline

◆ bringItemCenter() [2/2]

template<typename TFinalClass , typename TLayout , typename TItemClass , typename TScrollView >

void kanzi::ListBoxGridPresenter< TFinalClass, TLayout, TItemClass, TScrollView >::bringItemCenter	(	size_t	selection,
		bool	smooth ) const

inline

◆ getColumnCount()

template<typename TFinalClass , typename TLayout , typename TItemClass , typename TScrollView >

unsigned int kanzi::ListBoxGridPresenter< TFinalClass, TLayout, TItemClass, TScrollView >::getColumnCount ( ) const

inline

Gets the number of columns that are currently displayed.

Returns: Returns the number of columns.

◆ getRowCount()

template<typename TFinalClass , typename TLayout , typename TItemClass , typename TScrollView >

unsigned int kanzi::ListBoxGridPresenter< TFinalClass, TLayout, TItemClass, TScrollView >::getRowCount ( ) const

inline

Gets the number of rows that are currently displayed.

Returns: Returns the number of rows.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Member Typedef Documentation

◆ ListBoxGridPresenterType

◆ BaseClass

◆ LayoutSharedPtr

◆ ItemSharedPtr

◆ ScrollViewSharedPtr

Constructor & Destructor Documentation

◆ ListBoxGridPresenter()

Member Function Documentation

◆ initialize()

◆ isEffectivelyLooping()

◆ enableKeyNavigation()

◆ scrollToDirection()

◆ scrollPage()

◆ scrollToEdge()

◆ tryMoveFocusInDirection()

◆ tryMoveFocusToPage()

◆ tryMoveFocusToEdge()

◆ notifyItemAdded()

◆ notifyItemRemoved()

◆ notifyItemReplaced()

◆ notifyItemContainerChanged()

◆ doRemeasure() [1/2]

◆ doRemeasure() [2/2]

◆ update()

◆ updateScrollViewBounds()

◆ updateOffsetProperties()

◆ isStateChanged()

◆ getScrollBounds()

◆ deduceSkippedOffset()

◆ doUpdateRenderTransform() [1/2]

◆ doUpdateRenderTransform() [2/2]

◆ updateRenderTransform()

◆ getItem()

◆ addToLayout()

◆ removeFromLayout()

◆ snap()

◆ setScroll()

◆ bringItemCenter() [1/2]

◆ bringItemCenter() [2/2]

◆ getColumnCount()

◆ getRowCount()