ui::Panel Class Reference

A basic widget that displays a rounded rectangle behind another widget. More...

#include <panel.hpp>

Inheritance diagram for ui::Panel:

Public Member Functions
	Panel (Widget *child, color_t color, const Size &size={0, 0}, radius_t borderRadius=0, const Position &pos={0, 0}, const Alignment &align={ALIGN_LEFT, ALIGN_TOP}, const Padding &padding={0})
	Construct a panel with optional configuration.
void	draw () const override
	Render the widget to the screen.
void	update (time_t time_ms) override
	Update any internal state of the widget, and check if it needs to be re-rendered.
void	drawDone () override
	Reset any state variables after rendering has finished.
Size	size () const override
	Get the size of the widget.
void	setColor (color_t new_color)
	Set the panel color.
color_t	getColor () const
	Get the current widget color.
void	setBorderRadius (radius_t new_radius)
	Set the border radius.
Public Member Functions inherited from ui::SingleChildWidget
	SingleChildWidget (Widget *child, const Position &pos={0, 0}, const Alignment &align={ALIGN_LEFT, ALIGN_TOP}, const Padding &padding={0})
	Constructor.
	~SingleChildWidget () override
	Destructor.
Size	size () const override
	Get the size of the widget.
void	update (time_t time_ms) override
	Update any internal state of the widget, and check if it needs to be re-rendered.
void	render (bool force) const override
	Recursively render this widget and any child widgets that need it.
void	drawDone () override
	Reset any state variables after rendering has finished.
void	setChild (Widget *const child)
	Set the child widget.
bool	handleEvent (Event &event) override
	Handle events from the touchscreen.
Widget *	getChild () const
	Get the current child widget.
virtual void	drawBoundingBox (time_t time) const override
	Render the bounding box of this and any child widgets.
Widget *	getWidgetById (id_t id) noexcept override
	Get the first widget (this or any children) that has the given ID.
Public Member Functions inherited from ui::Widget
	Widget (const Position &pos={0, 0}, const Alignment &align={ALIGN_LEFT, ALIGN_TOP}, const Padding &padding={0})
	The default widget constructor.
virtual	~Widget ()
	The default widget destructor.
virtual Bounds	bounds () const
	Get the rendering bounds of this widget.
void	setPosition (const Position &pos)
	Set the position of this widget.
Position	getPosition () const
	Get the position of this widget.
void	setAlign (const Alignment &align)
	Set the alignment of this widget.
void	requestRedraw ()
	Tell this widget that it needs to be re-rendered.
void	requestParentRedraw ()
	Tell the parent widget that it needs to be re-rendered.
bool	needsRedraw () const
	Check if this widget has requested to be redrawn.
void	setParent (Widget *parent)
	Set the parent widget.
Bounds	parentBounds () const
	Get the bounds of the parent widget, if any.
void	onpress (std::function< void(Widget &, const Event &)> callback) override
	Register a touchscreen event handler that triggers on press.
void	onblur (std::function< void(Widget &, const Event &)> callback) override
	Register a touchscreen event handler that triggers when the widget stops being pressed.
void	onhold (std::function< void(Widget &, const Event &, time_t)> callback) override
	Register a touchscreen event handler that repeatedly triggers when the widget is held for a while.
void	onrelease (std::function< void(Widget &, const Event &)> callback) override
	Register a touchscreen event handler that triggers on release.
void	click ()
	Manually trigger the onrelease event handler.
void	press ()
	Manually trigger the onpress event handler.
void	blur ()
	Manually trigger the onblur event handler.
void	release ()
	Manually trigger the onrelease event handler.
void	hold (time_t time)
	Manually trigger the onhold event handler.
Public Member Functions inherited from ui::EventHandlers< Widget >
void	onpress (std::function< void(Widget &)> callback)
	Register a touchscreen event handler that triggers on press.
void	onpress (std::function< void(const Event &)> callback)
	Register a touchscreen event handler that triggers on press.
void	onpress (std::function< void()> callback)
	Register a touchscreen event handler that triggers on press.
void	onrelease (std::function< void(Widget &)> callback)
	Register a touchscreen event handler that triggers when the widget stops being pressed.
void	onrelease (std::function< void(const Event &)> callback)
	Register a touchscreen event handler that triggers when the widget stops being pressed.
void	onrelease (std::function< void()> callback)
	Register a touchscreen event handler that triggers when the widget stops being pressed.
void	onblur (std::function< void(Widget &)> callback)
	Register a touchscreen event handler that triggers when the widget stops being pressed.
void	onblur (std::function< void(const Event &)> callback)
	Register a touchscreen event handler that triggers when the widget stops being pressed.
void	onblur (std::function< void()> callback)
	Register a touchscreen event handler that triggers when the widget stops being pressed.
void	onhold (std::function< void(Widget &, time_t)> callback)
	Register a touchscreen event handler that repeatedly triggers when the widget is held for a while.
void	onhold (std::function< void(const Event &, time_t)> callback)
	Register a touchscreen event handler that repeatedly triggers when the widget is held for a while.
void	onhold (std::function< void(time_t)> callback)
	Register a touchscreen event handler that repeatedly triggers when the widget is held for a while.
void	onhold (std::function< void(Widget &)> callback)
	Register a touchscreen event handler that repeatedly triggers when the widget is held for a while.
void	onhold (std::function< void(const Event &)> callback)
	Register a touchscreen event handler that repeatedly triggers when the widget is held for a while.
void	onhold (std::function< void()> callback)
	Register a touchscreen event handler that repeatedly triggers when the widget is held for a while.
void	onclick (std::function< void(Widget &)> callback)
	Register a touchscreen event handler that triggers on release.
void	onclick (std::function< void(const Event &)> callback)
	Register a touchscreen event handler that triggers on release.
void	onclick (std::function< void()> callback)
	Register a touchscreen event handler that triggers on release.
Public Member Functions inherited from ui::CoreEventHandlers< T >
virtual void	onpress (std::function< void(T &, const Event &)> callback)=0
	Register a touchscreen event handler that triggers on press.
virtual void	onrelease (std::function< void(T &, const Event &)> callback)=0
	Register a touchscreen event handler that triggers when the widget stops being pressed.
virtual void	onblur (std::function< void(T &, const Event &)> callback)=0
	Register a touchscreen event handler that triggers when the widget stops being pressed.
virtual void	onhold (std::function< void(T &, const Event &, time_t)> callback)=0
	Register a touchscreen event handler that repeatedly triggers when the widget is held for a while.
void	onclick (std::function< void(T &, const Event &)> callback)
	Register a touchscreen event handler that triggers on release.

Additional Inherited Members
Public Attributes inherited from ui::Widget
id_t	id
	An optional (usually unique) identifier that can be used to search for this widget.
Protected Attributes inherited from ui::SingleChildWidget
Widget *	child
	The child widget.
Protected Attributes inherited from ui::Widget
Padding	padding
	The padding that will be applied to any child widgets.
bool	redrawSelf
	If true, force a redraw of this widget and any child widgets.

Detailed Description

A basic widget that displays a rounded rectangle behind another widget.

The child widget is usually some text label, but it can be any arbitrary widget.

Note

This widget does not automatically update its color etc. when clicked. That is up to the user to implement.

Constructor & Destructor Documentation

Panel()

ui::Panel::Panel	(	Widget *	child,
		color_t	color,
		const Size &	size = {0, 0},
		radius_t	borderRadius = 0,
		const Position &	pos = {0, 0},
		const Alignment &	align = {ALIGN_LEFT, ALIGN_TOP},
		const Padding &	padding = {0}
	)

Construct a panel with optional configuration.

Parameters

child	The child widget.
color	The color of the panel.
size	The minimum size of the panel. It may expand to fit the child widget.
borderRadius	The radius of the rounded parts of the panel.
pos	The position of the panel relative to its parent.
align	The alignment of the panel relative to its parent.
padding	The padding to apply to the child widget.

Member Function Documentation

draw()

void ui::Panel::draw ( ) const

overridevirtual

Render the widget to the screen.

This only gets called when widgets indicate that a redraw is needed of either themselves or their parents. Widgets that implement this method should only render graphics specific to this widget, not any children.

Implements ui::Widget.

drawDone()

void ui::Panel::drawDone ( )

overridevirtual

Reset any state variables after rendering has finished.

Reimplemented from ui::Widget.

getColor()

color_t ui::Panel::getColor

(

)

const

Get the current widget color.

Returns

The widget color.

setBorderRadius()

void ui::Panel::setBorderRadius

(

radius_t

new_radius

)

Set the border radius.

Parameters

new_radius

The new radius for the rounded parts of the panel.

setColor()

void ui::Panel::setColor

(

color_t

new_color

)

Set the panel color.

Parameters

new_color

The new panel color.

size()

Size ui::Panel::size ( ) const

overridevirtual

Get the size of the widget.

Returns

The width and height of the widget in pixels.

Warning

This value may be based on the size of the child widget, and so should never refer to the size of the parent widget!

Implements ui::Widget.

update()

void ui::Panel::update ( time_t  time )

overridevirtual

Update any internal state of the widget, and check if it needs to be re-rendered.

Parameters

time	The current time in milliseconds.

Reimplemented from ui::Widget.

---

The documentation for this class was generated from the following file:

• src/ui/panel.hpp