Skip to main content
Version: 4.16

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#

enumDisplayMode { 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()
voiddisplayLeadingZeroForHourIndicator(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_tgetAlpha() const
Gets the current alpha value of the widget.
virtual colortypegetColor() const
Gets the color of the text.
virtual DisplayModegetDisplayMode() const
Gets the current display mode.
virtual uint16_tgetTextWidth() const
Gets text width of the currently displayed DigitalClock.
virtual voidsetAlpha(uint8_t newAlpha)
Sets the opacity (alpha value).
virtual voidsetBaselineY(int16_t baselineY)
Adjusts the DigitalClock y coordinate so the text will have its baseline at the specified value.
virtual voidsetColor(colortype color)
Sets the color of the text.
virtual voidsetDisplayMode(DisplayMode dm)
Sets the display mode to 12/24 hour clock with or without seconds.
virtual voidsetHeight(int16_t height)
Sets the height of this drawable.
virtual voidsetTypedText(TypedText typedText)
Sets the typed text of the DigitalClock.
virtual voidsetWidth(int16_t width)
Sets the width of this drawable.

Protected Functions#

virtual voidupdateClock()
Update the visual representation of the clock on the display.

Protected Attributes#

const intBUFFER_SIZE
Buffer size of the wild card, worst case is "12:59:59 AM" (12 chars)
Unicode::UnicodeCharbuffer
Wild card buffer for the clock text.
DisplayModedisplayMode
The current display mode.
TextAreaWithOneWildcardtext
The clock text.
booluseLeadingZeroForHourIndicator
Print a leading zero if the hour is less than 10.

Additional inherited members#

Public Functions inherited from AbstractClock#

AbstractClock()
boolgetCurrentAM() const
Is the current time a.m.
uint8_tgetCurrentHour() const
Gets the current hour.
uint8_tgetCurrentHour12() const
Gets current hour 12, i.e.
uint8_tgetCurrentHour24() const
Gets current hour 24, i.e.
uint8_tgetCurrentMinute() const
Gets the current minute.
uint8_tgetCurrentSecond() const
Gets the current second.
virtual voidsetTime12Hour(uint8_t hour, uint8_t minute, uint8_t second, bool am)
Sets the time with input format as 12H.
virtual voidsetTime24Hour(uint8_t hour, uint8_t minute, uint8_t second)
Sets the time with input format as 24H.

Protected Attributes inherited from AbstractClock#

uint8_tcurrentHour
Local copy of the current hour.
uint8_tcurrentMinute
Local copy of the current minute.
uint8_tcurrentSecond
Local copy of the current second.

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

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.
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 & evt)
Defines the event handler interface for ClickEvents.
virtual voidhandleDragEvent(const DragEvent & evt)
Defines the event handler interface for DragEvents.
virtual voidhandleGestureEvent(const GestureEvent & evt)
Defines the event handler interface for GestureEvents.
virtual voidhandleTickEvent()
Called periodically by the framework if the Drawable instance has subscribed to timer ticks.
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.
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.
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 & rect)
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 Types Documentation#

DisplayMode#

Values that represent different display modes.

DISPLAY_12_HOUR_NO_SECONDS12 Hour clock. Seconds are not displayed
DISPLAY_24_HOUR_NO_SECONDS24 Hour clock. Seconds are not displayed
DISPLAY_12_HOUR12 Hour clock. Seconds are displayed
DISPLAY_24_HOUR24 Hour clock. Seconds are displayed

Public Functions Documentation#

DigitalClock#

displayLeadingZeroForHourIndicator#

void displayLeadingZeroForHourIndicator(booldisplayLeadingZero)

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.

Parameters:
displayLeadingZerotrue = 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).

Returns:

The current alpha value.

See also:

getColor#

virtual colortype getColor()const

Gets the color of the text.

Returns:

The color.

getDisplayMode#

virtual DisplayMode getDisplayMode()const

Gets the current display mode.

Returns:

The display mode.

See also:

getTextWidth#

virtual uint16_t getTextWidth()const

Gets text width of the currently displayed DigitalClock.

Returns:

The text width of the currently displayed DigitalClock.

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:

setBaselineY#

virtual void setBaselineY(int16_tbaselineY)

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.

Parameters:
baselineYThe y coordinate of the baseline of the text.
Note

that setTypedText must be called prior to setting the baseline.

setColor#

virtual void setColor(colortypecolor)

Sets the color of the text.

Parameters:
colorThe new text color.
Note

Automatically invalidates the DigitalClock.

setDisplayMode#

virtual void setDisplayMode(DisplayModedm)

Sets the display mode to 12/24 hour clock with or without seconds.

Parameters:
dmThe new display mode.
See also:

setHeight#

virtual void setHeight(int16_theight)

Sets the height of this drawable.

Parameters:
heightThe new height.
Note

For most Drawable widgets, changing this does normally not automatically yield a redraw.

Reimplements: touchgfx::Drawable::setHeight

setTypedText#

virtual void setTypedText(TypedTexttypedText)

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"
Parameters:
typedTextDescribes the typed text to use.
Note

Automatically invalidates the DigitalClock.

setWidth#

virtual void setWidth(int16_twidth)

Sets the width of this drawable.

Parameters:
widthThe 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#

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.