Skip to main content
Version: 4.16

BoxWithBorder

The BoxWithBorder class is used to create objects that can draw a box with a border on the display. The width of the border can be specified. If the border width is 0 the BoxWithBorder will function just like a Box.

Inherits from: Box, Widget, Drawable

Public Functions#

BoxWithBorder()
BoxWithBorder(uint16_t width, uint16_t height, colortype color, colortype borderColor, uint16_t borderSize, uint8_t alpha =255)
Constructor that allows specification of dimensions and colors of the BoxWithBorder.
virtual voiddraw(const Rect & invalidatedArea) const
Draw this drawable.
FORCE_INLINE_FUNCTION colortypegetBorderColor() const
Gets the color of the border drawn along the edge of the BoxWithBorder.
FORCE_INLINE_FUNCTION uint16_tgetBorderSize() const
Gets the width of the border.
voidsetBorderColor(colortype color)
Sets the color of the border drawn along the edge of the BoxWithBorder.
voidsetBorderSize(uint16_t size)
Sets the width of the border.

Protected Attributes#

colortypeborderColor
The color of the border along the edge.
uint16_tborderSize
Width of the border along the edge.

Additional inherited members#

Public Functions inherited from Box#

Box()
Construct a new Box with a default alpha value of 255 (solid)
Box(uint16_t width, uint16_t height, colortype color, uint8_t alpha =255)
Construct a Box with the given size and color (and optionally alpha).
FORCE_INLINE_FUNCTION uint8_tgetAlpha() const
Gets the current alpha value of the widget.
FORCE_INLINE_FUNCTION colortypegetColor() const
Gets the current color of the Box.
virtual RectgetSolidRect() const
Get (the largest possible) rectangle that is guaranteed to be solid (opaque).
voidsetAlpha(uint8_t newAlpha)
Sets the opacity (alpha value).
voidsetColor(colortype color)
Sets the color of the Box.

Protected Attributes inherited from Box#

uint8_talpha
The alpha value used for this Box.
colortypecolor
The fill color for this Box.

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#

BoxWithBorder#

BoxWithBorder#

BoxWithBorder(uint16_twidth ,
uint16_theight ,
colortypecolor ,
colortypeborderColor ,
uint16_tborderSize ,
uint8_talpha =255
)

Constructor that allows specification of dimensions and colors of the BoxWithBorder.

Parameters:
widthThe width.
heightThe height.
colorThe color.
borderColorThe border color.
borderSizeSize of the border.
alpha(Optional) The alpha.

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::Box::draw

getBorderColor#

FORCE_INLINE_FUNCTION colortype getBorderColor()const

Gets the color of the border drawn along the edge of the BoxWithBorder.

Returns:

The color of the border.

See also:

getBorderSize#

FORCE_INLINE_FUNCTION uint16_t getBorderSize()const

Gets the width of the border.

Returns:

The width of the border.

See also:

setBorderColor#

Sets the color of the border drawn along the edge of the BoxWithBorder.

Parameters:
colorThe color of the border.
See also:

setBorderSize#

void setBorderSize(uint16_tsize)

Sets the width of the border.

If the width is set to 0, the BoxWithBorder will look exactly like a Box.

Parameters:
sizeThe width of the border.
See also:

Protected Attributes Documentation#

borderColor#

colortype borderColor

The color of the border along the edge.

borderSize#

uint16_t borderSize

Width of the border along the edge.