Skip to main content
Version: 4.16

RepeatButton

A RepeatButton in TouchGFX is a widget that is aware of touch events and can send a callback when the RepeatButton is pressed. The button activates its pressed action immediately, then after a given delay, then repeatedly after an interval. Each state, Pressed and Released, is associated with an image.

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

RepeatButton running in the simulator

Widget Group#

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

RepeatButton in TouchGFX Designer

Properties#

The properties for a RepeatButton in TouchGFX Designer.

Property GroupProperty Descriptions
NameName of the widget. Name is the unique identifier used in TouchGFX Designer and code.
LocationX 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 RepeatButton is determined by the size of the selected images.

Lock specifies if the widget should be locked in its current X, Y, W and H.
Locking the widget also disables interacting with the widget through the screen.

Visible specifies the visibility of the widget.
Making the widget invisible also disables interacting with the widget through the screen.
StyleStyle specifies a predefined setup of the widget, that sets select properties to predefined values.
These styles contain images that are free to use.
ImageReleased Image and Pressed Image specify the images assigned to the Pressed and Release states from the Designer skin library or the Project folder.
SettingsDelay specifies the time (ms) to wait when the button is pressed before starting the loop of triggers.

Interval specifies the time (ms) in between every trigger. Designer accepts inputs of milliseconds and converts them into ticks.
AppearanceAlpha 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.
MixinsDraggable 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 RepeatButton are described in the following sections.

Actions#

Standard widget actionsDescription
Move widgetMove a widget to a new position over time.
Fade widgetModify alpha value of widget over time.
Hide widgetHides a widget (sets visibility to false).
Show widgetMake a hidden widget visible (sets visibility to true).

Triggers#

TriggerDescription
Button is clickedA button has been clicked.

Performance#

A RepeatButton is composed of two images and is dependent on image drawing. Therefore, a RepeatButton 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 RepeatButton.

Screen1ViewBase.cpp
#include <gui_generated/screen1_screen/Screen1ViewBase.hpp>
#include "BitmapDatabase.hpp"
Screen1ViewBase::Screen1ViewBase() :
buttonCallback(this, &Screen1ViewBase::buttonCallbackHandler)
{
repeatButtonName.setXY(155, 106);
repeatButtonName.setBitmaps(touchgfx::Bitmap(BITMAP_BLUE_BUTTONS_ROUND_EDGE_SMALL_ID), touchgfx::Bitmap(BITMAP_BLUE_BUTTONS_ROUND_EDGE_SMALL_PRESSED_ID));
repeatButtonName.setDelay(12); // Set at 200 (ms) in Designer
repeatButtonName.setInterval(20); // Set at 333 (ms) in Designer
repeatButtonName.setAction(buttonCallback);
add(repeatButtonName);
}
void Screen1ViewBase::buttonCallbackHandler(const touchgfx::AbstractButton& src)
{
if (&src == &repeatButtonName)
{
//InteractionName
//When repeatButtonName clicked calls the new virtual function "functionName()" set by the user
functionName();
}
}
Tip
You can use these functions and the others available in the RepeatButton class in user code. Remember to force a redraw by calling repeatButtonName.invalidate() if you change the appearance of the widget.

API Reference#