Skip to main content
Version: 4.16

ButtonWithIcon

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

Typical use case could be a blue button with a released and a pressed image. Those images can be reused across several buttons. The ButtonWithIcon will then allow an image to superimposed on top of the blue button.

Inherits from: Button, AbstractButton, Widget, Drawable

Public Functions#

ButtonWithIcon()
virtual voiddraw(const Rect & invalidatedArea) const
Draw this drawable.
BitmapgetCurrentlyDisplayedIcon() const
Gets currently displayed icon.
int16_tgetIconX() const
Gets the x coordinate of the icon bitmap.
int16_tgetIconY() const
Gets the y coordinate of the icon bitmap.
virtual voidsetBitmaps(const Bitmap & newBackgroundReleased, const Bitmap & newBackgroundPressed, const Bitmap & newIconReleased, const Bitmap & newIconPressed)
Sets the four bitmaps used by this button.
voidsetIconX(int16_t x)
Sets the x coordinate of the icon bitmaps.
voidsetIconXY(int16_t x, int16_t y)
Sets the x and y coordinates of the icon bitmap.
voidsetIconY(int16_t y)
Sets the y coordinate of the icon bitmaps.

Protected Attributes#

BitmapiconPressed
Icon to display when button is pressed.
BitmapiconReleased
Icon to display when button is not pressed.
int16_ticonX
x coordinate offset for icon.
int16_ticonY
y coordinate offset for icon.

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).

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#

ButtonWithIcon#

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

getCurrentlyDisplayedIcon#

Gets currently displayed icon.

This depends on the current state of the button, released (normal) or pressed.

Returns:

The icon currently displayed.

getIconX#

int16_t getIconX()const

Gets the x coordinate of the icon bitmap.

Returns:

The x coordinate of the icon bitmap.

getIconY#

int16_t getIconY()const

Gets the y coordinate of the icon bitmap.

Returns:

The y coordinate of the icon bitmap.

setBitmaps#

virtual void setBitmaps(const Bitmap &newBackgroundReleased ,
const Bitmap &newBackgroundPressed ,
const Bitmap &newIconReleased ,
const Bitmap &newIconPressed
)

Sets the four bitmaps used by this button.

The last two bitmaps are drawn on top of the first two, again depending on the current state of the Button. This means that when the button state is released (normal), the newIconReleased is drawn on top of the newBackgroundReleased, and when the button state is pressed, the newIconPressed is drawn on top of the newBackgroundPressed.

The default position if the icons is set to the center of the bitmaps. The two icons are assumed to have the same dimensions. The size of the released icon is used to position the icons centered on the Button.

Parameters:
newBackgroundReleasedBitmap to use when button is released.
newBackgroundPressedBitmap to use when button is pressed.
newIconReleasedThe bitmap for the icon in the released (normal) button state.
newIconPressedThe bitmap for the icon in the pressed button state.
Note

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

setIconX#

void setIconX(int16_tx)

Sets the x coordinate of the icon bitmaps.

The same x coordinate is used for both icons (released and pressed).

Parameters:
xThe new x value, relative to the background bitmap. A negative value is allowed.
Note

The user code must call invalidate() in order to update the button on the display. The value set is overwritten on a subsequent call to setBitmaps.

setIconXY#

void setIconXY(int16_tx ,
int16_ty
)

Sets the x and y coordinates of the icon bitmap.

Same as calling setIconX and setIconY.

Parameters:
xThe new x value, relative to the background bitmap. A negative value is allowed.
yThe new y value, relative to the background bitmap. A negative value is allowed.
Note

The user code must call invalidate() in order to update the button on the display. The values set are overwritten on a subsequent call to setBitmaps.

setIconY#

void setIconY(int16_ty)

Sets the y coordinate of the icon bitmaps.

The same y coordinate is used for both icons (released and pressed).

Parameters:
yThe new y value, relative to the background bitmap. A negative value is allowed.
Note

The user code must call invalidate() in order to update the button on the display. The value set is overwritten on a subsequent call to setBitmaps.

Protected Attributes Documentation#

iconPressed#

Bitmap iconPressed

Icon to display when button is pressed.

iconReleased#

Bitmap iconReleased

Icon to display when button is not pressed.

iconX#

int16_t iconX

x coordinate offset for icon.

iconY#

int16_t iconY

y coordinate offset for icon.