Skip to main content

AbstractProgressIndicator

The AbstractProgressIndicator declares methods that provides the basic mechanisms and tools to implement a progress indicator. For more specific implementations see classes that inherit from AbstractProgressIndicator.

See: BoxProgress, CircleProgress, ImageProgress, LineProgress, TextProgress

Inherits from: Container, Drawable

Inherited by: AbstractDirectionProgress, CircleProgress, Gauge, LineProgress, TextProgress

Public Functions

AbstractProgressIndicator()
Initializes a new instance of the AbstractProgressIndicator class with a default range 0-100.
virtual uint8_tgetAlpha() const
Gets the current alpha value of the widget.
virtual uint16_tgetProgress(uint16_t range =100) const
Gets the current progress based on the range set by setRange() and the value set by setValue().
virtual int16_tgetProgressIndicatorHeight() const
Gets progress indicator height.
virtual int16_tgetProgressIndicatorWidth() const
Gets progress indicator width.
virtual int16_tgetProgressIndicatorX() const
Gets progress indicator x coordinate.
virtual int16_tgetProgressIndicatorY() const
Gets progress indicator y coordinate.
virtual voidgetRange(int & min, int & max) const
Gets the range set by setRange().
virtual voidgetRange(int & min, int & max, uint16_t & steps) const
Gets the range set by setRange().
virtual voidgetRange(int & min, int & max, uint16_t & steps, uint16_t & minStep) const
Gets the range set by setRange().
virtual intgetValue() const
Gets the current value set by setValue().
virtual voidhandleTickEvent()
Called periodically by the framework if the Drawable instance has subscribed to timer ticks.
virtual voidinvalidateContent() const
Tell the framework that the contents of the Drawable needs to be redrawn.
virtual voidsetAlpha(uint8_t newAlpha)
Sets the opacity (alpha value).
virtual voidsetBackground(const Bitmap & bitmapBackground)
Sets the background image.
virtual voidsetEasingEquation(EasingEquation easingEquation)
Sets easing equation to be used in updateValue.
virtual voidsetProgressIndicatorPosition(int16_t x, int16_t y, int16_t width, int16_t height)
Sets the position and dimensions of the actual progress indicator relative to the background image.
virtual voidsetRange(int min, int max, uint16_t steps =0, uint16_t minStep =0)
Sets the range for the progress indicator.
virtual voidsetValue(int value)
Sets the current value in the range (min..max) set by setRange().
voidsetValueSetAction(GenericCallback< const AbstractProgressIndicator & > & callback)
Sets callback that will be triggered every time a new value is assigned to the progress indicator.
voidsetValueUpdatedAction(GenericCallback< const AbstractProgressIndicator & > & callback)
Sets callback that will be triggered when updateValue has finished animating to the final value.
virtual voidupdateValue(int value, uint16_t duration)
Update the current value in the range (min..max) set by setRange().

Protected Attributes

intanimationDuration
Duration of the animation.
intanimationEndValue
The animation end value.
boolanimationRunning
Is the animation running.
intanimationStartValue
The animation start value.
intanimationStep
The current animation step.
Imagebackground
The background image.
intcurrentValue
The current value.
EasingEquationequation
The equation used in updateValue()
ContainerprogressIndicatorContainer
The container that holds the actual progress indicator.
intrangeMax
The range maximum.
intrangeMin
The range minimum.
uint16_trangeSteps
The range steps.
uint16_trangeStepsMin
The range steps minimum.
GenericCallback< const AbstractProgressIndicator & > *valueSetCallback
New value assigned Callback.
GenericCallback< const AbstractProgressIndicator & > *valueUpdatedCallback
Animation ended Callback.

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 voidhandleDragEvent(const DragEvent & event)
Defines the event handler interface for DragEvents.
virtual voidhandleGestureEvent(const GestureEvent & event)
Defines the event handler interface for GestureEvents.
virtual voidinvalidate() const
Tell the framework that this entire 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.
virtual voidsetHeight(int16_t height)
Sets the height of this 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.
virtual voidsetWidth(int16_t width)
Sets the width of this drawable.
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.

Public Functions Documentation

AbstractProgressIndicator

Initializes a new instance of the AbstractProgressIndicator class with a default range 0-100.

getAlpha

virtual uint8_t getAlpha()const

Gets the current alpha value of the widget.

The alpha value is in range 255 (solid) to 0 (invisible).

Returns:

The current alpha value.

See also:

getProgress

virtual uint16_t getProgress(uint16_trange =100)

Gets the current progress based on the range set by setRange() and the value set by setValue().

Parameters:
range(Optional) The range, default is 100.
Returns:

The progress.

See also:

getProgressIndicatorHeight

virtual int16_t getProgressIndicatorHeight()const

Gets progress indicator height.

Returns:

The progress indicator height.

See also:

getProgressIndicatorWidth

virtual int16_t getProgressIndicatorWidth()const

Gets progress indicator width.

Returns:

The progress indicator width.

See also:

getProgressIndicatorX

virtual int16_t getProgressIndicatorX()const

Gets progress indicator x coordinate.

Returns:

The progress indicator x coordinate.

See also:

getProgressIndicatorY

virtual int16_t getProgressIndicatorY()const

Gets progress indicator y coordinate.

Returns:

The progress indicator y coordinate.

See also:

getRange

virtual void getRange(int &min ,const
int &maxconst
)const

Gets the range set by setRange().

Parameters:
minThe minimum input value.
maxThe maximum input value.
See also:

getRange

virtual void getRange(int &min ,const
int &max ,const
uint16_t &stepsconst
)const

Gets the range set by setRange().

Parameters:
minThe minimum input value.
maxThe maximum input value.
stepsThe steps in which to report progress.
See also:

getRange

virtual void getRange(int &min ,const
int &max ,const
uint16_t &steps ,const
uint16_t &minStepconst
)const

Gets the range set by setRange().

Parameters:
minThe minimum input value.
maxThe maximum input value.
stepsThe steps in which to report progress.
minStepThe step which the minimum input value is mapped to.
See also:

getValue

virtual int getValue()const

Gets the current value set by setValue().

Returns:

The value.

See also:

handleTickEvent

virtual void handleTickEvent()

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

See also:

Reimplements: touchgfx::Drawable::handleTickEvent

invalidateContent

virtual void invalidateContent()const

Tell the framework that the contents of the Drawable needs to be redrawn.

If the Drawable is invisible, nothing happens. Subclasses of Drawable are encouraged to implement this function and invalidate as little as possible, i.e. the smallest rectangle covering the visual element(s) drawn by the widget.

Reimplements: touchgfx::Container::invalidateContent

Reimplemented by: touchgfx::Gauge::invalidateContent

setAlpha

virtual void setAlpha(uint8_tnewAlpha)

Sets the opacity (alpha value).

This can be used to fade it away by gradually decreasing the alpha value from 255 (solid) to 0 (invisible).

Parameters:
newAlphaThe new alpha value. 255=solid, 0=invisible.
Note

The user code must call invalidate() in order to update the display.

See also:

Reimplemented by: touchgfx::BoxProgress::setAlpha, touchgfx::CircleProgress::setAlpha, touchgfx::ImageProgress::setAlpha, touchgfx::LineProgress::setAlpha, touchgfx::TextProgress::setAlpha, touchgfx::Gauge::setAlpha

setBackground

virtual void setBackground(const Bitmap &bitmapBackground)

Sets the background image.

The width and height of the progress indicator widget is updated according to the dimensions of the bitmap.

Parameters:
bitmapBackgroundThe background bitmap.

setEasingEquation

virtual void setEasingEquation(EasingEquationeasingEquation)

Sets easing equation to be used in updateValue.

Parameters:
easingEquationThe easing equation.
See also:

setProgressIndicatorPosition

virtual void setProgressIndicatorPosition(int16_tx ,
int16_ty ,
int16_twidth ,
int16_theight
)

Sets the position and dimensions of the actual progress indicator relative to the background image.

Parameters:
xThe x coordinate.
yThe y coordinate.
widthThe width of the box progress indicator.
heightThe height of the box progress indicator.
See also:

Reimplemented by: touchgfx::BoxProgress::setProgressIndicatorPosition, touchgfx::CircleProgress::setProgressIndicatorPosition, touchgfx::ImageProgress::setProgressIndicatorPosition, touchgfx::LineProgress::setProgressIndicatorPosition, touchgfx::TextProgress::setProgressIndicatorPosition, touchgfx::Gauge::setProgressIndicatorPosition

setRange

virtual void setRange(intmin ,
intmax ,
uint16_tsteps =0,
uint16_tminStep =0
)

Sets the range for the progress indicator.

The range is the values that are given to the progress indicator while progressing through the task at hand. If an app needs to work through 237 items to finish a task, the range should be set to (0, 237) assuming that 0 items is the minimum. Though the minimum is often 0, it is possible to customize this.

The steps parameter is used to specify at what granularity you want the progress indicator to report a new progress value. If the 237 items to be reported as 0%, 10%, 20%, ... 100%, the steps should be set to 10 as there are ten steps from 0% to 100%. If you want to update a widget which is 150 pixels wide, you might want to set steps to 150 to get a new progress value for every pixel. If you are updating a clock and want this to resemble an analog clock, you might want to use 12 or perhaps 60 as number of steps.

The minStep parameter is used when the minimum input value (min) should give a progress different from 0. For example, if progress is a clock face, you want to count from 0..1000 and you want progress per minute, but want to make sure that 0 is not a blank clock face, but instead you want 1 minute to show, use

setRange(0, 1000, 60, 1)

to make sure that as values progress from 0 to 1000, getProgress() start from 1 and goes up to 60. Another example could be a BoxProgress with a TextProgress on top and you want to make sure that "0%" will always show in the box, use something like

setRange(0, 1000, 200, 40)

if your box is 200 pixels wide and "0%" is 40 pixels wide.

Parameters:
minThe minimum input value.
maxThe maximum input value.
steps(Optional) The steps in which to report progress.
minStep(Optional) The step which the minimum input value is mapped to.
See also:

setValue

virtual void setValue(intvalue)

Sets the current value in the range (min..max) set by setRange().

Values lower than min are mapped to min, values higher than max are mapped to max. If a callback function has been set using setValueSetAction, that callback will be called (unless the new value is the same as the current value).

Parameters:
valueThe value.
Note

if value is equal to the current value, nothing happens, and the callback will not be called.

See also:

Reimplemented by: touchgfx::BoxProgress::setValue, touchgfx::CircleProgress::setValue, touchgfx::ImageProgress::setValue, touchgfx::LineProgress::setValue, touchgfx::TextProgress::setValue, touchgfx::Gauge::setValue

setValueSetAction

Sets callback that will be triggered every time a new value is assigned to the progress indicator.

This can happen directly from setValue() or during a gradual change initiated using updateValue().

Parameters:
callbackThe callback.
See also:

setValueUpdatedAction

Sets callback that will be triggered when updateValue has finished animating to the final value.

Parameters:
callbackThe callback.
See also:

updateValue

virtual void updateValue(intvalue ,
uint16_tduration
)

Update the current value in the range (min..max) set by setRange().

Values lower than min are mapped to min, values higher than max are mapped to max. The value is changed gradually in the given number of ticks using the easing equation set in setEasingEquation. Function setValue() is called for every new value during the change of value, and if a callback function has been set using setValueSetAction, that callback will be called for every new value. The callback set using setValueUpdatedCallback is called when the animation has finished.

Parameters:
valueThe value.
durationThe duration.
Note

If duration is 0, setValue will be called immediately and the valueUpdated action is called immediately.

See also:

Protected Attributes Documentation

animationDuration

int animationDuration

Duration of the animation.

animationEndValue

int animationEndValue

The animation end value.

animationRunning

bool animationRunning

Is the animation running.

animationStartValue

int animationStartValue

The animation start value.

animationStep

int animationStep

The current animation step.

background

Image background

The background image.

currentValue

int currentValue

The current value.

equation

EasingEquation equation

The equation used in updateValue()

progressIndicatorContainer

Container progressIndicatorContainer

The container that holds the actual progress indicator.

rangeMax

int rangeMax

The range maximum.

rangeMin

int rangeMin

The range minimum.

rangeSteps

uint16_t rangeSteps

The range steps.

rangeStepsMin

uint16_t rangeStepsMin

The range steps minimum.

valueSetCallback

GenericCallback< const AbstractProgressIndicator & > * valueSetCallback

New value assigned Callback.

valueUpdatedCallback

GenericCallback< const AbstractProgressIndicator & > * valueUpdatedCallback

Animation ended Callback.