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

docs(event): add API section

Browse Source
This commit is contained in:
Gabor Kiss-Vamosi
2023-01-03 07:46:32 +01:00
parent 96c4279929
commit 53dd646770
1 changed files with 11 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/overview/event.md
View File

@@ -75,7 +75,7 @@ The following event codes exist:
- `LV_EVENT_CLICKED` Called on release if an object did not scroll (regardless of long press) - `LV_EVENT_CLICKED` Called on release if an object did not scroll (regardless of long press)
- `LV_EVENT_RELEASED` Called in every case when an object has been released - `LV_EVENT_RELEASED` Called in every case when an object has been released
- `LV_EVENT_SCROLL_BEGIN` Scrolling begins. The event parameter is `NULL` or an `lv_anim_t *` with a scroll animation descriptor that can be modified if required. - `LV_EVENT_SCROLL_BEGIN` Scrolling begins. The event parameter is `NULL` or an `lv_anim_t *` with a scroll animation descriptor that can be modified if required.
- `LV_EVENT_SCROLL_THROW_BEGIN` Sent once when the object is released while scrolling but the "momentum" still keeps the content scrolling. - `LV_EVENT_SCROLL_THROW_BEGIN` Sent once when the object is released while scrolling but the "momentum" still keeps the content scrolling.
- `LV_EVENT_SCROLL_END` Scrolling ends. - `LV_EVENT_SCROLL_END` Scrolling ends.
- `LV_EVENT_SCROLL` An object was scrolled - `LV_EVENT_SCROLL` An object was scrolled
- `LV_EVENT_GESTURE` A gesture is detected. Get the gesture with `lv_indev_get_gesture_dir(lv_indev_get_act());` - `LV_EVENT_GESTURE` A gesture is detected. Get the gesture with `lv_indev_get_gesture_dir(lv_indev_get_act());`
@@ -172,3 +172,13 @@ The *target* parameter of the event is always the current target object, not the
.. include:: ../../examples/event/index.rst .. include:: ../../examples/event/index.rst
``` ```
## API
```eval_rst
.. doxygenfile:: lv_event.h
:project: lvgl
```