hV_GUI.h File Reference

GUI with text, button, dialog box, menu, slider. More...

#include "PDLS_Common.h"
#include "Screen_EPD.h"

Include dependency graph for hV_GUI.h:

This graph shows which files directly or indirectly include this file:

Classes
class	GUI
	GUI. More...
struct	Item
	Item combines index and text for GUI elements. More...
class	Area
	Area GUI element. More...
class	Button
	Button GUI element. More...
class	CheckBox
	Check-box GUI element. More...
class	Switch
	Switch GUI element. More...
class	Cursor
	Cursor GUI element. More...
class	TextBox
	TextBox GUI element. More...
class	Text
	Text GUI element. More...
class	BarGraph
	Bar-graph GUI element. More...
class	PlusMinus
	Plus-minus button GUI element. More...
class	RadioButtons
	Radio-buttons GUI element. More...
class	Table
	Table GUI element. More...
class	Keyboard
	Keyboard GUI element. More...

Macros
#define	hV_GUI_RELEASE   902
	Library release number.
#define	ARRAY_SIZE(x)
	ARRAY_SIZE calculates the number of elements in an array.
States
#define	stateDisabled   false
	Input mode disable.
#define	stateEnabled   true
	Input mode enable.
Modes for check()
#define	checkNormal   0
	Normal mode.
#define	checkDirect   1
	Direct mode.
#define	checkInstant   2
	Instant mode.
#define	checkSpecial   3
	Special mode.
Modes for check(), synonyms
#define	checkStepOne   2
	Instant mode, one step.
#define	checkStepOneAndHalf   1
	Direct mode, one and a half steps.
#define	checkStepTwo   3
	Special mode, two steps.
#define	checkStepThree   0
	Normal mode, three steps.
Styles
#define	styleNormal   0
	Normal style.
#define	styleRounded   6
	Rounded style.
Font size
#define	fontSizeAutomatic   0xff
	Automatic.
Options for BarGraph, Cursor, PlusMinus, RadioButtons
#define	optionHorizontal   false
	Horizontal.
#define	optionVertical   true
	Vertical.
Options for Text and TextBox
#define	optionWithoutFrame   false
	No rectangle.
#define	optionWithFrame   true
	Text inside a rectangle.
Options for Button
#define	optionStandard   false
	Standard push button.
#define	optionFlipFlop   true
	Flip-flop button.
Options for horizontal and vertical position
#define	horizontalLeft   -1
	Left.
#define	horizontalCentre   0
	Centre.
#define	horizontalCenter   0
	American English variant for horizontalCentre.
#define	horizontalRight   1
	Right.
#define	verticalTop   1
	Top.
#define	verticalMiddle   0
	Middle.
#define	verticalBottom   -1
	Bottom.
#define	hL   horizontalLeft
	Short for horizontalLeft.
#define	hC   horizontalCentre
	Short for horizontalCentre.
#define	hR   horizontalRight
	Short for horizontalRight.
#define	vT   verticalTop
	Short for verticalTop.
#define	vM   verticalMiddle
	Short for verticalMiddle.
#define	vB   verticalBottom
	Short for verticalBottom.
Patterns for Table
#define	patternSquare   0x01
	Empty square.
#define	patternCircle   0x02
	Empty circle.
#define	patternTriangle   0x03
	Empty triangle.
#define	patternSquareSolid   0x11
	Solid square.
#define	patternCircleSolid   0x12
	Solid circle.
#define	patternTriangleSolid   0x13
	Solid triangle.

Enumerations
enum	fsmGUI_e { fsmReleased , fsmTouched , fsmConfirmed }
	Finite state machine. More...

Functions
Item	setItem (uint16_t index, STRING_CONST_TYPE text)
	Set item.

Detailed Description

GUI with text, button, dialog box, menu, slider.

Project Pervasive Displays Library Suite
Based on highView technology

Author

Rei Vilo

Date

21 Jan 2025

Version

902

Copyright

(c) Rei Vilo, 2010-2025

All rights reserved

For exclusive use with Pervasive Displays screens

• Evaluation edition: for professionals or organisations, evaluation only, no commercial usage
• Commercial edition: for professionals or organisations, commercial usage

• Viewer edition: for professionals or organisations, commercial usage

  Deprecated

  Rectangle coordinates are deprecated for GUI elements, use vector coordinates instead (6.0.5)
  See Coordinates

Warning

Starting release 6.0.5,

• The element constructor requires a GUI as parameter;
• The first letter of the element class is capitalised.

  GUI myGUI(&myScreen);
  Text myText(&myGUI);

Enumeration Type Documentation

fsmGUI_e

enum fsmGUI_e

Finite state machine.

Used for Button, CheckBox, Cursor, BarGraph

Enumerator
fsmReleased	No touch.
fsmTouched	First touch.
fsmConfirmed	Touch maintained.

Function Documentation

setItem()

Item setItem	(	uint16_t	index,
		STRING_CONST_TYPE	text )

Set item.

Packs index and text into an item

Parameters

index	index
text	text

Returns

item