Kanzi Graphics Engine
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros
KzuPresenterClass Struct Reference

Presenter class. More...

#include <kzu_presenter.h>

Data Fields

struct KzuPresenterConfiguration configuration
 Presenter configuration. More...
 
KzuPresenterDeleteFunction kzuPresenterDelete
 Deletes presenter. More...
 
KzuPresenterSnapFunction kzuPresenterSnap
 Snaps presenter to an item in the given direction from given position. More...
 
KzuPresenterSetScrollFunction kzuPresenterSetScroll
 Sets new scroll value for the presenter. More...
 
KzuPresenterGetScrollBoundsFunction kzuPresenterGetScrollBounds
 Returns allowed scrolling area of presenter. More...
 
KzuPresenterBringItemCenterFunction kzuPresenterBringItemCenter
 Outputs a scroll value such that the given item is in the center. More...
 
KzuPresenterAddToLayoutFunction kzuPresenterAddToLayout
 Adds the specified list box item to the layout. More...
 
KzuPresenterRemoveFromLayoutFunction kzuPresenterRemoveFromLayout
 Removes the specified list box item from the layout. More...
 
KzuPresenterClearLayoutFunction kzuPresenterClearLayout
 Removes all list box items from the layout. More...
 
KzuPresenterUpdateFunction kzuPresenterUpdate
 Updates layout's object nodes. More...
 
KzuPresenterItemAddedFunction kzuPresenterItemAdded
 Informs the presenter that an item was added to the virtual item list at the given index. More...
 
KzuPresenterItemRemovedFunction kzuPresenterItemRemoved
 Informs the presenter that an item was removed from the virtual item list from the given index. More...
 
KzuPresenterItemReplacedFunction kzuPresenterItemReplaced
 Informs the presenter that an item in the virtual item list at the given index was replaced. More...
 

Detailed Description

Presenter class.

Field Documentation

struct KzuPresenterConfiguration KzuPresenterClass::configuration

Presenter configuration.

KzuPresenterDeleteFunction KzuPresenterClass::kzuPresenterDelete

Deletes presenter.

KzuPresenterSnapFunction KzuPresenterClass::kzuPresenterSnap

Snaps presenter to an item in the given direction from given position.

Returns snapped item index and scroll position. If snapping happened towards no object, index will be -1. No value will be written to those output variables that are KZ_NULL. The changeTarget should be KZ_TRUE, if the list box target should be changed to the snapped item.

KzuPresenterSetScrollFunction KzuPresenterClass::kzuPresenterSetScroll

Sets new scroll value for the presenter.

KzuPresenterGetScrollBoundsFunction KzuPresenterClass::kzuPresenterGetScrollBounds

Returns allowed scrolling area of presenter.

KzuPresenterBringItemCenterFunction KzuPresenterClass::kzuPresenterBringItemCenter

Outputs a scroll value such that the given item is in the center.

KzuPresenterAddToLayoutFunction KzuPresenterClass::kzuPresenterAddToLayout

Adds the specified list box item to the layout.

KzuPresenterRemoveFromLayoutFunction KzuPresenterClass::kzuPresenterRemoveFromLayout

Removes the specified list box item from the layout.

KzuPresenterClearLayoutFunction KzuPresenterClass::kzuPresenterClearLayout

Removes all list box items from the layout.

KzuPresenterUpdateFunction KzuPresenterClass::kzuPresenterUpdate

Updates layout's object nodes.

KzuPresenterItemAddedFunction KzuPresenterClass::kzuPresenterItemAdded

Informs the presenter that an item was added to the virtual item list at the given index.

KzuPresenterItemRemovedFunction KzuPresenterClass::kzuPresenterItemRemoved

Informs the presenter that an item was removed from the virtual item list from the given index.

KzuPresenterItemReplacedFunction KzuPresenterClass::kzuPresenterItemReplaced

Informs the presenter that an item in the virtual item list at the given index was replaced.


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