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 void | draw(const Rect & invalidatedArea) const |
| Draw this drawable. | |
| TextRotation | getLabelRotation() |
| Gets the current rotation of the text on the label. | |
| TypedText | getLabelText() const |
| Gets the text used for the label. | |
| void | setLabelColor(colortype col) |
| Sets label color for the text when the button is in the normal, released state. | |
| void | setLabelColorPressed(colortype col) |
| Sets label color for the text when the button is in the pressed state. | |
| void | setLabelRotation(TextRotation rotation) |
| Sets the rotation of the text on the label. | |
| void | setLabelText(TypedText t) |
| Sets the text to display on the button. | |
| void | updateTextPosition() |
| Positions the label text horizontally centered. | |
Protected Attributes
| colortype | color |
| The color used for the label when the button is in the released, normal state. | |
| colortype | colorPressed |
| The color used for the label when the button is in the pressed state. | |
| TextRotation | rotation |
| The rotation used for the label. | |
| uint8_t | textHeightIncludingSpacing |
| Total height of the label (text height + spacing). | |
| TypedText | typedText |
| The TypedText used for the button label. | |
Additional inherited members
Public Functions inherited from Button
| Button() | |
| uint8_t | getAlpha() const |
| Gets the current alpha value of the widget. | |
| Bitmap | getCurrentlyDisplayedBitmap() const |
| Gets currently displayed bitmap. | |
| virtual Rect | getSolidRect() const |
| Get (the largest possible) rectangle that is guaranteed to be solid (opaque). | |
| void | setAlpha(uint8_t newAlpha) |
| Sets the opacity (alpha value). | |
| virtual void | setBitmaps(const Bitmap & bitmapReleased, const Bitmap & bitmapPressed) |
| Sets the two bitmaps used by this button. | |
Protected Attributes inherited from Button
| uint8_t | alpha |
| The current alpha value. 255=solid, 0=invisible. | |
| Bitmap | down |
| The image to display when button is pressed. | |
| Bitmap | up |
| 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 void | executeAction() |
| Executes the previously set action. | |
| virtual bool | getPressedState() const |
| Function to determine if the AbstractButton is currently pressed. | |
| virtual void | handleClickEvent(const ClickEvent & event) |
| Updates the current state of the button. | |
| void | setAction(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. | |
| bool | pressed |
| Is the button pressed or released? True if pressed. | |
Public Functions inherited from Widget
| virtual void | getLastChild(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
| 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. | |
| 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. | |
| 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 & 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 Functions Documentation
ButtonWithLabel
draw
Draw this drawable.
It is a requirement that the draw implementation does not draw outside the region specified by invalidatedArea.
| invalidatedArea | The 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.
The current rotation of the text.
getLabelText
| TypedText getLabelText | ( | ) | const |
Gets the text used for the label.
The text used for the label.
setLabelColor
| void setLabelColor | ( | colortype | col | ) | |
Sets label color for the text when the button is in the normal, released state.
| col | The 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.
setLabelColorPressed
| void setLabelColorPressed | ( | colortype | col | ) | |
Sets label color for the text when the button is in the pressed state.
| col | The 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.
setLabelRotation
| void setLabelRotation | ( | TextRotation | rotation | ) | |
Sets the rotation of the text on the label.
The text can be rotated in steps of 90 degrees.
| rotation | The 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.
setLabelText
| void setLabelText | ( | TypedText | t | ) | |
Sets the text to display on the button.
Texts with wildcards are not supported.
| t | The text to display. |
Note
The user code must call invalidate() in order to update the button on the display.
updateTextPosition
| void 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.