lv_msgbox.h
API reference for lv_msgbox.h
Functions
lv_msgbox_get_header
Get the header widget
lv_obj_t * lv_msgbox_get_header(lv_obj_t *obj)| Name | Type | Description |
|---|---|---|
obj | lv_obj_t * | pointer to a message box |
Returns: lv_obj_t * — the header, or NULL if not exists
lv_msgbox_get_content
Get the content widget
lv_obj_t * lv_msgbox_get_content(lv_obj_t *obj)| Name | Type | Description |
|---|---|---|
obj | lv_obj_t * | pointer to a message box |
Returns: lv_obj_t * — the content
lv_msgbox_get_title
Get the title label
lv_obj_t * lv_msgbox_get_title(lv_obj_t *obj)| Name | Type | Description |
|---|---|---|
obj | lv_obj_t * | pointer to a message box |
Returns: lv_obj_t * — the title, or NULL if it does not exist
lv_msgbox_create
Create an empty message box
lv_obj_t * lv_msgbox_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 on the top layer of the default screen. |
Returns: lv_obj_t * — the created message box
lv_msgbox_add_title
Add title to the message box. It also creates a header for the title.
lv_obj_t * lv_msgbox_add_title(lv_obj_t *obj, const char *title)| Name | Type | Description |
|---|---|---|
obj | lv_obj_t * | pointer to a message box |
title | const char * | the text of the tile. May be NULL.. See the default behaviour of lv_label_set_text |
Returns: lv_obj_t * — the created title label
lv_msgbox_add_header_button
Add a button to the header of to the message box. It also creates a header.
lv_obj_t * lv_msgbox_add_header_button(lv_obj_t *obj, const void *icon)| Name | Type | Description |
|---|---|---|
obj | lv_obj_t * | pointer to a message box |
icon | const void * | the icon of the button. May be NULL.. When NULL an empty button is created |
Returns: lv_obj_t * — the created button
lv_msgbox_add_text
Add a text to the content area of message box. Multiple texts will be created below each other.
lv_obj_t * lv_msgbox_add_text(lv_obj_t *obj, const char *text)| Name | Type | Description |
|---|---|---|
obj | lv_obj_t * | pointer to a message box |
text | const char * | text to add |
Returns: lv_obj_t * — the created label
lv_msgbox_add_text_fmt
Add a formatted text to the content area of message box. Multiple texts will be created below each other.
lv_obj_t * lv_msgbox_add_text_fmt(lv_obj_t *obj, const char *fmt,...)| Name | Type | Description |
|---|---|---|
obj | lv_obj_t * | pointer to a message box |
fmt | const char * | printf-like format string |
... |
Returns: lv_obj_t * — the created label
lv_msgbox_add_close_button
Add a close button to the message box. It also creates a header.
lv_obj_t * lv_msgbox_add_close_button(lv_obj_t *obj)| Name | Type | Description |
|---|---|---|
obj | lv_obj_t * | pointer to a message box |
Returns: lv_obj_t * — the created close button
lv_msgbox_close
Close a message box
void lv_msgbox_close(lv_obj_t *obj)| Name | Type | Description |
|---|---|---|
obj | lv_obj_t * | pointer to a message box |
lv_msgbox_close_async
Close a message box in the next call of the message box
void lv_msgbox_close_async(lv_obj_t *obj)| Name | Type | Description |
|---|---|---|
obj | lv_obj_t * | pointer to a message box |
Variables
lv_msgbox_class
const lv_obj_class_t lv_msgbox_classlv_msgbox_header_class
const lv_obj_class_t lv_msgbox_header_classlv_msgbox_content_class
const lv_obj_class_t lv_msgbox_content_classlv_msgbox_header_button_class
const lv_obj_class_t lv_msgbox_header_button_classlv_msgbox_backdrop_class
const lv_obj_class_t lv_msgbox_backdrop_classDependencies
Indirect dependencies
lv_anim.hlv_area.hlv_assert.hlv_bidi.hlv_color.hlv_color_op.hlv_conf_internal.hlv_display.hlv_draw.hlv_draw_arc.hlv_draw_blur.hlv_draw_buf.hlv_draw_image.hlv_draw_label.hlv_draw_line.hlv_draw_rect.hlv_draw_triangle.hlv_event.hlv_ext_data.hlv_flex.hlv_font.hlv_fs.hlv_grad.hlv_grid.hlv_group.hlv_image_decoder.hlv_image_dsc.hlv_indev.hlv_layout.hlv_log.hlv_math.hlv_matrix.hlv_mem.hlv_obj_class.hlv_obj_draw.hlv_obj_event.hlv_obj_pos.hlv_obj_property.hlv_obj_scroll.hlv_obj_style.hlv_obj_style_gen.hlv_obj_tree.hlv_palette.hlv_profiler.hlv_profiler_builtin.hlv_sprintf.hlv_string.hlv_style.hlv_style_gen.hlv_symbol_def.hlv_text.hlv_timer.hlv_types.h
Last updated on