BoxWithBorder

touchgfx/widgets/BoxWithBorder.hpp

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 colorMiddle, colortype colorBorder, uint16_t borderWidth, uint8_t boxAlpha =255)
	Constructor that allows specification of dimensions and colors of the BoxWithBorder.
virtual void	draw(const Rect & invalidatedArea) const
	Draw this drawable.
FORCE_INLINE_FUNCTION colortype	getBorderColor() const
	Gets the color of the border drawn along the edge of the BoxWithBorder.
FORCE_INLINE_FUNCTION uint16_t	getBorderSize() const
	Gets the width of the border.
void	setBorderColor(colortype colorBorder)
	Sets the color of the border drawn along the edge of the BoxWithBorder.
void	setBorderSize(uint16_t size)
	Sets the width of the border.

Protected Attributes

colortype	borderColor
	The color of the border along the edge.
uint16_t	borderSize
	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 boxColor, uint8_t boxAlpha =255)
	Construct a Box with the given size and color (and optionally alpha).
FORCE_INLINE_FUNCTION uint8_t	getAlpha() const
	Gets the current alpha value of the widget.
FORCE_INLINE_FUNCTION colortype	getColor() const
	Gets the current color of the Box.
virtual Rect	getSolidRect() const
	Get (the largest possible) rectangle that is guaranteed to be solid (opaque).
virtual void	invalidateContent() const
	Tell the framework that the contents of the Drawable needs to be redrawn.
void	setAlpha(uint8_t newAlpha)
	Sets the opacity (alpha value).
void	setColor(colortype newColor)
	Sets the color of the Box.

Protected Attributes inherited from Box

uint8_t	alpha
	The alpha value used for this Box.
colortype	color
	The fill color for this Box.

Public Functions inherited from Widget

virtual void	getLastChild(int16_t , int16_t , 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

void	center()
	Centers the Drawable inside its parent.
void	centerX()
	Center the Drawable horizontally inside its parent.
void	centerY()
	Center the Drawable vertically inside its parent.
virtual void	childGeometryChanged()
	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.
void	drawToDynamicBitmap(BitmapId id)
	Render the Drawable object into a dynamic bitmap.
void	expand(int margin =0)
	Expands the Drawable to have the same size as its parent with a given margin around the edge.
Rect	getAbsoluteRect() 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_t	getHeight() const
	Gets the height of this Drawable.
virtual void	getLastChild(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 Rect	getSolidRect() const =0
	Get (the largest possible) rectangle that is guaranteed to be solid (opaque).
virtual Rect	getSolidRectAbsolute()
	Helper function for obtaining the largest solid rect (as implemented by getSolidRect()) expressed in absolute coordinates.
virtual void	getVisibleRect(Rect & rect) const
	Function for finding the visible part of this drawable.
int16_t	getWidth() const
	Gets the width of this Drawable.
int16_t	getX() const
	Gets the x coordinate of this Drawable, relative to its parent.
int16_t	getY() const
	Gets the y coordinate of this Drawable, relative to its parent.
virtual void	handleClickEvent(const ClickEvent & event)
	Defines the event handler interface for ClickEvents.
virtual void	handleDragEvent(const DragEvent & event)
	Defines the event handler interface for DragEvents.
virtual void	handleGestureEvent(const GestureEvent & event)
	Defines the event handler interface for GestureEvents.
virtual void	handleTickEvent()
	Called periodically by the framework if the Drawable instance has subscribed to timer ticks.
virtual void	invalidate() const
	Tell the framework that this entire Drawable needs to be redrawn.
virtual void	invalidateContent() const
	Tell the framework that the contents of the Drawable needs to be redrawn.
virtual void	invalidateRect(Rect & invalidatedArea) const
	Request that a region of this drawable is redrawn.
bool	isTouchable() const
	Gets whether this Drawable receives touch events or not.
bool	isVisible() const
	Gets whether this Drawable is visible.
virtual void	moveRelative(int16_t x, int16_t y)
	Moves the drawable.
virtual void	moveTo(int16_t x, int16_t y)
	Moves the drawable.
virtual void	setHeight(int16_t height)
	Sets the height of this drawable.
void	setPosition(const Drawable & drawable)
	Sets the position of the Drawable to the same as the given Drawable.
void	setPosition(int16_t x, int16_t y, int16_t width, int16_t height)
	Sets the size and position of this Drawable, relative to its parent.
void	setTouchable(bool touch)
	Controls whether this Drawable receives touch events or not.
void	setVisible(bool vis)
	Controls whether this Drawable should be visible.
virtual void	setWidth(int16_t width)
	Sets the width of this drawable.
void	setWidthHeight(const Bitmap & bitmap)
	Sets the dimensions (width and height) of the Drawable without changing the x and y coordinates).
void	setWidthHeight(const Drawable & drawable)
	Sets the dimensions (width and height) of the Drawable without changing the x and y coordinates).
void	setWidthHeight(const Rect & other)
	Sets the dimensions (width and height) of the Drawable without changing the x and y coordinates).
void	setWidthHeight(int16_t width, int16_t height)
	Sets the dimensions (width and height) of the Drawable without changing the x and y coordinates).
virtual void	setX(int16_t x)
	Sets the x coordinate of this Drawable, relative to its parent.
void	setXY(const Drawable & drawable)
	Sets the x and y coordinates of this Drawable.
void	setXY(int16_t x, int16_t y)
	Sets the x and y coordinates of this Drawable, relative to its parent.
virtual void	setY(int16_t y)
	Sets the y coordinate of this Drawable, relative to its parent.
virtual void	translateRectToAbsolute(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.
Rect	rect
	The coordinates of this Drawable, relative to its parent.
bool	touchable
	True if this drawable should receive touch events.
bool	visible
	True if this drawable should be drawn.

Public Functions Documentation

BoxWithBorder

BoxWithBorder	(			)

BoxWithBorder

BoxWithBorder	(	uint16_t	width ,
		uint16_t	height ,
		colortype	colorMiddle ,
		colortype	colorBorder ,
		uint16_t	borderWidth ,
		uint8_t	boxAlpha =255
		)

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

Parameters:

width	The width.
height	The height.
colorMiddle	The color of the middle of the box.
colorBorder	The border color.
borderWidth	Size (width) of the border.
boxAlpha	(Optional) The alpha of the box and the border.

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:

invalidatedArea	The 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:

setBorderColor, getColor, Color::getRed, Color::getGreen, Color::getRed

getBorderSize

FORCE_INLINE_FUNCTION uint16_t getBorderSize	(			)	const

Gets the width of the border.

Returns:

The width of the border.

See also:

setBorderSize

setBorderColor

void setBorderColor	(	colortype	colorBorder	)

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

Parameters:

colorBorder	The color of the border.

See also:

setColor, getBorderColor, Color::getColorFromRGB

setBorderSize

void setBorderSize	(	uint16_t	size	)

Sets the width of the border.

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

Parameters:

size	The width of the border.

See also:

getBorderSize

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.