feat(docs): widget proofread wrap-up (#7405)

Co-authored-by: Liam <30486941+liamHowatt@users.noreply.github.com>
This commit is contained in:
Victor Wheeler
2024-12-08 15:13:21 -07:00
committed by GitHub
parent 39c3e23e06
commit 7ecf7c2e52
31 changed files with 173 additions and 169 deletions

View File

@@ -42,7 +42,7 @@ have a choice of several different types of units you can use.
:cpp:expr:`lv_pct(value)` converts ``value`` to a percentage.
E.g. :cpp:expr:`lv_obj_set_width(btn, lv_pct(50))`. If you want
to avoid the overhead of the call to :cpp:func:`lv_pct`, you can
also use the macro :c:macro:`LV_PCT(x)` to mean the same thing.
also use the macro :cpp:expr:`LV_PCT(x)` to mean the same thing.
Note that when you use this feature, your value is *stored as a
percent* so that if/when the size of the parent container (or
other positioning factor) changes, this style value dynamically
@@ -57,7 +57,7 @@ have a choice of several different types of units you can use.
:inches: Specify size as 1/160-th portion of an inch as if it were pixels
on a 160-DPI display, even though a display may have a different
DPI. Use :cpp:expr:`lv_dpx(n)` or :c:macro:`LV_DPX(n)` to do
DPI. Use :cpp:expr:`lv_dpx(n)` or :cpp:expr:`LV_DPX(n)` to do
this. Examples:
+----+-----+----------------------------+
@@ -84,11 +84,11 @@ Boxing Model
LVGL follows CSS's `border-box <https://developer.mozilla.org/en-US/docs/Web/CSS/box-sizing>`__
model. A Widget's "box" is built from the following parts:
- bounding box: the width/height of the elements.
- border width: the width of the border.
- padding: space between the sides of the Widget and its children.
- margin: space outside of the Widget (considered only by some layouts)
- content: the content area which is the size of the bounding box reduced by the border width and padding.
:bounding box: the width/height of the elements.
:border width: the width of the border.
:padding: space between the sides of the Widget and its children.
:margin: space outside of the Widget (considered only by some layouts)
:content: the content area which is the size of the bounding box reduced by the border width and padding.
.. image:: /misc/boxmodel.png
:alt: The box models of LVGL: The content area is smaller than the bounding box with the padding and border width
@@ -391,6 +391,8 @@ position setting. However, to keep the LVGL API lean, only the most
common coordinate setting features have a "simple" version and the more
complex features can be used via styles.
.. _coord_translation:
Translation
@@ -459,6 +461,8 @@ The translation actually moves the Widget. That means it makes the
scrollbars and :c:macro:`LV_SIZE_CONTENT` sized Widgets react to the position
change.
.. _coord_transformation:
Transformation

View File

@@ -765,7 +765,7 @@ Properties to describe the outline. It's like a border but drawn outside of the
outline_width
~~~~~~~~~~~~~
Set width of outline in pixels.
Set width of outline in pixels.
.. raw:: html
@@ -1004,7 +1004,7 @@ Set gap between dashes in pixels. Note that dash works only on horizontal and ve
line_rounded
~~~~~~~~~~~~
Make end points of the lines rounded. `true`: rounded, `false`: perpendicular line ending
Make end points of the lines rounded. `true`: rounded, `false`: perpendicular line ending
.. raw:: html
@@ -1065,7 +1065,7 @@ Set width (thickness) of arcs in pixels.
arc_rounded
~~~~~~~~~~~
Make end points of arcs rounded. `true`: rounded, `false`: perpendicular line ending
Make end points of arcs rounded. `true`: rounded, `false`: perpendicular line ending
.. raw:: html
@@ -1154,7 +1154,7 @@ Set opacity of text. Value 0, `LV_OPA_0` or `LV_OPA_TRANSP` means fully transpar
text_font
~~~~~~~~~
Set font of text (a pointer `lv_font_t *`).
Set font of text (a pointer `lv_font_t *`).
.. raw:: html
@@ -1327,7 +1327,7 @@ The intensity of mixing of color filter.
anim
~~~~
Animation template for Widget's animation. Should be a pointer to `lv_anim_t`. The animation parameters are widget specific, e.g. animation time could be the E.g. blink time of the cursor on the text area or scroll time of a roller. See Widgets' documentation to learn more.
Animation template for Widget's animation. Should be a pointer to `lv_anim_t`. The animation parameters are widget specific, e.g. animation time could be the E.g. blink time of the cursor on the Text Area or scroll time of a roller. See Widgets' documentation to learn more.
.. raw:: html
@@ -1341,7 +1341,7 @@ Animation template for Widget's animation. Should be a pointer to `lv_anim_t`. T
anim_duration
~~~~~~~~~~~~~
Animation duration in milliseconds. Its meaning is widget specific. E.g. blink time of the cursor on the text area or scroll time of a roller. See Widgets' documentation to learn more.
Animation duration in milliseconds. Its meaning is widget specific. E.g. blink time of the cursor on the Text Area or scroll time of a roller. See Widgets' documentation to learn more.
.. raw:: html