widget.h File Reference

GUI: Widget view module API. More...

#include <gui/view.h>
#include "widget_elements/widget_element.h"

Go to the source code of this file.

Macros
#define	widget_add_frame_element(widget, x, y, width, height, radius)
	Add Frame Element.

Typedefs
typedef struct Widget	Widget
typedef struct WidgetElement	WidgetElement

Functions
Widget *	widget_alloc (void)
	Allocate Widget that holds Widget Elements.
void	widget_free (Widget *widget)
	Free Widget.
void	widget_reset (Widget *widget)
	Reset Widget.
View *	widget_get_view (Widget *widget)
	Get Widget view.
void	widget_add_string_multiline_element (Widget *widget, uint8_t x, uint8_t y, Align horizontal, Align vertical, Font font, const char *text)
	Add Multi String Element.
void	widget_add_string_element (Widget *widget, uint8_t x, uint8_t y, Align horizontal, Align vertical, Font font, const char *text)
	Add String Element.
void	widget_add_text_box_element (Widget *widget, uint8_t x, uint8_t y, uint8_t width, uint8_t height, Align horizontal, Align vertical, const char *text, bool strip_to_dots)
	Add Text Box Element.
void	widget_add_text_scroll_element (Widget *widget, uint8_t x, uint8_t y, uint8_t width, uint8_t height, const char *text)
	Add Text Scroll Element.
void	widget_add_button_element (Widget *widget, GuiButtonType button_type, const char *text, ButtonCallback callback, void *context)
	Add Button Element.
void	widget_add_icon_element (Widget *widget, uint8_t x, uint8_t y, const Icon *icon)
	Add Icon Element.
void	widget_add_rect_element (Widget *widget, uint8_t x, uint8_t y, uint8_t width, uint8_t height, uint8_t radius, bool fill)
	Add Rect Element.
void	widget_add_circle_element (Widget *widget, uint8_t x, uint8_t y, uint8_t radius, bool fill)
	Add Circle Element.
void	widget_add_line_element (Widget *widget, uint8_t x1, uint8_t y1, uint8_t x2, uint8_t y2)
	Add Line Element.

Detailed Description

GUI: Widget view module API.

Macro Definition Documentation

widget_add_frame_element

#define widget_add_frame_element	(		widget,
			x,
			y,
			width,
			height,
			radius )

Value:

    widget_add_rect_element((widget), (x), (y), (width), (height), (radius), false)

Add Frame Element.

Parameters

widget	Widget instance
x	top left x coordinate
y	top left y coordinate
width	frame width
height	frame height
radius	frame radius

Warning

deprecated, use widget_add_rect_element instead

Function Documentation

widget_add_button_element()

void widget_add_button_element	(	Widget *	widget,
		GuiButtonType	button_type,
		const char *	text,
		ButtonCallback	callback,
		void *	context )

Add Button Element.

Parameters

widget	Widget instance
button_type	GuiButtonType instance
text	text on allocated button
callback	ButtonCallback instance
context	pointer to context

widget_add_circle_element()

void widget_add_circle_element	(	Widget *	widget,
		uint8_t	x,
		uint8_t	y,
		uint8_t	radius,
		bool	fill )

Add Circle Element.

Parameters

widget	Widget instance
x	center x coordinate
y	center y coordinate
radius	circle radius
fill	whether to fill the circle or not

widget_add_icon_element()

void widget_add_icon_element	(	Widget *	widget,
		uint8_t	x,
		uint8_t	y,
		const Icon *	icon )

Add Icon Element.

Parameters

widget	Widget instance
x	top left x coordinate
y	top left y coordinate
icon	Icon instance

widget_add_line_element()

void widget_add_line_element	(	Widget *	widget,
		uint8_t	x1,
		uint8_t	y1,
		uint8_t	x2,
		uint8_t	y2 )

Add Line Element.

Parameters

widget	Widget instance
x1	first x coordinate
y1	first y coordinate
x2	second x coordinate
y2	second y coordinate

widget_add_rect_element()

void widget_add_rect_element	(	Widget *	widget,
		uint8_t	x,
		uint8_t	y,
		uint8_t	width,
		uint8_t	height,
		uint8_t	radius,
		bool	fill )

Add Rect Element.

Parameters

widget	Widget instance
x	top left x coordinate
y	top left y coordinate
width	rect width
height	rect height
radius	corner radius
fill	whether to fill the box or not

widget_add_string_element()

void widget_add_string_element	(	Widget *	widget,
		uint8_t	x,
		uint8_t	y,
		Align	horizontal,
		Align	vertical,
		Font	font,
		const char *	text )

Add String Element.

Parameters

	widget	Widget instance
	x	x coordinate
	y	y coordinate
	horizontal	Align instance
	vertical	Align instance
	font	Font instance
[in]	text	The text

widget_add_string_multiline_element()

void widget_add_string_multiline_element	(	Widget *	widget,
		uint8_t	x,
		uint8_t	y,
		Align	horizontal,
		Align	vertical,
		Font	font,
		const char *	text )

Add Multi String Element.

Parameters

	widget	Widget instance
	x	x coordinate
	y	y coordinate
	horizontal	Align instance
	vertical	Align instance
	font	Font instance
[in]	text	The text

widget_add_text_box_element()

void widget_add_text_box_element	(	Widget *	widget,
		uint8_t	x,
		uint8_t	y,
		uint8_t	width,
		uint8_t	height,
		Align	horizontal,
		Align	vertical,
		const char *	text,
		bool	strip_to_dots )

Add Text Box Element.

Parameters

	widget	Widget instance
	x	x coordinate
	y	y coordinate
	width	width to fit text
	height	height to fit text
	horizontal	Align instance
	vertical	Align instance
[in]	text	Formatted text. The following formats are available: "\e#Bold text\e#" - bold font is used "\e*Monospaced text\e*" - monospaced font is used "\e!Inversed text\e!" - white text on black background
	strip_to_dots	Strip text to ... if does not fit to width

widget_add_text_scroll_element()

void widget_add_text_scroll_element	(	Widget *	widget,
		uint8_t	x,
		uint8_t	y,
		uint8_t	width,
		uint8_t	height,
		const char *	text )

Add Text Scroll Element.

Parameters

	widget	Widget instance
	x	x coordinate
	y	y coordinate
	width	width to fit text
	height	height to fit text
[in]	text	Formatted text. Default format: align left, Secondary font. The following formats are available: "\e#Bold text" - sets bold font before until next ' ' symbol "\e*Monospaced text\e*" - sets monospaced font before until next ' ' symbol "\ecCenter-aligned text" - sets center horizontal align until the next ' ' symbol "\erRight-aligned text" - sets right horizontal align until the next ' ' symbol

widget_alloc()

Widget * widget_alloc

(

void

)

Allocate Widget that holds Widget Elements.

Returns

Widget instance

widget_free()

void widget_free

(

Widget *

widget

)

Free Widget.

Note

this function free allocated Widget Elements

Parameters

widget

Widget instance

widget_get_view()

View * widget_get_view

(

Widget *

widget

)

Get Widget view.

Parameters

widget

Widget instance

Returns

View instance

widget_reset()

void widget_reset

(

Widget *

widget

)

Reset Widget.

Parameters

widget

Widget instance