Kanzi 4.1.0
kanzi::DefaultListBoxGridPresenter< TFinalClass, TLayout, TItemClass, TScrollView > Class Template Reference

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

Inheritance diagram for kanzi::DefaultListBoxGridPresenter< TFinalClass, TLayout, TItemClass, TScrollView >:
[legend]

Public Member Functions

 DefaultListBoxGridPresenter ()
 
- Public Member Functions inherited from kanzi::ListBoxGridPresenter< DefaultListBoxGridPresenter< TFinalClass, TLayout, TItemClass, TScrollView >, TFinalClass, TLayout, TItemClass, TScrollView >
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< TDerivedClass, TListBoxClass, TScrollView >
ScrollViewSharedPtr getScrollView () const
 Returns the Scroll View that the presenter uses.
 
void initialize (TListBoxClass *listBox)
 ListBoxScrollPresenterConceptImpl specific initialization.
 
 ListBoxScrollPresenterConceptImpl ()=default
 Constructor.
 

Additional Inherited Members

- Public Types inherited from kanzi::ListBoxGridPresenter< DefaultListBoxGridPresenter< TFinalClass, TLayout, TItemClass, TScrollView >, TFinalClass, TLayout, TItemClass, TScrollView >
using BaseClass
 
using ItemSharedPtr
 
using LayoutSharedPtr
 
using ListBoxGridPresenterType
 
using ScrollViewSharedPtr
 
- Static Public Member Functions inherited from kanzi::ListBoxGridPresenter< DefaultListBoxGridPresenter< TFinalClass, TLayout, TItemClass, TScrollView >, TFinalClass, TLayout, TItemClass, TScrollView >
static void doRemeasure (Node2D &node)
 
static void doRemeasure (Node3D &node)
 
static void doUpdateRenderTransform (Node2D &node, Vector2 scroll)
 
static void doUpdateRenderTransform (Node3D &node, Vector2 scroll)
 
- Protected Member Functions inherited from kanzi::ListBoxScrollPresenterConceptImpl< TDerivedClass, TListBoxClass, TScrollView >
TDerivedClassgetThisObject ()
 
const TDerivedClassgetThisObject () const
 
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< TDerivedClass, TListBoxClass, TScrollView >
TListBoxClassm_listBox
 List Box that owns this presenter.
 

Constructor & Destructor Documentation

◆ DefaultListBoxGridPresenter()

template<typename TFinalClass , typename TLayout , typename TItemClass , typename TScrollView >
kanzi::DefaultListBoxGridPresenter< TFinalClass, TLayout, TItemClass, TScrollView >::DefaultListBoxGridPresenter ( )
inlineexplicit

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