mirror of
https://github.com/lvgl/lvgl.git
synced 2026-05-27 20:57:01 +08:00
docs(examples): remove index.rst files (#10036)
This commit is contained in:
committed by
GitHub
parent
c329a2db34
commit
7f0fadc698
@@ -1,104 +0,0 @@
|
|||||||
# Examples Directory Requirements
|
|
||||||
|
|
||||||
```
|
|
||||||
lvgl/examples/
|
|
||||||
index.rst (directory-order directive since sub-dirs
|
|
||||||
are not presented in alphabetical order)
|
|
||||||
anim/
|
|
||||||
index.rst (see below for expected contents)
|
|
||||||
lv_example_anim_1.c
|
|
||||||
lv_example_anim_2.c
|
|
||||||
lv_example_anim_3.c
|
|
||||||
lv_example_anim_4.c
|
|
||||||
lv_example_anim_timeline_1.c
|
|
||||||
...
|
|
||||||
layouts/
|
|
||||||
flex/
|
|
||||||
index.rst (see below for expected contents)
|
|
||||||
lv_example_flex_1.c
|
|
||||||
lv_example_flex_2.c
|
|
||||||
lv_example_flex_3.c
|
|
||||||
etc.
|
|
||||||
grid/
|
|
||||||
etc.
|
|
||||||
libs/
|
|
||||||
index.rst (section-heading name: "3rd-Party Libraries"
|
|
||||||
[since it is different than parent directory name])
|
|
||||||
barcode/
|
|
||||||
index.rst (see below for expected contents)
|
|
||||||
lv_example_barcode_1.c
|
|
||||||
lv_example_barcode_1.h
|
|
||||||
bmp/
|
|
||||||
etc.
|
|
||||||
etc.
|
|
||||||
etc.
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## index.rst Requirements
|
|
||||||
|
|
||||||
```
|
|
||||||
Example 1 Title <-- required for each example
|
|
||||||
--------------- <-- required for each example
|
|
||||||
<-- blank lines are ignored
|
|
||||||
.. lv_example:: anim/lv_example_anim_1 <-- path relative to the `lvgl/examples/` dir
|
|
||||||
:language: c
|
|
||||||
```
|
|
||||||
|
|
||||||
Repeat the above pattern for each example in current directory. That number may be zero (0) for directories like `libs/` in which all examples are in directories below that level. See directory structure above.
|
|
||||||
|
|
||||||
For paths outside the current directory, simply provide the path to the code example relative to the `lvgl/examples/` directory. Example from `lvgl/examples/widgets/scale/index.rst`:
|
|
||||||
|
|
||||||
```
|
|
||||||
...
|
|
||||||
|
|
||||||
A round scale style simulating a compass
|
|
||||||
----------------------------------------
|
|
||||||
|
|
||||||
.. lv_example:: widgets/scale/lv_example_scale_12
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Axis ticks and labels with scrolling on a chart
|
|
||||||
-----------------------------------------------
|
|
||||||
|
|
||||||
.. lv_example:: widgets/chart/lv_example_chart_2 <-- path is outside scale/ dir
|
|
||||||
:language: c
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Note
|
|
||||||
|
|
||||||
Starting the example code filename with `lv_example_` is not a requirement of the `example_list.py` script, but does make it clear that it is an example, so this pattern should be preserved for new and changed examples.
|
|
||||||
|
|
||||||
|
|
||||||
### Custom Section Headings
|
|
||||||
|
|
||||||
If a section heading needs to be spelled differently than the capitalized name of the parent directory, then an `index.rst` file in that directory may contain the desired section-heading name in an `.. example_heading:` pseudo-directive. Example from `lvgl/examples/libs/index.rst`:
|
|
||||||
|
|
||||||
```
|
|
||||||
.. example_heading: 3rd-Party Libraries
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
### Optional Directory Reordering
|
|
||||||
|
|
||||||
There are cases where it is not appropriate to present the contents of a set of subdirectories in alphabetical order. When this is the case, a pseudo-directive in the `index.rst` file in the parent directory can be specified to govern the sequence its subdirectories are processed. The example below is from `lvgl/examples/widgets/index.rst`. It is provided in order to cause the "Base Widget" (obj) directory to be processed first (and thus included in the output first).
|
|
||||||
|
|
||||||
```rst
|
|
||||||
.. dir_order:
|
|
||||||
|
|
||||||
obj
|
|
||||||
animimg
|
|
||||||
arc
|
|
||||||
arclabel
|
|
||||||
bar
|
|
||||||
button
|
|
||||||
buttonmatrix
|
|
||||||
etc.
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Note
|
|
||||||
|
|
||||||
A warning is issued if either:
|
|
||||||
|
|
||||||
- a subdirectory is named that does not exist, or
|
|
||||||
- a subdirectory exists that is not in the list and not in the `avoid_dirs` list.
|
|
||||||
@@ -1,29 +0,0 @@
|
|||||||
.. example_heading: Animations
|
|
||||||
|
|
||||||
|
|
||||||
Start animation on an event
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
.. lv_example:: anim/lv_example_anim_1
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Playback animation
|
|
||||||
------------------
|
|
||||||
.. lv_example:: anim/lv_example_anim_2
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Cubic Bezier animation
|
|
||||||
----------------------
|
|
||||||
.. lv_example:: anim/lv_example_anim_3
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Pause animation
|
|
||||||
----------------------
|
|
||||||
.. lv_example:: anim/lv_example_anim_4
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Animation timeline
|
|
||||||
------------------
|
|
||||||
.. lv_example:: anim/lv_example_anim_timeline_1
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
@@ -1,37 +0,0 @@
|
|||||||
.. example_heading: Events
|
|
||||||
|
|
||||||
|
|
||||||
Button click event
|
|
||||||
------------------
|
|
||||||
|
|
||||||
.. lv_example:: event/lv_example_event_click
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Click streaks
|
|
||||||
-------------
|
|
||||||
|
|
||||||
.. lv_example:: event/lv_example_event_streak
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Handle multiple events
|
|
||||||
----------------------
|
|
||||||
.. lv_example:: event/lv_example_event_button
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
|
|
||||||
Event bubbling
|
|
||||||
--------------
|
|
||||||
.. lv_example:: event/lv_example_event_bubble
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Event trickle-down
|
|
||||||
------------------
|
|
||||||
.. lv_example:: event/lv_example_event_trickle
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Draw event
|
|
||||||
----------
|
|
||||||
.. lv_example:: event/lv_example_event_draw
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
|
|
||||||
@@ -1,26 +0,0 @@
|
|||||||
.. example_heading: Getting Started
|
|
||||||
|
|
||||||
|
|
||||||
A very simple *hello world* label
|
|
||||||
---------------------------------
|
|
||||||
|
|
||||||
.. lv_example:: get_started/lv_example_get_started_1
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
A button with a label and react on click event
|
|
||||||
----------------------------------------------
|
|
||||||
|
|
||||||
.. lv_example:: get_started/lv_example_get_started_2
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Create styles from scratch for buttons
|
|
||||||
--------------------------------------
|
|
||||||
.. lv_example:: get_started/lv_example_get_started_3
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Create a slider and write its value on a label
|
|
||||||
----------------------------------------------
|
|
||||||
.. lv_example:: get_started/lv_example_get_started_4
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
|
|
||||||
@@ -1,26 +0,0 @@
|
|||||||
.. example_heading: Gradients
|
|
||||||
|
|
||||||
|
|
||||||
Simple Horizontal Gradient
|
|
||||||
--------------------------
|
|
||||||
|
|
||||||
.. lv_example:: grad/lv_example_grad_1
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Linear (Skew) Gradient
|
|
||||||
----------------------
|
|
||||||
|
|
||||||
.. lv_example:: grad/lv_example_grad_2
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Radial Gradient
|
|
||||||
---------------
|
|
||||||
|
|
||||||
.. lv_example:: grad/lv_example_grad_3
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Conical Gradient
|
|
||||||
----------------
|
|
||||||
|
|
||||||
.. lv_example:: grad/lv_example_grad_4
|
|
||||||
:language: c
|
|
||||||
@@ -1,13 +0,0 @@
|
|||||||
.. dir_order:
|
|
||||||
|
|
||||||
get_started
|
|
||||||
styles
|
|
||||||
grad
|
|
||||||
anim
|
|
||||||
event
|
|
||||||
layouts
|
|
||||||
scroll
|
|
||||||
widgets
|
|
||||||
libs
|
|
||||||
others
|
|
||||||
porting
|
|
||||||
@@ -1,37 +0,0 @@
|
|||||||
A simple row and a column layout with flexbox
|
|
||||||
---------------------------------------------
|
|
||||||
|
|
||||||
.. lv_example:: layouts/flex/lv_example_flex_1
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Arrange items in rows with wrap and even spacing
|
|
||||||
------------------------------------------------
|
|
||||||
|
|
||||||
.. lv_example:: layouts/flex/lv_example_flex_2
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Demonstrate flex grow
|
|
||||||
---------------------
|
|
||||||
|
|
||||||
.. lv_example:: layouts/flex/lv_example_flex_3
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Demonstrate flex grow
|
|
||||||
---------------------
|
|
||||||
|
|
||||||
.. lv_example:: layouts/flex/lv_example_flex_4
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Demonstrate column and row gap style properties
|
|
||||||
-----------------------------------------------
|
|
||||||
|
|
||||||
.. lv_example:: layouts/flex/lv_example_flex_5
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
RTL base direction changes order of the items
|
|
||||||
---------------------------------------------
|
|
||||||
|
|
||||||
.. lv_example:: layouts/flex/lv_example_flex_6
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
|
|
||||||
@@ -1,37 +0,0 @@
|
|||||||
A simple grid
|
|
||||||
-------------
|
|
||||||
|
|
||||||
.. lv_example:: layouts/grid/lv_example_grid_1
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Demonstrate cell placement and span
|
|
||||||
-----------------------------------
|
|
||||||
|
|
||||||
.. lv_example:: layouts/grid/lv_example_grid_2
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Demonstrate grid's -free unit-
|
|
||||||
------------------------------
|
|
||||||
|
|
||||||
.. lv_example:: layouts/grid/lv_example_grid_3
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Demonstrate track placement
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
.. lv_example:: layouts/grid/lv_example_grid_4
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Demonstrate column and row gap
|
|
||||||
------------------------------
|
|
||||||
|
|
||||||
.. lv_example:: layouts/grid/lv_example_grid_5
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Demonstrate RTL direction on grid
|
|
||||||
---------------------------------
|
|
||||||
|
|
||||||
.. lv_example:: layouts/grid/lv_example_grid_6
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
|
|
||||||
@@ -1,6 +0,0 @@
|
|||||||
Create a Barcode
|
|
||||||
----------------
|
|
||||||
|
|
||||||
.. lv_example:: libs/barcode/lv_example_barcode_1
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
.. example_heading: BMP
|
|
||||||
|
|
||||||
|
|
||||||
Open a BMP image from file
|
|
||||||
--------------------------
|
|
||||||
|
|
||||||
.. lv_example:: libs/bmp/lv_example_bmp_1
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
.. example_heading: FFmpeg
|
|
||||||
|
|
||||||
|
|
||||||
Decode image
|
|
||||||
------------
|
|
||||||
|
|
||||||
.. lv_example:: libs/ffmpeg/lv_example_ffmpeg_1
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Decode video
|
|
||||||
------------
|
|
||||||
|
|
||||||
.. lv_example:: libs/ffmpeg/lv_example_ffmpeg_2
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
@@ -1,20 +0,0 @@
|
|||||||
.. example_heading: FreeType
|
|
||||||
|
|
||||||
|
|
||||||
Create a font with FreeType
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
.. lv_example:: libs/freetype/lv_example_freetype_1
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Use a bitmap font to draw Emojis using FreeType
|
|
||||||
-----------------------------------------------
|
|
||||||
|
|
||||||
.. lv_example:: libs/freetype/lv_example_freetype_2
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Freetype font kerning
|
|
||||||
---------------------
|
|
||||||
|
|
||||||
.. lv_example:: libs/freetype/lv_example_freetype_3
|
|
||||||
:language: c
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
.. example_heading: GIF
|
|
||||||
|
|
||||||
|
|
||||||
Open a GIF image from file and variable
|
|
||||||
---------------------------------------
|
|
||||||
|
|
||||||
.. lv_example:: libs/gif/lv_example_gif_1
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
@@ -1,28 +0,0 @@
|
|||||||
.. example_heading: glTF
|
|
||||||
|
|
||||||
|
|
||||||
Open a glTF from a file and make it spin forever like a platter
|
|
||||||
---------------------------------------------------------------
|
|
||||||
|
|
||||||
.. lv_example:: libs/gltf/lv_example_gltf_1
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
|
|
||||||
Open a glTF from a file and iterate through each camera
|
|
||||||
-------------------------------------------------------
|
|
||||||
|
|
||||||
.. lv_example:: libs/gltf/lv_example_gltf_2
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Load multiple models in a single glTF object and modify their position, rotation and scale at runtime
|
|
||||||
-----------------------------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
.. lv_example:: libs/gltf/lv_example_gltf_3
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
|
|
||||||
Share a model across different glTF objects
|
|
||||||
-------------------------------------------
|
|
||||||
|
|
||||||
.. lv_example:: libs/gltf/lv_example_gltf_4
|
|
||||||
:language: c
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
.. example_heading: GStreamer
|
|
||||||
|
|
||||||
|
|
||||||
Loads a video from the internet using the gstreamer widget
|
|
||||||
----------------------------------------------------------
|
|
||||||
|
|
||||||
.. lv_example:: libs/gstreamer/lv_example_gstreamer_1
|
|
||||||
:language: c
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
.. example_heading: 3rd-Party Libraries
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
.. example_heading: libjpeg-turbo
|
|
||||||
|
|
||||||
|
|
||||||
Load a JPG image
|
|
||||||
-----------------
|
|
||||||
|
|
||||||
.. lv_example:: libs/libjpeg_turbo/lv_example_libjpeg_turbo_1
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
.. example_heading: libpng
|
|
||||||
|
|
||||||
|
|
||||||
Open a PNG image from file and variable
|
|
||||||
---------------------------------------
|
|
||||||
|
|
||||||
.. lv_example:: libs/libpng/lv_example_libpng_1
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
.. example_heading: LibWebP
|
|
||||||
|
|
||||||
|
|
||||||
Open a WEBP image from file and variable
|
|
||||||
----------------------------------------
|
|
||||||
|
|
||||||
.. lv_example:: libs/libwebp/lv_example_libwebp_1
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
.. example_heading: LodePNG
|
|
||||||
|
|
||||||
|
|
||||||
Open a PNG image from file and variable
|
|
||||||
---------------------------------------
|
|
||||||
|
|
||||||
.. lv_example:: libs/lodepng/lv_example_lodepng_1
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
.. example_heading: QR-Code Generator
|
|
||||||
|
|
||||||
|
|
||||||
Create a QR Code
|
|
||||||
----------------
|
|
||||||
|
|
||||||
.. lv_example:: libs/qrcode/lv_example_qrcode_1
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
.. example_heading: rlottie
|
|
||||||
|
|
||||||
|
|
||||||
Load a Lottie animation from raw data
|
|
||||||
-------------------------------------
|
|
||||||
|
|
||||||
.. lv_example:: libs/rlottie/lv_example_rlottie_1
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Load a Lottie animation from a file
|
|
||||||
-----------------------------------
|
|
||||||
|
|
||||||
.. lv_example:: libs/rlottie/lv_example_rlottie_2
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
@@ -1,20 +0,0 @@
|
|||||||
.. example_heading: SVG
|
|
||||||
|
|
||||||
|
|
||||||
Load and render SVG data
|
|
||||||
------------------------
|
|
||||||
|
|
||||||
.. lv_example:: libs/svg/lv_example_svg_1
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Load and render SVG data from a file
|
|
||||||
------------------------------------
|
|
||||||
|
|
||||||
.. lv_example:: libs/svg/lv_example_svg_2
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Load and render SVG data in a draw event
|
|
||||||
----------------------------------------
|
|
||||||
|
|
||||||
.. lv_example:: libs/svg/lv_example_svg_3
|
|
||||||
:language: c
|
|
||||||
@@ -1,21 +0,0 @@
|
|||||||
.. example_heading: Tiny TTF
|
|
||||||
|
|
||||||
|
|
||||||
Open a font with Tiny TTF from data array
|
|
||||||
------------------------------------------
|
|
||||||
|
|
||||||
.. lv_example:: libs/tiny_ttf/lv_example_tiny_ttf_1
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
|
|
||||||
Load a font with Tiny_TTF from file
|
|
||||||
-----------------------------------
|
|
||||||
|
|
||||||
.. lv_example:: libs/tiny_ttf/lv_example_tiny_ttf_2
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Change font size with Tiny_TTF
|
|
||||||
------------------------------
|
|
||||||
|
|
||||||
.. lv_example:: libs/tiny_ttf/lv_example_tiny_ttf_3
|
|
||||||
:language: c
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
.. example_heading: Tiny JPEG Decompressor (TJpgDec)
|
|
||||||
|
|
||||||
|
|
||||||
Load a JPG image
|
|
||||||
------------------
|
|
||||||
|
|
||||||
.. lv_example:: libs/tjpgd/lv_example_tjpgd_1
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
|
|
||||||
Simple File Explorer
|
|
||||||
--------------------
|
|
||||||
|
|
||||||
.. lv_example:: others/file_explorer/lv_example_file_explorer_1
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Control File Explorer
|
|
||||||
---------------------
|
|
||||||
|
|
||||||
.. lv_example:: others/file_explorer/lv_example_file_explorer_2
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Custom sort
|
|
||||||
-----------
|
|
||||||
|
|
||||||
.. lv_example:: others/file_explorer/lv_example_file_explorer_3
|
|
||||||
:language: c
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
|
|
||||||
Create FreeType Font
|
|
||||||
--------------------
|
|
||||||
|
|
||||||
.. lv_example:: others/font_manager/lv_example_font_manager_1
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Create Font Family
|
|
||||||
------------------
|
|
||||||
|
|
||||||
.. lv_example:: others/font_manager/lv_example_font_manager_2
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Create Custom Image Font
|
|
||||||
------------------------
|
|
||||||
|
|
||||||
.. lv_example:: others/font_manager/lv_example_font_manager_3
|
|
||||||
:language: c
|
|
||||||
@@ -1,14 +0,0 @@
|
|||||||
.. example_heading: Fragment Manager
|
|
||||||
|
|
||||||
|
|
||||||
Basic fragment usage
|
|
||||||
--------------------
|
|
||||||
|
|
||||||
.. lv_example:: others/fragment/lv_example_fragment_1
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Stack navigation example
|
|
||||||
------------------------
|
|
||||||
|
|
||||||
.. lv_example:: others/fragment/lv_example_fragment_2
|
|
||||||
:language: c
|
|
||||||
@@ -1,32 +0,0 @@
|
|||||||
.. example_heading: Grid Navigation
|
|
||||||
|
|
||||||
|
|
||||||
Basic grid navigation
|
|
||||||
---------------------
|
|
||||||
|
|
||||||
.. lv_example:: others/gridnav/lv_example_gridnav_1
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Grid navigation on a list
|
|
||||||
-------------------------
|
|
||||||
|
|
||||||
.. lv_example:: others/gridnav/lv_example_gridnav_2
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Nested grid navigations
|
|
||||||
-----------------------
|
|
||||||
|
|
||||||
.. lv_example:: others/gridnav/lv_example_gridnav_3
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Simple navigation on a list widget
|
|
||||||
----------------------------------
|
|
||||||
|
|
||||||
.. lv_example:: others/gridnav/lv_example_gridnav_4
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Grid navigation for only one axis
|
|
||||||
---------------------------------
|
|
||||||
|
|
||||||
.. lv_example:: others/gridnav/lv_example_gridnav_5
|
|
||||||
:language: c
|
|
||||||
@@ -1,14 +0,0 @@
|
|||||||
.. example_heading: Pinyin IME
|
|
||||||
|
|
||||||
|
|
||||||
Pinyin IME 26 key input
|
|
||||||
-----------------------
|
|
||||||
|
|
||||||
.. lv_example:: others/ime/lv_example_ime_pinyin_1
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Pinyin IME 9 key input
|
|
||||||
----------------------
|
|
||||||
|
|
||||||
.. lv_example:: others/ime/lv_example_ime_pinyin_2
|
|
||||||
:language: c
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
.. example_heading: Image Font
|
|
||||||
|
|
||||||
|
|
||||||
Use emojis in a text.
|
|
||||||
---------------------
|
|
||||||
|
|
||||||
.. lv_example:: others/imgfont/lv_example_imgfont_1
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
|
|
||||||
Touchpad monkey example
|
|
||||||
-----------------------
|
|
||||||
|
|
||||||
.. lv_example:: others/monkey/lv_example_monkey_1
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Encoder monkey example
|
|
||||||
----------------------
|
|
||||||
|
|
||||||
.. lv_example:: others/monkey/lv_example_monkey_2
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Button monkey example
|
|
||||||
---------------------
|
|
||||||
|
|
||||||
.. lv_example:: others/monkey/lv_example_monkey_3
|
|
||||||
:language: c
|
|
||||||
@@ -1,38 +0,0 @@
|
|||||||
|
|
||||||
Bind a slider's value to a label
|
|
||||||
--------------------------------
|
|
||||||
|
|
||||||
.. lv_example:: others/observer/lv_example_observer_1
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Handling login and its states
|
|
||||||
-----------------------------
|
|
||||||
|
|
||||||
.. lv_example:: others/observer/lv_example_observer_2
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Set time with 12/24 mode and AM/PM
|
|
||||||
----------------------------------
|
|
||||||
|
|
||||||
.. lv_example:: others/observer/lv_example_observer_3
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Custom tab view with state management
|
|
||||||
-------------------------------------
|
|
||||||
|
|
||||||
.. lv_example:: others/observer/lv_example_observer_4
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Firmware update process
|
|
||||||
-----------------------
|
|
||||||
|
|
||||||
.. lv_example:: others/observer/lv_example_observer_5
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Modular style update on theme change
|
|
||||||
------------------------------------
|
|
||||||
|
|
||||||
.. lv_example:: others/observer/lv_example_observer_6
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
|
|
||||||
@@ -1,7 +0,0 @@
|
|||||||
Simple snapshot example
|
|
||||||
-----------------------
|
|
||||||
|
|
||||||
.. lv_example:: others/snapshot/lv_example_snapshot_1
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
|
|
||||||
@@ -1,13 +0,0 @@
|
|||||||
Simple translation example
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
.. lv_example:: others/translation/lv_example_translation_1
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Dynamic language selection
|
|
||||||
--------------------------
|
|
||||||
|
|
||||||
.. lv_example:: others/translation/lv_example_translation_2
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
.. example_heading: OS Abstraction Layer (OSAL)
|
|
||||||
|
|
||||||
|
|
||||||
Basic Example
|
|
||||||
-------------
|
|
||||||
|
|
||||||
.. lv_example:: porting/osal/lv_example_osal
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
@@ -1,49 +0,0 @@
|
|||||||
.. example_heading: Scrolling
|
|
||||||
|
|
||||||
Nested scrolling
|
|
||||||
----------------
|
|
||||||
|
|
||||||
.. lv_example:: scroll/lv_example_scroll_1
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Snapping
|
|
||||||
--------
|
|
||||||
.. lv_example:: scroll/lv_example_scroll_2
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Floating button
|
|
||||||
----------------
|
|
||||||
.. lv_example:: scroll/lv_example_scroll_3
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Styling the scrollbars
|
|
||||||
----------------------
|
|
||||||
.. lv_example:: scroll/lv_example_scroll_4
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Right to left scrolling
|
|
||||||
-----------------------
|
|
||||||
.. lv_example:: scroll/lv_example_scroll_5
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Translate on scroll
|
|
||||||
-------------------
|
|
||||||
.. lv_example:: scroll/lv_example_scroll_6
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Infinite scrolling
|
|
||||||
------------------
|
|
||||||
.. lv_example:: scroll/lv_example_scroll_7
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Circular scrolling
|
|
||||||
------------------
|
|
||||||
.. lv_example:: scroll/lv_example_scroll_8
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Scrolling Properties
|
|
||||||
--------------------
|
|
||||||
.. lv_example:: scroll/lv_example_scroll_9
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
|
|
||||||
@@ -1,126 +0,0 @@
|
|||||||
|
|
||||||
Size styles
|
|
||||||
-----------
|
|
||||||
|
|
||||||
.. lv_example:: styles/lv_example_style_1
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Background styles
|
|
||||||
-----------------
|
|
||||||
|
|
||||||
.. lv_example:: styles/lv_example_style_2
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Border styles
|
|
||||||
-------------
|
|
||||||
|
|
||||||
.. lv_example:: styles/lv_example_style_3
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Outline styles
|
|
||||||
--------------
|
|
||||||
|
|
||||||
.. lv_example:: styles/lv_example_style_4
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Shadow styles
|
|
||||||
-------------
|
|
||||||
|
|
||||||
.. lv_example:: styles/lv_example_style_5
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Image styles
|
|
||||||
------------
|
|
||||||
|
|
||||||
.. lv_example:: styles/lv_example_style_6
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Arc styles
|
|
||||||
----------
|
|
||||||
|
|
||||||
.. lv_example:: styles/lv_example_style_7
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Text styles
|
|
||||||
-----------
|
|
||||||
|
|
||||||
.. lv_example:: styles/lv_example_style_8
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Line styles
|
|
||||||
-----------
|
|
||||||
|
|
||||||
.. lv_example:: styles/lv_example_style_9
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Drop shadow styles
|
|
||||||
------------------
|
|
||||||
|
|
||||||
.. lv_example:: styles/lv_example_style_10
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Transition
|
|
||||||
----------
|
|
||||||
|
|
||||||
.. lv_example:: styles/lv_example_style_11
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Using multiple styles
|
|
||||||
---------------------
|
|
||||||
|
|
||||||
.. lv_example:: styles/lv_example_style_12
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Local styles
|
|
||||||
------------
|
|
||||||
|
|
||||||
.. lv_example:: styles/lv_example_style_13
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Add styles to parts and states
|
|
||||||
------------------------------
|
|
||||||
|
|
||||||
.. lv_example:: styles/lv_example_style_14
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Extending the current theme
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
.. lv_example:: styles/lv_example_style_15
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Opacity and Transformations
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
.. lv_example:: styles/lv_example_style_16
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Metallic knob with conic gradient
|
|
||||||
---------------------------------
|
|
||||||
|
|
||||||
.. lv_example:: styles/lv_example_style_17
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Radial gradient as background
|
|
||||||
-----------------------------
|
|
||||||
|
|
||||||
.. lv_example:: styles/lv_example_style_18
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Gradients for button background
|
|
||||||
-------------------------------
|
|
||||||
|
|
||||||
.. lv_example:: styles/lv_example_style_19
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Test between recolor style or full background modal
|
|
||||||
---------------------------------------------------
|
|
||||||
|
|
||||||
.. lv_example:: styles/lv_example_style_20
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Transform style
|
|
||||||
---------------
|
|
||||||
|
|
||||||
.. lv_example:: styles/lv_example_style_21
|
|
||||||
:language: c
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
.. example_heading: Animation Image
|
|
||||||
|
|
||||||
|
|
||||||
Simple Animation Image
|
|
||||||
----------------------
|
|
||||||
|
|
||||||
.. lv_example:: widgets/animimg/lv_example_animimg_1
|
|
||||||
:language: c
|
|
||||||
:description: A simple example to demonstrate the use of an animation image.
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
Simple Arc
|
|
||||||
----------
|
|
||||||
|
|
||||||
.. lv_example:: widgets/arc/lv_example_arc_1
|
|
||||||
:language: c
|
|
||||||
:description: A simple example to demonstrate the use of an arc.
|
|
||||||
|
|
||||||
Loader with Arc
|
|
||||||
---------------
|
|
||||||
|
|
||||||
.. lv_example:: widgets/arc/lv_example_arc_2
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Pie Chart with clickable slices using Arcs
|
|
||||||
------------------------------------------
|
|
||||||
|
|
||||||
.. lv_example:: widgets/arc/lv_example_arc_3
|
|
||||||
:language: c
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
.. example_heading: Arc Label
|
|
||||||
|
|
||||||
|
|
||||||
Simple Arc Label
|
|
||||||
----------------
|
|
||||||
|
|
||||||
.. lv_example:: widgets/arclabel/lv_example_arclabel_1
|
|
||||||
:language: c
|
|
||||||
:description: A simple example to demonstrate the use of an arc label.
|
|
||||||
@@ -1,42 +0,0 @@
|
|||||||
Simple Bar
|
|
||||||
----------
|
|
||||||
|
|
||||||
.. lv_example:: widgets/bar/lv_example_bar_1
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Styling a bar
|
|
||||||
-------------
|
|
||||||
|
|
||||||
.. lv_example:: widgets/bar/lv_example_bar_2
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Temperature meter
|
|
||||||
-----------------
|
|
||||||
|
|
||||||
.. lv_example:: widgets/bar/lv_example_bar_3
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Stripe pattern and range value
|
|
||||||
------------------------------
|
|
||||||
|
|
||||||
.. lv_example:: widgets/bar/lv_example_bar_4
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Bar with LTR and RTL base direction
|
|
||||||
-----------------------------------
|
|
||||||
|
|
||||||
.. lv_example:: widgets/bar/lv_example_bar_5
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Custom drawer to show the current value
|
|
||||||
---------------------------------------
|
|
||||||
|
|
||||||
.. lv_example:: widgets/bar/lv_example_bar_6
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Bar with opposite direction
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
.. lv_example:: widgets/bar/lv_example_bar_7
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
@@ -1,20 +0,0 @@
|
|||||||
|
|
||||||
Simple Buttons
|
|
||||||
--------------
|
|
||||||
|
|
||||||
.. lv_example:: widgets/button/lv_example_button_1
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
|
|
||||||
Styling buttons
|
|
||||||
---------------
|
|
||||||
|
|
||||||
.. lv_example:: widgets/button/lv_example_button_2
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Gummy button
|
|
||||||
------------
|
|
||||||
|
|
||||||
.. lv_example:: widgets/button/lv_example_button_3
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
@@ -1,24 +0,0 @@
|
|||||||
.. example_heading: Button Matrix
|
|
||||||
|
|
||||||
|
|
||||||
Simple Button matrix
|
|
||||||
--------------------
|
|
||||||
|
|
||||||
.. lv_example:: widgets/buttonmatrix/lv_example_buttonmatrix_1
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
|
|
||||||
Custom buttons
|
|
||||||
--------------
|
|
||||||
|
|
||||||
.. lv_example:: widgets/buttonmatrix/lv_example_buttonmatrix_2
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
|
|
||||||
Pagination
|
|
||||||
----------
|
|
||||||
|
|
||||||
.. lv_example:: widgets/buttonmatrix/lv_example_buttonmatrix_3
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
|
|
||||||
Calendar with header
|
|
||||||
--------------------
|
|
||||||
|
|
||||||
.. lv_example:: widgets/calendar/lv_example_calendar_1
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Chinese calendar
|
|
||||||
-------------------------------------
|
|
||||||
|
|
||||||
.. lv_example:: widgets/calendar/lv_example_calendar_2
|
|
||||||
:language: c
|
|
||||||
@@ -1,78 +0,0 @@
|
|||||||
Drawing on the Canvas and rotate
|
|
||||||
--------------------------------
|
|
||||||
|
|
||||||
.. lv_example:: widgets/canvas/lv_example_canvas_1
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Transparent Canvas with chroma keying
|
|
||||||
-------------------------------------
|
|
||||||
|
|
||||||
.. lv_example:: widgets/canvas/lv_example_canvas_2
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
|
|
||||||
Draw a rectangle to the canvas
|
|
||||||
------------------------------
|
|
||||||
|
|
||||||
.. lv_example:: widgets/canvas/lv_example_canvas_3
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
|
|
||||||
Draw a label to the canvas
|
|
||||||
--------------------------
|
|
||||||
|
|
||||||
.. lv_example:: widgets/canvas/lv_example_canvas_4
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
|
|
||||||
Draw an arc to the canvas
|
|
||||||
-------------------------
|
|
||||||
|
|
||||||
.. lv_example:: widgets/canvas/lv_example_canvas_5
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
|
|
||||||
Draw an image to the canvas
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
.. lv_example:: widgets/canvas/lv_example_canvas_6
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
|
|
||||||
Draw a line to the canvas
|
|
||||||
-------------------------
|
|
||||||
|
|
||||||
.. lv_example:: widgets/canvas/lv_example_canvas_7
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Draw a vector graphic to the canvas
|
|
||||||
-----------------------------------
|
|
||||||
|
|
||||||
.. lv_example:: widgets/canvas/lv_example_canvas_8
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Draw a triangle to the canvas
|
|
||||||
-----------------------------
|
|
||||||
|
|
||||||
.. lv_example:: widgets/canvas/lv_example_canvas_9
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Blur an area on the canvas
|
|
||||||
-----------------------------
|
|
||||||
|
|
||||||
.. lv_example:: widgets/canvas/lv_example_canvas_10
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
|
|
||||||
Draw Fancy Letter Effects
|
|
||||||
-------------------------
|
|
||||||
|
|
||||||
.. lv_example:: widgets/canvas/lv_example_canvas_11
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
|
|
||||||
Draw Fancy Letter Effects 2
|
|
||||||
---------------------------
|
|
||||||
.. lv_example:: widgets/canvas/lv_example_canvas_12
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
@@ -1,49 +0,0 @@
|
|||||||
|
|
||||||
Line Chart
|
|
||||||
----------
|
|
||||||
|
|
||||||
.. lv_example:: widgets/chart/lv_example_chart_1
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
|
|
||||||
Axis ticks and labels with scrolling
|
|
||||||
------------------------------------------------
|
|
||||||
|
|
||||||
.. lv_example:: widgets/chart/lv_example_chart_2
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Show the value of the pressed points
|
|
||||||
------------------------------------
|
|
||||||
|
|
||||||
.. lv_example:: widgets/chart/lv_example_chart_3
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Recolor bars based on their value
|
|
||||||
------------------------------------
|
|
||||||
|
|
||||||
.. lv_example:: widgets/chart/lv_example_chart_4
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Faded area line chart with custom division lines
|
|
||||||
---------------------------------------------------
|
|
||||||
|
|
||||||
.. lv_example:: widgets/chart/lv_example_chart_5
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Show cursor on the clicked point
|
|
||||||
--------------------------------
|
|
||||||
|
|
||||||
.. lv_example:: widgets/chart/lv_example_chart_6
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Scatter chart
|
|
||||||
-------------
|
|
||||||
|
|
||||||
.. lv_example:: widgets/chart/lv_example_chart_7
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Circular line chart with gap
|
|
||||||
----------------------------
|
|
||||||
|
|
||||||
.. lv_example:: widgets/chart/lv_example_chart_8
|
|
||||||
:language: c
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
|
|
||||||
Simple Checkboxes
|
|
||||||
-----------------
|
|
||||||
|
|
||||||
.. lv_example:: widgets/checkbox/lv_example_checkbox_1
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Checkboxes as radio buttons
|
|
||||||
---------------------------
|
|
||||||
.. lv_example:: widgets/checkbox/lv_example_checkbox_2
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
@@ -1,20 +0,0 @@
|
|||||||
|
|
||||||
Simple Drop down list
|
|
||||||
---------------------
|
|
||||||
|
|
||||||
.. lv_example:: widgets/dropdown/lv_example_dropdown_1
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Drop down in four directions
|
|
||||||
----------------------------
|
|
||||||
|
|
||||||
.. lv_example:: widgets/dropdown/lv_example_dropdown_2
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
|
|
||||||
Menu
|
|
||||||
----
|
|
||||||
|
|
||||||
.. lv_example:: widgets/dropdown/lv_example_dropdown_3
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
@@ -1,28 +0,0 @@
|
|||||||
|
|
||||||
Image from variable and symbol
|
|
||||||
------------------------------
|
|
||||||
|
|
||||||
.. lv_example:: widgets/image/lv_example_image_1
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
|
|
||||||
Image recoloring
|
|
||||||
----------------
|
|
||||||
|
|
||||||
.. lv_example:: widgets/image/lv_example_image_2
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
|
|
||||||
Rotate and zoom
|
|
||||||
---------------
|
|
||||||
|
|
||||||
.. lv_example:: widgets/image/lv_example_image_3
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
Image offset and styling
|
|
||||||
------------------------
|
|
||||||
|
|
||||||
.. lv_example:: widgets/image/lv_example_image_4
|
|
||||||
:language: c
|
|
||||||
|
|
||||||
|
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user