Check-box GUI element. More...

#include <hV_GUI.h>

Inheritance diagram for CheckBox:

[legend]

Collaboration diagram for CheckBox:

[legend]

Public Member Functions
	CheckBox (GUI *gui)
	Constructor.

void	draw (fsmGUI_e fsm=fsmReleased)
	Draw the button.

bool	check (uint8_t mode=0)
	Check button is pressed.

Public Member Functions inherited from Button
	Button (GUI *gui)
	Constructor.

void	dDefine (uint16_t x0, uint16_t y0, uint16_t dx, uint16_t dy, Item item0, uint8_t size0=0xff)
	Define item-based button, vector coordinates.

void	dStringDefine (uint16_t x0, uint16_t y0, uint16_t dx, uint16_t dy, STRING_CONST_TYPE text0, uint8_t size0=0xff)
	Define item-based button, vector coordinates.

void	draw (fsmGUI_e fsm=fsmReleased)
	Draw the button.

bool	check (uint8_t mode=0)
	Check button is pressed.

void	setValue (bool value=true)
	Set current value of the flip-flop button.

bool	getValue ()
	Return current value of the flip-flop button.

Public Member Functions inherited from Area
	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

Check-box GUI element.

CheckBox is a flip-flop button

Constructor & Destructor Documentation

CheckBox::CheckBox ( GUI * gui )

Constructor.

Parameters

gui	&gui to which the element belongs

bool CheckBox::check ( uint8_t mode = 0 )

Check button is pressed.

With button animation

Parameters

mode	default = checkNormal = area waits for release, checkInstant = element is activated by press only

void CheckBox::draw ( fsmGUI_e fsm = fsmReleased )

Draw the button.

Parameters

fsm state

Note: 4 states
* if button enabled,
fsm = fsmReleased, fsmTouched, fsmConfirmed
* if button disabled,
flag = true: statement checkbox, flag = false: unavailable checkbox

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