lv_dropdown.h

lv_dropdown_set_text

Set text of the drop-down list's button. If set to NULL the selected option's text will be displayed on the button. If set to a specific text then that text will be shown regardless of the selected option.

void lv_dropdown_set_text(lv_obj_t *obj, const char *text)

lv_dropdown_set_text_static

Set text of the drop-down list's button. If set to NULL the selected option's text will be displayed on the button. If set to a specific text then that text will be shown regardless of the selected option.

void lv_dropdown_set_text_static(lv_obj_t *obj, const char *text)

lv_dropdown_set_text_translation_tag

Assign a translation tag for the drop-down list's button text. Memory will be allocated to store the tag. The button text will automatically update when the language is changed via lv_translation_set_language.

void lv_dropdown_set_text_translation_tag(lv_obj_t *obj, const char *tag)

lv_dropdown_set_options

Set the options in a drop-down list from a string. The options will be copied and saved in the object so the options can be destroyed after calling this function

void lv_dropdown_set_options(lv_obj_t *obj, const char *options)

lv_dropdown_set_options_static

Set the options in a drop-down list from a static string (global, static or dynamically allocated). Only the pointer of the option string will be saved.

void lv_dropdown_set_options_static(lv_obj_t *obj, const char *options)

lv_dropdown_set_options_translation_tag

Assign a translation tag for the options of the drop-down list. Memory will be allocated to store the tag. The options will automatically update when the language is changed via lv_translation_set_language. The translation should contain the options in a '<br/> ' separated list. E.g. "One\nTwo\nThree"

void lv_dropdown_set_options_translation_tag(lv_obj_t *obj, const char *tag)

lv_dropdown_set_selected

Set the selected option

void lv_dropdown_set_selected(lv_obj_t *obj, uint32_t sel_opt)

lv_dropdown_set_dir

Set the direction of the a drop-down list

void lv_dropdown_set_dir(lv_obj_t *obj, lv_dir_t dir)

lv_dropdown_set_symbol

Set an arrow or other symbol to display when on drop-down list's button. Typically a down caret or arrow.

void lv_dropdown_set_symbol(lv_obj_t *obj, const void *symbol)

lv_dropdown_set_selected_highlight

Set whether the selected option in the list should be highlighted or not

void lv_dropdown_set_selected_highlight(lv_obj_t *obj, bool en)

lv_dropdown_get_list

Get the list of a drop-down to allow styling or other modifications

lv_obj_t * lv_dropdown_get_list(lv_obj_t *obj)

Returns: lv_obj_t * — pointer to the list of the drop-down

lv_dropdown_get_text

Get text of the drop-down list's button.

const char * lv_dropdown_get_text(lv_obj_t *obj)

Returns: const char * — the text as string, NULL if no text

lv_dropdown_get_options

Get the options of a drop-down list

const char * lv_dropdown_get_options(const lv_obj_t *obj)

Returns: const char * — the options separated by '<br/> '-s (E.g. "Option1\nOption2\nOption3")

lv_dropdown_get_selected

Get the index of the selected option

uint32_t lv_dropdown_get_selected(const lv_obj_t *obj)

Returns: uint32_t — index of the selected option (0 ... number of option - 1);

lv_dropdown_get_option_count

Get the total number of options

uint32_t lv_dropdown_get_option_count(const lv_obj_t *obj)

Returns: uint32_t — the total number of options in the list

lv_dropdown_get_selected_str

Get the current selected option as a string

void lv_dropdown_get_selected_str(const lv_obj_t *obj, char *buf, uint32_t buf_size)

lv_dropdown_get_option_index

Get the index of an option.

int32_t lv_dropdown_get_option_index(lv_obj_t *obj, const char *option)

Returns: int32_t — index of option in the list of all options. -1 if not found.

lv_dropdown_get_symbol

Get the symbol on the drop-down list. Typically a down caret or arrow.

const char * lv_dropdown_get_symbol(lv_obj_t *obj)

Returns: const char * — the symbol or NULL if not enabled

lv_dropdown_get_selected_highlight

Get whether the selected option in the list should be highlighted or not

bool lv_dropdown_get_selected_highlight(lv_obj_t *obj)

Returns: bool — true: highlight enabled; false: disabled

lv_dropdown_get_dir

Get the direction of the drop-down list

lv_dir_t lv_dropdown_get_dir(const lv_obj_t *obj)

Returns: lv_dir_t — LV_DIR_LEF/RIGHT/TOP/BOTTOM

lv_dropdown_create

Create a drop-down list object

lv_obj_t * lv_dropdown_create(lv_obj_t *parent)

Returns: lv_obj_t * — pointer to the created drop-down list

lv_dropdown_add_option

Add an options to a drop-down list from a string. Only works for non-static options.

void lv_dropdown_add_option(lv_obj_t *obj, const char *option, uint32_t pos)

lv_dropdown_clear_options

Clear all options in a drop-down list. Works with both static and dynamic options.

void lv_dropdown_clear_options(lv_obj_t *obj)

lv_dropdown_open

Open the drop.down list

void lv_dropdown_open(lv_obj_t *dropdown_obj)

lv_dropdown_close

Close (Collapse) the drop-down list

void lv_dropdown_close(lv_obj_t *obj)

lv_dropdown_is_open

Tells whether the list is opened or not

bool lv_dropdown_is_open(lv_obj_t *obj)

Returns: bool — true if the list os opened

lv_dropdown_bind_value

Bind an integer Subject to a Dropdown's value.

lv_observer_t * lv_dropdown_bind_value(lv_obj_t *obj, lv_subject_t *subject)

Returns: lv_observer_t * — pointer to newly-created Observer