Skip to main content
Version: 4.16

ButtonWithLabel

A Button that has a bitmap with a text on top of it. It is possible to have two different colors for the text depending on the current state of the button (released or pressed).

Typical use case could be a red button with a normal and a pressed image. Those images can be reused across several buttons. The ButtonWithLabel will then allow a text to be superimposed on top of the red button.

See: Button

Inherits from: Button, AbstractButton, Widget, Drawable

Public Functions#

ButtonWithLabel()
virtual voiddraw(const Rect & invalidatedArea) const
Draw this drawable.
TextRotationgetLabelRotation()
Gets the current rotation of the text on the label.
TypedTextgetLabelText() const
Gets the text used for the label.
voidsetLabelColor(colortype col)
Sets label color for the text when the button is in the normal, released state.
voidsetLabelColorPressed(colortype col)
Sets label color for the text when the button is in the pressed state.
voidsetLabelRotation(TextRotation rotation)
Sets the rotation of the text on the label.
voidsetLabelText(TypedText t)
Sets the text to display on the button.
voidupdateTextPosition()
Positions the label text horizontally centered.

Protected Attributes#

colortypecolor
The color used for the label when the button is in the released, normal state.
colortypecolorPressed
The color used for the label when the button is in the pressed state.
TextRotationrotation
The rotation used for the label.
uint8_ttextHeightIncludingSpacing
Total height of the label (text height + spacing).
TypedTexttypedText
The TypedText used for the button label.

Additional inherited members#

Public Functions inherited from Button#

Button()
uint8_tgetAlpha() const
Gets the current alpha value of the widget.
BitmapgetCurrentlyDisplayedBitmap() const
Gets currently displayed bitmap.
virtual RectgetSolidRect() const
Get (the largest possible) rectangle that is guaranteed to be solid (opaque).
voidsetAlpha(uint8_t newAlpha)
Sets the opacity (alpha value).
virtual voidsetBitmaps(const Bitmap & bitmapReleased, const Bitmap & bitmapPressed)
Sets the two bitmaps used by this button.

Protected Attributes inherited from Button#

uint8_talpha
The current alpha value. 255=solid, 0=invisible.
Bitmapdown
The image to display when button is pressed.
Bitmapup
The image to display when button is released (normal state).

Public Functions inherited from AbstractButton#

AbstractButton()
Sets this Widget touchable so the user can interact with buttons.
virtual voidexecuteAction()
Executes the previously set action.
virtual boolgetPressedState() const
Function to determine if the AbstractButton is currently pressed.
virtual voidhandleClickEvent(const ClickEvent & event)
Updates the current state of the button.
voidsetAction(GenericCallback< const AbstractButton & > & callback)
Associates an action with the button.

Protected Attributes inherited from AbstractButton#

GenericCallback< const AbstractButton & > *action
The callback to be executed when this AbstractButton is clicked.
boolpressed
Is the button pressed or released? True if pressed.

Public Functions inherited from Widget#

virtual voidgetLastChild(int16_t x, int16_t y, Drawable ** last)
Since a Widget is only one Drawable, Widget::getLastChild simply yields itself as result, but only if the Widget isVisible and isTouchable.

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.
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.
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 & 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 Functions Documentation#

ButtonWithLabel#

draw#

virtual void draw(const Rect &invalidatedArea)

Draw this drawable.

It is a requirement that the draw implementation does not draw outside the region specified by invalidatedArea.

Parameters:
invalidatedAreaThe sub-region of this drawable that needs to be redrawn, expressed in coordinates relative to its parent (e.g. for a complete redraw, invalidatedArea will be (0, 0, width, height).

Reimplements: touchgfx::Button::draw

getLabelRotation#

TextRotation getLabelRotation()

Gets the current rotation of the text on the label.

Returns:

The current rotation of the text.

getLabelText#

TypedText getLabelText()const

Gets the text used for the label.

Returns:

The text used for the label.

setLabelColor#

Sets label color for the text when the button is in the normal, released state.

Parameters:
colThe color with which the text label should be drawn.
Note

If the button is currently in the normal, released state, the button should be forced to redraw itself. This is done by calling invalidate() on the ButtonWithLabel. The user code must call invalidate() in order to update the button on the display.

See also:

setLabelColorPressed#

Sets label color for the text when the button is in the pressed state.

Parameters:
colThe color with which the text label should be drawn when the button is pressed.
Note

If the button is currently in the pressed state, the button should be forced to redraw itself. This is done by calling invalidate() on the ButtonWithLabel. The user code must call invalidate() in order to update the button on the display.

See also:

setLabelRotation#

Sets the rotation of the text on the label.

The text can be rotated in steps of 90 degrees.

Parameters:
rotationThe rotation of the text. Default is TEXT_ROTATE_0.
Note

that this will not rotate the bitmap of the label, only the text. The user code must call invalidate() in order to update the button on the display.

See also:

setLabelText#

Sets the text to display on the button.

Texts with wildcards are not supported.

Parameters:
tThe text to display.
Note

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

updateTextPosition#

Positions the label text horizontally centered.

If the text changes due to a language change you may need to reposition the label text by calling this function to keep the text horizontally centered.

Note

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

Protected Attributes Documentation#

color#

colortype color

The color used for the label when the button is in the released, normal state.

colorPressed#

colortype colorPressed

The color used for the label when the button is in the pressed state.

rotation#

TextRotation rotation

The rotation used for the label.

textHeightIncludingSpacing#

uint8_t textHeightIncludingSpacing

Total height of the label (text height + spacing).

typedText#

TypedText typedText

The TypedText used for the button label.