ScrollList

A simple list of scrolling drawables. Since a long list of drawables only display a few of items at any one time, the drawables are re-used to preserve resources.

See: DrawableList

Inherits from: ScrollBase, Container, Drawable

Public Functions

int16_t	getItem(int16_t drawableIndex)
	Gets an item.
int16_t	getPaddingAfter() const
	Gets distance after last drawable in ScrollList.
int16_t	getPaddingBefore() const
	Gets distance before first drawable in ScrollList.
bool	getSnapping() const
	Gets the current snap stetting.
virtual void	handleClickEvent(const ClickEvent & event)
	Defines the event handler interface for ClickEvents.
	ScrollList()
virtual void	setDrawables(DrawableListItemsInterface & drawableListItems, GenericCallback< DrawableListItemsInterface *, int16_t, int16_t > & updateDrawableCallback)
	Setup a list of drawables and provide a function to call to update a given Drawable with new contents.
virtual void	setDrawableSize(int16_t drawableSize, int16_t drawableMargin)
	Sets drawables size.
virtual void	setHeight(int16_t height)
	Sets the height of this drawable.
void	setPadding(int16_t paddingBefore, int16_t paddingAfter)
	Sets distance offset before and after the "visible" drawables in the ScrollList.
void	setSnapping(bool snap)
	Set snapping.
virtual void	setWidth(int16_t width)
	Sets the width of this drawable.
void	setWindowSize(int16_t items)
	Sets window size, i.e.

Protected Functions

virtual int32_t	getNearestAlignedOffset(int32_t offset) const
	Gets nearest offset aligned to a multiple of itemSize.
virtual int32_t	getPositionForItem(int16_t itemIndex)
	Get the position for an item.
virtual int32_t	keepOffsetInsideLimits(int32_t newOffset, int16_t overShoot) const
	Keep offset inside limits.

Protected Attributes

int16_t	paddingAfterLastItem
	The distance after last item.
bool	snapping
	Is snapping enabled?
int	windowSize
	Number of items that should always be visible.

Additional inherited members

Protected Types inherited from ScrollBase

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

Public Functions inherited from ScrollBase

void	allowHorizontalDrag(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).
void	allowVerticalDrag(bool enable)
	Enables the vertical scroll.
virtual void	animateToItem(int16_t itemIndex, int16_t animationSteps =-1)
	Go to a specific item, possibly with animation.
uint16_t	getAnimationSteps() const
	Gets animation steps as set in setAnimationSteps.
virtual bool	getCircular() const
	Gets the circular setting, previously set using setCircular().
uint16_t	getDragAcceleration() const
	Gets drag acceleration (times 10).
virtual int16_t	getDrawableMargin() const
	Gets drawable margin as set through the second parameter in most recent call to setDrawableSize().
virtual int16_t	getDrawableSize() const
	Gets drawable size as set through the first parameter in most recent call to setDrawableSize().
virtual bool	getHorizontal() const
	Gets the orientation of the drawables, previously set using setHorizontal().
uint16_t	getMaxSwipeItems() const
	Gets maximum swipe items as set by setMaxSwipeItems.
virtual int16_t	getNumberOfItems() const
	Gets number of items in the DrawableList, as previously set using setNumberOfItems().
uint8_t	getOvershootPercentage() const
	Gets overshoot percentage, as previously set using setOvershootPercentage.
uint16_t	getSwipeAcceleration() const
	Gets swipe acceleration (times 10).
virtual void	handleDragEvent(const DragEvent & event)
	Defines the event handler interface for DragEvents.
virtual void	handleGestureEvent(const GestureEvent & event)
	Defines the event handler interface for GestureEvents.
virtual void	handleTickEvent()
	Called periodically by the framework if the Drawable instance has subscribed to timer ticks.
virtual void	initialize()
	Removed all drawables and initializes the content of these items.
bool	isAnimating() const
	Query if an animation is ongoing.
virtual void	itemChanged(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()
void	setAnimationEndedCallback(GenericCallback<> & callback)
	Callback, called when the set animation ended.
void	setAnimationSteps(int16_t steps)
	Sets animation steps (in ticks) when moving to a new selected item.
virtual void	setCircular(bool circular)
	Sets whether the list is circular (infinite) or not.
void	setDragAcceleration(uint16_t acceleration)
	Sets drag acceleration times 10, so "10" means "1", "15" means "1.5".
void	setEasingEquation(EasingEquation equation)
	Sets easing equation when changing the selected item, for example via swipe or AnimateTo.
virtual void	setHorizontal(bool horizontal)
	Sets a horizontal or vertical layout.
void	setItemPressedCallback(GenericCallback< int16_t > & callback)
	Set Callback which will be called when a item is pressed.
void	setItemSelectedCallback(GenericCallback< int16_t > & callback)
	Sets Callback which will be called when the selected item is clicked.
void	setMaxSwipeItems(uint16_t maxItems)
	Sets maximum swipe items.
virtual void	setNumberOfItems(int16_t numberOfItems)
	Sets number of items in the DrawableList.
void	setOvershootPercentage(uint8_t percentage)
	Sets overshoot percentage when dragging a non-circular list.
void	setSwipeAcceleration(uint16_t acceleration)
	Sets swipe acceleration (times 10).
void	stopAnimation()
	Stops an animation if one is ongoing.

Protected Functions inherited from ScrollBase

virtual void	animateToPosition(int32_t position, int16_t steps =-1)
	Animate to a new position/offset using the given number of steps.
int	getNormalizedOffset(int offset) const
	Gets normalized offset from a given offset from 0 down to -numItems*itemSize.
virtual int32_t	getOffset() const
	Gets display offset of first item.
virtual void	setOffset(int32_t offset)
	Sets display offset of first item.

Protected Attributes inherited from ScrollBase

GenericCallback *	animationEndedCallback
	The animation ended callback.
AnimationState	currentAnimationState
	The current animation state.
uint16_t	defaultAnimationSteps
	The animation steps.
int16_t	distanceBeforeAlignedItem
	The distance before aligned item.
uint16_t	dragAcceleration
	The drag acceleration x10.
bool	draggableX
	Is the container draggable in the horizontal direction.
bool	draggableY
	Is the container draggable in the vertical direction.
EasingEquation	easingEquation
	The easing equation used for animation.
int	gestureEnd
	The gesture end.
int	gestureStart
	The gesture start.
int	gestureStep
	The current gesture step.
int	gestureStepsTotal
	The total gesture steps.
int32_t	initialSwipeOffset
	The initial swipe offset.
GenericCallback *	itemLockedInCallback
	The item locked in callback.
GenericCallback< int16_t > *	itemPressedCallback
	The item pressed callback.
GenericCallback< int16_t > *	itemSelectedCallback
	The item selected callback.
int16_t	itemSize
	Size of the item (including margin)
DrawableList	list
	The list.
uint16_t	maxSwipeItems
	The maximum swipe items.
int16_t	numberOfDrawables
	Number of drawables.
uint8_t	overshootPercentage
	The overshoot percentage when dragging.
uint16_t	swipeAcceleration
	The swipe acceleration x10.
int16_t	xClick
	The x coordinate of a click.
int16_t	yClick
	The y coordinate of a click.

Public Functions inherited from Container

virtual void	add(Drawable & d)
	Adds a Drawable instance as child to this Container.
	Container()
virtual bool	contains(const Drawable & d)
	Query if a given Drawable has been added directly to this Container.
virtual void	draw(const Rect & invalidatedArea) const
	Draw this drawable.
virtual void	forEachChild(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 void	getLastChild(int16_t x, int16_t y, Drawable ** last)
	Gets the last child in the list of children in this Container.
virtual void	getLastChildNear(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 Rect	getSolidRect() const
	Get (the largest possible) rectangle that is guaranteed to be solid (opaque).
virtual void	insert(Drawable * previous, Drawable & d)
	Inserts a Drawable after a specific child node.
virtual void	invalidateContent() const
	Tell the framework that the contents of the Drawable needs to be redrawn.
virtual void	remove(Drawable & d)
	Removes a Drawable from the container by removing it from the linked list of children.
virtual void	removeAll()
	Removes all children in the Container by resetting their parent and sibling pointers.
virtual void	unlink()
	Removes all children by unlinking the first child.

Protected Functions inherited from Container

virtual Rect	getContainedArea() const
	Gets a rectangle describing the total area covered by the children of this container.
virtual void	moveChildrenRelative(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

void	center()
	Centers the Drawable inside its parent.
void	centerX()
	Center the Drawable horizontally inside its parent.
void	centerY()
	Center the Drawable vertically inside its parent.
virtual void	childGeometryChanged()
	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 void	draw(const Rect & invalidatedArea) const =0
	Draw this drawable.
	Drawable()
	Initializes a new instance of the Drawable class.
void	drawToDynamicBitmap(BitmapId id)
	Render the Drawable object into a dynamic bitmap.
void	expand(int margin =0)
	Expands the Drawable to have the same size as its parent with a given margin around the edge.
Rect	getAbsoluteRect() 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_t	getHeight() const
	Gets the height of this Drawable.
virtual void	getLastChild(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 Rect	getSolidRect() const =0
	Get (the largest possible) rectangle that is guaranteed to be solid (opaque).
virtual Rect	getSolidRectAbsolute()
	Helper function for obtaining the largest solid rect (as implemented by getSolidRect()) expressed in absolute coordinates.
virtual void	getVisibleRect(Rect & rect) const
	Function for finding the visible part of this drawable.
int16_t	getWidth() const
	Gets the width of this Drawable.
int16_t	getX() const
	Gets the x coordinate of this Drawable, relative to its parent.
int16_t	getY() const
	Gets the y coordinate of this Drawable, relative to its parent.
virtual void	handleDragEvent(const DragEvent & event)
	Defines the event handler interface for DragEvents.
virtual void	handleGestureEvent(const GestureEvent & event)
	Defines the event handler interface for GestureEvents.
virtual void	handleTickEvent()
	Called periodically by the framework if the Drawable instance has subscribed to timer ticks.
virtual void	invalidate() const
	Tell the framework that this entire Drawable needs to be redrawn.
virtual void	invalidateContent() const
	Tell the framework that the contents of the Drawable needs to be redrawn.
virtual void	invalidateRect(Rect & invalidatedArea) const
	Request that a region of this drawable is redrawn.
bool	isTouchable() const
	Gets whether this Drawable receives touch events or not.
bool	isVisible() const
	Gets whether this Drawable is visible.
virtual void	moveRelative(int16_t x, int16_t y)
	Moves the drawable.
virtual void	moveTo(int16_t x, int16_t y)
	Moves the drawable.
void	setPosition(const Drawable & drawable)
	Sets the position of the Drawable to the same as the given Drawable.
void	setPosition(int16_t x, int16_t y, int16_t width, int16_t height)
	Sets the size and position of this Drawable, relative to its parent.
void	setTouchable(bool touch)
	Controls whether this Drawable receives touch events or not.
void	setVisible(bool vis)
	Controls whether this Drawable should be visible.
void	setWidthHeight(const Bitmap & bitmap)
	Sets the dimensions (width and height) of the Drawable without changing the x and y coordinates).
void	setWidthHeight(const Drawable & drawable)
	Sets the dimensions (width and height) of the Drawable without changing the x and y coordinates).
void	setWidthHeight(const Rect & other)
	Sets the dimensions (width and height) of the Drawable without changing the x and y coordinates).
void	setWidthHeight(int16_t width, int16_t height)
	Sets the dimensions (width and height) of the Drawable without changing the x and y coordinates).
virtual void	setX(int16_t x)
	Sets the x coordinate of this Drawable, relative to its parent.
void	setXY(const Drawable & drawable)
	Sets the x and y coordinates of this Drawable.
void	setXY(int16_t x, int16_t y)
	Sets the x and y coordinates of this Drawable, relative to its parent.
virtual void	setY(int16_t y)
	Sets the y coordinate of this Drawable, relative to its parent.
virtual void	translateRectToAbsolute(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.
Rect	rect
	The coordinates of this Drawable, relative to its parent.
bool	touchable
	True if this drawable should receive touch events.
bool	visible
	True if this drawable should be drawn.

Public Functions Documentation

getItem

int16_t getItem	(	int16_t	drawableIndex	)

Gets an item.

Parameters:

drawableIndex	Zero-based index of the drawable.

Returns:

The item.

getPaddingAfter

int16_t getPaddingAfter	(			)	const

Gets distance after last drawable in ScrollList.

Returns:

The distance after the last drawable in the ScrollList.

See also:

setPadding, getPaddingBefore

getPaddingBefore

int16_t getPaddingBefore	(			)	const

Gets distance before first drawable in ScrollList.

Returns:

The distance before.

See also:

setPadding, getPaddingAfter

getSnapping

bool getSnapping	(			)	const

Gets the current snap stetting.

Returns:

true if snapping is set, false otherwise.

See also:

setSnapping

handleClickEvent

virtual void handleClickEvent	(	const ClickEvent &	event	)

Defines the event handler interface for ClickEvents.

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

Parameters:

event	The ClickEvent received from the HAL.

Reimplements: touchgfx::Drawable::handleClickEvent

ScrollList

ScrollList	(			)

setDrawables

virtual void setDrawables	(	DrawableListItemsInterface &	drawableListItems ,
		GenericCallback< DrawableListItemsInterface *, int16_t, int16_t > &	updateDrawableCallback
		)

Setup a list of drawables and provide a function to call to update a given Drawable with new contents.

Parameters:

drawableListItems	The drawables allocated.
updateDrawableCallback	A callback to update the contents of a specific drawable with a specific item.

See also:

DrawableList::setDrawables

setDrawableSize

virtual void setDrawableSize	(	int16_t	drawableSize ,
		int16_t	drawableMargin
		)

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:

drawableSize	The size of the drawable.
drawableMargin	The margin around drawables (margin before and margin after).

See also:

setWidth, setHeight, setHorizontal

Reimplements: touchgfx::ScrollBase::setDrawableSize

setHeight

virtual void setHeight	(	int16_t	height	)

Sets the height of this drawable.

Parameters:

height	The 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::ScrollBase::setHeight

setPadding

void setPadding	(	int16_t	paddingBefore ,
		int16_t	paddingAfter
		)

Sets distance offset before and after the "visible" drawables in the ScrollList.

This allows the actual area where widgets are placed to have a little extra area where parts of drawables can be seen. For example if the ScrollList is 200, each drawable is 50 and distance before and distance after are 25, then there is room for three visible drawables inside the ScrollList. When scrolling, part of the scrolled out drawables can be seen before and after the three drawables. In this case 25/50 = 50% of a drawable can be seen before and after the three drawables in the ScrollList.

Parameters:

paddingBefore	The distance before the first drawable in the ScrollList.
paddingAfter	The distance after the last drawable in the ScrollList.

See also:

getPaddingBefore, getPaddingAfter

setSnapping

void setSnapping	(	bool	snap	)

Set snapping.

If snapping is false, the items can flow freely. If snapping is true, the items will snap into place so an item is always in the "selected" spot.

Parameters:

snap	true to snap.

See also:

getSnapping

setWidth

virtual void setWidth	(	int16_t	width	)

Sets the width of this drawable.

Parameters:

width	The 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::ScrollBase::setWidth

setWindowSize

void setWindowSize	(	int16_t	items	)

Sets window size, i.e.

the number of items that should always be visible. The default value is 1. If three items are visible on the display and window size is set to three, no part of the screen will be blank (unless the list contains less than three items and the list is not circular).

Parameters:

items	The number of items that should always be visible.

Note

This only applies to non-circular lists.

Protected Functions Documentation

getNearestAlignedOffset

virtual int32_t getNearestAlignedOffset	(	int32_t	offset	)

Gets nearest offset aligned to a multiple of itemSize.

Parameters:

offset	The offset.

Returns:

The nearest aligned offset.

Reimplements: touchgfx::ScrollBase::getNearestAlignedOffset

getPositionForItem

virtual int32_t getPositionForItem	(	int16_t	itemIndex	)

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:

itemIndex	Zero-based index of the item.

Returns:

The position for item.

Reimplements: touchgfx::ScrollBase::getPositionForItem

keepOffsetInsideLimits

virtual int32_t keepOffsetInsideLimits	(	int32_t	newOffset ,		const
		int16_t	overShoot		const
		)	const

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:

newOffset	The new offset.
overShoot	The over shoot.

Returns:

The new offset inside the limits.

Reimplements: touchgfx::ScrollBase::keepOffsetInsideLimits

Protected Attributes Documentation

paddingAfterLastItem

int16_t paddingAfterLastItem

The distance after last item.

snapping

bool snapping

Is snapping enabled?

windowSize

int windowSize

Number of items that should always be visible.