docs: fix references, lists, texts (#5193)
This commit is contained in:
PGNetHun
@@ -88,7 +88,7 @@ the screen of ``obj``.
|
||||
Removing styles
|
||||
^^^^^^^^^^^^^^^
|
||||
|
||||
As it's described in the `Using styles <#using-styles>`__ section,
|
||||
As it's described in the :ref:`coord_using_styles` section,
|
||||
coordinates can also be set via style properties. To be more precise,
|
||||
under the hood every style coordinate related property is stored as a
|
||||
style property. If you use :cpp:expr:`lv_obj_set_x(obj, 20)` LVGL saves ``x=20``
|
||||
|
||||
@@ -86,7 +86,7 @@ types are :ref:`Base object <lv_obj>` and :ref:`Image <lv_image>`
|
||||
(to create a wallpaper).
|
||||
|
||||
To create a screen, use
|
||||
``lv_obj_t * scr = lv_<type>_create(NULL)``. `NULL` indicates no parent.
|
||||
:cpp:expr:`lv_obj_t * scr = lv_<type>_create(NULL)`. ``NULL`` indicates no parent.
|
||||
|
||||
To load a screen, use :cpp:expr:`lv_screen_load(scr)`. To get the active screen,
|
||||
use :cpp:expr:`lv_screen_active()`. These functions work on the default display. If
|
||||
|
||||
@@ -33,7 +33,7 @@ In practice, it looks like this:
|
||||
}
|
||||
|
||||
In the example :cpp:enumerator:`LV_EVENT_CLICKED` means that only the click event will
|
||||
call ``my_event_cb``. See the `list of event codes <#event-codes>`__ for
|
||||
call ``my_event_cb``. See the :ref:`list of event codes <events_codes>` for
|
||||
all the options. :cpp:enumerator:`LV_EVENT_ALL` can be used to receive all events.
|
||||
|
||||
The last parameter of :cpp:func:`lv_obj_add_event` is a pointer to any custom
|
||||
@@ -83,6 +83,7 @@ Remove event(s) from widgets
|
||||
}
|
||||
}
|
||||
|
||||
.. _events_codes:
|
||||
|
||||
Event codes
|
||||
***********
|
||||
@@ -114,11 +115,11 @@ Input device events
|
||||
- :cpp:enumerator:`LV_EVENT_CLICKED`: Called on release if not scrolled (regardless to long press)
|
||||
- :cpp:enumerator:`LV_EVENT_RELEASED`: Called in every cases when the object has been released
|
||||
- :cpp:enumerator:`LV_EVENT_SCROLL_BEGIN`: Scrolling begins. The event parameter is a pointer to the animation of the scroll. Can be modified
|
||||
- :cpp:enumerator:`LV_EVENT_SCROLL_THROW_BEGIN,
|
||||
- :cpp:enumerator:`LV_EVENT_SCROLL_THROW_BEGIN`:
|
||||
- :cpp:enumerator:`LV_EVENT_SCROLL_END`: Scrolling ends
|
||||
- :cpp:enumerator:`LV_EVENT_SCROLL`: Scrolling
|
||||
- :cpp:enumerator:`LV_EVENT_GESTURE`: A gesture is detected. Get the gesture with `lv_indev_get_gesture_dir(lv_indev_active());`
|
||||
- :cpp:enumerator:`LV_EVENT_KEY`: A key is sent to the object. Get the key with `lv_indev_get_key(lv_indev_active());`
|
||||
- :cpp:enumerator:`LV_EVENT_GESTURE`: A gesture is detected. Get the gesture with :cpp:expr:`lv_indev_get_gesture_dir(lv_indev_active());`
|
||||
- :cpp:enumerator:`LV_EVENT_KEY`: A key is sent to the object. Get the key with :cpp:expr:`lv_indev_get_key(lv_indev_active());`
|
||||
- :cpp:enumerator:`LV_EVENT_FOCUSED`: The object is focused
|
||||
- :cpp:enumerator:`LV_EVENT_DEFOCUSED`: The object is defocused
|
||||
- :cpp:enumerator:`LV_EVENT_LEAVE`: The object is defocused but still selected
|
||||
@@ -128,8 +129,8 @@ Input device events
|
||||
Drawing events
|
||||
--------------
|
||||
|
||||
- :cpp:enumerator:`LV_EVENT_COVER_CHECK`: Check if the object fully covers an area. The event parameter is `lv_cover_check_info_t *`.
|
||||
- :cpp:enumerator:`LV_EVENT_REFR_EXT_DRAW_SIZE`: Get the required extra draw area around the object (e.g. for shadow). The event parameter is `int32_t *` to store the size.
|
||||
- :cpp:enumerator:`LV_EVENT_COVER_CHECK`: Check if the object fully covers an area. The event parameter is :cpp:type:`lv_cover_check_info_t *`.
|
||||
- :cpp:enumerator:`LV_EVENT_REFR_EXT_DRAW_SIZE`: Get the required extra draw area around the object (e.g. for shadow). The event parameter is :cpp:type:`int32_t *` to store the size.
|
||||
- :cpp:enumerator:`LV_EVENT_DRAW_MAIN_BEGIN`: Starting the main drawing phase
|
||||
- :cpp:enumerator:`LV_EVENT_DRAW_MAIN`: Perform the main drawing
|
||||
- :cpp:enumerator:`LV_EVENT_DRAW_MAIN_END`: Finishing the main drawing phase
|
||||
@@ -226,10 +227,12 @@ contains all data about the event. The following values can be gotten from it:
|
||||
|
||||
- :cpp:expr:`lv_event_get_code(e)`: get the event code
|
||||
- :cpp:expr:`lv_event_get_current_target(e)`: get the object to which an event was sent. I.e. the object whose event handler is being called.
|
||||
- :cpp:expr:`lv_event_get_target(e)`: get the object that originally triggered the event (different from :cpp:func:`lv_event_get_target` if `event bubbling <#event-bubbling>`__ is enabled)
|
||||
- :cpp:expr:`lv_event_get_target(e)`: get the object that originally triggered the event (different from :cpp:func:`lv_event_get_target` if :ref:`event bubbling <events_bubbling>` is enabled)
|
||||
- :cpp:expr:`lv_event_get_user_data(e)`: get the pointer passed as the last parameter of :cpp:func:`lv_obj_add_event`.
|
||||
- :cpp:expr:`lv_event_get_param(e)`: get the parameter passed as the last parameter of :cpp:func:`lv_event_send`
|
||||
|
||||
.. _events_bubbling:
|
||||
|
||||
Event bubbling
|
||||
**************
|
||||
|
||||
|
||||
@@ -75,7 +75,7 @@ bullet symbol (U+2022) and the built-in symbols (see below).
|
||||
Special fonts
|
||||
-------------
|
||||
|
||||
- :c:macro:`LV_FONT_MONTSERRAT_28_COMPRESSED`: Same as normal 28 px font but stored as a `compressed font <#compress-fonts>`__ with 3 bpp
|
||||
- :c:macro:`LV_FONT_MONTSERRAT_28_COMPRESSED`: Same as normal 28 px font but stored as a :ref:`fonts_compressed` with 3 bpp
|
||||
- :c:macro:`LV_FONT_DEJAVU_16_PERSIAN_HEBREW`: 16 px font with normal range + Hebrew, Arabic, Persian letters and all their forms
|
||||
- :c:macro:`LV_FONT_SIMSUN_16_CJK`: 16 px font with normal range plus 1000 of the most common CJK radicals
|
||||
- :c:macro:`LV_FONT_UNSCII_8`: 8 px pixel perfect font with only ASCII characters
|
||||
@@ -199,6 +199,8 @@ match with the library settings. By default, LVGL assumes ``RGB`` order,
|
||||
however this can be swapped by setting :c:macro:`LV_SUBPX_BGR` ``1`` in
|
||||
*lv_conf.h*.
|
||||
|
||||
.. _fonts_compressed:
|
||||
|
||||
Compressed fonts
|
||||
----------------
|
||||
|
||||
|
||||
@@ -15,6 +15,8 @@ You can store images in two places
|
||||
- as a variable in internal memory (RAM or ROM)
|
||||
- as a file
|
||||
|
||||
.. _overview_image_variables:
|
||||
|
||||
Variables
|
||||
---------
|
||||
|
||||
@@ -23,7 +25,7 @@ Images stored internally in a variable are composed mainly of an
|
||||
|
||||
- **header**:
|
||||
|
||||
- *cf*: Color format. See `below <#color-format>`__
|
||||
- *cf*: Color format. See :ref:`below <overview_image_color_formats>`
|
||||
- *w*: width in pixels (<= 2048)
|
||||
- *h*: height in pixels (<= 2048)
|
||||
- *always zero*: 3 bits which need to be always zero
|
||||
@@ -34,6 +36,8 @@ Images stored internally in a variable are composed mainly of an
|
||||
These are usually stored within a project as C files. They are linked
|
||||
into the resulting executable like any other constant data.
|
||||
|
||||
.. _overview_image_files:
|
||||
|
||||
Files
|
||||
-----
|
||||
|
||||
@@ -107,9 +111,9 @@ Adding an image to LVGL via the online converter is easy.
|
||||
|
||||
1. You need to select a *BMP*, *PNG* or *JPG* image first.
|
||||
2. Give the image a name that will be used within LVGL.
|
||||
3. Select the `Color format <#color-formats>`__.
|
||||
3. Select the :ref:`Color format <overview_image_color_formats>`.
|
||||
4. Select the type of image you want. Choosing a binary will generate a
|
||||
``.bin`` file that must be stored separately and read using the `file support <#files>`__.
|
||||
``.bin`` file that must be stored separately and read using the :ref:`file support <overview_image_files>`.
|
||||
Choosing a variable will generate a standard C file that can be linked into your project.
|
||||
5. Hit the *Convert* button. Once the conversion is finished, your
|
||||
browser will automatically download the resulting file.
|
||||
@@ -174,7 +178,7 @@ you want to use it.
|
||||
Image decoder
|
||||
*************
|
||||
|
||||
As you can see in the `Color formats <#color-formats>`__ section, LVGL
|
||||
As you can see in the :ref:`overview_image_color_formats` section, LVGL
|
||||
supports several built-in image formats. In many cases, these will be
|
||||
all you need. LVGL doesn't directly support, however, generic image
|
||||
formats like PNG or JPG.
|
||||
@@ -223,7 +227,7 @@ a fully opaque image, using an alpha channel.
|
||||
|
||||
After decoding, the *raw* formats are considered *True color* by the
|
||||
library. In other words, the image decoder must decode the *Raw* images
|
||||
to *True color* according to the format described in the `Color formats <#color-formats>`__ section.
|
||||
to *True color* according to the format described in the :ref:`overview_image_color_formats` section.
|
||||
|
||||
|
||||
Register an image decoder
|
||||
|
||||
@@ -134,15 +134,15 @@ There are some predefined keys which have special meaning:
|
||||
- :cpp:enumerator:`LV_KEY_HOME`: Go to the beginning/top (E.g. in a :ref:`Text area <lv_textarea>`)
|
||||
- :cpp:enumerator:`LV_KEY_END`: Go to the end (E.g. in a :ref:`Text area <lv_textarea>`)
|
||||
|
||||
The most important special keys In your ``read_cb`` function
|
||||
The most important special keys in your :cpp:func:`read_cb` function are:
|
||||
|
||||
- :cpp:enumerator:`LV_KEY_NEXT`
|
||||
- :cpp:enumerator:`LV_KEY_PREV`
|
||||
- :cpp:enumerator:`LV_KEY_ENTER`,
|
||||
- :cpp:enumerator:`LV_KEY_UP`,
|
||||
- :cpp:enumerator:`LV_KEY_DOWN`,
|
||||
- :cpp:enumerator:`LV_KEY_LEFT`
|
||||
- :cpp:enumerator:`LV_KEY_RIGHT`
|
||||
- :cpp:enumerator:`LV_KEY_NEXT`
|
||||
- :cpp:enumerator:`LV_KEY_PREV`
|
||||
- :cpp:enumerator:`LV_KEY_ENTER`
|
||||
- :cpp:enumerator:`LV_KEY_UP`
|
||||
- :cpp:enumerator:`LV_KEY_DOWN`
|
||||
- :cpp:enumerator:`LV_KEY_LEFT`
|
||||
- :cpp:enumerator:`LV_KEY_RIGHT`
|
||||
|
||||
You should translate some of your keys to these special keys to support navigation
|
||||
in a group and interact with selected objects.
|
||||
|
||||
@@ -1849,7 +1849,7 @@ bg_grad
|
||||
~~~~~~~
|
||||
|
||||
Set the gradient definition. The pointed instance must exist while the
|
||||
object is alive. NULL to disable. It wraps :cpp:enumerator:`BG_GRAD_COLOR`,
|
||||
object is alive. ``NULL`` to disable. It wraps :cpp:enumerator:`BG_GRAD_COLOR`,
|
||||
:cpp:enumerator:`BG_GRAD_DIR`, :cpp:enumerator:`BG_MAIN_STOP` and :cpp:enumerator:`BG_GRAD_STOP` into one
|
||||
descriptor and allows creating gradients with more colors too.
|
||||
|
||||
@@ -2746,7 +2746,7 @@ Properties to describe the shadow drawn under the rectangles.
|
||||
shadow_width
|
||||
~~~~~~~~~~~~
|
||||
|
||||
Set the width of the shadow in pixels. The value should be >= 0.
|
||||
Set the width of the shadow in pixels. The value should be ``>= 0``.
|
||||
|
||||
.. raw:: html
|
||||
|
||||
|
||||
Reference in New Issue
Block a user