跳转到主要内容

ScrollBase

touchgfx/containers/scrollers/ScrollBase.hpp

The ScrollBase class is an abstract class used for Widgets that needs to show (a lot of) elements in a DrawableList that can be scrolled. Due to memory limitations, this is implemented by re-using the Drawables in the DrawableList - once an element is moved off screen, it is filled with new content and moved to the other end and the of the scrolling list.

Lists can be horizontal or vertical and the can be circular (infinite scrolling).

See:

Inherits from: Container, Drawable

Inherited by: ScrollList, ScrollWheelBase

Protected Types

enumAnimationState { NO_ANIMATION, ANIMATING_GESTURE, ANIMATING_DRAG }
Values that represent animation states.

Public Functions

voidallowHorizontalDrag(bool enable)
Enables horizontal scrolling to be passed to the children in the list (in case a child widget is able to handle drag events).
voidallowVerticalDrag(bool enable)
Enables the vertical scroll.
virtual voidanimateToItem(int16_t itemIndex, int16_t animationSteps =-1)
Go to a specific item, possibly with animation.
uint16_tgetAnimationSteps() const
Gets animation steps as set in setAnimationSteps.
virtual boolgetCircular() const
Gets the circular setting, previously set using setCircular().
uint16_tgetDragAcceleration() const
Gets drag acceleration (times 10).
virtual int16_tgetDrawableMargin() const
Gets drawable margin as set through the second parameter in most recent call to setDrawableSize().
virtual int16_tgetDrawableSize() const
Gets drawable size as set through the first parameter in most recent call to setDrawableSize().
virtual boolgetHorizontal() const
Gets the orientation of the drawables, previously set using setHorizontal().
boolgetIsPressed() const
Gets if the container is currently pressed.
boolgetIsScrolling() const
Gets if the containner is currently scrolled.
uint16_tgetMaxSwipeItems() const
Gets maximum swipe items as set by setMaxSwipeItems.
virtual int16_tgetNumberOfItems() const
Gets number of items in the DrawableList, as previously set using setNumberOfItems().
uint8_tgetOvershootPercentage() const
Gets overshoot percentage, as previously set using setOvershootPercentage.
uint16_tgetSwipeAcceleration() const
Gets swipe acceleration (times 10).
virtual voidhandleDragEvent(const DragEvent & event)
Defines the event handler interface for DragEvents.
virtual voidhandleGestureEvent(const GestureEvent & event)
Defines the event handler interface for GestureEvents.
virtual voidhandleTickEvent()
Called periodically by the framework if the Drawable instance has subscribed to timer ticks.
virtual voidinitialize()
Removed all drawables and initializes the content of these items.
boolisAnimating() const
Query if an animation is ongoing.
virtual voiditemChanged(int itemIndex)
Inform the scroll list that the contents of an item has changed and force all drawables with the given item index to be updated via the callback provided.
ScrollBase()
voidsetAnimationEndedCallback(GenericCallback<> & callback)
Callback, called when the set animation ended.
voidsetAnimationSteps(int16_t steps)
Sets animation steps (in ticks) when moving to a new selected item.
virtual voidsetCircular(bool circular)
Sets whether the list is circular (infinite) or not.
voidsetDragAcceleration(uint16_t acceleration)
Sets drag acceleration times 10, so "10" means "1", "15" means "1.5".
virtual voidsetDrawableSize(int16_t drawableSize, int16_t drawableMargin)
Sets drawables size.
voidsetEasingEquation(EasingEquation equation)
Sets easing equation when changing the selected item, for example via swipe or AnimateTo.
virtual voidsetHeight(int16_t height)
Sets the height of this drawable.
virtual voidsetHorizontal(bool horizontal)
Sets a horizontal or vertical layout.
voidsetItemPressedCallback(GenericCallback< int16_t > & callback)
Set Callback which will be called when a item is pressed.
voidsetItemSelectedCallback(GenericCallback< int16_t > & callback)
Sets Callback which will be called when the selected item is clicked or dragged.
voidsetMaxSwipeItems(uint16_t maxItems)
Sets maximum swipe items.
virtual voidsetNumberOfItems(int16_t numberOfItems)
Sets number of items in the DrawableList.
voidsetOvershootPercentage(uint8_t percentage)
Sets overshoot percentage when dragging a non-circular list.
voidsetSwipeAcceleration(uint16_t acceleration)
Sets swipe acceleration (times 10).
virtual voidsetWidth(int16_t width)
Sets the width of this drawable.
voidstopAnimation()
Stops an animation if one is ongoing.

Protected Functions

virtual voidanimateToPosition(int32_t position, int16_t steps =-1)
Animate to a new position/offset using the given number of steps.
virtual int32_tgetNearestAlignedOffset(int32_t offset) const
Gets nearest offset aligned to a multiple of itemSize.
intgetNormalizedOffset(int offset) const
Gets normalized offset from a given offset from 0 down to -numItems*itemSize.
virtual int32_tgetOffset() const
Gets display offset of first item.
virtual int32_tgetPositionForItem(int16_t itemIndex) =0
Get the position for an item.
virtual int32_tkeepOffsetInsideLimits(int32_t newOffset, int16_t overShoot) const =0
Keep offset inside limits.
virtual voidsetOffset(int32_t offset)
Sets display offset of first item.

Protected Attributes

GenericCallback *animationEndedCallback
The animation ended callback.
AnimationStatecurrentAnimationState
The current animation state.
uint16_tdefaultAnimationSteps
The animation steps.
int16_tdistanceBeforeAlignedItem
The distance before aligned item.
uint16_tdragAcceleration
The drag acceleration x10.
booldraggableX
Is the container draggable in the horizontal direction.
booldraggableY
Is the container draggable in the vertical direction.
EasingEquationeasingEquation
The easing equation used for animation.
intgestureEnd
The gesture end.
intgestureStart
The gesture start.
intgestureStep
The current gesture step.
intgestureStepsTotal
The total gesture steps.
int32_tinitialSwipeOffset
The initial swipe offset.
boolisPressed
Is the container currently pressed (maybe show scrollbars)
boolisScrolling
Is the container scrolling (i.e. has overcome the initial larger drag that is required to initiate a scroll).
GenericCallback *itemLockedInCallback
The item locked in callback.
GenericCallback< int16_t > *itemPressedCallback
The item pressed callback.
GenericCallback< int16_t > *itemSelectedCallback
The item selected callback.
int16_titemSize
Size of the item (including margin)
DrawableListlist
The list.
uint16_tmaxSwipeItems
The maximum swipe items.
int16_tnumberOfDrawables
Number of drawables.
uint8_tovershootPercentage
The overshoot percentage when dragging.
uint16_tswipeAcceleration
The swipe acceleration x10.
int16_txClick
The x coordinate of a click.
int16_tyClick
The y coordinate of a click.

Additional inherited members

Public Functions inherited from Container

virtual voidadd(Drawable & d)
Adds a Drawable instance as child to this Container.
Container()
virtual boolcontains(const Drawable & d)
Query if a given Drawable has been added directly to this Container.
virtual voiddraw(const Rect & invalidatedArea) const
Draw this drawable.
virtual voidforEachChild(GenericCallback< Drawable & > * function)
Executes the specified callback function for each child in the Container.
virtual Drawable *getFirstChild()
Obtain a pointer to the first child of this container.
virtual voidgetLastChild(int16_t x, int16_t y, Drawable ** last)
Gets the last child in the list of children in this Container.
virtual voidgetLastChildNear(int16_t x, int16_t y, Drawable * last, int16_t fingerAdjustmentX, int16_t * fingerAdjustmentY)
Works similar to getLastChild() but also considers the current set finger size in HAL.
virtual RectgetSolidRect() const
Get (the largest possible) rectangle that is guaranteed to be solid (opaque).
virtual voidinsert(Drawable * previous, Drawable & d)
Inserts a Drawable after a specific child node.
virtual voidremove(Drawable & d)
Removes a Drawable from the container by removing it from the linked list of children.
virtual voidremoveAll()
Removes all children in the Container by resetting their parent and sibling pointers.
virtual voidunlink()
Removes all children by unlinking the first child.

Protected Functions inherited from Container

virtual RectgetContainedArea() const
Gets a rectangle describing the total area covered by the children of this container.
virtual voidmoveChildrenRelative(int16_t deltaX, int16_t deltaY)
Calls moveRelative on all children.

Protected Attributes inherited from Container

Drawable *firstChild
Pointer to the first child of this container. Subsequent children can be found through firstChild's nextSibling.

Public Functions inherited from Drawable

voidcenter()
Centers the Drawable inside its parent.
voidcenterX()
Center the Drawable horizontally inside its parent.
voidcenterY()
Center the Drawable vertically inside its parent.
virtual voidchildGeometryChanged()
This function can be called on parent nodes to signal that the size or position of one or more of its children has changed.
virtual voiddraw(const Rect & invalidatedArea) const =0
Draw this drawable.
Drawable()
Initializes a new instance of the Drawable class.
voiddrawToDynamicBitmap(BitmapId id)
Render the Drawable object into a dynamic bitmap.
voidexpand(int margin =0)
Expands the Drawable to have the same size as its parent with a given margin around the edge.
RectgetAbsoluteRect() const
Helper function for obtaining the rectangle this Drawable covers, expressed in absolute coordinates.
virtual Drawable *getFirstChild()
Function for obtaining the first child of this drawable if any.
int16_tgetHeight() const
Gets the height of this Drawable.
virtual voidgetLastChild(int16_t x, int16_t y, Drawable ** last) =0
Function for obtaining the the last child of this drawable that intersects with the specified point.
Drawable *getNextSibling()
Gets the next sibling node.
Drawable *getParent() const
Returns the parent node.
const Rect &getRect() const
Gets the rectangle this Drawable covers, in coordinates relative to its parent.
virtual RectgetSolidRect() const =0
Get (the largest possible) rectangle that is guaranteed to be solid (opaque).
virtual RectgetSolidRectAbsolute()
Helper function for obtaining the largest solid rect (as implemented by getSolidRect()) expressed in absolute coordinates.
virtual voidgetVisibleRect(Rect & rect) const
Function for finding the visible part of this drawable.
int16_tgetWidth() const
Gets the width of this Drawable.
int16_tgetX() const
Gets the x coordinate of this Drawable, relative to its parent.
int16_tgetY() const
Gets the y coordinate of this Drawable, relative to its parent.
virtual voidhandleClickEvent(const ClickEvent & event)
Defines the event handler interface for ClickEvents.
virtual voidinvalidate() const
Tell the framework that this entire Drawable needs to be redrawn.
virtual voidinvalidateContent() const
Tell the framework that the contents of the Drawable needs to be redrawn.
virtual voidinvalidateRect(Rect & invalidatedArea) const
Request that a region of this drawable is redrawn.
boolisTouchable() const
Gets whether this Drawable receives touch events or not.
boolisVisible() const
Gets whether this Drawable is visible.
virtual voidmoveRelative(int16_t x, int16_t y)
Moves the drawable.
virtual voidmoveTo(int16_t x, int16_t y)
Moves the drawable.
voidsetPosition(const Drawable & drawable)
Sets the position of the Drawable to the same as the given Drawable.
voidsetPosition(int16_t x, int16_t y, int16_t width, int16_t height)
Sets the size and position of this Drawable, relative to its parent.
voidsetTouchable(bool touch)
Controls whether this Drawable receives touch events or not.
voidsetVisible(bool vis)
Controls whether this Drawable should be visible.
voidsetWidthHeight(const Bitmap & bitmap)
Sets the dimensions (width and height) of the Drawable without changing the x and y coordinates).
voidsetWidthHeight(const Drawable & drawable)
Sets the dimensions (width and height) of the Drawable without changing the x and y coordinates).
voidsetWidthHeight(const Rect & other)
Sets the dimensions (width and height) of the Drawable without changing the x and y coordinates).
voidsetWidthHeight(int16_t width, int16_t height)
Sets the dimensions (width and height) of the Drawable without changing the x and y coordinates).
virtual voidsetX(int16_t x)
Sets the x coordinate of this Drawable, relative to its parent.
voidsetXY(const Drawable & drawable)
Sets the x and y coordinates of this Drawable.
voidsetXY(int16_t x, int16_t y)
Sets the x and y coordinates of this Drawable, relative to its parent.
virtual voidsetY(int16_t y)
Sets the y coordinate of this Drawable, relative to its parent.
virtual voidtranslateRectToAbsolute(Rect & r) const
Helper function for converting a region of this Drawable to absolute coordinates.
virtual ~Drawable()
Finalizes an instance of the Drawable class.

Protected Attributes inherited from Drawable

Drawable *nextSibling
Pointer to the next Drawable.
Drawable *parent
Pointer to this drawable's parent.
Rectrect
The coordinates of this Drawable, relative to its parent.
booltouchable
True if this drawable should receive touch events.
boolvisible
True if this drawable should be drawn.

Protected Types Documentation

AnimationState

Values that represent animation states.

NO_ANIMATIONNo animation.
ANIMATING_GESTUREAnimating a gesture.
ANIMATING_DRAGAnimating a drag.

Public Functions Documentation

allowHorizontalDrag

void allowHorizontalDrag(boolenable)

Enables horizontal scrolling to be passed to the children in the list (in case a child widget is able to handle drag events).

By default, scrolling in either direction is disabled. This function can be used to explicitly (dis)allow scrolling in the horizontal direction.

Parameters:
enableIf true, horizontal scrolling is enabled. If false (default), scrolling is disabled.

allowVerticalDrag

void allowVerticalDrag(boolenable)

Enables the vertical scroll.

Enables the vertical scroll to be passed to the children in the list (in case a child widget is able to handle drag events). By default, scrolling in either direction is disabled. This function can be used to explicitly (dis)allow scrolling in the vertical direction.

Parameters:
enableIf true, vertical scrolling is enabled. If false (default), scrolling is disabled.

animateToItem

virtual void animateToItem(int16_titemIndex ,
int16_tanimationSteps =-1
)

Go to a specific item, possibly with animation.

The given item index is scrolled into view. If animationSteps is omitted, the default number of animation steps is used. If animationSteps is 0 no animation will be used, otherwise the number of animation steps specified is used.

Parameters:
itemIndexZero-based index of the item.
animationSteps(Optional) The steps to use for the animation. 0 means no animation. If omitted, default animation steps are used.
See also:

getAnimationSteps

uint16_t getAnimationSteps()const

Gets animation steps as set in setAnimationSteps.

Returns:

The animation steps.

See also:

getCircular

virtual bool getCircular()const

Gets the circular setting, previously set using setCircular().

Returns:

True if the list is circular (infinite), false if the list is not circular (finite).

See also:

getDragAcceleration

uint16_t getDragAcceleration()const

Gets drag acceleration (times 10).

Returns:

The drag acceleration.

Note

The reason for multiplying the acceleration by 10 is to avoid introducing floating point arithmetic.

See also:

getDrawableMargin

virtual int16_t getDrawableMargin()const

Gets drawable margin as set through the second parameter in most recent call to setDrawableSize().

Returns:

The drawable margin.

See also:

getDrawableSize

virtual int16_t getDrawableSize()const

Gets drawable size as set through the first parameter in most recent call to setDrawableSize().

Returns:

The drawable size.

See also:

getHorizontal

virtual bool getHorizontal()const

Gets the orientation of the drawables, previously set using setHorizontal().

Returns:

True if it horizontal, false if it is vertical.

See also:

getIsPressed

bool getIsPressed()const

Gets if the container is currently pressed.

Returns:

if the container is currently pressed.

getIsScrolling

bool getIsScrolling()const

Gets if the containner is currently scrolled.

Returns:

if the containner is currently scrolled.

getMaxSwipeItems

uint16_t getMaxSwipeItems()const

Gets maximum swipe items as set by setMaxSwipeItems.

Returns:

The maximum swipe items, 0 means "no limit".

See also:

getNumberOfItems

virtual int16_t getNumberOfItems()const

Gets number of items in the DrawableList, as previously set using setNumberOfItems().

Returns:

The number of items.

See also:

getOvershootPercentage

uint8_t getOvershootPercentage()const

Gets overshoot percentage, as previously set using setOvershootPercentage.

Returns:

The overshoot percentage.

See also:

getSwipeAcceleration

uint16_t getSwipeAcceleration()const

Gets swipe acceleration (times 10).

Returns:

The swipe acceleration.

Note

The reason for multiplying the acceleration by 10 is to avoid introducing floating point arithmetic.

See also:

handleDragEvent

virtual void handleDragEvent(const DragEvent &event)

Defines the event handler interface for DragEvents.

The default implementation ignores the event. The event is only received if the drawable is touchable and visible.

Parameters:
eventThe DragEvent received from the HAL.

Reimplements: touchgfx::Drawable::handleDragEvent

Reimplemented by: touchgfx::ScrollWheelBase::handleDragEvent

handleGestureEvent

virtual void handleGestureEvent(const GestureEvent &event)

Defines the event handler interface for GestureEvents.

The default implementation ignores the event. The event is only received if the Drawable is touchable and visible.

Parameters:
eventThe GestureEvent received from the HAL.

Reimplements: touchgfx::Drawable::handleGestureEvent

Reimplemented by: touchgfx::ScrollWheelBase::handleGestureEvent

handleTickEvent

virtual void handleTickEvent()

Called periodically by the framework if the Drawable instance has subscribed to timer ticks.

See also:

Reimplements: touchgfx::Drawable::handleTickEvent

initialize

virtual void initialize()

Removed all drawables and initializes the content of these items.

Reimplemented by: touchgfx::ScrollWheelWithSelectionStyle::initialize

isAnimating

bool isAnimating()const

Query if an animation is ongoing.

This can be good to know if getSelectedItem() is called, as the result might not be as expected if isAnimating() returns true, since the display is not showing the selected item in the right place yet.

Returns:

true if animating, false if not.

itemChanged

virtual void itemChanged(intitemIndex)

Inform the scroll list that the contents of an item has changed and force all drawables with the given item index to be updated via the callback provided.

This is important as a circular list with very few items might display the same item more than once and all these items should be updated.

Parameters:
itemIndexZero-based index of the changed item.

Reimplemented by: touchgfx::ScrollWheelWithSelectionStyle::itemChanged

ScrollBase

setAnimationEndedCallback

Callback, called when the set animation ended.

Parameters:
callbackThe ended callback.

setAnimationSteps

void setAnimationSteps(int16_tsteps)

Sets animation steps (in ticks) when moving to a new selected item.

The default value is 30.

Parameters:
stepsThe animation steps.
See also:

setCircular

virtual void setCircular(boolcircular)

Sets whether the list is circular (infinite) or not.

A circular list is a list where the first drawable re-appears after the last item in the list - and the last item in the list appears before the first item in the list.

Parameters:
circularTrue if the list should be circular, false if the list should not be circular.
See also:

Reimplemented by: touchgfx::ScrollWheelWithSelectionStyle::setCircular

setDragAcceleration

void setDragAcceleration(uint16_tacceleration)

Sets drag acceleration times 10, so "10" means "1", "15" means "1.5".

10 makes the containers follow the finger, higher values makes the containers move faster. This can often be useful if the list is very long.

Parameters:
accelerationThe drag acceleration.
Note

The reason for multiplying the acceleration by 10 is to avoid introducing floating point arithmetic.

See also:

setDrawableSize

virtual void setDrawableSize(int16_tdrawableSize ,
int16_tdrawableMargin
)

Sets drawables size.

The drawable is is the size of each drawable in the list in the set direction of the list (this is enforced by the DrawableList class). The specified margin is added above and below each item for spacing. The entire size of an item is thus size + 2 * spacing.

For a horizontal list each element will be drawableSize high and have the same width as set using setWidth(). For a vertical list each element will be drawableSize wide and have the same height as set using setHeight().

Parameters:
drawableSizeThe size of the drawable.
drawableMarginThe margin around drawables (margin before and margin after).
See also:

Reimplemented by: touchgfx::ScrollList::setDrawableSize, touchgfx::ScrollWheelWithSelectionStyle::setDrawableSize

setEasingEquation

Sets easing equation when changing the selected item, for example via swipe or AnimateTo.

Parameters:
equationThe equation.
See also:

setHeight

virtual void setHeight(int16_theight)

Sets the height of this drawable.

Parameters:
heightThe new height.
Note

For most Drawable widgets, changing this does normally not automatically yield a redraw.Also sets the height of the children.

Reimplements: touchgfx::Drawable::setHeight

Reimplemented by: touchgfx::ScrollList::setHeight, touchgfx::ScrollWheelWithSelectionStyle::setHeight

setHorizontal

virtual void setHorizontal(boolhorizontal)

Sets a horizontal or vertical layout.

If parameter horizontal is set true, all drawables are arranged side by side. If horizontal is set false, the drawables are arranged above and below each other (vertically).

Parameters:
horizontalTrue to align drawables horizontal, false to align drawables vertically.
Note

Default value is false, i.e. vertical layout.

See also:

Reimplemented by: touchgfx::ScrollWheelWithSelectionStyle::setHorizontal

setItemPressedCallback

void setItemPressedCallback(GenericCallback< int16_t > &callback)

Set Callback which will be called when a item is pressed.

Parameters:
callbackThe callback.

setItemSelectedCallback

void setItemSelectedCallback(GenericCallback< int16_t > &callback)

Sets Callback which will be called when the selected item is clicked or dragged.

Parameters:
callbackThe callback.

setMaxSwipeItems

void setMaxSwipeItems(uint16_tmaxItems)

Sets maximum swipe items.

Often useful when there are e.g. five visible items on the screen and a swipe action should at most swipe the next/previous five items into view to achieve sort of a paging effect.

Parameters:
maxItemsThe maximum items, 0 means "no limit" (which is also the default).
See also:

setNumberOfItems

virtual void setNumberOfItems(int16_tnumberOfItems)

Sets number of items in the DrawableList.

This forces all drawables to be updated to ensure that the content is correct. For example a date selector might switch number of days between 28, 29, 30, and 31 depending on the month. A circular list might show 27-28-29-30-31 and might need to update this to show 27-28-1-2-3.

Parameters:
numberOfItemsNumber of items.
Note

The DrawableList is refreshed to reflect the change.

Reimplemented by: touchgfx::ScrollWheelWithSelectionStyle::setNumberOfItems

setOvershootPercentage

void setOvershootPercentage(uint8_tpercentage)

Sets overshoot percentage when dragging a non-circular list.

This is the size relative to an item that can be dragged further than the actual list. Setting this to 50, it is possible to drag the list to show an empty space half the size of an item. Setting this to 0 prevents dragging further than the actual elements in the list.

Parameters:
percentageThe overshoot percentage.
See also:

setSwipeAcceleration

void setSwipeAcceleration(uint16_tacceleration)

Sets swipe acceleration (times 10).

Default value, if not set, is 10, i.e. 1.0.

Parameters:
accelerationThe acceleration times 10, so "9" means "0.9" and "75" means "7.5".
Note

The reason for multiplying the acceleration by 10 is to avoid introducing floating point arithmetic.

See also:

setWidth

virtual void setWidth(int16_twidth)

Sets the width of this drawable.

Parameters:
widthThe new width.
Note

For most Drawable widgets, changing this does normally not automatically yield a redraw.Also sets the width of the children.

Reimplements: touchgfx::Drawable::setWidth

Reimplemented by: touchgfx::ScrollList::setWidth, touchgfx::ScrollWheelWithSelectionStyle::setWidth

stopAnimation

Stops an animation if one is ongoing.

Immediately moves to the item which is being animated to.

Protected Functions Documentation

animateToPosition

virtual void animateToPosition(int32_tposition ,
int16_tsteps =-1
)

Animate to a new position/offset using the given number of steps.

Parameters:
positionThe new position.
steps(Optional) The steps.

Reimplemented by: touchgfx::ScrollWheelBase::animateToPosition

getNearestAlignedOffset

virtual int32_t getNearestAlignedOffset(int32_toffset)

Gets nearest offset aligned to a multiple of itemSize.

Parameters:
offsetThe offset.
Returns:

The nearest aligned offset.

Reimplemented by: touchgfx::ScrollList::getNearestAlignedOffset

getNormalizedOffset

int getNormalizedOffset(intoffset)

Gets normalized offset from a given offset from 0 down to -numItems*itemSize.

Parameters:
offsetThe offset.
Returns:

The normalized offset.

getOffset

virtual int32_t getOffset()const

Gets display offset of first item.

Returns:

The offset.

getPositionForItem

virtual int32_t getPositionForItem(int16_titemIndex)

Get the position for an item.

The position should ensure that the item is in view as defined by the semantics of the actual scroll class. If the item is already in view, the current offset is returned and not the offset of the given item.

Parameters:
itemIndexZero-based index of the item.
Returns:

The position for item.

Reimplemented by: touchgfx::ScrollList::getPositionForItem, touchgfx::ScrollWheelBase::getPositionForItem

keepOffsetInsideLimits

virtual int32_t keepOffsetInsideLimits(int32_tnewOffset ,const =0
int16_toverShootconst =0
)const =0

Keep offset inside limits.

Return the new offset that is inside the limits of the scroll list, with the overShoot value added at both ends of the list.

Parameters:
newOffsetThe new offset.
overShootThe over shoot.
Returns:

The new offset inside the limits.

Reimplemented by: touchgfx::ScrollList::keepOffsetInsideLimits, touchgfx::ScrollWheelBase::keepOffsetInsideLimits

setOffset

virtual void setOffset(int32_toffset)

Sets display offset of first item.

Parameters:
offsetThe offset.

Reimplemented by: touchgfx::ScrollWheelWithSelectionStyle::setOffset

Protected Attributes Documentation

animationEndedCallback

GenericCallback * animationEndedCallback

The animation ended callback.

currentAnimationState

AnimationState currentAnimationState

The current animation state.

defaultAnimationSteps

uint16_t defaultAnimationSteps

The animation steps.

distanceBeforeAlignedItem

int16_t distanceBeforeAlignedItem

The distance before aligned item.

dragAcceleration

uint16_t dragAcceleration

The drag acceleration x10.

draggableX

bool draggableX

Is the container draggable in the horizontal direction.

draggableY

bool draggableY

Is the container draggable in the vertical direction.

easingEquation

EasingEquation easingEquation

The easing equation used for animation.

gestureEnd

int gestureEnd

The gesture end.

gestureStart

int gestureStart

The gesture start.

gestureStep

int gestureStep

The current gesture step.

gestureStepsTotal

int gestureStepsTotal

The total gesture steps.

initialSwipeOffset

int32_t initialSwipeOffset

The initial swipe offset.

isPressed

bool isPressed

Is the container currently pressed (maybe show scrollbars)

isScrolling

bool isScrolling

Is the container scrolling (i.e. has overcome the initial larger drag that is required to initiate a scroll).

itemLockedInCallback

GenericCallback * itemLockedInCallback

The item locked in callback.

itemPressedCallback

GenericCallback< int16_t > * itemPressedCallback

The item pressed callback.

itemSelectedCallback

GenericCallback< int16_t > * itemSelectedCallback

The item selected callback.

itemSize

int16_t itemSize

Size of the item (including margin)

list

The list.

maxSwipeItems

uint16_t maxSwipeItems

The maximum swipe items.

numberOfDrawables

int16_t numberOfDrawables

Number of drawables.

overshootPercentage

uint8_t overshootPercentage

The overshoot percentage when dragging.

swipeAcceleration

uint16_t swipeAcceleration

The swipe acceleration x10.

xClick

int16_t xClick

The x coordinate of a click.

yClick

int16_t yClick

The y coordinate of a click.