Skip to content

Latest commit

 

History

History
88 lines (62 loc) · 2.8 KB

spinbox.rst

File metadata and controls

88 lines (62 loc) · 2.8 KB
Raw

Spinbox (lv_spinbox)

Overview

The Spinbox contains a number as text which can be increased or decreased by Keys or API functions. Under the hood the Spinbox is a modified Text area <lv_textarea>.

Parts and Styles

The parts of the Spinbox are identical to the Text area <lv_textarea>.

Value, range and step

  • :cpplv_spinbox_set_value(spinbox, 1234) sets a new value on the Spinbox.

- :cpplv_spinbox_increment(spinbox) and :cpplv_spinbox_decrement(spinbox) increments/decrements the value of the Spinbox according to the currently selected digit. - :cpplv_spinbox_set_range(spinbox, -1000, 2500) sets a range. If the value is changed by :cpplv_spinbox_set_value, by Keys,lv_spinbox_increment/decrement this range will be respected. - :cpplv_spinbox_set_step(spinbox, 100) sets which digits to change on increment/decrement. Only multiples of ten can be set, and not for example 3. - :cpplv_spinbox_set_cursor_pos(spinbox, 1) sets the cursor to a specific digit to change on increment/decrement. For example position '0' sets the cursor to the least significant digit.

If an encoder is used as input device, the selected digit is shifted to the right by default whenever the encoder button is clicked. To change this behaviour to shifting to the left, the :cpplv_spinbox_set_digit_step_direction(spinbox, LV_DIR_LEFT) can be used

Format

:cpplv_spinbox_set_digit_format(spinbox, digit_count, separator_position) sets the number format. digit_count is the number of digits excluding the decimal separator and the sign. separator_position is the number of digits before the decimal point. If 0, no decimal point is displayed.

Rollover

:cpplv_spinbox_set_rollover(spinbox, true/false) enables/disabled rollover mode. If either the minimum or maximum value is reached with rollover enabled, the value will change to the other limit. If rollover is disabled the value will remain at the minimum or maximum value.

Events

  • :cppLV_EVENT_VALUE_CHANGED Sent when the value has changed.

See the events of the Text area <lv_textarea> too.

Learn more about events.

Keys

  • LV_KEY_LEFT/RIGHT With Keypad move the cursor left/right. With Encoder decrement/increment the selected digit.
  • LV_KEY_UP/DOWN With Keypad and Encoder increment/decrement the value.
  • :cppLV_KEY_ENTER With Encoder got the net digit. Jump to the first after the last.

Example

API