LcdGfxMenu Class Reference

Class implements menu objects for lcdgfx library. More...

#include <menu.h>

Public Member Functions
	LcdGfxMenu (const char **items, uint8_t count, const NanoRect &rect={})
	Creates menu object with the provided list of menu items. More...
void	down ()
	Moves selection pointer down by 1 item. More...
void	up ()
	Moves selection pointer up by 1 item. More...
uint8_t	selection ()
	Returns currently selected menu item. More...
void	setSelection (uint8_t s)
void	setRect (const NanoRect &rect={})
	Sets rect area for the menu. More...
uint8_t	size ()
	Returns total count of menu items in menu.
template<typename D >
void	updateSize (D &d)
	Updates size of the object, if it was not set previously.
template<typename D >
void	show (D &d)
	Shows menu items on the display. More...

Detailed Description

Class implements menu objects for lcdgfx library.

Definition at line 54 of file menu.h.

Constructor & Destructor Documentation

LcdGfxMenu()

LcdGfxMenu::LcdGfxMenu	(	const char **	items,
		uint8_t	count,
		const NanoRect &	rect = {}
	)

Creates menu object with the provided list of menu items.

List of menu items (strings) must exist all until menu object is no longer needed. Selection is set to the first item by default.

Parameters

items	array of null-termintated strings (located in SRAM)
count	count of menu items in the array
rect	screen area to use for menu

Member Function Documentation

down()

void LcdGfxMenu::down

(

)

Moves selection pointer down by 1 item.

If there are no items below, it will set selection pointer to the first item. Use show() to refresh menu state on the display.

selection()

uint8_t LcdGfxMenu::selection

(

)

Returns currently selected menu item.

First item has zero-index.

setRect()

void LcdGfxMenu::setRect

(

const NanoRect &

rect = {}

)

Sets rect area for the menu.

Parameters

rect	rect area to use for menu

show()

template<typename D >

void LcdGfxMenu::show

(

D &

d

)

Shows menu items on the display.

If menu items cannot fit the display, the function provides scrolling.

Parameters

d	display object

Definition at line 218 of file menu.h.

up()

void LcdGfxMenu::up

(

)

Moves selection pointer up by 1 item.

If selected item is the first one, then selection pointer will set to the last item in menu list. Use show() to refresh menu state on the display.

---

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

• src/v2/gui/menu.h