summaryrefslogtreecommitdiff
path: root/lib/lvgl/docs/widgets/spinner.rst
blob: 486230f498002670c7109cb171ef824535a6d003 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
.. _lv_spinner:

====================
Spinner (lv_spinner)
====================

Overview
********

The Spinner object is a spinning arc over a ring.

.. _lv_spinner_parts_and_styles:

Parts and Styles
****************

The parts are identical to the parts of :ref:`lv_arc`.

.. _lv_spinner_usage:

Usage
*****

Create a spinner
----------------

To create a spinner use
:cpp:expr:`lv_spinner_create(parent)`.

Using :cpp:expr:`lv_spinner_set_anim_params(spinner, spin_duration, angle)` the duration
of one revulation and the length of he arc can be customized.

.. _lv_spinner_events:

Events
******

No special events are sent to the Spinner.

See the events of the `Arc </widgets/arc>`__ too.

Learn more about :ref:`events`.

.. _lv_spinner_keys:

Keys
****

No *Keys* are processed by the object type.

Learn more about :ref:`indev_keys`.

.. _lv_spinner_example:

Example
*******

.. include:: ../examples/widgets/spinner/index.rst

.. _lv_spinner_api:

API
***