Karl Zweimüller / Menu

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of Menu by Peihsun Yeh

Embed: (wiki syntax)

« Back to documentation index

MenuItem Class Reference
Data Structures | Public Types | Public Member Functions | Data Fields

MenuItem Class Reference

MenuItem is a menu-item of menu. More...

#include <MenuItem.h>

Data Structures

struct  menu_data
 structure to pass data to menu and back More...

Public Types

enum  mode { mode_default = 0, mode_wait_select = 1, mode_yes_no = 2 }
 

modes of MenuItems

More...

Public Member Functions

 MenuItem (void(*)(), int, Menu *, char *, uint8_t=mode_default, menu_data *=NULL)
 a sub-menu

Data Fields

void(* userAction )()
 pointer to user-action to execute when menu item is selected
char * selText
 Text of Menue-Item to display.
int pos
 position of menuitem in menu
Menu * childMenu
 Pointer to child-menue.
uint8_t itemMode
 itemMode

Detailed Description

MenuItem is a menu-item of menu.

Definition at line 10 of file MenuItem.h.

Member Enumeration Documentation

enum mode

modes of MenuItems

Enumerator:
mode_default 

default mode: just display the Menu-Text an perform user_action

mode_wait_select 

wait_select: Call user_action and then only accept a select use for displaying text, values,...

the menu is paused until select is pressed

mode_yes_no 

mode_yes_no: show text and ask user for yes/no

Definition at line 16 of file MenuItem.h.

Constructor & Destructor Documentation

MenuItem ( void(*)()  userAction,
int  position,
Menu *  child,
char *  text,
uint8_t  itemMode = mode_default,
menu_data *  menu_parameter = NULL 
)

a sub-menu

Definition at line 5 of file MenuItem.cpp.

Field Documentation

Menu* childMenu

Pointer to child-menue.

Definition at line 58 of file MenuItem.h.

uint8_t itemMode

itemMode

Definition at line 61 of file MenuItem.h.

int pos

position of menuitem in menu

Definition at line 55 of file MenuItem.h.

char* selText

Text of Menue-Item to display.

Definition at line 52 of file MenuItem.h.

void(* userAction)()

pointer to user-action to execute when menu item is selected

Definition at line 49 of file MenuItem.h.

Generated on Fri Jul 15 2022 06:41:56 by  doxygen 1.7.2