DigitalClock
A digital clock. Can be set in either 12 or 24 hour mode. Seconds are optional. Width and height must be set manually to match the typography and alignment specified in the text database. The Digital Clock requires a typedText with one wildcard and uses the following characters (not including quotes) "AMP :0123456789" These must be present in the text database with the same typography as the wildcard text. Leading zero for the hour indicator can be enabled/disable by the displayLeadingZeroForHourIndicator method.
Inherits from: AbstractClock, Container, Drawable
Public Types
enum | DisplayMode { DISPLAY_12_HOUR_NO_SECONDS, DISPLAY_24_HOUR_NO_SECONDS, DISPLAY_12_HOUR, DISPLAY_24_HOUR } |
Values that represent different display modes. | |
Public Functions
DigitalClock() | |
void | displayLeadingZeroForHourIndicator(bool displayLeadingZero) |
Sets whether to display a leading zero for the hour indicator or not, when the hour value only has one digit. | |
virtual uint8_t | getAlpha() const |
Gets the current alpha value of the widget. | |
virtual colortype | getColor() const |
Gets the color of the text. | |
virtual DisplayMode | getDisplayMode() const |
Gets the current display mode. | |
virtual uint16_t | getTextWidth() const |
Gets text width of the currently displayed DigitalClock. | |
virtual void | invalidateContent() const |
Tell the framework that the contents of the Drawable needs to be redrawn. | |
virtual void | setAlpha(uint8_t newAlpha) |
Sets the opacity (alpha value). | |
virtual void | setBaselineY(int16_t baselineY) |
Adjusts the DigitalClock y coordinate so the text will have its baseline at the specified value. | |
virtual void | setColor(colortype color) |
Sets the color of the text. | |
virtual void | setDisplayMode(DisplayMode dm) |
Sets the display mode to 12/24 hour clock with or without seconds. | |
virtual void | setHeight(int16_t height) |
Sets the height of this drawable. | |
virtual void | setTypedText(TypedText typedText) |
Sets the typed text of the DigitalClock. | |
virtual void | setWidth(int16_t width) |
Sets the width of this drawable. | |
Protected Functions
virtual void | updateClock() |
Update the visual representation of the clock on the display. | |
Protected Attributes
const int | BUFFER_SIZE |
Buffer size of the wild card, worst case is "12:59:59 AM" (12 chars) | |
Unicode::UnicodeChar | buffer |
Wild card buffer for the clock text. | |
DisplayMode | displayMode |
The current display mode. | |
TextAreaWithOneWildcard | text |
The clock text. | |
bool | useLeadingZeroForHourIndicator |
Print a leading zero if the hour is less than 10. | |
Additional inherited members
Public Functions inherited from AbstractClock
AbstractClock() | |
bool | getCurrentAM() const |
Is the current time a.m. | |
uint8_t | getCurrentHour() const |
Gets the current hour. | |
uint8_t | getCurrentHour12() const |
Gets current hour 12, i.e. | |
uint8_t | getCurrentHour24() const |
Gets current hour 24, i.e. | |
uint8_t | getCurrentMinute() const |
Gets the current minute. | |
uint8_t | getCurrentSecond() const |
Gets the current second. | |
virtual void | setTime12Hour(uint8_t hour, uint8_t minute, uint8_t second, bool am) |
Sets the time with input format as 12H. | |
virtual void | setTime24Hour(uint8_t hour, uint8_t minute, uint8_t second) |
Sets the time with input format as 24H. | |
Protected Attributes inherited from AbstractClock
uint8_t | currentHour |
Local copy of the current hour. | |
uint8_t | currentMinute |
Local copy of the current minute. | |
uint8_t | currentSecond |
Local copy of the current second. | |
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 | 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 Types Documentation
DisplayMode
enum DisplayMode
Values that represent different display modes.
DISPLAY_12_HOUR_NO_SECONDS | 12 Hour clock. Seconds are not displayed |
DISPLAY_24_HOUR_NO_SECONDS | 24 Hour clock. Seconds are not displayed |
DISPLAY_12_HOUR | 12 Hour clock. Seconds are displayed |
DISPLAY_24_HOUR | 24 Hour clock. Seconds are displayed |
Public Functions Documentation
DigitalClock
displayLeadingZeroForHourIndicator
void displayLeadingZeroForHourIndicator | ( | bool | displayLeadingZero | ) | |
Sets whether to display a leading zero for the hour indicator or not, when the hour value only has one digit.
For example 8 can be displayed as "8:" (displayLeadingZero=false) or "08:" (displayLeadingZero=true).
Default value for this setting is false.
displayLeadingZero | true = show leading zero. false = do not show leading zero. |
Note
This does not affect the display of minutes or seconds.
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).
The current alpha value.
getColor
virtual colortype getColor | ( | ) | const |
Gets the color of the text.
The color.
getDisplayMode
virtual DisplayMode getDisplayMode | ( | ) | const |
getTextWidth
virtual uint16_t getTextWidth | ( | ) | const |
Gets text width of the currently displayed DigitalClock.
The text width of the currently displayed DigitalClock.
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
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.
setBaselineY
virtual void setBaselineY | ( | int16_t | baselineY | ) | |
Adjusts the DigitalClock y coordinate so the text will have its baseline at the specified value.
The placements is relative to the specified TypedText so if the TypedText is changed, you have to set the baseline again.
baselineY | The y coordinate of the baseline of the text. |
Note
that setTypedText must be called prior to setting the baseline.
setColor
Sets the color of the text.
color | The new text color. |
Note
Automatically invalidates the DigitalClock.
setDisplayMode
virtual void setDisplayMode | ( | DisplayMode | dm | ) | |
Sets the display mode to 12/24 hour clock with or without seconds.
dm | The new display mode. |
setHeight
virtual void setHeight | ( | int16_t | height | ) | |
Sets the height of this drawable.
height | The new height. |
Note
For most Drawable widgets, changing this does normally not automatically yield a redraw.
Reimplements: touchgfx::Drawable::setHeight
setTypedText
virtual void setTypedText | ( | TypedText | typedText | ) | |
Sets the typed text of the DigitalClock.
Expects a TypedText with one wildcard and that the following characters are defined for the typography of the TypedText:
- 12 hour clock: "AMP :0123456789"
- 24 hour clock: ":0123456789"
typedText | Describes the typed text to use. |
Note
Automatically invalidates the DigitalClock.
setWidth
virtual void setWidth | ( | int16_t | width | ) | |
Sets the width of this drawable.
width | The new width. |
Note
For most Drawable widgets, changing this does normally not automatically yield a redraw.
Reimplements: touchgfx::Drawable::setWidth
Protected Functions Documentation
updateClock
virtual void updateClock | ( | ) |
Update the visual representation of the clock on the display.
Reimplements: touchgfx::AbstractClock::updateClock
Protected Attributes Documentation
BUFFER_SIZE
const int BUFFER_SIZE = 12
Buffer size of the wild card, worst case is "12:59:59 AM" (12 chars)
buffer
Unicode::UnicodeChar buffer
Wild card buffer for the clock text.
displayMode
DisplayMode displayMode
The current display mode.
text
The clock text.
useLeadingZeroForHourIndicator
bool useLeadingZeroForHourIndicator
Print a leading zero if the hour is less than 10.