Area Class Reference

Area GUI element. More...

#include <hV_GUI.h>

Inheritance diagram for Area:

Public Member Functions
	Area (GUI *gui)
	Constructor.
void	dDefine (uint16_t x0, uint16_t y0, uint16_t dx, uint16_t dy, uint16_t index=0x0000)
	Define area, vector coordinates.
bool	getState ()
	Return state of the area.
void	setState (bool state=true)
	Define state of the area.
void	setOption (bool option=true)
	Set option of the area.
void	setStyle (uint8_t style=0)
	Define the default style.
bool	check (uint8_t mode=0)
	Check if area is pressed.
uint16_t	getIndex ()
	Return index.

Detailed Description

Area GUI element.

Area defines an active zone on the screen to manage touch

Constructor & Destructor Documentation

Area()

Area::Area

(

GUI *

gui

)

Constructor.

Parameters

gui	&gui to which the element belongs

Member Function Documentation

check()

bool Area::check

(

uint8_t

mode = 0

)

Check if area is pressed.

Parameters

mode	default = checkNormal = area waits for release, checkDirect = no final redraw if selected, checkInstant = element is activated by press only

Returns

true if area pressed

dDefine()

void Area::dDefine	(	uint16_t	x0,
		uint16_t	y0,
		uint16_t	dx,
		uint16_t	dy,
		uint16_t	index = 0x0000 )

Define area, vector coordinates.

Parameters

x0	point coordinate, x-axis
y0	point coordinate, y-axis
dx	length, x-axis
dy	height, y-axis
index	index, optional

Note

State set to value from GUI

More: Coordinates

getIndex()

uint16_t Area::getIndex

(

)

Return index.

Returns

index of the area

getState()

bool Area::getState

(

)

Return state of the area.

Returns

true if area enabled, false otherwise

setOption()

void Area::setOption

(

bool

option = true

)

Set option of the area.

Exact usage of the option is defined by the object.

Parameters

option

default = true = option enabled, false = otherwise

setState()

void Area::setState

(

bool

state = true

)

Define state of the area.

Parameters

state

default = stateEnabled = area enabled, stateDisabled = otherwise

Note

When created, state set to value from GUI

setStyle()

void Area::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