Loading...
Searching...
No Matches
menu.h File Reference

GUI: Menu view module API. More...

#include <gui/view.h>

Go to the source code of this file.

Typedefs

typedef struct Menu Menu
 Menu anonymous structure.
 
typedef void(* MenuItemCallback) (void *context, uint32_t index)
 Menu Item Callback.
 

Functions

Menumenu_alloc (void)
 Menu allocation and initialization.
 
void menu_free (Menu *menu)
 Free menu.
 
Viewmenu_get_view (Menu *menu)
 Get Menu view.
 
void menu_add_item (Menu *menu, const char *label, const Icon *icon, uint32_t index, MenuItemCallback callback, void *context)
 Add item to menu.
 
void menu_reset (Menu *menu)
 Clean menu.
 
void menu_set_selected_item (Menu *menu, uint32_t index)
 Set current menu item.
 

Detailed Description

GUI: Menu view module API.

Function Documentation

◆ menu_add_item()

void menu_add_item ( Menu * menu,
const char * label,
const Icon * icon,
uint32_t index,
MenuItemCallback callback,
void * context )

Add item to menu.

Parameters
menuMenu instance
labelmenu item string label
iconIconAnimation instance
indexmenu item index
callbackMenuItemCallback instance
contextpointer to context

◆ menu_alloc()

Menu * menu_alloc ( void )

Menu allocation and initialization.

Returns
Menu instance

◆ menu_free()

void menu_free ( Menu * menu)

Free menu.

Parameters
menuMenu instance

◆ menu_get_view()

View * menu_get_view ( Menu * menu)

Get Menu view.

Parameters
menuMenu instance
Returns
View instance

◆ menu_reset()

void menu_reset ( Menu * menu)

Clean menu.

Note
this function does not free menu instance
Parameters
menuMenu instance

◆ menu_set_selected_item()

void menu_set_selected_item ( Menu * menu,
uint32_t index )

Set current menu item.

Parameters
menuMenu instance
indexThe index