ScrollWheelWithSelectionStyle

A scroll wheel is very much like the digit selector on a padlock with numbers. The digits always snap into place and exactly one number is always the "selected" number. Similar to an ordinary ScrollWheel, but with a different style for the selected item which can thus be bold, have a different color or similar effect to highlight it and help create a 3D effect using very few resources.

See: DrawableList, ScrollWheel

Inherits from: ScrollWheelBase, ScrollBase, Container, Drawable

Public Functions

virtual int16_t	getSelectedItemExtraSizeAfter() const
	Gets selected item extra size after.
virtual int16_t	getSelectedItemExtraSizeBefore() const
	Gets selected item extra size before.
virtual int16_t	getSelectedItemMarginAfter() const
	Gets selected item margin after.
virtual int16_t	getSelectedItemMarginBefore() const
	Gets selected item margin before.
virtual void	initialize()
	Removed all drawables and initializes the content of these items.
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.
	ScrollWheelWithSelectionStyle()
virtual void	setCircular(bool circular)
	Sets whether the list is circular (infinite) or not.
virtual void	setDrawables(DrawableListItemsInterface & drawableListItems, GenericCallback< DrawableListItemsInterface , int16_t, int16_t > & updateDrawableCallback, DrawableListItemsInterface & centerDrawableListItems, GenericCallback< DrawableListItemsInterface , int16_t, int16_t > & updateCenterDrawableCallback)
	Setups the widget.
virtual void	setDrawableSize(int16_t drawableSize, int16_t drawableMargin)
	Sets drawables size.
virtual void	setHeight(int16_t height)
	Sets the height of this drawable.
virtual void	setHorizontal(bool horizontal)
	Sets a horizontal or vertical layout.
virtual void	setNumberOfItems(int16_t numberOfItems)
	Sets number of items in the DrawableList.
virtual void	setSelectedItemExtraSize(int16_t extraSizeBefore, int16_t extraSizeAfter)
	Sets selected item extra size to make the size of the area for the center drawables larger.
virtual void	setSelectedItemMargin(int16_t marginBefore, int16_t marginAfter)
	Sets margin around selected item.
virtual void	setSelectedItemOffset(int16_t offset)
	Sets selected item offset, measured in pixels, from the edge of the widget.
virtual void	setSelectedItemPosition(int16_t offset, int16_t extraSizeBefore, int16_t extraSizeAfter, int16_t marginBefore, int16_t marginAfter)
	Sets the selected item offset.
virtual void	setWidth(int16_t width)
	Sets the width of this drawable.

Protected Functions

void	refreshDrawableListsLayout()
	Refresh drawable lists layout.
virtual void	setOffset(int32_t offset)
	Sets display offset of first item.

Protected Attributes

DrawableListItemsInterface *	centerDrawables
	The drawables at the center of the scroll wheel.
DrawableListItemsInterface *	drawables
	The drawables at the beginning and end of the scroll wheel.
int16_t	drawablesInFirstList
	List of drawables in firsts.
int16_t	extraSizeAfterSelectedItem
	The distance after selected item.
int16_t	extraSizeBeforeSelectedItem
	The distance before selected item.
DrawableList	list1
	The center list.
DrawableList	list2
	The list for items not in the center.
int16_t	marginAfterSelectedItem
	The distance after selected item.
int16_t	marginBeforeSelectedItem
	The distance before selected item.
GenericCallback< DrawableListItemsInterface , int16_t, int16_t >	originalUpdateCenterDrawableCallback
	The original update center drawable callback.
GenericCallback< DrawableListItemsInterface , int16_t, int16_t >	originalUpdateDrawableCallback
	The original update drawable callback.

Additional inherited members

Public Functions inherited from ScrollWheelBase

int	getSelectedItem() const
	Gets selected item.
virtual int16_t	getSelectedItemOffset() const
	Gets offset of selected item measured in pixels relative to the start of the widget.
virtual void	handleClickEvent(const ClickEvent & event)
	Defines the event handler interface for ClickEvents.
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 int32_t	keepOffsetInsideLimits(int32_t newOffset, int16_t overShoot) const
	Keep offset inside limits.
	ScrollWheelBase()
void	setAnimateToCallback(GenericCallback< int16_t > & callback)
	Sets Callback which will be called when the ScrollWheel animates to a new item.

Protected Functions inherited from ScrollWheelBase

virtual void	animateToPosition(int32_t position, int16_t steps =-1)
	Animate to a new position/offset using the given number of steps.
virtual int32_t	getPositionForItem(int16_t itemIndex)
	Get the position for an item.

Protected Attributes inherited from ScrollWheelBase

GenericCallback< int16_t > *	animateToCallback
	The animate to callback.

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().
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.
bool	isAnimating() const
	Query if an animation is ongoing.
	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.
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.
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.
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.
virtual int32_t	getNearestAlignedOffset(int32_t offset) const
	Gets nearest offset aligned to a multiple of itemSize.
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 int32_t	getPositionForItem(int16_t itemIndex) =0
	Get the position for an item.
virtual int32_t	keepOffsetInsideLimits(int32_t newOffset, int16_t overShoot) const =0
	Keep offset inside limits.

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.
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 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	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

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.
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	handleClickEvent(const ClickEvent & event)
	Defines the event handler interface for ClickEvents.
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	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 & rect)
	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

getSelectedItemExtraSizeAfter

virtual int16_t getSelectedItemExtraSizeAfter	(			)	const

Gets selected item extra size after.

Returns:

The selected item extra size after.

See also:

setSelectedItemExtraSize

getSelectedItemExtraSizeBefore

virtual int16_t getSelectedItemExtraSizeBefore	(			)	const

Gets selected item extra size before.

Returns:

The selected item extra size before.

See also:

setSelectedItemExtraSize

getSelectedItemMarginAfter

virtual int16_t getSelectedItemMarginAfter	(			)	const

Gets selected item margin after.

Returns:

The selected item margin after.

See also:

setSelectedItemMargin

getSelectedItemMarginBefore

virtual int16_t getSelectedItemMarginBefore	(			)	const

Gets selected item margin before.

Returns:

The selected item margin before.

See also:

setSelectedItemMargin

initialize

virtual void initialize	(			)

Removed all drawables and initializes the content of these items.

Reimplements: touchgfx::ScrollBase::initialize

itemChanged

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.

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:

itemIndex	Zero-based index of the changed item.

Reimplements: touchgfx::ScrollBase::itemChanged

ScrollWheelWithSelectionStyle

ScrollWheelWithSelectionStyle	(			)

setCircular

virtual void setCircular	(	bool	circular	)

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:

circular	True if the list should be circular, false if the list should not be circular.

See also:

DrawableList::setCircular, getCircular

Reimplements: touchgfx::ScrollBase::setCircular

setDrawables

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

Setups the widget.

Numerous parameters control the position of the widget, the two scroll lists inside and the values in them.

Parameters:

drawableListItems	Number of drawables in outer array.
updateDrawableCallback	The callback to update a drawable.
centerDrawableListItems	Number of drawables in center array.
updateCenterDrawableCallback	The callback to update a center drawable.

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

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

setHorizontal

virtual void setHorizontal	(	bool	horizontal	)

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:

horizontal	True to align drawables horizontal, false to align drawables vertically.

Note

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

See also:

DrawableList::setHorizontal, getHorizontal

Reimplements: touchgfx::ScrollBase::setHorizontal

setNumberOfItems

virtual void setNumberOfItems	(	int16_t	numberOfItems	)

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:

numberOfItems	Number of items.

Note

The DrawableList is refreshed to reflect the change.

Reimplements: touchgfx::ScrollBase::setNumberOfItems

setSelectedItemExtraSize

virtual void setSelectedItemExtraSize	(	int16_t	extraSizeBefore ,
		int16_t	extraSizeAfter
		)

Sets selected item extra size to make the size of the area for the center drawables larger.

Parameters:

extraSizeBefore	The extra size before.
extraSizeAfter	The extra size after.

See also:

setSelectedItemOffset

setSelectedItemMargin

virtual void setSelectedItemMargin	(	int16_t	marginBefore ,
		int16_t	marginAfter
		)

Sets margin around selected item.

This like an invisible area added before and after the selected item (including extra size).

Parameters:

marginBefore	The margin before.
marginAfter	The margin after.

See also:

setSelectedItemOffset, setSelectedItemExtraSize

setSelectedItemOffset

virtual void setSelectedItemOffset	(	int16_t	offset	)

Sets selected item offset, measured in pixels, from the edge of the widget.

The offset is the relative x coordinate if the ScrollWheel is horizontal, otherwise it is the relative y coordinate. If this value is zero, the selected item is placed at the very start of the widget.

Parameters:

offset	The offset.

See also:

getSelectedItemOffset

Reimplements: touchgfx::ScrollWheelBase::setSelectedItemOffset

setSelectedItemPosition

virtual void setSelectedItemPosition	(	int16_t	offset ,
		int16_t	extraSizeBefore ,
		int16_t	extraSizeAfter ,
		int16_t	marginBefore ,
		int16_t	marginAfter
		)

Sets the selected item offset.

This is the distance from the beginning of the ScrollWheel measured in pixels. The distance before and after that should also be drawn using the center drawables - for example to extend area of emphasized elements - can also be specified. Further, if a gap is needed between the "normal" drawables and the center drawables - for example to give the illusion that that items disappear under a graphical element, only to appear in the center.

This is a combination of setSelectedItemOffset, setSelectedItemExtraSize and setSelectedItemMargin.

Parameters:

offset	The offset of the selected item.
extraSizeBefore	The extra size before the selected item.
extraSizeAfter	The extra size after the selected item.
marginBefore	The margin before the selected item.
marginAfter	The margin after the selected item.

See also:

setSelectedItemOffset, setSelectedItemExtraSize, setSelectedItemMargin

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

Protected Functions Documentation

refreshDrawableListsLayout

void refreshDrawableListsLayout	(			)

Refresh drawable lists layout.

Ensure that the three DrawableLists are places correctly and setup properly. This is typically done after the ScrollWheelWithSelectionStyle has been resized or the size of the selected item is changed.

setOffset

virtual void setOffset	(	int32_t	offset	)

Sets display offset of first item.

Parameters:

offset	The offset.

Reimplements: touchgfx::ScrollBase::setOffset

Protected Attributes Documentation

centerDrawables

DrawableListItemsInterface * centerDrawables

The drawables at the center of the scroll wheel.

drawables

DrawableListItemsInterface * drawables

The drawables at the beginning and end of the scroll wheel.

drawablesInFirstList

int16_t drawablesInFirstList

List of drawables in firsts.

extraSizeAfterSelectedItem

int16_t extraSizeAfterSelectedItem

The distance after selected item.

extraSizeBeforeSelectedItem

int16_t extraSizeBeforeSelectedItem

The distance before selected item.

list1

DrawableList list1

The center list.

list2

DrawableList list2

The list for items not in the center.

marginAfterSelectedItem

int16_t marginAfterSelectedItem

The distance after selected item.

marginBeforeSelectedItem

int16_t marginBeforeSelectedItem

The distance before selected item.

originalUpdateCenterDrawableCallback

GenericCallback< DrawableListItemsInterface , int16_t, int16_t > originalUpdateCenterDrawableCallback

The original update center drawable callback.

originalUpdateDrawableCallback

GenericCallback< DrawableListItemsInterface , int16_t, int16_t > originalUpdateDrawableCallback

The original update drawable callback.