TextProgress
touchgfx/containers/progress_indicators/TextProgress.hpp
A text progress will display progress as a number with a given number of decimals.
Note: The implementation does not use floating point variables to calculate the progress.
Inherits from: AbstractProgressIndicator, Container, Drawable
Public Functions
virtual colortype | getColor() const |
Gets the color of the text in the used text area. | |
virtual uint16_t | getNumberOfDecimals() const |
Gets number of decimals. | |
virtual const TypedText & | getTypedText() const |
Gets the typed text. | |
virtual void | setAlpha(uint8_t newAlpha) |
Sets the opacity (alpha value). | |
virtual void | setColor(colortype color) |
Sets the color of the text in the used text area. | |
virtual void | setNumberOfDecimals(uint16_t numberOfDecimals) |
Sets number of decimals when displaying progress. | |
virtual void | setProgressIndicatorPosition(int16_t x, int16_t y, int16_t width, int16_t height) |
Sets the position and dimensions of the text progress indicator. | |
virtual void | setTypedText(const TypedText & t) |
Sets the typed text. | |
virtual void | setValue(int value) |
Sets the new value for the progress indicator. | |
TextProgress() | |
Protected Attributes
uint16_t | decimals |
The number of decimals. | |
TextAreaWithOneWildcard | textArea |
The text area. | |
Unicode::UnicodeChar | textBuffer |
Room for 100.0000. | |
Additional inherited members
Public Functions inherited from AbstractProgressIndicator
AbstractProgressIndicator() | |
Initializes a new instance of the AbstractProgressIndicator class with a default range 0-100. | |
virtual uint8_t | getAlpha() const |
Gets the current alpha value of the widget. | |
virtual uint16_t | getProgress(uint16_t range =100) const |
Gets the current progress based on the range set by setRange() and the value set by setValue(). | |
virtual int16_t | getProgressIndicatorHeight() const |
Gets progress indicator height. | |
virtual int16_t | getProgressIndicatorWidth() const |
Gets progress indicator width. | |
virtual int16_t | getProgressIndicatorX() const |
Gets progress indicator x coordinate. | |
virtual int16_t | getProgressIndicatorY() const |
Gets progress indicator y coordinate. | |
virtual void | getRange(int & min, int & max) const |
Gets the range set by setRange(). | |
virtual void | getRange(int & min, int & max, uint16_t & steps) const |
Gets the range set by setRange(). | |
virtual void | getRange(int & min, int & max, uint16_t & steps, uint16_t & minStep) const |
Gets the range set by setRange(). | |
virtual int | getValue() const |
Gets the current value set by setValue(). | |
virtual void | handleTickEvent() |
Called periodically by the framework if the Drawable instance has subscribed to timer ticks. | |
virtual void | invalidateContent() const |
Tell the framework that the contents of the Drawable needs to be redrawn. | |
virtual void | setBackground(const Bitmap & bitmapBackground) |
Sets the background image. | |
virtual void | setEasingEquation(EasingEquation easingEquation) |
Sets easing equation to be used in updateValue. | |
virtual void | setRange(int min, int max, uint16_t steps =0, uint16_t minStep =0) |
Sets the range for the progress indicator. | |
void | setValueSetAction(GenericCallback< const AbstractProgressIndicator & > & callback) |
Sets callback that will be triggered every time a new value is assigned to the progress indicator. | |
void | setValueUpdatedAction(GenericCallback< const AbstractProgressIndicator & > & callback) |
Sets callback that will be triggered when updateValue has finished animating to the final value. | |
virtual void | updateValue(int value, uint16_t duration) |
Update the current value in the range (min..max) set by setRange(). | |
Protected Attributes inherited from AbstractProgressIndicator
int | animationDuration |
Duration of the animation. | |
int | animationEndValue |
The animation end value. | |
bool | animationRunning |
Is the animation running. | |
int | animationStartValue |
The animation start value. | |
int | animationStep |
The current animation step. | |
Image | background |
The background image. | |
int | currentValue |
The current value. | |
EasingEquation | equation |
The equation used in updateValue() | |
Container | progressIndicatorContainer |
The container that holds the actual progress indicator. | |
int | rangeMax |
The range maximum. | |
int | rangeMin |
The range minimum. | |
uint16_t | rangeSteps |
The range steps. | |
uint16_t | rangeStepsMin |
The range steps minimum. | |
GenericCallback< const AbstractProgressIndicator & > * | valueSetCallback |
New value assigned Callback. | |
GenericCallback< const AbstractProgressIndicator & > * | valueUpdatedCallback |
Animation ended Callback. | |
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 | 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 | 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 | 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. | |
virtual void | setHeight(int16_t height) |
Sets the height of this 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. | |
virtual void | setWidth(int16_t width) |
Sets the width of this drawable. | |
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
getColor
virtual colortype getColor | ( | ) | const |
Gets the color of the text in the used text area.
The color.
getNumberOfDecimals
virtual uint16_t getNumberOfDecimals | ( | ) | const |
getTypedText
virtual const TypedText & getTypedText | ( | ) | const |
setAlpha
virtual void setAlpha | ( | uint8_t | newAlpha | ) | |
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).
newAlpha | The new alpha value. 255=solid, 0=invisible. |
Note
The user code must call invalidate() in order to update the display.
Reimplements: touchgfx::AbstractProgressIndicator::setAlpha
setColor
Sets the color of the text in the used text area.
color | The color. |
setNumberOfDecimals
virtual void setNumberOfDecimals | ( | uint16_t | numberOfDecimals | ) | |
Sets number of decimals when displaying progress.
numberOfDecimals | Number of decimals. Only up to two decimals is supported. |
setProgressIndicatorPosition
virtual void setProgressIndicatorPosition | ( | int16_t | x , | ||
int16_t | y , | ||||
int16_t | width , | ||||
int16_t | height | ||||
) |
Sets the position and dimensions of the text progress indicator.
Sets the position and dimensions of the text progress indicator relative to the background image.
x | The x coordinate. |
y | The y coordinate. |
width | The width of the text progress indicator. |
height | The height of the text progress indicator. |
Reimplements: touchgfx::AbstractProgressIndicator::setProgressIndicatorPosition
setTypedText
virtual void setTypedText | ( | const TypedText & | t | ) | |
Sets the typed text.
The text should have exactly one wildcard and could for example look like this: "<progress>\%".
t | The TypedText to process. |
setValue
virtual void setValue | ( | int | value | ) | |
Sets the new value for the progress indicator.
value | The value. |
Reimplements: touchgfx::AbstractProgressIndicator::setValue
TextProgress
Protected Attributes Documentation
decimals
uint16_t decimals
The number of decimals.
textArea
TextAreaWithOneWildcard textArea
The text area.
textBuffer
Unicode::UnicodeChar textBuffer
Room for 100.0000.