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

docs: removes non ascii characters (#4175)

Browse Source
This commit is contained in:
Kevin Schlosser
2023-04-27 11:47:13 -06:00
committed by GitHub
parent e485dd8bb4
commit b1df744538
67 changed files with 457 additions and 457 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/widgets/animimg.rst
View File

@@ -4,7 +4,7 @@ Animation Image (lv_animimg)
Overview
********
The animation image is similar to the normal ‘Image’ object. The only
The animation image is similar to the normal 'Image' object. The only
difference is that instead of one source image, you set an array of
multiple source images.

18
docs/widgets/arc.rst
View File

@@ -11,14 +11,14 @@ Parts and Styles
****************
- :cpp:enumerator:`LV_PART_MAIN` Draws a background using the typical background
style properties and an arc using the arc style properties. The arc’s
style properties and an arc using the arc style properties. The arc's
size and position will respect the *padding* style properties.
- :cpp:enumerator:`LV_PART_INDICATOR` Draws another arc using the *arc* style
properties. Its padding values are interpreted relative to the
background arc.
- :cpp:enumerator:`LV_PART_KNOB` Draws a handle on the end of the indicator using all
background properties and padding values. With zero padding the knob
size is the same as the indicator’s width. Larger padding makes it
size is the same as the indicator's width. Larger padding makes it
larger, smaller padding makes it smaller.
Usage
@@ -32,13 +32,13 @@ value is interpreted in a range (minimum and maximum values) which can
be modified with :cpp:expr:`lv_arc_set_range(arc, min, max)`. The default range
is 0..100.
The indicator arc is drawn on the main part’s arc. This if the value is
set to maximum the indicator arc will cover the entire “background” arc.
The indicator arc is drawn on the main part's arc. This if the value is
set to maximum the indicator arc will cover the entire "background" arc.
To set the start and end angle of the background arc use the
:cpp:expr:`lv_arc_set_bg_angles(arc, start_angle, end_angle)` functions or
``lv_arc_set_bg_start/end_angle(arc, angle)``.
Zero degrees is at the middle right (3 o’clock) of the object and the
Zero degrees is at the middle right (3 o'clock) of the object and the
degrees are increasing in clockwise direction. The angles should be in
the [0;360] range.
@@ -81,10 +81,10 @@ relative to the end of the arc The knob offset can be set by
Setting the indicator manually
------------------------------
It’s also possible to set the angles of the indicator arc directly with
It's also possible to set the angles of the indicator arc directly with
:cpp:expr:`lv_arc_set_angles(arc, start_angle, end_angle)` function or
``lv_arc_set_start/end_angle(arc, start_angle)``. In this case the set
“value” and “mode” are ignored.
"value" and "mode" are ignored.
In other words, the angle and value settings are independent. You should
exclusively use one or the other. Mixing the two might result in
@@ -110,14 +110,14 @@ Place another object to the knob
--------------------------------
Another object can be positioned according to the current position of
the arc in order to follow the arc’s current value (angle). To do this
the arc in order to follow the arc's current value (angle). To do this
use :cpp:expr:`lv_arc_align_obj_to_angle(arc, obj_to_align, radius_offset)`.
Similarly
:cpp:expr:`lv_arc_rotate_obj_to_angle(arc, obj_to_rotate, radius_offset)` can be
used to rotate the object to the current value of the arc.
It’s a typical use case to call these functions in the ``VALUE_CHANGED``
It's a typical use case to call these functions in the ``VALUE_CHANGED``
event of the arc.
Events

16
docs/widgets/btnmatrix.rst
View File

@@ -27,7 +27,7 @@ Parts and Styles
Usage
*****
Button’s text
Button's text
-------------
There is a text on each button. To specify them a descriptor string
@@ -38,7 +38,7 @@ that the last element has to be either ``NULL`` or an empty string
(``""``)!
Use ``"\n"`` in the map to insert a **line break**. E.g.
``{"btn1", "btn2", "\n", "btn3", ""}``. Each line’s buttons have their
``{"btn1", "btn2", "\n", "btn3", ""}``. Each line's buttons have their
width calculated automatically. So in the example the first row will
have 2 buttons each with 50% width and a second row with 1 button having
100% width.
@@ -46,10 +46,10 @@ have 2 buttons each with 50% width and a second row with 1 button having
Control buttons
---------------
The buttons’ width can be set relative to the other button in the same
The buttons' width can be set relative to the other button in the same
row with :cpp:expr:`lv_btnmatrix_set_btn_width(btnm, btn_id, width)` E.g. in a
line with two buttons: *btnA, width = 1* and *btnB, width = 2*, *btnA*
will have 33 % width and *btnB* will have 66 % width. It’s similar to
will have 33 % width and *btnB* will have 66 % width. It's similar to
how the
```flex-grow`` <https://developer.mozilla.org/en-US/docs/Web/CSS/flex-grow>`__
property works in CSS. The width must be in the [1..15] range and the
@@ -71,7 +71,7 @@ following parameters:
By default, all flags are disabled.
To set or clear a button’s control attribute, use
To set or clear a button's control attribute, use
``lv_btnmatrix_set_btn_ctrl(btnm, btn_id, LV_BTNM_CTRL_...)`` and
``lv_btnmatrix_clear_btn_ctrl(btnm, btn_id, LV_BTNMATRIX_CTRL_...)``
respectively. More ``LV_BTNM_CTRL_...`` values can be OR-ed
@@ -90,7 +90,7 @@ The number of elements should be equal to the number of buttons
One check
---------
The “One check” feature can be enabled with
The "One check" feature can be enabled with
:cpp:expr:`lv_btnmatrix_set_one_checked(btnm, true)` to allow only one button to
be checked at a time.
@@ -130,11 +130,11 @@ Keys
Note that long pressing the button matrix with an encoder can mean to
enter/leave edit mode and simply long pressing a button to make it
repeat as well. To avoid this contradiction it’s suggested to add
repeat as well. To avoid this contradiction it's suggested to add
:cpp:expr:`lv_btnmatrix_set_btn_ctrl_all(btnm, LV_BTNMATRIX_CTRL_CLICK_TRIG | LV_BTNMATRIX_CTRL_NO_REPEAT)`
to the button matrix if used with encoder. This way, the pressed button
repeat feature is disabled and on leaving edit mode the selected button
won’t be activated.
won't be activated.
Learn more about :ref:`indev_keys`.

8
docs/widgets/calendar.rst
View File

@@ -12,8 +12,8 @@ The Calendar is added to the default group (if it is set). Calendar is
an editable object which allow selecting and clicking the dates with
encoder navigation too.
To make the Calendar flexible, by default it doesn’t show the current
year or month. Instead, there are optional “headers” that can be
To make the Calendar flexible, by default it doesn't show the current
year or month. Instead, there are optional "headers" that can be
attached to the calendar.
Parts and Styles
@@ -28,7 +28,7 @@ object under the hood to arrange the days into a matrix.
- day names have no border, no background and drawn with a gray color
- days of the previous and next month have :cpp:enumerator:`LV_BTNMATRIX_CTRL_DISABLED` flag
- today has a thicker border with the theme’s primary color - highlighted days have some opacity with the theme’s primary color.
- today has a thicker border with the theme's primary color - highlighted days have some opacity with the theme's primary color.
Usage
*****
@@ -55,7 +55,7 @@ Highlighted days
The list of highlighted dates should be stored in a
:cpp:struct:`lv_calendar_date_t` array loaded by
:cpp:expr:`lv_calendar_set_highlighted_dates(calendar, highlighted_dates, date_num)`.
Only the array’s pointer will be saved so the array should be a static
Only the array's pointer will be saved so the array should be a static
or global variable.
Name of the days

12
docs/widgets/canvas.rst
View File

@@ -6,7 +6,7 @@ Overview
A Canvas inherits from `Image </widgets/img>`__ where the user can draw
anything. Rectangles, texts, images, lines, arcs can be drawn here using
lvgl’s drawing engine. Additionally “effects” can be applied, such as
lvgl's drawing engine. Additionally "effects" can be applied, such as
rotation, zoom and blur.
Parts and Styles
@@ -45,18 +45,18 @@ sets pixels with *index=3* to red.
Drawing
-------
To set a pixel’s color on the canvas, use
To set a pixel's color on the canvas, use
:cpp:expr:`lv_canvas_set_px_color(canvas, x, y, LV_COLOR_RED)`. With
``LV_IMG_CF_INDEXED_...`` the index of the color needs to be passed as
color. E.g. ``lv_color_t c; c.full = 3;``
To set a pixel’s opacity with :cpp:enumerator:`LV_IMG_CF_TRUE_COLOR_ALPHA` or
To set a pixel's opacity with :cpp:enumerator:`LV_IMG_CF_TRUE_COLOR_ALPHA` or
``LV_IMG_CF_ALPHA_...`` format on the canvas, use
:cpp:expr:`lv_canvas_set_px_opa(canvas, x, y, opa)`.
:cpp:expr:`lv_canvas_fill_bg(canvas, LV_COLOR_BLUE, LV_OPA_50)` fills the whole
canvas to blue with 50% opacity. Note that if the current color format
doesn’t support colors (e.g. :cpp:enumerator:`LV_IMG_CF_ALPHA_2BIT`) the color will be
doesn't support colors (e.g. :cpp:enumerator:`LV_IMG_CF_ALPHA_2BIT`) the color will be
ignored. Similarly, if opacity is not supported
(e.g. :cpp:enumerator:`LV_IMG_CF_TRUE_COLOR`) it will be ignored.
@@ -78,7 +78,7 @@ which should be first initialized with one of
``lv_draw_rect/label/img/line/arc_dsc_init()`` and then modified with
the desired colors and other values.
The draw function can draw to any color format. For example, it’s
The draw function can draw to any color format. For example, it's
possible to draw a text to an :cpp:enumerator:`LV_IMG_VF_ALPHA_8BIT` canvas and use
the result image as a `draw mask </overview/drawing>`__ later.
@@ -99,7 +99,7 @@ following parameters:
- ``pivot_y`` pivot Y of rotation. Relative to the source canvas. Set to ``source height / 2`` to rotate around the center
- ``antialias`` true: apply anti-aliasing during the transformation. Looks better but slower.
Note that a canvas can’t be rotated on itself. You need a source and
Note that a canvas can't be rotated on itself. You need a source and
destination canvas or image.
Blur

16
docs/widgets/chart.rst
View File

@@ -20,7 +20,7 @@ Parts and Styles
charts ``pad_column`` sets the space between the columns of the
adjacent indices.
- :cpp:enumerator:`LV_PART_SCROLLBAR` The scrollbar used if the chart is zoomed. See
the `Base object </widgets/obj>`__\ ’s documentation for details.
the `Base object </widgets/obj>`__\ 's documentation for details.
- :cpp:enumerator:`LV_PART_ITEMS` Refers to the line or bar series.
- Line chart: The *line* properties are used by the lines.
@@ -49,7 +49,7 @@ The following data display types exist:
- :cpp:enumerator:`LV_CHART_TYPE_NONE`: Do not display any data. Can be used to hide the series.
- :cpp:enumerator:`LV_CHART_TYPE_LINE`: Draw lines between the data points and/or points (rectangles or circles) on the data points.
- :cpp:enumerator:`LV_CHART_TYPE_BAR`: Draw bars.
- :cpp:enumerator:`LV_CHART_TYPE_SCATTER`: X/Y chart drawing point’s and lines between the points. .
- :cpp:enumerator:`LV_CHART_TYPE_SCATTER`: X/Y chart drawing point's and lines between the points. .
You can specify the display type with
:cpp:expr:`lv_chart_set_type(chart, LV_CHART_TYPE_...)`.
@@ -67,13 +67,13 @@ an array for the data points. ``axis`` can have the following values:
- :cpp:enumerator:`LV_CHART_AXIS_PRIMARY_X` Bottom axis
- :cpp:enumerator:`LV_CHART_AXIS_SECONDARY_X` Top axis
``axis`` tells which axis’s range should be used te scale the values.
``axis`` tells which axis's range should be used te scale the values.
:cpp:expr:`lv_chart_set_ext_y_array(chart, ser, value_array)` makes the chart
use an external array for the given series. ``value_array`` should look
like this: ``lv_coord_t * value_array[num_points]``. The array size
needs to be large enough to hold all the points of that series. The
array’s pointer will be saved in the chart so it needs to be global,
array's pointer will be saved in the chart so it needs to be global,
static or dynamically allocated. Note: you should call
:cpp:expr:`lv_chart_refresh(chart)` after the external data source has been
updated to update the chart.
@@ -130,7 +130,7 @@ Handling large number of points
On line charts, if the number of points is greater than the pixels
horizontally, the Chart will draw only vertical lines to make the
drawing of large amount of data effective. If there are, let’s say, 10
drawing of large amount of data effective. If there are, let's say, 10
points to a pixel, LVGL searches the smallest and the largest value and
draws a vertical lines between them to ensure no peaks are missed.
@@ -152,7 +152,7 @@ The number of horizontal and vertical division lines can be modified by
:cpp:expr:`lv_chart_set_div_line_count(chart, hdiv_num, vdiv_num)`. The default
settings are 3 horizontal and 5 vertical division lines. If there is a
visible border on a side and no padding on that side, the division line
would be drawn on top of the border and therefore it won’t be drawn.
would be drawn on top of the border and therefore it won't be drawn.
Override default start point for series
---------------------------------------
@@ -200,11 +200,11 @@ the cursor. ``pos`` is a pointer to an :cpp:struct:`lv_point_t` variable. E.g.
will remain in the same place.
:cpp:expr:`lv_chart_get_point_pos_by_id(chart, series, id, &point_out)` gets the
coordinate of a given point. It’s useful to place the cursor at a given
coordinate of a given point. It's useful to place the cursor at a given
point.
:cpp:expr:`lv_chart_set_cursor_point(chart, cursor, series, point_id)` sticks
the cursor at a point. If the point’s position changes (new value or
the cursor at a point. If the point's position changes (new value or
scrolling) the cursor will move with the point.
Events

10
docs/widgets/checkbox.rst
View File

@@ -4,7 +4,7 @@ Checkbox (lv_checkbox)
Overview
********
The Checkbox object is created from a “tick box” and a label. When the
The Checkbox object is created from a "tick box" and a label. When the
Checkbox is clicked the tick box is toggled.
Parts and Styles
@@ -13,9 +13,9 @@ Parts and Styles
- :cpp:enumerator:`LV_PART_MAIN` The is the background of the Checkbox and it uses
the text and all the typical background style properties.
``pad_column`` adjusts the spacing between the tickbox and the label
- :cpp:enumerator:`LV_PART_INDICATOR` The “tick box” is a square that uses all the
- :cpp:enumerator:`LV_PART_INDICATOR` The "tick box" is a square that uses all the
typical background style properties. By default, its size is equal to
the height of the main part’s font. Padding properties make the tick
the height of the main part's font. Padding properties make the tick
box larger in the respective directions.
The Checkbox is added to the default group (if it is set).
@@ -31,7 +31,7 @@ The text can be modified with the
dynamically allocated.
To set a static text, use :cpp:expr:`lv_checkbox_set_static_text(cb, txt)`. This
way, only a pointer to ``txt`` will be stored. The text then shouldn’t
way, only a pointer to ``txt`` will be stored. The text then shouldn't
be deallocated while the checkbox exists.
Check, uncheck, disable
@@ -69,7 +69,7 @@ Learn more about :ref:`events`.
Keys
****
The following *Keys* are processed by the ‘Buttons’: -
The following *Keys* are processed by the 'Buttons': -
``LV_KEY_RIGHT/UP`` Go to toggled state if toggling is enabled -
``LV_KEY_LEFT/DOWN`` Go to non-toggled state if toggling is enabled -
:cpp:enumerator:`LV_KEY_ENTER` Clicks the checkbox and toggles it

6
docs/widgets/colorwheel.rst
View File

@@ -27,7 +27,7 @@ Create a color wheel
--------------------
:cpp:expr:`lv_colorwheel_create(parent, knob_recolor)` creates a new color
wheel. With ``knob_recolor=true`` the knob’s background color will be
wheel. With ``knob_recolor=true`` the knob's background color will be
set to the current color.
Set color
@@ -57,9 +57,9 @@ Learn more about :ref:`events`.
Keys
****
- :cpp:enumerator:`LV_KEY_UP`, :cpp:enumerator:`LV_KEY_RIGHT` Increment the current parameter’s
- :cpp:enumerator:`LV_KEY_UP`, :cpp:enumerator:`LV_KEY_RIGHT` Increment the current parameter's
value by 1
- :cpp:enumerator:`LV_KEY_DOWN`, :cpp:enumerator:`LV_KEY_LEFT` Decrement the current parameter’s
- :cpp:enumerator:`LV_KEY_DOWN`, :cpp:enumerator:`LV_KEY_LEFT` Decrement the current parameter's
value by 1
- :cpp:enumerator:`LV_KEY_ENTER` A long press will show the next mode. Double click
to reset the current parameter.

6
docs/widgets/dropdown.rst
View File

@@ -18,7 +18,7 @@ with encoder navigation too.
Parts and Styles
****************
The Dropdown widget is built from the elements: “button” and “list”
The Dropdown widget is built from the elements: "button" and "list"
(both not related to the button and list widgets)
Button
@@ -29,7 +29,7 @@ Button
- :cpp:enumerator:`LV_PART_INDICATOR` Typically an arrow symbol that can be an image
or a text (:cpp:enumerator:`LV_SYMBOL`).
The button goes to :cpp:enumerator:`LV_STATE_CHECKED` when it’s opened.
The button goes to :cpp:enumerator:`LV_STATE_CHECKED` when it's opened.
List
----
@@ -74,7 +74,7 @@ inserts a new option to ``pos`` index.
To save memory the options can set from a static(constant) string too
with :cpp:expr:`lv_dropdown_set_static_options(dropdown, options)`. In this case
the options string should be alive while the drop-down list exists and
:cpp:func:`lv_dropdown_add_option` can’t be used
:cpp:func:`lv_dropdown_add_option` can't be used
You can select an option manually with
:cpp:expr:`lv_dropdown_set_selected(dropdown, id)`, where ``id`` is the index of

20
docs/widgets/img.rst
View File

@@ -38,7 +38,7 @@ To make the variable visible in the C file, you need to declare it with
To use external files, you also need to convert the image files using
the online converter tool but now you should select the binary output
format. You also need to use LVGL’s file system module and register a
format. You also need to use LVGL's file system module and register a
driver with some functions for the basic file operation. Go to the
`File system </overview/file-system>`__ to learn more. To set an image sourced
from a file, use :cpp:expr:`lv_img_set_src(img, "S:folder1/my_img.bin")`.
@@ -46,7 +46,7 @@ from a file, use :cpp:expr:`lv_img_set_src(img, "S:folder1/my_img.bin")`.
You can also set a symbol similarly to `Labels </widgets/label>`__. In
this case, the image will be rendered as text according to the *font*
specified in the style. It enables to use of light-weight monochrome
“letters” instead of real images. You can set symbol like
"letters" instead of real images. You can set symbol like
:cpp:expr:`lv_img_set_src(img1, LV_SYMBOL_OK)`.
Label as an image
@@ -67,7 +67,7 @@ handling methods:
- **Chroma-keying** - Pixels with :c:macro:`LV_COLOR_CHROMA_KEY` (*lv_conf.h*)
color will be transparent.
- **Alpha byte** - An alpha byte is added to every pixel that contains
the pixel’s opacity
the pixel's opacity
Palette and Alpha index
-----------------------
@@ -98,13 +98,13 @@ Auto-size
---------
If the width or height of the image object is set to :c:macro:`LV_SIZE_CONTENT`
the object’s size will be set according to the size of the image source
the object's size will be set according to the size of the image source
in the respective direction.
Mosaic
------
If the object’s size is greater than the image size in any directions,
If the object's size is greater than the image size in any directions,
then the image will be repeated like a mosaic. This allows creation a
large image from only a very narrow source. For example, you can have a
*300 x 5* image with a special gradient and set it as a wallpaper using
@@ -117,7 +117,7 @@ With :cpp:expr:`lv_img_set_offset_x(img, x_ofs)` and
:cpp:expr:`lv_img_set_offset_y(img, y_ofs)`, you can add some offset to the
displayed image. Useful if the object size is smaller than the image
source size. Using the offset parameter a `Texture atlas <https://en.wikipedia.org/wiki/Texture_atlas>`__
or a “running image” effect can be created by `Animating </overview/animation>`__ the x or y offset.
or a "running image" effect can be created by `Animating </overview/animation>`__ the x or y offset.
Transformations
***************
@@ -149,7 +149,7 @@ In other words transformations work only on true color images stored as
C array, or if a custom `Image decoder </overview/images#image-edecoder>`__
returns the whole image.
Note that the real coordinates of image objects won’t change during
Note that the real coordinates of image objects won't change during
transformation. That is ``lv_obj_get_width/height/x/y()`` will return
the original, non-zoomed coordinates.
@@ -158,7 +158,7 @@ transformation properties coming from styles. (See
`here </overview/style#opacity-and-transformations>`__). The main
differences are that pure image widget transformation
- doesn’t transform the children of the image widget
- doesn't transform the children of the image widget
- image is transformed directly without creating an intermediate layer (buffer) to snapshot the widget
Size mode
@@ -166,14 +166,14 @@ Size mode
By default, when the image is zoomed or rotated the real coordinates of
the image object are not changed. The larger content simply overflows
the object’s boundaries. It also means the layouts are not affected the
the object's boundaries. It also means the layouts are not affected the
by the transformations.
If you need the object size to be updated to the transformed size set
:cpp:expr:`lv_img_set_size_mode(img, LV_IMG_SIZE_MODE_REAL)`. (The previous mode
is the default and called :cpp:enumerator:`LV_IMG_SIZE_MODE_VIRTUAL`). In this case if
the width/height of the object is set to :c:macro:`LV_SIZE_CONTENT` the
object’s size will be set to the zoomed and rotated size. If an explicit
object's size will be set to the zoomed and rotated size. If an explicit
size is set then the overflowing content will be cropped.
Rounded image

4
docs/widgets/imgbtn.rst
View File

@@ -4,7 +4,7 @@ Image button (lv_imgbtn)
Overview
********
The Image button is very similar to the simple ‘Button’ object. The only
The Image button is very similar to the simple 'Button' object. The only
difference is that it displays user-defined images in each state instead
of drawing a rectangle.
@@ -28,7 +28,7 @@ To set the image in a state, use the
:cpp:expr:`lv_imgbtn_set_src(imgbtn, LV_IMGBTN_STATE_..., src_left, src_center, src_right)`.
The image sources work the same as described in the `Image object </widgets/img>`__
except that “Symbols” are not supported by the Image button. Any of the sources can ``NULL``.
except that "Symbols" are not supported by the Image button. Any of the sources can ``NULL``.
The possible states are:

10
docs/widgets/keyboard.rst
View File

@@ -30,7 +30,7 @@ The Keyboards have the following modes:
- :cpp:enumerator:`LV_KEYBOARD_MODE_NUMBER` Display numbers, +/- sign, and decimal dot
- :cpp:enumerator:`LV_KEYBOARD_MODE_USER_1` through :cpp:enumerator:`LV_KEYBOARD_MODE_USER_4` User-defined modes.
The ``TEXT`` modes’ layout contains buttons to change mode.
The ``TEXT`` modes' layout contains buttons to change mode.
To set the mode manually, use :cpp:expr:`lv_keyboard_set_mode(kb, mode)`. The
default mode is :cpp:enumerator:`LV_KEYBOARD_MODE_TEXT_UPPER`.
@@ -57,7 +57,7 @@ boundaries. To account for this, reserve extra free space on top of the
keyboard or ensure that the keyboard is added *after* any widgets
adjacent to its top boundary so that the popovers can draw over those.
The popovers currently are merely a visual effect and don’t allow
The popovers currently are merely a visual effect and don't allow
selecting additional characters such as accents yet.
New Keymap
@@ -77,9 +77,9 @@ with the original map:
- :c:macro:`LV_SYMBOL_LEFT` Move the cursor left.
- :c:macro:`LV_SYMBOL_RIGHT` Move the cursor right.
- :c:macro:`LV_SYMBOL_NEW_LINE` New line.
- *“ABC”* Load the uppercase map.
- *“abc”* Load the lower case map.
- *“1#”* Load the lower case map.
- *"ABC"* Load the uppercase map.
- *"abc"* Load the lower case map.
- *"1#"* Load the lower case map.
Events
******

16
docs/widgets/label.rst
View File

@@ -13,7 +13,7 @@ Parts and Styles
text properties. The padding values can be used to add space between
the text and the background.
- :cpp:enumerator:`LV_PART_SCROLLBAR` The scrollbar that is shown when the text is
larger than the widget’s size.
larger than the widget's size.
- :cpp:enumerator:`LV_PART_SELECTED` Tells the style of the `selected
text <#text-selection>`__. Only ``text_color`` and ``bg_color`` style
properties can be used.
@@ -27,7 +27,7 @@ Set text
You can set the text on a label at runtime with
:cpp:expr:`lv_label_set_text(label, "New text")`. This will allocate a buffer
dynamically, and the provided string will be copied into that buffer.
Therefore, you don’t need to keep the text you pass to
Therefore, you don't need to keep the text you pass to
:cpp:func:`lv_label_set_text` in scope after that function returns.
With :cpp:expr:`lv_label_set_text_fmt(label, "Value: %d", 15)` printf formatting
@@ -36,7 +36,7 @@ can be used to set the text.
Labels are able to show text from a static character buffer. To do so,
use :cpp:expr:`lv_label_set_text_static(label, "Text")`. In this case, the text
is not stored in the dynamic memory and the given buffer is used
directly instead. This means that the array can’t be a local variable
directly instead. This means that the array can't be a local variable
which goes out of scope when the function exits. Constant strings are
safe to use with :cpp:func:`lv_label_set_text_static` (except when used with
:cpp:enumerator:`LV_LABEL_LONG_DOT`, as it modifies the buffer in-place), as they are
@@ -56,16 +56,16 @@ By default, the width and height of the label is set to
:c:macro:`LV_SIZE_CONTENT`. Therefore, the size of the label is automatically
expanded to the text size. Otherwise, if the width or height are
explicitly set (using e.g.\ :cpp:func:`lv_obj_set_width` or a layout), the lines
wider than the label’s width can be manipulated according to several
wider than the label's width can be manipulated according to several
long mode policies. Similarly, the policies can be applied if the height
of the text is greater than the height of the label.
- :cpp:enumerator:`LV_LABEL_LONG_WRAP` Wrap too long lines. If the height is :c:macro:`LV_SIZE_CONTENT` the label’s
- :cpp:enumerator:`LV_LABEL_LONG_WRAP` Wrap too long lines. If the height is :c:macro:`LV_SIZE_CONTENT` the label's
height will be expanded, otherwise the text will be clipped. (Default)
- :cpp:enumerator:`LV_LABEL_LONG_DOT` Replaces the last 3 characters from bottom right corner of the label with dots (``.``)
- :cpp:enumerator:`LV_LABEL_LONG_SCROLL` If the text is wider than the label scroll it horizontally back and forth. If it’s
- :cpp:enumerator:`LV_LABEL_LONG_SCROLL` If the text is wider than the label scroll it horizontally back and forth. If it's
higher, scroll vertically. Only one direction is scrolled and horizontal scrolling has higher precedence.
- :cpp:enumerator:`LV_LABEL_LONG_SCROLL_CIRCULAR` If the text is wider than the label scroll it horizontally continuously. If it’s
- :cpp:enumerator:`LV_LABEL_LONG_SCROLL_CIRCULAR` If the text is wider than the label scroll it horizontally continuously. If it's
higher, scroll vertically. Only one direction is scrolled and horizontal scrolling has higher precedence.
- :cpp:enumerator:`LV_LABEL_LONG_CLIP` Simply clip the parts of the text outside the label.
@@ -90,7 +90,7 @@ Text selection
--------------
If enabled by :c:macro:`LV_LABEL_TEXT_SELECTION` part of the text can be
selected. It’s similar to when you use your mouse on a PC to select a
selected. It's similar to when you use your mouse on a PC to select a
text. The whole mechanism (click and select the text as you drag your
finger/mouse) is implemented in `Text area </widgets/textarea>`__ and
the Label widget only allows manual text selection with

6
docs/widgets/line.rst
View File

@@ -24,15 +24,15 @@ the object by the :cpp:expr:`lv_line_set_points(lines, point_array, point_cnt)`
function.
Their coordinates can either be specified as raw pixel coordinates
(e.g. ``{5, 10}``), or as a percentage of the line’s bounding box using
:cpp:expr:`lv_pct(x)`. In the latter case, the line’s width/height may need to
(e.g. ``{5, 10}``), or as a percentage of the line's bounding box using
:cpp:expr:`lv_pct(x)`. In the latter case, the line's width/height may need to
be set explicitly using ``lv_obj_set_width/height``, as percentage
values do not automatically expand the bounding box.
Auto-size
---------
By default, the Line’s width and height are set to :c:macro:`LV_SIZE_CONTENT`.
By default, the Line's width and height are set to :c:macro:`LV_SIZE_CONTENT`.
This means it will automatically set its size to fit all the points. If
the size is set explicitly, parts on the line may not be visible.

4
docs/widgets/list.rst
View File

@@ -15,7 +15,7 @@ Parts and Styles
- :cpp:enumerator:`LV_PART_MAIN` The main part of the list that uses all the typical background properties
- :cpp:enumerator:`LV_PART_SCROLLBAR` The scrollbar. See the `Base objects </widgets/obj>`__ documentation for details.
**Buttons and Texts** See the `Button </widgets/btn>`__\ ’s and `Label </widgets/label>`__\ ’s documentation.
**Buttons and Texts** See the `Button </widgets/btn>`__\ 's and `Label </widgets/label>`__\ 's documentation.
Usage
*****
@@ -28,7 +28,7 @@ Buttons
- that can be an image or symbol
- and a text.
The text starts to scroll horizontally if it’s too long.
The text starts to scroll horizontally if it's too long.
Texts
-----

12
docs/widgets/meter.rst
View File

@@ -56,7 +56,7 @@ Needle line
``indic = lv_meter_add_needle_line(meter, line_width, line_color, r_mod)``
adds a needle line to a Scale. By default, the length of the line is the
same as the scale’s radius but ``r_mod`` changes the length.
same as the scale's radius but ``r_mod`` changes the length.
:cpp:expr:`lv_meter_set_indicator_value(meter, indic, value)` sets the value of
the indicator.
@@ -78,7 +78,7 @@ Arc
``indic = lv_meter_add_arc(meter, arc_width, arc_color, r_mod)`` adds
and arc indicator. . By default, the radius of the arc is the same as
the scale’s radius but ``r_mod`` changes the radius.
the scale's radius but ``r_mod`` changes the radius.
:cpp:expr:`lv_meter_set_indicator_start_value(meter, indic, value)` and
:cpp:expr:`lv_meter_set_indicator_end_value(meter, inidicator, value)` sets the
@@ -89,11 +89,11 @@ Scale lines (ticks)
``indic = lv_meter_add_scale_lines(meter, color_start, color_end, local, width_mod)``
adds an indicator that modifies the ticks lines. If ``local`` is
``true`` the ticks’ color will be faded from ``color_start`` to
``color_end`` in the indicator’s start and end value range. If ``local``
``true`` the ticks' color will be faded from ``color_start`` to
``color_end`` in the indicator's start and end value range. If ``local``
is ``false`` ``color_start`` and ``color_end`` will be mapped to the
start and end value of the scale and only a “slice” of that color
gradient will be visible in the indicator’s start and end value range.
start and end value of the scale and only a "slice" of that color
gradient will be visible in the indicator's start and end value range.
``width_mod`` modifies the width of the tick lines.
:cpp:expr:`lv_meter_set_indicator_start_value(meter, inidicator, value)` and

6
docs/widgets/msgbox.rst
View File

@@ -18,7 +18,7 @@ Parts and Styles
****************
The message box is built from other widgets, so you can check these
widgets’ documentation for details.
widgets' documentation for details.
- Background: `lv_obj </widgets/obj>`__
- Close button: `lv_btn </widgets/btn>`__
@@ -36,9 +36,9 @@ creates a message box.
If ``parent`` is ``NULL`` the message box will be modal. ``title`` and
``txt`` are strings for the title and the text. ``btn_txts[]`` is an
array with the buttons’ text. E.g.
array with the buttons' text. E.g.
``const char * btn_txts[] = {"Ok", "Cancel", NULL}``. ``add_close_btn``
can be ``true`` or ``false`` to add/don’t add a close button.
can be ``true`` or ``false`` to add/don't add a close button.
Get the parts
-------------

14
docs/widgets/obj.rst
View File

@@ -4,7 +4,7 @@ Base object (lv_obj)
Overview
********
The ‘Base Object’ implements the basic properties of widgets on a
The 'Base Object' implements the basic properties of widgets on a
screen, such as:
- coordinates
@@ -19,7 +19,7 @@ objects in LVGL are inherited.
The functions and functionalities of the Base object can be used with
other widgets too. For example :cpp:expr:`lv_obj_set_width(slider, 100)`
The Base object can be directly used as a simple widget: it’s nothing
The Base object can be directly used as a simple widget: it's nothing
more than a rectangle. In HTML terms, think of it as a ``<div>``.
Coordinates
@@ -118,11 +118,11 @@ When you have created a screen like
:cpp:expr:`lv_scr_load(screen)`. The :cpp:func:`lv_scr_act` function gives you a
pointer to the active screen.
If you have multiple displays, it’s important to know that the screen
If you have multiple displays, it's important to know that the screen
functions operate on the most recently created display or the one
explicitly selected with :cpp:func:`lv_disp_set_default`.
To get an object’s screen use the :cpp:expr:`lv_obj_get_screen(obj)` function.
To get an object's screen use the :cpp:expr:`lv_obj_get_screen(obj)` function.
Events
------
@@ -156,13 +156,13 @@ Flags
There are some attributes which can be enabled/disabled by
``lv_obj_add/clear_flag(obj, LV_OBJ_FLAG_...)``:
- :cpp:enumerator:`LV_OBJ_FLAG_HIDDEN` Make the object hidden. (Like it wasn’t there at all)
- :cpp:enumerator:`LV_OBJ_FLAG_HIDDEN` Make the object hidden. (Like it wasn't there at all)
- :cpp:enumerator:`LV_OBJ_FLAG_CLICKABLE` Make the object clickable by input devices
- :cpp:enumerator:`LV_OBJ_FLAG_CLICK_FOCUSABLE` Add focused state to the object when clicked
- :cpp:enumerator:`LV_OBJ_FLAG_CHECKABLE` Toggle checked state when the object is clicked
- :cpp:enumerator:`LV_OBJ_FLAG_SCROLLABLE` Make the object scrollable
- :cpp:enumerator:`LV_OBJ_FLAG_SCROLL_ELASTIC` Allow scrolling inside but with slower speed
- :cpp:enumerator:`LV_OBJ_FLAG_SCROLL_MOMENTUM` Make the object scroll further when “thrown”
- :cpp:enumerator:`LV_OBJ_FLAG_SCROLL_MOMENTUM` Make the object scroll further when "thrown"
- :cpp:enumerator:`LV_OBJ_FLAG_SCROLL_ONE` Allow scrolling only one snappable children
- :cpp:enumerator:`LV_OBJ_FLAG_SCROLL_CHAIN_HOR` Allow propagating the horizontal scroll to a parent
- :cpp:enumerator:`LV_OBJ_FLAG_SCROLL_CHAIN_VER` Allow propagating the vertical scroll to a parent
@@ -176,7 +176,7 @@ There are some attributes which can be enabled/disabled by
- :cpp:enumerator:`LV_OBJ_FLAG_ADV_HITTEST` Allow performing more accurate hit (click) test. E.g. accounting for rounded corners
- :cpp:enumerator:`LV_OBJ_FLAG_IGNORE_LAYOUT` Make the object positionable by the layouts
- :cpp:enumerator:`LV_OBJ_FLAG_FLOATING` Do not scroll the object when the parent scrolls and ignore layout
- :cpp:enumerator:`LV_OBJ_FLAG_OVERFLOW_VISIBLE` Do not clip the children’s content to the parent’s boundary
- :cpp:enumerator:`LV_OBJ_FLAG_OVERFLOW_VISIBLE` Do not clip the children's content to the parent's boundary
- :cpp:enumerator:`LV_OBJ_FLAG_LAYOUT_1` Custom flag, free to use by layouts
- :cpp:enumerator:`LV_OBJ_FLAG_LAYOUT_2` Custom flag, free to use by layouts
- :cpp:enumerator:`LV_OBJ_FLAG_WIDGET_1` Custom flag, free to use by widget

2
docs/widgets/roller.rst
View File

@@ -12,7 +12,7 @@ Parts and Styles
- :cpp:enumerator:`LV_PART_MAIN` The background of the roller uses all the typical
background properties and text style properties.
``style_text_line_space`` adjusts the space between the options. When
the Roller is scrolled and doesn’t stop exactly on an option it will
the Roller is scrolled and doesn't stop exactly on an option it will
scroll to the nearest valid option automatically in ``anim_time``
milliseconds as specified in the style.
- :cpp:enumerator:`LV_PART_SELECTED` The selected option in the middle. Besides the

8
docs/widgets/slider.rst
View File

@@ -32,7 +32,7 @@ Value and range
---------------
To set an initial value use :cpp:expr:`lv_slider_set_value(slider, new_value, LV_ANIM_ON/OFF)`. The
animation time is set by the styles’ ``anim_time`` property.
animation time is set by the styles' ``anim_time`` property.
To specify the range (min, max values), :cpp:expr:`lv_slider_set_range(slider, min , max)` can be used.
@@ -60,7 +60,7 @@ desirable to set the slider to react on dragging the knob only. This
feature is enabled by adding the :cpp:enumerator:`LV_OBJ_FLAG_ADV_HITTEST`:
:cpp:expr:`lv_obj_add_flag(slider, LV_OBJ_FLAG_ADV_HITTEST)`.
The extended click area (set by :cpp:expr:`lv_obj_set_ext_click_area(slider, value)`) increases to knob’s click area.
The extended click area (set by :cpp:expr:`lv_obj_set_ext_click_area(slider, value)`) increases to knob's click area.
Events
******
@@ -93,8 +93,8 @@ Learn more about :ref:`events`.
Keys
****
- ``LV_KEY_UP/RIGHT`` Increment the slider’s value by 1
- ``LV_KEY_DOWN/LEFT`` Decrement the slider’s value by 1
- ``LV_KEY_UP/RIGHT`` Increment the slider's value by 1
- ``LV_KEY_DOWN/LEFT`` Decrement the slider's value by 1
Learn more about :ref:`indev_keys`.

2
docs/widgets/span.rst
View File

@@ -33,7 +33,7 @@ Retrieving a span child
-----------------------
Spangroups store their children differently from normal objects, so
normal functions for getting children won’t work.
normal functions for getting children won't work.
:cpp:expr:`lv_spangroup_get_child(spangroup, id)` will return a pointer to the
child span at index ``id``. In addition, ``id`` can be negative to index

2
docs/widgets/spinbox.rst
View File

@@ -30,7 +30,7 @@ value is changed by :cpp:func:`lv_spinbox_set_value`, by
increment/decrement. Only multiples of ten can be set, and not for example 3.
:cpp:expr:`lv_spinbox_set_cursor_pos(spinbox, 1)` sets the cursor to a specific
digit to change on increment/decrement. For example position ‘0’ sets the cursor to the least significant digit.
digit to change on increment/decrement. For example position '0' sets the cursor to the least significant digit.
If an encoder is used as input device, the selected digit is shifted to
the right by default whenever the encoder button is clicked. To change this behaviour to shifting

4
docs/widgets/table.rst
View File

@@ -66,12 +66,12 @@ To merge more adjacent cells call this function for each cell.
Scroll
------
If the label’s width or height is set to :c:macro:`LV_SIZE_CONTENT` that size
If the label's width or height is set to :c:macro:`LV_SIZE_CONTENT` that size
will be used to show the whole table in the respective direction. E.g.
:cpp:expr:`lv_obj_set_size(table, LV_SIZE_CONTENT, LV_SIZE_CONTENT)`
automatically sets the table size to show all the columns and rows.
If the width or height is set to a smaller number than the “intrinsic”
If the width or height is set to a smaller number than the "intrinsic"
size then the table becomes scrollable.
Events

2
docs/widgets/tabview.rst
View File

@@ -41,7 +41,7 @@ Add tabs
New tabs can be added with :cpp:expr:`lv_tabview_add_tab(tabview, "Tab name")`.
This will return a pointer to an `lv_obj </widgets/obj>`__ object where
the tab’s content can be created.
the tab's content can be created.
Rename tabs
-----------

14
docs/widgets/textarea.rst
View File

@@ -25,11 +25,11 @@ Parts and Styles
``bg_color`` style properties can be used. ``bg_color`` should be set
directly on the label of the text area.
- :cpp:enumerator:`LV_PART_CURSOR` Marks the position where the characters are
inserted. The cursor’s area is always the bounding box of the current
inserted. The cursor's area is always the bounding box of the current
character. A block cursor can be created by adding a background color
and background opacity to :cpp:enumerator:`LV_PART_CURSOR`\ ’s style. The create
and background opacity to :cpp:enumerator:`LV_PART_CURSOR`\ 's style. The create
line cursor leave the cursor transparent and set a left border. The
``anim_time`` style property sets the cursor’s blink time.
``anim_time`` style property sets the cursor's blink time.
- :cpp:enumerator:`LV_PART_TEXTAREA_PLACEHOLDER` Unique to Text Area, allows styling
the placeholder text.
@@ -39,7 +39,7 @@ Usage
Add text
--------
You can insert text or characters to the current cursor’s position with:
You can insert text or characters to the current cursor's position with:
- :cpp:expr:`lv_textarea_add_char(textarea, 'c')`
- :cpp:expr:`lv_textarea_add_text(textarea, "insert this text")`
@@ -69,8 +69,8 @@ Move the cursor
The cursor position can be modified directly like
:cpp:expr:`lv_textarea_set_cursor_pos(textarea, 10)`. The ``0`` position means
“before the first characters”, :cpp:enumerator:`LV_TA_CURSOR_LAST` means “after the
last character”
"before the first characters", :cpp:enumerator:`LV_TA_CURSOR_LAST` means "after the
last character"
You can step the cursor with
@@ -135,7 +135,7 @@ scrolling and drawing might be slow. However, by enabling
:c:macro:`LV_LABEL_LONG_TXT_HINT` in ``lv_conf.h`` the performance can be
hugely improved. This will save some additional information about the
label to speed up its drawing. Using :c:macro:`LV_LABEL_LONG_TXT_HINT` the
scrolling and drawing will as fast as with “normal” short texts.
scrolling and drawing will as fast as with "normal" short texts.
Select text
-----------

2
docs/widgets/win.rst
View File

@@ -34,7 +34,7 @@ Title and buttons
Any number of texts (but typically only one) can be added to the header
with :cpp:expr:`lv_win_add_title(win, "The title")`.
Control buttons can be added to the window’s header with
Control buttons can be added to the window's header with
:cpp:expr:`lv_win_add_btn(win, icon, btn_width)`. ``icon`` can be any image
source, and ``btn_width`` is the width of the button.