lv_list.h
API reference for lv_list.h
Functions
lv_list_set_button_text
Set text of a given list button
> Deprecated: The lv_list widget is deprecated. See lv_example_flex_list.
void lv_list_set_button_text(lv_obj_t *list, lv_obj_t *btn, const char *txt)| Name | Type | Description |
|---|---|---|
list | lv_obj_t * | pointer to a list |
btn | lv_obj_t * | pointer to the button |
txt | const char * | pointer to the text |
lv_list_set_button_translation_tag
Set translation tag text of a given list button
> Deprecated: The lv_list widget is deprecated. See lv_example_flex_list.
void lv_list_set_button_translation_tag(lv_obj_t *list, lv_obj_t *btn, const char *tag)| Name | Type | Description |
|---|---|---|
list | lv_obj_t * | pointer to a list |
btn | lv_obj_t * | pointer to the button |
tag | const char * | pointer to the translation tag |
lv_list_get_button_text
Get text of a given list button
> Deprecated: The lv_list widget is deprecated. See lv_example_flex_list.
const char * lv_list_get_button_text(lv_obj_t *list, lv_obj_t *btn)| Name | Type | Description |
|---|---|---|
list | lv_obj_t * | pointer to a list |
btn | lv_obj_t * | pointer to the button |
Returns: const char * — text of btn, if btn doesn't have text "" will be returned
lv_list_create
Create a list object
> Deprecated: Use a flex container with LV_FLEX_FLOW_COLUMN instead. See lv_example_flex_list.
lv_obj_t * lv_list_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 list
lv_list_add_text
Add text to a list
> Deprecated: Add a full-width lv_label to a flex container instead. See lv_example_flex_list.
lv_obj_t * lv_list_add_text(lv_obj_t *list, const char *txt)| Name | Type | Description |
|---|---|---|
list | lv_obj_t * | pointer to a list, it will be the parent of the new label |
txt | const char * | text of the new label. May be NULL. When NULL the label is left empty. |
Returns: lv_obj_t * — pointer to the created label
lv_list_add_button
Add button to a list
> Deprecated: Add a full-width lv_button to a flex container instead. See lv_example_flex_list.
lv_obj_t * lv_list_add_button(lv_obj_t *list, const void *icon, const char *txt)| Name | Type | Description |
|---|---|---|
list | lv_obj_t * | pointer to a list, it will be the parent of the new button |
icon | const void * | icon for the button. May be NULL. When NULL it will have no icon. |
txt | const char * | text of the new button. May be NULL. When NULL no text will be added. |
Returns: lv_obj_t * — pointer to the created button
lv_list_add_translation_tag
Add translation tag text to a list
> Deprecated: The lv_list widget is deprecated. See lv_example_flex_list.
lv_obj_t * lv_list_add_translation_tag(lv_obj_t *list, const char *tag)| Name | Type | Description |
|---|---|---|
list | lv_obj_t * | pointer to a list, it will be the parent of the new label |
tag | const char * | translation tag of the new label |
Returns: lv_obj_t * — pointer to the created label
lv_list_add_button_translation_tag
Add translation tag button to a list
> Deprecated: The lv_list widget is deprecated. See lv_example_flex_list.
lv_obj_t * lv_list_add_button_translation_tag(lv_obj_t *list, const void *icon, const char *tag)| Name | Type | Description |
|---|---|---|
list | lv_obj_t * | pointer to a list, it will be the parent of the new button |
icon | const void * | icon for the button. May be NULL. When NULL it will have no icon. |
tag | const char * | translation tag of the new button. May be NULL. When NULL no translation tag will be added. |
Returns: lv_obj_t * — pointer to the created button
Macros
LV_LIST_DEPRECATED_MSG
#define LV_LIST_DEPRECATED_MSG "lv_list is deprecated; build a list from a flex column instead. See the lv_example_flex_list example."> Deprecated: The lv_list widget is deprecated and kept only for backward compatibility. A list is just a flex container with a column flow, so build one directly from lv_obj + a LV_FLEX_FLOW_COLUMN layout instead. See the lv_example_flex_list example for a starting point.
Variables
lv_list_class
const lv_obj_class_t lv_list_classlv_list_text_class
const lv_obj_class_t lv_list_text_classlv_list_button_class
const lv_obj_class_t lv_list_button_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