Skip to main content
Version: 4.16

BoxWithBorder

A BoxWithBorder in TouchGFX is a rectangular shaped widget that can be assigned a single color for all contained pixels within a specified border with a separate color and size. The BoxWithBorder can be assigned any size and position.

BoxWithBorder running in the simulator

Widget Group#

The BoxWithBorder can be found in the Shapes widget group in TouchGFX Designer.

BoxWithBorder in TouchGFX Designer

Properties#

The properties for a BoxWithBorder 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.

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.
AppearanceColor specifies the color of all the pixels contained within the rectangle.

Border Color specifies the color of the outer border pixels.

Border Size specifies the size of the outer border.

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.
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 a BoxWithBorder in TouchGFX Designer.

Actions#

Widget specific actionsDescription
Resize widgetResize a widget.
Change box colorChange the color of a Box widget.
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#

A BoxWithBorder does not emit any triggers.

Performance#

A BoxWithBorder is one of the most lightweight widgets in all of TouchGFX because it does not have to read any pixel data or do any complicated calculations. Therefore, the BoxWithBorder is considered a very fast performing widget on most platforms.

For more details on 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 BoxWithBorder widget.

Screen1ViewBase.cpp
#include <gui_generated/screen1_screen/Screen1ViewBase.hpp>
#include <touchgfx/Color.hpp>
Screen1ViewBase::Screen1ViewBase()
{
boxWithBorderName.setPosition(240, 56, 337, 132);
boxWithBorderName.setColor(touchgfx::Color::getColorFrom24BitRGB(212, 27, 27));
boxWithBorderName.setBorderColor(touchgfx::Color::getColorFrom24BitRGB(21, 24, 202));
boxWithBorderName.setBorderSize(20);
add(boxWithBorderName);
}
Tip
  • You can use these functions and the others available in the BoxWithBorder class in user code. Remember to force a redraw by calling boxWithBorderName.invalidate() if you change the appearance of the widget.
  • API Reference#