Skip to content

Latest commit

 

History

History
96 lines (65 loc) · 2.74 KB

imagebutton.rst

File metadata and controls

96 lines (65 loc) · 2.74 KB
Raw

Image button (lv_imagebutton)

Overview

The Image button is very similar to the simple 'Button' object. The only difference is that it displays user-defined images in each state instead of drawing a rectangle.

You can set a left, right and center image, and the center image will be repeated to match the width of the object.

Parts and Styles

  • :cppLV_PART_MAIN Refers to the image(s). If background style properties are used, a rectangle will be drawn behind the image button.

Usage

Image sources

To set the image in a state, use the :cpplv_imagebutton_set_src(imagebutton, LV_IMAGEBUTTON_STATE_..., src_left, src_center, src_right).

The image sources work the same as described in the Image object except that "Symbols" are not supported by the Image button. Any of the sources can NULL.

If only src_center is specified, the width of the widget will be set automatically to the width of the image. However, if all three sources are set, the width needs to be set by the user (using e.g. :cpplv_obj_set_width) and the center image will be tiled to fill the given size.

The possible states are:

  • :cppLV_IMAGEBUTTON_STATE_RELEASED
  • :cppLV_IMAGEBUTTON_STATE_PRESSED
  • :cppLV_IMAGEBUTTON_STATE_DISABLED
  • :cppLV_IMAGEBUTTON_STATE_CHECKED_RELEASED
  • :cppLV_IMAGEBUTTON_STATE_CHECKED_PRESSED
  • :cppLV_IMAGEBUTTON_STATE_CHECKED_DISABLED

If you set sources only in :cppLV_IMAGEBUTTON_STATE_RELEASED, these sources will be used in other states too. If you set e.g. :cppLV_IMAGEBUTTON_STATE_PRESSED they will be used in pressed state instead of the released images.

States

Instead of the regular :cpplv_obj_add_state and :cpplv_obj_remove_state functions, the :cpplv_imagebutton_set_state(imagebutton, LV_IMAGEBUTTON_STATE_...) function should be used to manually set a state.

Events

  • :cppLV_EVENT_VALUE_CHANGED Sent when the button is toggled.

Learn more about events.

Keys

  • LV_KEY_RIGHT/UP Go to toggled state if :cppLV_OBJ_FLAG_CHECKABLE is enabled.
  • LV_KEY_LEFT/DOWN Go to non-toggled state if :cppLV_OBJ_FLAG_CHECKABLE is enabled.
  • :cppLV_KEY_ENTER Clicks the button

Learn more about indev_keys.

Example

API