lv_win.h
API reference for lv_win.h
Functions
lv_win_get_header
Get the header of the window
> Deprecated: The lv_win widget is deprecated. See lv_example_flex_win.
lv_obj_t * lv_win_get_header(lv_obj_t *win)| Name | Type | Description |
|---|---|---|
win | lv_obj_t * | pointer to a window widget |
Returns: lv_obj_t * — the header of the window
lv_win_get_content
Get the content of the window
> Deprecated: The lv_win widget is deprecated. See lv_example_flex_win.
lv_obj_t * lv_win_get_content(lv_obj_t *win)| Name | Type | Description |
|---|---|---|
win | lv_obj_t * | pointer to a window widget |
Returns: lv_obj_t * — the content of the window
lv_win_create
Create a window widget
> Deprecated: Use a flex column with a header and content area instead. See lv_example_flex_win.
lv_obj_t * lv_win_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 * — the created window
lv_win_add_title
Add a title to the window
> Deprecated: The lv_win widget is deprecated. See lv_example_flex_win.
lv_obj_t * lv_win_add_title(lv_obj_t *win, const char *txt)| Name | Type | Description |
|---|---|---|
win | lv_obj_t * | pointer to a window widget |
txt | const char * | the text of the title |
Returns: lv_obj_t * — the widget where the content of the title can be created
lv_win_add_button
Add a button to the window
> Deprecated: The lv_win widget is deprecated. See lv_example_flex_win.
lv_obj_t * lv_win_add_button(lv_obj_t *win, const void *icon, int32_t btn_w)| Name | Type | Description |
|---|---|---|
win | lv_obj_t * | pointer to a window widget |
icon | const void * | an icon to be displayed on the button May be NULL. |
btn_w | int32_t | width of the button |
Returns: lv_obj_t * — the widget where the content of the button can be created
Macros
LV_WIN_DEPRECATED_MSG
#define LV_WIN_DEPRECATED_MSG "lv_win is deprecated; build a window from a flex column instead. See the lv_example_flex_win example."> Deprecated: The lv_win widget is deprecated and kept only for backward compatibility. A window is just a flex column with a header bar and a content area, so build one directly from lv_obj instead. See the lv_example_flex_win example for a starting point.
Variables
lv_win_class
const lv_obj_class_t lv_win_classDependencies
Indirect dependencies
lv_anim.hlv_area.hlv_assert.hlv_bidi.hlv_color.hlv_color_op.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