lv_menu.h

API reference for lv_menu.h

Summary

Functions

public/widgets/lv_menu.h:138function

Name	Type	Description
`page_obj`	`lv_obj_t *`	pointer to the menu page
`title`	`char const *const`	pointer to text for title in header. May be `NULL`. When NULL no title is displayed.

Name	Type	Description
`page_obj`	`lv_obj_t *`	pointer to the menu page
`title`	`char const *const`	pointer to text for title in header. May be `NULL`. When NULL no title is displayed.

lv_menu_set_mode_root_back_button

Set whether back button should appear at root

> Deprecated: The lv_menu widget is deprecated. See lv_example_menu_navigation.

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

public/widgets/lv_menu.h:197function

lv_menu_get_cur_main_page

Get a pointer to menu page that is currently displayed in main

> Deprecated: The lv_menu widget is deprecated. See lv_example_menu_navigation.

lv_obj_t * lv_menu_get_cur_main_page(lv_obj_t *obj)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to the menu

Returns: lv_obj_t * — pointer to current page

public/widgets/lv_menu.h:218function

lv_menu_get_cur_sidebar_page

Get a pointer to menu page that is currently displayed in sidebar

> Deprecated: The lv_menu widget is deprecated. See lv_example_menu_navigation.

lv_obj_t * lv_menu_get_cur_sidebar_page(lv_obj_t *obj)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to the menu

Returns: lv_obj_t * — pointer to current page

public/widgets/lv_menu.h:227function

lv_menu_get_main_header

Get a pointer to main header obj

> Deprecated: The lv_menu widget is deprecated. See lv_example_menu_navigation.

lv_obj_t * lv_menu_get_main_header(lv_obj_t *obj)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to the menu

Returns: lv_obj_t * — pointer to main header obj

public/widgets/lv_menu.h:236function

lv_menu_get_main_header_back_button

Get a pointer to main header back btn obj

> Deprecated: The lv_menu widget is deprecated. See lv_example_menu_navigation.

lv_obj_t * lv_menu_get_main_header_back_button(lv_obj_t *obj)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to the menu

Returns: lv_obj_t * — pointer to main header back btn obj

public/widgets/lv_menu.h:245function

lv_menu_get_sidebar_header

Get a pointer to sidebar header obj

> Deprecated: The lv_menu widget is deprecated. See lv_example_menu_navigation.

lv_obj_t * lv_menu_get_sidebar_header(lv_obj_t *obj)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to the menu

Returns: lv_obj_t * — pointer to sidebar header obj

public/widgets/lv_menu.h:254function

lv_menu_get_sidebar_header_back_button

Get a pointer to sidebar header obj

> Deprecated: The lv_menu widget is deprecated. See lv_example_menu_navigation.

lv_obj_t * lv_menu_get_sidebar_header_back_button(lv_obj_t *obj)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to the menu

Returns: lv_obj_t * — pointer to sidebar header back btn obj

public/widgets/lv_menu.h:273function

lv_menu_get_mode_header

Get the header mode of the menu

> Deprecated: The lv_menu widget is deprecated. See lv_example_menu_navigation.

lv_menu_mode_header_t lv_menu_get_mode_header(lv_obj_t *obj)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to a menu

Returns: lv_menu_mode_header_t — LV_MENU_HEADER_TOP_FIXED/TOP_UNFIXED/BOTTOM_FIXED

public/widgets/lv_menu.h:282function

lv_menu_get_mode_root_back_button

Get the root back button mode of the menu

> Deprecated: The lv_menu widget is deprecated. See lv_example_menu_navigation.

lv_menu_mode_root_back_button_t lv_menu_get_mode_root_back_button(lv_obj_t *obj)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to a menu

Returns: lv_menu_mode_root_back_button_t — LV_MENU_ROOT_BACK_BUTTON_DISABLED/ENABLED

public/widgets/lv_menu.h:84function

lv_menu_create

Create a menu object

> Deprecated: The lv_menu widget is deprecated. Build menu navigation from base widgets instead. See lv_example_menu_navigation.

lv_obj_t * lv_menu_create(lv_obj_t *parent)

Name	Type	Description
`parent`	`lv_obj_t *`	pointer to a parent widget May be `NULL`.. When NULL, the widget is created as a screen on the default display.

Returns: lv_obj_t * — pointer to the created menu

public/widgets/lv_menu.h:99function

This call inserts the new page under menu->storage as its parent, which is itself a child of the menu, so the resulting object hierarchy is: menu => storage => new_page where storage is a Base Widget.

> Deprecated: The lv_menu widget is deprecated. See lv_example_menu_navigation.

lv_obj_t * lv_menu_page_create(lv_obj_t *menu, char const *const title)

Name	Type	Description
`menu`	`lv_obj_t *`	pointer to menu object.
`title`	`char const *const`	pointer to text for title in header. May be `NULL`. When NULL no title is displayed.

Returns: lv_obj_t * — pointer to the created menu page

public/widgets/lv_menu.h:108function

lv_menu_cont_create

Create a menu cont object

> Deprecated: The lv_menu widget is deprecated. See lv_example_menu_navigation.

lv_obj_t * lv_menu_cont_create(lv_obj_t *parent)

Name	Type	Description
`parent`	`lv_obj_t *`	pointer to a menu page or menu section object, it will be the parent of the new menu cont object

Returns: lv_obj_t * — pointer to the created menu cont

public/widgets/lv_menu.h:117function

lv_menu_section_create

Create a menu section object

> Deprecated: The lv_menu widget is deprecated. See lv_example_menu_navigation.

lv_obj_t * lv_menu_section_create(lv_obj_t *parent)

Name	Type	Description
`parent`	`lv_obj_t *`	pointer to a menu page object, it will be the parent of the new menu section object

Returns: lv_obj_t * — pointer to the created menu section

public/widgets/lv_menu.h:126function

lv_menu_separator_create

Create a menu separator object

> Deprecated: The lv_menu widget is deprecated. See lv_example_menu_navigation.

lv_obj_t * lv_menu_separator_create(lv_obj_t *parent)

Name	Type	Description
`parent`	`lv_obj_t *`	pointer to a menu page object, it will be the parent of the new menu separator object

Returns: lv_obj_t * — pointer to the created menu separator

public/widgets/lv_menu.h:264function

lv_menu_back_button_is_root

Check if an obj is a root back btn

> Deprecated: The lv_menu widget is deprecated. See lv_example_menu_navigation.

bool lv_menu_back_button_is_root(lv_obj_t *menu, lv_obj_t *obj)

Name	Type	Description
`menu`	`lv_obj_t *`	pointer to the menu
`obj`	`lv_obj_t *`	pointer to the back button

Returns: bool — true if it is a root back btn

public/widgets/lv_menu.h:290function

lv_menu_clear_history

Clear menu history

> Deprecated: The lv_menu widget is deprecated. See lv_example_menu_navigation.

void lv_menu_clear_history(lv_obj_t *obj)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to the menu

Enums

public/widgets/lv_menu.h:42enum

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

public/widgets/lv_menu.h:48enum

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

public/widgets/lv_menu.h:64enum

__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`

Macros

public/widgets/lv_menu.h:36macro

LV_MENU_DEPRECATED_MSG

#define LV_MENU_DEPRECATED_MSG "lv_menu is deprecated; build menu navigation from base widgets instead. See the lv_example_menu_navigation example."

> Deprecated: The lv_menu widget is deprecated and kept only for backward compatibility. A menu is page navigation over base widgets: pages built from lv_obj and a back button that swaps the visible page. Build it directly instead. See the lv_example_menu_navigation example. All lv_menu_* functions below are deprecated.

Variables

public/widgets/lv_menu.h:53variable

lv_menu_class

const lv_obj_class_t lv_menu_class

public/widgets/lv_menu.h:54variable

lv_menu_page_class

const lv_obj_class_t lv_menu_page_class

public/widgets/lv_menu.h:55variable

lv_menu_cont_class

const lv_obj_class_t lv_menu_cont_class

public/widgets/lv_menu.h:56variable

lv_menu_section_class

const lv_obj_class_t lv_menu_section_class

public/widgets/lv_menu.h:57variable

lv_menu_separator_class

const lv_obj_class_t lv_menu_separator_class

public/widgets/lv_menu.h:58variable

lv_menu_sidebar_cont_class

const lv_obj_class_t lv_menu_sidebar_cont_class

public/widgets/lv_menu.h:59variable

lv_menu_main_cont_class

const lv_obj_class_t lv_menu_main_cont_class

public/widgets/lv_menu.h:60variable

lv_menu_sidebar_header_cont_class

const lv_obj_class_t lv_menu_sidebar_header_cont_class

public/widgets/lv_menu.h:61variable

lv_menu_main_header_cont_class

const lv_obj_class_t lv_menu_main_header_cont_class

lv_menu.h

On this page