summaryrefslogtreecommitdiff
path: root/lib/lvgl/docs/widgets/extra/tileview.md
diff options
context:
space:
mode:
Diffstat (limited to 'lib/lvgl/docs/widgets/extra/tileview.md')
m---------lib/lvgl0
-rw-r--r--lib/lvgl/docs/widgets/extra/tileview.md54
2 files changed, 54 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/tileview.md b/lib/lvgl/docs/widgets/extra/tileview.md
new file mode 100644
index 00000000..efe3bc6b
--- /dev/null
+++ b/lib/lvgl/docs/widgets/extra/tileview.md
@@ -0,0 +1,54 @@
+# Tile view (lv_tileview)
+
+## Overview
+
+The Tile view is a container object whose elements (called *tiles*) can be arranged in grid form.
+A user can navigate between the tiles by swiping.
+Any direction of swiping can be disabled on the tiles individually to not allow moving from one tile to another.
+
+If the Tile view is screen sized, the user interface resembles what you may have seen on smartwatches.
+
+## Parts and Styles
+The Tile view is built from an [lv_obj](/widgets/obj) container and [lv_obj](/widgets/obj) tiles.
+
+The parts and styles work the same as for [lv_obj](/widgets/obj).
+
+## Usage
+
+### Add a tile
+
+`lv_tileview_add_tile(tileview, row_id, col_id, dir)` creates a new tile on the `row_id`th row and `col_id`th column.
+`dir` can be `LV_DIR_LEFT/RIGHT/TOP/BOTTOM/HOR/VER/ALL` or OR-ed values to enable moving to the adjacent tiles into the given direction by swiping.
+
+The returned value is an `lv_obj_t *` on which the content of the tab can be created.
+
+### Change tile
+The Tile view can scroll to a tile with `lv_obj_set_tile(tileview, tile_obj, LV_ANIM_ON/OFF)` or `lv_obj_set_tile_id(tileviewv, col_id, row_id, LV_ANIM_ON/OFF);`
+
+
+## Events
+- `LV_EVENT_VALUE_CHANGED` Sent when a new tile loaded by scrolling. `lv_tileview_get_tile_act(tabview)` can be used to get current tile.
+
+## Keys
+*Keys* are not handled by the Tile view.
+
+Learn more about [Keys](/overview/indev).
+
+## Example
+
+
+```eval_rst
+
+.. include:: ../../../examples/widgets/tileview/index.rst
+
+```
+
+
+## API
+
+```eval_rst
+
+.. doxygenfile:: lv_tileview.h
+ :project: lvgl
+
+```