# lv_list.h (/api/widgets/list/lv_list_h)



<ApiSummary functions="8" variables="3" />

Functions [#functions]

<ApiTabs items="[&#x22;Setters (2)&#x22;,&#x22;Getters (1)&#x22;,&#x22;Other (5)&#x22;]">
  <ApiTab value="Setters (2)">
    <ApiMember kind="function" name="lv_list_set_button_text" file="widgets/list/lv_list.h" line="77" url="https://github.com/lvgl/lvgl/tree/a7b95c5b0839ce901c09c205610bc2c77cc3345d/src/widgets/list/lv_list.h#L77">
      lv_list_set_button_text [#lv_list_set_button_text]

      Set text of a given list button

      ```c title=" " lineNumbers=1
      void lv_list_set_button_text(lv_obj_t *list, lv_obj_t *btn, const char *txt)
      ```

      <span className="sr-only">
        Parameters
      </span>

      | Name   | Type                                             | Description           |
      | ------ | ------------------------------------------------ | --------------------- |
      | `list` | <ApiLink name="lv_obj_t" display="lv_obj_t *" /> | pointer to a list     |
      | `btn`  | <ApiLink name="lv_obj_t" display="lv_obj_t *" /> | pointer to the button |
      | `txt`  | `const char *`                                   | pointer to the text   |
    </ApiMember>

    <ApiMember kind="function" name="lv_list_set_button_translation_tag" file="widgets/list/lv_list.h" line="104" url="https://github.com/lvgl/lvgl/tree/a7b95c5b0839ce901c09c205610bc2c77cc3345d/src/widgets/list/lv_list.h#L104">
      lv_list_set_button_translation_tag [#lv_list_set_button_translation_tag]

      Set translation tag text of a given list button

      ```c title=" " lineNumbers=1
      void lv_list_set_button_translation_tag(lv_obj_t *list, lv_obj_t *btn, const char *tag)
      ```

      <span className="sr-only">
        Parameters
      </span>

      | Name   | Type                                             | Description                    |
      | ------ | ------------------------------------------------ | ------------------------------ |
      | `list` | <ApiLink name="lv_obj_t" display="lv_obj_t *" /> | pointer to a list              |
      | `btn`  | <ApiLink name="lv_obj_t" display="lv_obj_t *" /> | pointer to the button          |
      | `tag`  | `const char *`                                   | pointer to the translation tag |
    </ApiMember>
  </ApiTab>

  <ApiTab value="Getters (1)">
    <ApiMember kind="function" name="lv_list_get_button_text" file="widgets/list/lv_list.h" line="69" url="https://github.com/lvgl/lvgl/tree/a7b95c5b0839ce901c09c205610bc2c77cc3345d/src/widgets/list/lv_list.h#L69">
      lv_list_get_button_text [#lv_list_get_button_text]

      Get text of a given list button

      ```c title=" " lineNumbers=1
      const char * lv_list_get_button_text(lv_obj_t *list, lv_obj_t *btn)
      ```

      <span className="sr-only">
        Parameters
      </span>

      | Name   | Type                                             | Description           |
      | ------ | ------------------------------------------------ | --------------------- |
      | `list` | <ApiLink name="lv_obj_t" display="lv_obj_t *" /> | pointer to a list     |
      | `btn`  | <ApiLink name="lv_obj_t" display="lv_obj_t *" /> | pointer to the button |

      **Returns:** `const char *` — text of btn, if btn doesn't have text "" will be returned
    </ApiMember>
  </ApiTab>

  <ApiTab value="Other (5)">
    <ApiMember kind="function" name="lv_list_create" file="widgets/list/lv_list.h" line="44" url="https://github.com/lvgl/lvgl/tree/a7b95c5b0839ce901c09c205610bc2c77cc3345d/src/widgets/list/lv_list.h#L44">
      lv_list_create [#lv_list_create]

      Create a list object

      ```c title=" " lineNumbers=1
      lv_obj_t * lv_list_create(lv_obj_t *parent)
      ```

      <span className="sr-only">
        Parameters
      </span>

      | Name     | Type                                             | Description                                                 |
      | -------- | ------------------------------------------------ | ----------------------------------------------------------- |
      | `parent` | <ApiLink name="lv_obj_t" display="lv_obj_t *" /> | pointer to an object, it will be the parent of the new list |

      **Returns:** <ApiLink name="lv_obj_t" display="lv_obj_t *" /> — pointer to the created list
    </ApiMember>

    <ApiMember kind="function" name="lv_list_add_text" file="widgets/list/lv_list.h" line="52" url="https://github.com/lvgl/lvgl/tree/a7b95c5b0839ce901c09c205610bc2c77cc3345d/src/widgets/list/lv_list.h#L52">
      lv_list_add_text [#lv_list_add_text]

      Add text to a list

      ```c title=" " lineNumbers=1
      lv_obj_t * lv_list_add_text(lv_obj_t *list, const char *txt)
      ```

      <span className="sr-only">
        Parameters
      </span>

      | Name   | Type                                             | Description                                               |
      | ------ | ------------------------------------------------ | --------------------------------------------------------- |
      | `list` | <ApiLink name="lv_obj_t" display="lv_obj_t *" /> | pointer to a list, it will be the parent of the new label |
      | `txt`  | `const char *`                                   | text of the new label                                     |

      **Returns:** <ApiLink name="lv_obj_t" display="lv_obj_t *" /> — pointer to the created label
    </ApiMember>

    <ApiMember kind="function" name="lv_list_add_button" file="widgets/list/lv_list.h" line="61" url="https://github.com/lvgl/lvgl/tree/a7b95c5b0839ce901c09c205610bc2c77cc3345d/src/widgets/list/lv_list.h#L61">
      lv_list_add_button [#lv_list_add_button]

      Add button to a list

      ```c title=" " lineNumbers=1
      lv_obj_t * lv_list_add_button(lv_obj_t *list, const void *icon, const char *txt)
      ```

      <span className="sr-only">
        Parameters
      </span>

      | Name   | Type                                             | Description                                                |
      | ------ | ------------------------------------------------ | ---------------------------------------------------------- |
      | `list` | <ApiLink name="lv_obj_t" display="lv_obj_t *" /> | pointer to a list, it will be the parent of the new button |
      | `icon` | `const void *`                                   | icon for the button, when NULL it will have no icon        |
      | `txt`  | `const char *`                                   | text of the new button, when NULL no text will be added    |

      **Returns:** <ApiLink name="lv_obj_t" display="lv_obj_t *" /> — pointer to the created button
    </ApiMember>

    <ApiMember kind="function" name="lv_list_add_translation_tag" file="widgets/list/lv_list.h" line="87" url="https://github.com/lvgl/lvgl/tree/a7b95c5b0839ce901c09c205610bc2c77cc3345d/src/widgets/list/lv_list.h#L87">
      lv_list_add_translation_tag [#lv_list_add_translation_tag]

      Add translation tag text to a list

      ```c title=" " lineNumbers=1
      lv_obj_t * lv_list_add_translation_tag(lv_obj_t *list, const char *tag)
      ```

      <span className="sr-only">
        Parameters
      </span>

      | Name   | Type                                             | Description                                               |
      | ------ | ------------------------------------------------ | --------------------------------------------------------- |
      | `list` | <ApiLink name="lv_obj_t" display="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:** <ApiLink name="lv_obj_t" display="lv_obj_t *" /> — pointer to the created label
    </ApiMember>

    <ApiMember kind="function" name="lv_list_add_button_translation_tag" file="widgets/list/lv_list.h" line="96" url="https://github.com/lvgl/lvgl/tree/a7b95c5b0839ce901c09c205610bc2c77cc3345d/src/widgets/list/lv_list.h#L96">
      lv_list_add_button_translation_tag [#lv_list_add_button_translation_tag]

      Add translation tag button to a list

      ```c title=" " lineNumbers=1
      lv_obj_t * lv_list_add_button_translation_tag(lv_obj_t *list, const void *icon, const char *tag)
      ```

      <span className="sr-only">
        Parameters
      </span>

      | Name   | Type                                             | Description                                                                   |
      | ------ | ------------------------------------------------ | ----------------------------------------------------------------------------- |
      | `list` | <ApiLink name="lv_obj_t" display="lv_obj_t *" /> | pointer to a list, it will be the parent of the new button                    |
      | `icon` | `const void *`                                   | icon for the button, when NULL it will have no icon                           |
      | `tag`  | `const char *`                                   | translation tag of the new button, when NULL no translation tag will be added |

      **Returns:** <ApiLink name="lv_obj_t" display="lv_obj_t *" /> — pointer to the created button
    </ApiMember>
  </ApiTab>
</ApiTabs>

Variables [#variables]

<ApiMember kind="variable" name="lv_list_class" file="widgets/list/lv_list.h" line="32" url="https://github.com/lvgl/lvgl/tree/a7b95c5b0839ce901c09c205610bc2c77cc3345d/src/widgets/list/lv_list.h#L32">
  lv_list_class [#lv_list_class]

  ```c title=" " lineNumbers=1
  const lv_obj_class_t lv_list_class
  ```
</ApiMember>

<ApiMember kind="variable" name="lv_list_text_class" file="widgets/list/lv_list.h" line="33" url="https://github.com/lvgl/lvgl/tree/a7b95c5b0839ce901c09c205610bc2c77cc3345d/src/widgets/list/lv_list.h#L33">
  lv_list_text_class [#lv_list_text_class]

  ```c title=" " lineNumbers=1
  const lv_obj_class_t lv_list_text_class
  ```
</ApiMember>

<ApiMember kind="variable" name="lv_list_button_class" file="widgets/list/lv_list.h" line="34" url="https://github.com/lvgl/lvgl/tree/a7b95c5b0839ce901c09c205610bc2c77cc3345d/src/widgets/list/lv_list.h#L34">
  lv_list_button_class [#lv_list_button_class]

  ```c title=" " lineNumbers=1
  const lv_obj_class_t lv_list_button_class
  ```
</ApiMember>

Dependencies [#dependencies]

<FileIncludes includes="[&#x22;lv_obj.h&#x22;]" transitiveIncludes="[&#x22;lv_anim.h&#x22;, &#x22;lv_area.h&#x22;, &#x22;lv_array.h&#x22;, &#x22;lv_assert.h&#x22;, &#x22;lv_bidi.h&#x22;, &#x22;lv_color.h&#x22;, &#x22;lv_color_op.h&#x22;, &#x22;lv_conf_internal.h&#x22;, &#x22;lv_conf_kconfig.h&#x22;, &#x22;lv_display.h&#x22;, &#x22;lv_draw.h&#x22;, &#x22;lv_draw_arc.h&#x22;, &#x22;lv_draw_blur.h&#x22;, &#x22;lv_draw_buf.h&#x22;, &#x22;lv_draw_image.h&#x22;, &#x22;lv_draw_label.h&#x22;, &#x22;lv_draw_line.h&#x22;, &#x22;lv_draw_rect.h&#x22;, &#x22;lv_draw_triangle.h&#x22;, &#x22;lv_event.h&#x22;, &#x22;lv_ext_data.h&#x22;, &#x22;lv_flex.h&#x22;, &#x22;lv_font.h&#x22;, &#x22;lv_fs.h&#x22;, &#x22;lv_grad.h&#x22;, &#x22;lv_grid.h&#x22;, &#x22;lv_group.h&#x22;, &#x22;lv_image_decoder.h&#x22;, &#x22;lv_image_dsc.h&#x22;, &#x22;lv_indev.h&#x22;, &#x22;lv_layout.h&#x22;, &#x22;lv_ll.h&#x22;, &#x22;lv_log.h&#x22;, &#x22;lv_math.h&#x22;, &#x22;lv_matrix.h&#x22;, &#x22;lv_mem.h&#x22;, &#x22;lv_obj_class.h&#x22;, &#x22;lv_obj_draw.h&#x22;, &#x22;lv_obj_event.h&#x22;, &#x22;lv_obj_pos.h&#x22;, &#x22;lv_obj_property.h&#x22;, &#x22;lv_obj_property_names.h&#x22;, &#x22;lv_obj_scroll.h&#x22;, &#x22;lv_obj_style.h&#x22;, &#x22;lv_obj_style_gen.h&#x22;, &#x22;lv_obj_tree.h&#x22;, &#x22;lv_palette.h&#x22;, &#x22;lv_profiler.h&#x22;, &#x22;lv_profiler_builtin.h&#x22;, &#x22;lv_sprintf.h&#x22;, &#x22;lv_string.h&#x22;, &#x22;lv_style.h&#x22;, &#x22;lv_style_gen.h&#x22;, &#x22;lv_style_properties.h&#x22;, &#x22;lv_symbol_def.h&#x22;, &#x22;lv_text.h&#x22;, &#x22;lv_tick.h&#x22;, &#x22;lv_timer.h&#x22;, &#x22;lv_types.h&#x22;]" />