const char * text
The text to be displayed on a help page.
Definition helpPages.h:70
void deinitHelpScreen(helpPageVars_t *help)
Deinitialize a help screen.
Definition helpPages.c:50
const helpPage_t * pages
All the help pages.
Definition helpPages.h:80
int32_t arrowBlinkTimer
A timer used to blink arrows indicating more pages.
Definition helpPages.h:83
bool buttonHelp(helpPageVars_t *help, buttonEvt_t *evt)
Handle a button event on the help screen.
Definition helpPages.c:127
void drawHelp(helpPageVars_t *help, int32_t elapsedUs)
Draw the help screen.
Definition helpPages.c:61
menuMegaRenderer_t * menuRenderer
A renderer to render the menu with.
Definition helpPages.h:79
int32_t numPages
The number of help pages in helpPageVars_t.pages.
Definition helpPages.h:81
int32_t helpIdx
The index of the page currently being displayed.
Definition helpPages.h:82
const char * title
The title for an individual help page.
Definition helpPages.h:69
menu_t * bgMenu
A menu to render behind the help text. Must not have any entries.
Definition helpPages.h:78
helpPageVars_t * initHelpScreen(menu_t *bgMenu, menuMegaRenderer_t *menuRenderer, const helpPage_t *pages, int32_t numPages)
Initialize a help screen.
Definition helpPages.c:34
All the variables required for a help screen.
Definition helpPages.h:77
A help page consisting of a title and text.
Definition helpPages.h:68