Skip to content

Latest commit

 

History

History
172 lines (118 loc) · 5.09 KB

dropdown.rst

File metadata and controls

172 lines (118 loc) · 5.09 KB
Raw

Drop-down list (lv_dropdown)

Overview

The drop-down list allows the user to select one value from a list.

The drop-down list is closed by default and displays a single value or a predefined text. When activated (by click on the drop-down list), a list is created from which the user may select one option. When the user selects a new value, the list is deleted again.

The Drop-down list is added to the default group (if it is set). Besides the Drop-down list is an editable object to allow selecting an option with encoder navigation too.

Parts and Styles

The Dropdown widget is built from the elements: "button" and "list" (both not related to the button and list widgets)

Button

  • :cppLV_PART_MAIN The background of the button. Uses the typical background properties and text properties for the text on it.
  • :cppLV_PART_INDICATOR Typically an arrow symbol that can be an image or a text (:cppLV_SYMBOL).

The button goes to :cppLV_STATE_CHECKED when it's opened.

List

  • :cppLV_PART_MAIN The list itself. Uses the typical background properties. max_height can be used to limit the height of the list.
  • :cppLV_PART_SCROLLBAR The scrollbar background, border, shadow properties and width (for its own width) and right padding for the spacing on the right.
  • :cppLV_PART_SELECTED Refers to the currently pressed, checked or pressed+checked option. Also uses the typical background properties.

The list is hidden/shown on open/close. To add styles to it use :cpplv_dropdown_get_list(dropdown) to get the list object. For example:

lv_obj_t * list = lv_dropdown_get_list(dropdown) /*Get the list*/
lv_obj_add_style(list, &my_style, selector)      /*Add the styles to the list*/

Alternatively the theme can be extended with the new styles.

Usage

Options

Set options

Options are passed to the drop-down list as a string with :cpplv_dropdown_set_options(dropdown, options). Options should be separated by \n. For example: "First\nSecond\nThird". This string will be saved in the drop-down list, so it can in a local variable.

The :cpplv_dropdown_add_option(dropdown, "New option", pos) function inserts a new option to pos index.

To save memory the options can set from a static(constant) string too with :cpplv_dropdown_set_static_options(dropdown, options). In this case the options string should be alive while the drop-down list exists and :cpplv_dropdown_add_option can't be used

You can select an option manually with :cpplv_dropdown_set_selected(dropdown, id), where id is the index of an option.

Get selected option

The get the index of the selected option, use :cpplv_dropdown_get_selected(dropdown).

:cpplv_dropdown_get_selected_str(dropdown, buf, buf_size) copies the name of the selected option to buf.

Direction

The list can be created on any side. The default :cppLV_DIR_BOTTOM can be modified by :cpplv_dropdown_set_dir(dropdown, LV_DIR_LEFT) function.

If the list would be vertically out of the screen, it will be aligned to the edge.

Symbol

A symbol (typically an arrow) can be added to the dropdown list with :cpplv_dropdown_set_symbol(dropdown, LV_SYMBOL_...)

If the direction of the drop-down list is :cppLV_DIR_LEFT the symbol will be shown on the left, otherwise on the right.

Show selected

The main part can either show the selected option or a static text. If a static is set with :cpplv_dropdown_set_text(dropdown, "Some text") it will be shown regardless to th selected option. If the text is NULL the selected option is displayed on the button.

Manually open/close

To manually open or close the drop-down list the lv_dropdown_open/close(dropdown) function can be used.

Events

Apart from the Generic events, the following Special events are sent by the drop-down list:

  • :cppLV_EVENT_VALUE_CHANGED Sent when the new option is selected or the list is opened/closed.
  • :cppLV_EVENT_CANCEL Sent when the list is closed
  • :cppLV_EVENT_READY Sent when the list is opened

See the events of the Base object <lv_obj> too.

Learn more about events.

Keys

  • LV_KEY_RIGHT/DOWN Select the next option.
  • LV_KEY_LEFT/UP Select the previous option.
  • :cppLV_KEY_ENTER Apply the selected option (Sends :cppLV_EVENT_VALUE_CHANGED event and closes the drop-down list).

Learn more about indev_keys.

Example

API