GUI Class Reference

GUI. More...

#include <hV_GUI.h>

Public Member Functions
	GUI (Screen_EPD *screen)
	Constructor.
void	begin ()
	Initialise the GUI.
void	setColours (uint16_t frontColour=myColours.black, uint16_t backColour=myColours.white, uint16_t middleColour=myColours.grey)
	Set the colours palette.
void	setState (bool state=true)
	Define the default state.
void	setStyle (uint8_t style=0)
	Define the default style.
void	setMarginXY (uint16_t marginX=0, uint16_t marginY=0)
	Set margins for GUI elements.
void	delegate (bool delegate=true)
	Delegate the refresh policy.

Friends
class	Area
class	Button
class	CheckBox
class	Cursor
class	Text
class	PlusMinus
class	RadioButtons
class	Table
class	Keyboard
class	Switch
class	TextBox
class	BarGraph

Detailed Description

GUI.

Shared settings

Constructor & Destructor Documentation

GUI()

GUI::GUI

(

Screen_EPD *

screen

)

Constructor.

Parameters

screen

&screen to which the GUI elements belong

Member Function Documentation

begin()

void GUI::begin

(

)

Initialise the GUI.

Note

By default, the GUI element manages refresh with fast update. Use delegate(false) to change.

delegate()

void GUI::delegate

(

bool

delegate = true

)

Delegate the refresh policy.

Parameters

delegate

true = default = refresh managed by the GUI element with fast update

Note

If false, refresh managed by the caller

• full update
• fast update

setColours()

void GUI::setColours	(	uint16_t	frontColour = myColours.black,
		uint16_t	backColour = myColours.white,
		uint16_t	middleColour = myColours.grey )

Set the colours palette.

Parameters

frontColour	16-bit colours for text and rectangles
backColour	16-bit colours for background
middleColour	16-bit colours for intermediate

setMarginXY()

void GUI::setMarginXY	(	uint16_t	marginX = 0,
		uint16_t	marginY = 0 )

Set margins for GUI elements.

Parameters

marginX	x-axis margin in pixels
marginY	y-axis margin in pixels

setState()

void GUI::setState

(

bool

state = true

)

Define the default state.

Parameters

state

default = stateEnabled = enabled, stateDisabled = disabled

setStyle()

void GUI::setStyle

(

uint8_t

style = 0

)

Define the default style.

Parameters

state

default = 0 = styleNormal, otherwise = 5 = styleRounded

---

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

• hV_GUI.h