ButtonWithIcon

A ButtonWithIcon in TouchGFX is a widget that is aware of touch events and can send a callback when the ButtonWithIcon is released. Each state, pressed and released, is associated with an image and an icon.

The ButtonWithIcon can be replicated with the FlexButton. A FlexButton is a more configurable button that takes up a bit more RAM in exchange for flexibility.

ButtonWithIcon running in the simulator

Widget Group

The ButtonWithIcon can be found in the Buttons widget group in TouchGFX Designer.

ButtonWithIcon in TouchGFX Designer

Properties

The properties for a ButtonWithIcon in TouchGFX Designer.

Property Group	Property Descriptions
Name	Name of the widget. Name is the unique identifier used in TouchGFX Designer and code.
Location	X and Y specify the top left corner of the widget relative to its parent. W and H specify the width and height of the widget. The size of a ButtonWithIcon is determined by the size of the selected images. Visible specifies the visibility of the widget. Making the widget invisible also disables interacting with the widget through the screen.
Image	Button Style specifies a predefined setup of the widget, that sets select properties to predefined values. These styles contain images that are free to use. Released Image and Pressed Image specify the images assigned to the pressed and released states from the Designer skin library or the Project folder.
Icon	Icon Style specifies a predefined setup of the widget, that sets select properties to predefined values. These styles contain images that are free to use. Released Icon and Pressed Icon specify the images assigned to the pressed and released states of the icon from the Designer skin library or the Project folder.
Icon Location	X and Y specify the top left corner of the icon relative to its parent. W and H specify the width and height of the icon, based on the selected image.
Appearance	Alpha specifies the transparency of the widget. The alpha value ranges between 0 and 255 for the widget. 0 is fully transparent and 255 is solid.
Mixins	Draggable specifies if the widget is draggable at runtime. ClickListener specifies if the widget emits a callback when clicked. FadeAnimator specifies if the widget can animate changes to its Alpha value. MoveAnimator specifies if the widget can animate changes to X and Y values.

Interactions

The actions and triggers supported by the ButtonWithIcon are described in the following sections.

Actions

Standard widget action	Description
Move widget	Move a widget to a new position over time.
Fade widget	Modify alpha value of widget over time.
Hide widget	Hides a widget (sets visibility to false).
Show widget	Make a hidden widget visible (sets visibility to true).

Triggers

Trigger	Description
Button is clicked	A ButtonWithIcon has been clicked.

Performance

The ButtonWithIcon is composed of four images and is dependent on image drawing. Therefore, a ButtonWithIcon is considered a fast performing widget on most platforms.

For more details on image drawing performance, read the General UI Component Performance section.

Examples

Generated Code

In the generated code for the View base class we can see how TouchGFX Designer sets up a ButtonWithIcon.

Screen1ViewBase.cpp

#include <gui_generated/screen1_screen/Screen1ViewBase.hpp>
#include "BitmapDatabase.hpp"

Screen1ViewBase::Screen1ViewBase() :
    buttonCallback(this, &Screen1ViewBase::buttonCallbackHandler)
{
    buttonWithIconName.setXY(155, 106);
    buttonWithIconName.setBitmaps(touchgfx::Bitmap(BITMAP_BLUE_BUTTONS_ROUND_EDGE_SMALL_ID), touchgfx::Bitmap(BITMAP_BLUE_BUTTONS_ROUND_EDGE_SMALL_PRESSED_ID), touchgfx::Bitmap(BITMAP_BLUE_ICONS_ADD_NEW_32_ID), touchgfx::Bitmap(BITMAP_BLUE_ICONS_ADD_NEW_32_ID));
    buttonWithIconName.setIconXY(71, 16);
    buttonWithIconName.setAction(buttonCallback);

    add(buttonWithIconName);
}

void Screen1ViewBase::buttonCallbackHandler(const touchgfx::AbstractButton& src)
{
    if (&src == &buttonWithIconName)
    {
        //InteractionName
        //When buttonName clicked calls the new virtual function "functionName()" set by the user
        functionName();
    }
}

Tip

You can use these functions and the others available in the ButtonWithIcon class in user code. Remember to force a redraw by calling buttonWithIconName.invalidate() if you change the appearance of the widget.

TouchGFX Designer Examples

To further explore the ButtonWithIcon, try creating a new application within TouchGFX Designer with the following UI template:

Transition Example UI template in TouchGFX Designer

API Reference

Further reading

API reference for the ButtonWithIcon class