lv_msgbox.h

Functions

lv_obj_t *lv_msgbox_create(lv_obj_t *parent)

Create an empty message box

Parameters:

parent -- the parent or NULL to create a modal msgbox

Returns:

the created message box

lv_obj_t *lv_msgbox_add_title(lv_obj_t *obj, const char *title)

Add title to the message box. It also creates a header for the title.

Parameters:
  • obj -- pointer to a message box

  • title -- the text of the tile

Returns:

the created title label

lv_obj_t *lv_msgbox_add_header_button(lv_obj_t *obj, const void *icon)

Add a button to the header of to the message box. It also creates a header.

Parameters:
  • obj -- pointer to a message box

  • icon -- the icon of the button

Returns:

the created button

lv_obj_t *lv_msgbox_add_text(lv_obj_t *obj, const char *text)

Add a text to the content area of message box. Multiple texts will be created below each other.

Parameters:
  • obj -- pointer to a message box

  • text -- text to add

Returns:

the created button

Add a button to the footer of to the message box. It also creates a footer.

Parameters:
  • obj -- pointer to a message box

  • text -- the text of the button

Returns:

the created button

lv_obj_t *lv_msgbox_add_close_button(lv_obj_t *obj)

Add a close button to the message box. It also creates a header.

Parameters:

obj -- pointer to a message box

Returns:

the created close button

lv_obj_t *lv_msgbox_get_header(lv_obj_t *obj)

Get the header widget

Parameters:

obj -- pointer to a message box

Returns:

the header, or NULL if not exists

lv_obj_t *lv_msgbox_get_footer(lv_obj_t *obj)

Get the footer widget

Parameters:

obj -- pointer to a message box

Returns:

the footer, or NULL if not exists

lv_obj_t *lv_msgbox_get_content(lv_obj_t *obj)

Get the content widget

Parameters:

obj -- pointer to a message box

Returns:

the content

lv_obj_t *lv_msgbox_get_title(lv_obj_t *obj)

Get the title label

Parameters:

obj -- pointer to a message box

Returns:

the title, or NULL if it does not exist

void lv_msgbox_close(lv_obj_t *mbox)

Close a message box

Parameters:

mbox -- pointer to a message box

void lv_msgbox_close_async(lv_obj_t *mbox)

Close a message box in the next call of the message box

Parameters:

mbox -- pointer to a message box

Variables

const lv_obj_class_t lv_msgbox_class
const lv_obj_class_t lv_msgbox_header_class
const lv_obj_class_t lv_msgbox_content_class
const lv_obj_class_t lv_msgbox_header_button_class
const lv_obj_class_t lv_msgbox_backdrop_class