AbstractClock

Superclass of clock widgets. Allows the hour, minute and second of the clock to be set and read.

See: AnalogClock, DigitalClock

Inherits from: Container, Drawable

Inherited by: AnalogClock, DigitalClock

Public Functions

	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 Functions

virtual void	updateClock() =0
	Update the visual representation of the clock on the display.

Protected Attributes

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.

Additional inherited members

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	invalidateContent() const
	Tell the framework that the contents of the Drawable needs to be redrawn.
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

AbstractClock

AbstractClock	(			)

getCurrentAM

bool getCurrentAM	(			)	const

Is the current time a.m.

or p.m.? True for a.m. and false for p.m.

Returns:

True if a.m., false if p.m.

getCurrentHour

uint8_t getCurrentHour	(			)	const

Gets the current hour.

Returns:

The current hour in range 0-23.

See also:

getCurrentHour24, getCurrentHour12

getCurrentHour12

uint8_t getCurrentHour12	(			)	const

Gets current hour 12, i.e.

between 1 and 12.

Returns:

The current hour in range 1-12.

See also:

getCurrentHour24, getCurrentAM

getCurrentHour24

uint8_t getCurrentHour24	(			)	const

Gets current hour 24, i.e.

between 0 and 23.

Returns:

The current hour in range 0-23.

getCurrentMinute

uint8_t getCurrentMinute	(			)	const

Gets the current minute.

Returns:

The current minute in range 0-59.

getCurrentSecond

uint8_t getCurrentSecond	(			)	const

Gets the current second.

Returns:

The current second in range 0-59.

setTime12Hour

virtual void setTime12Hour	(	uint8_t	hour ,
		uint8_t	minute ,
		uint8_t	second ,
		bool	am
		)

Sets the time with input format as 12H.

Note that this does not affect any selected presentation formats.

Parameters:

hour	The hours, value should be between 1 and 12.
minute	The minutes, value should be between 0 and 59.
second	The seconds, value should be between 0 and 59.
am	AM/PM setting. True = AM, false = PM.

Note

all values passed are saved modulo the values limit. For example minutes=62 is treated as minutes=2.

setTime24Hour

virtual void setTime24Hour	(	uint8_t	hour ,
		uint8_t	minute ,
		uint8_t	second
		)

Sets the time with input format as 24H.

Note that this does not affect any selected presentation formats.

Parameters:

hour	The hours, value should be between 0 and 23.
minute	The minutes, value should be between 0 and 59.
second	The seconds, value should be between 0 and 59.

Note

all values passed are saved modulo the values limit. For example minutes=62 is treated as minutes=2.

Protected Functions Documentation

updateClock

virtual void updateClock	(			)	=0

Update the visual representation of the clock on the display.

Reimplemented by: touchgfx::AnalogClock::updateClock, touchgfx::DigitalClock::updateClock

Protected Attributes Documentation

currentHour

uint8_t currentHour

Local copy of the current hour.

currentMinute

uint8_t currentMinute

Local copy of the current minute.

currentSecond

uint8_t currentSecond

Local copy of the current second.