github-code/lvgl
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: fix links, add references, rename files (#5138)

Browse Source
This commit is contained in:
PGNetHun
2024-01-04 07:25:13 +01:00
committed by GitHub
parent 6136bd6cd0
commit 2a129562d8
94 changed files with 1441 additions and 837 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
docs/widgets/imagebutton.rst
View File

@@ -1,5 +1,8 @@
.. _lv_imagebutton:
=============================
Image button (lv_imagebutton)
========================
=============================
Overview
********
@@ -11,6 +14,8 @@ 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.
.. _lv_imagebutton_parts_and_styles:
Parts and Styles
****************
@@ -18,6 +23,8 @@ Parts and Styles
properties are used, a rectangle will be drawn behind the image
button.
.. _lv_imagebutton_usage:
Usage
*****
@@ -27,7 +34,7 @@ Image sources
To set the image in a state, use the
:cpp:expr:`lv_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 </widgets/img>`__
The image sources work the same as described in the `Image object </widgets/image>`__
except that "Symbols" are not supported by the Image button. Any of the sources can ``NULL``.
The possible states are:
@@ -46,10 +53,12 @@ they will be used in pressed state instead of the released images.
States
------
Instead of the regular ``lv_obj_add/remove_state()`` functions the
:cpp:expr:`lv_imagebutton_set_state(imagebutton, LV_IMAGEBUTTON_STATE_...)` functions should be
Instead of the regular :cpp:func:`lv_obj_add_state`and :cpp:func:`lv_obj_remove_state` functions,
the :cpp:expr:`lv_imagebutton_set_state(imagebutton, LV_IMAGEBUTTON_STATE_...)` function should be
used to manually set a state.
.. _lv_imagebutton_events:
Events
******
@@ -57,6 +66,8 @@ Events
Learn more about :ref:`events`.
.. _lv_imagebutton_keys:
Keys
****
@@ -68,10 +79,14 @@ Keys
Learn more about :ref:`indev_keys`.
.. _lv_imagebutton_example:
Example
*******
.. include:: ../examples/widgets/imgagebutton/index.rst
.. include:: ../examples/widgets/imagebutton/index.rst
.. _lv_imagebutton_api:
API
***