summaryrefslogtreecommitdiff
path: root/lib/lvgl/docs/widgets/extra/spinner.md
diff options
context:
space:
mode:
authorjacqueline <me@jacqueline.id.au>2023-06-01 15:41:47 +1000
committerjacqueline <me@jacqueline.id.au>2023-06-01 15:41:47 +1000
commitdd27c3530432ea0b09f01e604bf577f31d8ef841 (patch)
treebbf86cf81a78f0ff0b07f31f1c390db473f26fd3 /lib/lvgl/docs/widgets/extra/spinner.md
parent6fd588e970470b15936187980829916d0dbe77bb (diff)
downloadtangara-fw-dd27c3530432ea0b09f01e604bf577f31d8ef841.tar.gz
convert lvgl from submodule to a plain old directory
Diffstat (limited to 'lib/lvgl/docs/widgets/extra/spinner.md')
m---------lib/lvgl0
-rw-r--r--lib/lvgl/docs/widgets/extra/spinner.md44
2 files changed, 44 insertions, 0 deletions
diff --git a/lib/lvgl b/lib/lvgl
deleted file mode 160000
-Subproject 0732400e7b564dd0e7dc4a924619d8e19c5b23a
diff --git a/lib/lvgl/docs/widgets/extra/spinner.md b/lib/lvgl/docs/widgets/extra/spinner.md
new file mode 100644
index 00000000..8c9b37c9
--- /dev/null
+++ b/lib/lvgl/docs/widgets/extra/spinner.md
@@ -0,0 +1,44 @@
+# Spinner (lv_spinner)
+
+## Overview
+The Spinner object is a spinning arc over a ring.
+
+## Parts and Styles
+The parts are identical to the parts of [lv_arc](/widgets/core/arc).
+
+## Usage
+
+### Create a spinner
+
+To create a spinner use `lv_spinner_create(parent, spin_time, arc_length)`. `spin time` sets the spin time in milliseconds, `arc_length` sets the length of the spinning arc in degrees.
+
+## Events
+No special events are sent to the Spinner.
+
+See the events of the [Arc](/widgets/core/arc) too.
+
+Learn more about [Events](/overview/event).
+
+## Keys
+No *Keys* are processed by the object type.
+
+Learn more about [Keys](/overview/indev).
+
+
+
+## Example
+
+```eval_rst
+
+.. include:: ../../../examples/widgets/spinner/index.rst
+
+```
+
+## API
+
+```eval_rst
+
+.. doxygenfile:: lv_spinner.h
+ :project: lvgl
+
+```