lv_menu.h

API reference for lv_menu.h

Summary

Functions

widgets/menu/lv_menu.h:112function

lv_menu_set_page

Set menu page to display in main

void lv_menu_set_page(lv_obj_t *obj, lv_obj_t *page)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to the menu
`page`	`lv_obj_t *`	pointer to the menu page to set (NULL to clear main and clear menu history)

widgets/menu/lv_menu.h:119function

lv_menu_set_page_title

Set menu page title

void lv_menu_set_page_title(lv_obj_t *page, char const *const title)

Name	Type	Description
`page`	`lv_obj_t *`	pointer to the menu page
`title`	`char const *const`	pointer to text for title in header (NULL to not display title)

widgets/menu/lv_menu.h:127function

lv_menu_set_page_title_static

Set menu page title with a static text. It will not be saved by the label so the 'text' variable has to be 'alive' while the page exists.

void lv_menu_set_page_title_static(lv_obj_t *page, char const *const title)

Name	Type	Description
`page`	`lv_obj_t *`	pointer to the menu page
`title`	`char const *const`	pointer to text for title in header (NULL to not display title)

widgets/menu/lv_menu.h:134function

lv_menu_set_sidebar_page

Set menu page to display in sidebar

void lv_menu_set_sidebar_page(lv_obj_t *obj, lv_obj_t *page)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to the menu
`page`	`lv_obj_t *`	pointer to the menu page to set (NULL to clear sidebar)

widgets/menu/lv_menu.h:141function

lv_menu_set_mode_header

Set the how the header should behave and its position

void lv_menu_set_mode_header(lv_obj_t *obj, lv_menu_mode_header_t mode)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to a menu
`mode`	`lv_menu_mode_header_t`	LV_MENU_HEADER_TOP_FIXED/TOP_UNFIXED/BOTTOM_FIXED

widgets/menu/lv_menu.h:148function

lv_menu_set_mode_root_back_button

Set whether back button should appear at root

void lv_menu_set_mode_root_back_button(lv_obj_t *obj, lv_menu_mode_root_back_button_t mode)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to a menu
`mode`	`lv_menu_mode_root_back_button_t`	LV_MENU_ROOT_BACK_BUTTON_DISABLED/ENABLED

widgets/menu/lv_menu.h:156function

lv_menu_set_load_page_event

Add menu to the menu item

void lv_menu_set_load_page_event(lv_obj_t *menu, lv_obj_t *obj, lv_obj_t *page)

Name	Type	Description
`menu`	`lv_obj_t *`	pointer to the menu
`obj`	`lv_obj_t *`	pointer to the obj
`page`	`lv_obj_t *`	pointer to the page to load when obj is clicked

Enums

widgets/menu/lv_menu.h:32enum

lv_menu_mode_header_t

Name	Description
`LV_MENU_HEADER_TOP_FIXED`	Header is positioned at the top
`LV_MENU_HEADER_TOP_UNFIXED`	Header is positioned at the top and can be scrolled out of view
`LV_MENU_HEADER_BOTTOM_FIXED`	Header is positioned at the bottom

Used by 1 function

lv_menu_set_mode_header — param mode

widgets/menu/lv_menu.h:38enum

lv_menu_mode_root_back_button_t

Name
`LV_MENU_ROOT_BACK_BUTTON_DISABLED`
`LV_MENU_ROOT_BACK_BUTTON_ENABLED`

Used by 1 function

lv_menu_set_mode_root_back_button — param mode

widgets/menu/lv_menu.h:54enum

__lv_property_menu_id_t

Name	Value
`LV_PROPERTY_MENU_MODE_HEADER`	`(LV_PROPERTY_MENU_START + ((int) 0 )) \| (( 1 ) << 28 )`
`LV_PROPERTY_MENU_MODE_ROOT_BACK_BUTTON`	`(LV_PROPERTY_MENU_START + ((int) 1 )) \| (( 1 ) << 28 )`
`LV_PROPERTY_MENU_END`

Variables

widgets/menu/lv_menu.h:43variable

lv_menu_class

const lv_obj_class_t lv_menu_class

widgets/menu/lv_menu.h:44variable

lv_menu_page_class

const lv_obj_class_t lv_menu_page_class

widgets/menu/lv_menu.h:45variable

lv_menu_cont_class

const lv_obj_class_t lv_menu_cont_class

widgets/menu/lv_menu.h:46variable

lv_menu_section_class

const lv_obj_class_t lv_menu_section_class

widgets/menu/lv_menu.h:47variable

lv_menu_separator_class

const lv_obj_class_t lv_menu_separator_class

widgets/menu/lv_menu.h:48variable

lv_menu_sidebar_cont_class

const lv_obj_class_t lv_menu_sidebar_cont_class

widgets/menu/lv_menu.h:49variable

lv_menu_main_cont_class

const lv_obj_class_t lv_menu_main_cont_class

widgets/menu/lv_menu.h:50variable

lv_menu_sidebar_header_cont_class

const lv_obj_class_t lv_menu_sidebar_header_cont_class

widgets/menu/lv_menu.h:51variable

lv_menu_main_header_cont_class

const lv_obj_class_t lv_menu_main_header_cont_class