docs more spelling fixes (#2499)

This commit is contained in:
ckielstra
2021-08-27 12:15:39 +02:00
committed by GitHub
parent 9f6d911b37
commit 5249a34d5d
60 changed files with 167 additions and 169 deletions

View File

@@ -90,7 +90,7 @@ void lv_disp_load_scr(lv_obj_t * scr)
/**
* Return with the top layer. (Same on every screen and it is above the normal screen layer)
* @param disp pointer to display which top layer should be get. (NULL to use the default screen)
* @return pointer to the top layer object (transparent screen sized lv_obj)
* @return pointer to the top layer object (transparent screen sized lv_obj)
*/
lv_obj_t * lv_disp_get_layer_top(lv_disp_t * disp)
{
@@ -106,8 +106,8 @@ lv_obj_t * lv_disp_get_layer_top(lv_disp_t * disp)
/**
* Return with the sys. layer. (Same on every screen and it is above the normal screen and the top
* layer)
* @param disp pointer to display which sys. layer should be get. (NULL to use the default screen)
* @return pointer to the sys layer object (transparent screen sized lv_obj)
* @param disp pointer to display which sys. layer should be retrieved. (NULL to use the default screen)
* @return pointer to the sys layer object (transparent screen sized lv_obj)
*/
lv_obj_t * lv_disp_get_layer_sys(lv_disp_t * disp)
{
@@ -121,9 +121,8 @@ lv_obj_t * lv_disp_get_layer_sys(lv_disp_t * disp)
}
/**
* Get the theme of a display
* Set the theme of a display
* @param disp pointer to a display
* @return the display's theme (can be NULL)
*/
void lv_disp_set_theme(lv_disp_t * disp, lv_theme_t * th)
{
@@ -191,7 +190,7 @@ void lv_disp_set_bg_image(lv_disp_t * disp, const void * img_src)
}
/**
* Opacity of the background
* Set opacity of the background
* @param disp pointer to a display
* @param opa opacity (0..255)
*/
@@ -329,7 +328,7 @@ void lv_scr_load_anim(lv_obj_t * new_scr, lv_scr_load_anim_t anim_type, uint32_t
/**
* Get elapsed time since last user activity on a display (e.g. click)
* @param disp pointer to an display (NULL to get the overall smallest inactivity)
* @param disp pointer to a display (NULL to get the overall smallest inactivity)
* @return elapsed ticks (milliseconds) since the last activity
*/
uint32_t lv_disp_get_inactive_time(const lv_disp_t * disp)
@@ -350,7 +349,7 @@ uint32_t lv_disp_get_inactive_time(const lv_disp_t * disp)
/**
* Manually trigger an activity on a display
* @param disp pointer to an display (NULL to use the default display)
* @param disp pointer to a display (NULL to use the default display)
*/
void lv_disp_trig_activity(lv_disp_t * disp)
{
@@ -365,7 +364,7 @@ void lv_disp_trig_activity(lv_disp_t * disp)
/**
* Clean any CPU cache that is related to the display.
* @param disp pointer to an display (NULL to use the default display)
* @param disp pointer to a display (NULL to use the default display)
*/
void lv_disp_clean_dcache(lv_disp_t * disp)
{

View File

@@ -67,22 +67,21 @@ void lv_disp_load_scr(lv_obj_t * scr);
/**
* Return with the top layer. (Same on every screen and it is above the normal screen layer)
* @param disp pointer to display which top layer should be get. (NULL to use the default screen)
* @return pointer to the top layer object (transparent screen sized lv_obj)
* @return pointer to the top layer object (transparent screen sized lv_obj)
*/
lv_obj_t * lv_disp_get_layer_top(lv_disp_t * disp);
/**
* Return with the sys. layer. (Same on every screen and it is above the normal screen and the top
* layer)
* @param disp pointer to display which sys. layer should be get. (NULL to use the default screen)
* @return pointer to the sys layer object (transparent screen sized lv_obj)
* @param disp pointer to display which sys. layer should be retrieved. (NULL to use the default screen)
* @return pointer to the sys layer object (transparent screen sized lv_obj)
*/
lv_obj_t * lv_disp_get_layer_sys(lv_disp_t * disp);
/**
* Get the theme of a display
* Set the theme of a display
* @param disp pointer to a display
* @return the display's theme (can be NULL)
*/
void lv_disp_set_theme(lv_disp_t * disp, lv_theme_t * th);
@@ -108,7 +107,7 @@ void lv_disp_set_bg_color(lv_disp_t * disp, lv_color_t color);
void lv_disp_set_bg_image(lv_disp_t * disp, const void * img_src);
/**
* Opacity of the background
* Set opacity of the background
* @param disp pointer to a display
* @param opa opacity (0..255)
*/
@@ -126,20 +125,20 @@ void lv_scr_load_anim(lv_obj_t * scr, lv_scr_load_anim_t anim_type, uint32_t tim
/**
* Get elapsed time since last user activity on a display (e.g. click)
* @param disp pointer to an display (NULL to get the overall smallest inactivity)
* @param disp pointer to a display (NULL to get the overall smallest inactivity)
* @return elapsed ticks (milliseconds) since the last activity
*/
uint32_t lv_disp_get_inactive_time(const lv_disp_t * disp);
/**
* Manually trigger an activity on a display
* @param disp pointer to an display (NULL to use the default display)
* @param disp pointer to a display (NULL to use the default display)
*/
void lv_disp_trig_activity(lv_disp_t * disp);
/**
* Clean any CPU cache that is related to the display.
* @param disp pointer to an display (NULL to use the default display)
* @param disp pointer to a display (NULL to use the default display)
*/
void lv_disp_clean_dcache(lv_disp_t * disp);
@@ -229,7 +228,7 @@ static inline lv_coord_t lv_dpx(lv_coord_t n)
* considering the DPI of the given display.
* It ensures that e.g. `lv_dpx(100)` will have the same physical size regardless to the
* DPI of the display.
* @param obj an display whose dpi should be considered
* @param obj a display whose dpi should be considered
* @param n the number of pixels to scale
* @return `n x current_dpi/160`
*/

View File

@@ -193,8 +193,8 @@ uint32_t lv_event_register_id(void);
/**
* Nested events can be called and one of them might belong to an object that is being deleted.
* Mark this object's `event_temp_data` deleted to know that it's `lv_event_send` should return `LV_RES_INV`
* @param obj pointer to an obejct to mark as deleted
* Mark this object's `event_temp_data` deleted to know that its `lv_event_send` should return `LV_RES_INV`
* @param obj pointer to an object to mark as deleted
*/
void _lv_event_mark_deleted(struct _lv_obj_t * obj);

View File

@@ -242,10 +242,10 @@ static lv_obj_t * find_scroll_obj(_lv_indev_proc_t * proc)
lv_indev_t * indev_act = lv_indev_get_act();
lv_coord_t scroll_limit = indev_act->driver->scroll_limit;
/*Go until find an scrollable object in the current direction
/*Go until find a scrollable object in the current direction
*More precisely:
* 1. Check the pressed object and all of its ancestors and try to find an object which is scrollable
* 2. Scrollable means it has some content out of it's area
* 2. Scrollable means it has some content out of its area
* 3. If an object can be scrolled into the current direction then use it ("real match"")
* 4. If can be scrolled on the current axis (hor/ver) save it as candidate (at least show an elastic scroll effect)
* 5. Use the last candidate. Always the "deepest" parent or the object from point 3*/
@@ -402,8 +402,8 @@ static void init_scroll_limits(_lv_indev_proc_t * proc)
/**
* Search for snap point in the `min` - `max` range.
* @param obj the object on which snap point should be found
* @param min ignore snap points smaller then this. (Absolute coordinate)
* @param max ignore snap points greater then this. (Absolute coordinate)
* @param min ignore snap points smaller than this. (Absolute coordinate)
* @param max ignore snap points greater than this. (Absolute coordinate)
* @param ofs offset to snap points. Useful the get a snap point in an imagined case
* what if children are already moved by this value
* @return the distance of the snap point.
@@ -457,9 +457,9 @@ static lv_coord_t find_snap_point_x(const lv_obj_t * obj, lv_coord_t min, lv_coo
/**
* Search for snap point in the `min` - `max` range.
* @param obj the object on which snap point should be found
* @param min ignore snap points smaller then this. (Absolute coordinate)
* @param max ignore snap points greater then this. (Absolute coordinate)
* @param ofs offset to snap points. Useful the get a snap point in an imagined case
* @param min ignore snap points smaller than this. (Absolute coordinate)
* @param max ignore snap points greater than this. (Absolute coordinate)
* @param ofs offset to snap points. Useful to get a snap point in an imagined case
* what if children are already moved by this value
* @return the distance of the snap point.
*/

View File

@@ -62,8 +62,8 @@ typedef struct
* Initialize a rectangle draw descriptor from an object's styles in its current state
* @param obj pointer to an object
* @param part part of the object. E.g. `LV_PART_MAIN`, `LV_PART_SCROLLBAR`, `LV_PART_KNOB`, etc
* @param draw_dsc the descriptor the initialize.
* If an `..._opa` filed is set to `LV_OPA_TRANSP` the related properties won't be initialized.
* @param draw_dsc the descriptor to initialize.
* If an `..._opa` field is set to `LV_OPA_TRANSP` the related properties won't be initialized.
* Should be initialized with `lv_draw_rect_dsc_init(draw_dsc)`.
* @note Only the relevant fields will be set.
* E.g. if `border width == 0` the other border properties won't be evaluated.
@@ -74,8 +74,8 @@ void lv_obj_init_draw_rect_dsc(struct _lv_obj_t * obj, uint32_t part, lv_draw_re
* Initialize a label draw descriptor from an object's styles in its current state
* @param obj pointer to an object
* @param part part of the object. E.g. `LV_PART_MAIN`, `LV_PART_SCROLLBAR`, `LV_PART_KNOB`, etc
* @param draw_dsc the descriptor the initialize.
* If the `opa` filed is set to or the property is equal to `LV_OPA_TRANSP` the rest won't be initialized.
* @param draw_dsc the descriptor to initialize.
* If the `opa` field is set to or the property is equal to `LV_OPA_TRANSP` the rest won't be initialized.
* Should be initialized with `lv_draw_label_dsc_init(draw_dsc)`.
*/
void lv_obj_init_draw_label_dsc(struct _lv_obj_t * obj, uint32_t part, lv_draw_label_dsc_t * draw_dsc);
@@ -84,7 +84,7 @@ void lv_obj_init_draw_label_dsc(struct _lv_obj_t * obj, uint32_t part, lv_draw_l
* Initialize an image draw descriptor from an object's styles in its current state
* @param obj pointer to an object
* @param part part of the object. E.g. `LV_PART_MAIN`, `LV_PART_SCROLLBAR`, `LV_PART_KNOB`, etc
* @param draw_dsc the descriptor the initialize.
* @param draw_dsc the descriptor to initialize.
* Should be initialized with `lv_draw_image_dsc_init(draw_dsc)`.
*/
void lv_obj_init_draw_img_dsc(struct _lv_obj_t * obj, uint32_t part, lv_draw_img_dsc_t * draw_dsc);
@@ -94,7 +94,7 @@ void lv_obj_init_draw_img_dsc(struct _lv_obj_t * obj, uint32_t part, lv_draw_img
* Initialize a line draw descriptor from an object's styles in its current state
* @param obj pointer to an object
* @param part part of the object. E.g. `LV_PART_MAIN`, `LV_PART_SCROLLBAR`, `LV_PART_KNOB`, etc
* @param draw_dsc the descriptor the initialize.
* @param draw_dsc the descriptor to initialize.
* Should be initialized with `lv_draw_line_dsc_init(draw_dsc)`.
*/
void lv_obj_init_draw_line_dsc(struct _lv_obj_t * obj, uint32_t part, lv_draw_line_dsc_t * draw_dsc);
@@ -103,7 +103,7 @@ void lv_obj_init_draw_line_dsc(struct _lv_obj_t * obj, uint32_t part, lv_draw_li
* Initialize an arc draw descriptor from an object's styles in its current state
* @param obj pointer to an object
* @param part part of the object. E.g. `LV_PART_MAIN`, `LV_PART_SCROLLBAR`, `LV_PART_KNOB`, etc
* @param draw_dsc the descriptor the initialize.
* @param draw_dsc the descriptor to initialize.
* Should be initialized with `lv_draw_arc_dsc_init(draw_dsc)`.
*/
void lv_obj_init_draw_arc_dsc(struct _lv_obj_t * obj, uint32_t part, lv_draw_arc_dsc_t * draw_dsc);

View File

@@ -277,7 +277,7 @@ void lv_obj_mark_layout_as_dirty(lv_obj_t * obj)
{
obj->layout_inv = 1;
/*Mark the screen as dirty too to mark that there is an something to do on this screen*/
/*Mark the screen as dirty too to mark that there is something to do on this screen*/
lv_obj_t * scr = lv_obj_get_screen(obj);
scr->scr_layout_inv = 1;

View File

@@ -272,7 +272,7 @@ lv_coord_t lv_obj_get_height(const struct _lv_obj_t * obj);
lv_coord_t lv_obj_get_content_width(const struct _lv_obj_t * obj);
/**
* Get the height reduced by the top an bottom padding and the border width.
* Get the height reduced by the top and bottom padding and the border width.
* @param obj pointer to an object
* @note The position of the object is recalculated only on the next redraw. To force coordinate recalculation
* call `lv_obj_update_layout(obj)`.
@@ -379,7 +379,7 @@ bool lv_obj_hit_test(struct _lv_obj_t * obj, const lv_point_t * point);
* @param min_width the minimal width
* @param max_width the maximal width
* @param ref_width the reference width used when min/max width is in percentage
* @return the clampled width
* @return the clamped width
*/
lv_coord_t lv_clamp_width(lv_coord_t width, lv_coord_t min_width, lv_coord_t max_width, lv_coord_t ref_width);
@@ -389,7 +389,7 @@ lv_coord_t lv_clamp_width(lv_coord_t width, lv_coord_t min_width, lv_coord_t max
* @param min_height the minimal height
* @param max_height the maximal height
* @param ref_height the reference height used when min/max height is in percentage
* @return the clampled height
* @return the clamped height
*/
lv_coord_t lv_clamp_height(lv_coord_t height, lv_coord_t min_height, lv_coord_t max_height, lv_coord_t ref_height);

View File

@@ -172,9 +172,9 @@ lv_coord_t lv_obj_get_scroll_right(struct _lv_obj_t * obj);
/**
* Get the X and Y coordinates where the scrolling will end for this object if a scrolling animation is in progress.
* In no scrolling animation give the current `x` or `y` scroll position.
* If no scrolling animation, give the current `x` or `y` scroll position.
* @param obj pointer to an object
* @param end poinr to point to store the result
* @param end pointer to store the result
*/
void lv_obj_get_scroll_end(struct _lv_obj_t * obj, lv_point_t * end);

View File

@@ -153,7 +153,7 @@ lv_res_t lv_obj_get_local_style_prop(struct _lv_obj_t * obj, lv_style_prop_t pro
bool lv_obj_remove_local_style_prop(struct _lv_obj_t * obj, lv_style_prop_t prop, lv_style_selector_t selector);
/**
* Used internally to create a style tarnsition
* Used internally to create a style transition
* @param obj
* @param part
* @param prev_state

View File

@@ -41,7 +41,7 @@ typedef lv_obj_tree_walk_res_t (*lv_obj_tree_walk_cb_t)(struct _lv_obj_t *, void
**********************/
/**
* Delete an object and all of it's children.
* Delete an object and all of its children.
* Also remove the objects from their group and remove all animations (if any).
* Send `LV_EVENT_DELETED` to deleted objects.
* @param obj pointer to an object
@@ -103,9 +103,9 @@ void lv_obj_move_background(struct _lv_obj_t * obj);
/**
* Swap the positions of two objects.
* When used in listboxes, it can be used to sort the listbox items.
* @param obj1 pointer to the first object
* @param obj2 pointer to the second object
* When used in listboxes, it can be used to sort the listbox items.
* @param obj1 pointer to the first object
* @param obj2 pointer to the second object
*/
void lv_obj_swap(struct _lv_obj_t* obj1, struct _lv_obj_t* obj2);
@@ -126,14 +126,14 @@ void lv_obj_move_down(struct _lv_obj_t* obj);
/**
* Get the screen of an object
* @param obj pointer to an object
* @return pointer to the obejct's screen
* @return pointer to the object's screen
*/
struct _lv_obj_t * lv_obj_get_screen(const struct _lv_obj_t * obj);
/**
* Get the display of the object
* @param obj pointer to an object
* @return pointer to the obejct's display
* @return pointer to the object's display
*/
lv_disp_t * lv_obj_get_disp(const struct _lv_obj_t * obj);

View File

@@ -16,7 +16,7 @@
/*********************
* DEFINES
*********************/
#define SPLIT_RADIUS_LIMIT 10 /*With radius greater then this the arc will drawn in quarters. A quarter is drawn only if there is arc in it*/
#define SPLIT_RADIUS_LIMIT 10 /*With radius greater than this the arc will drawn in quarters. A quarter is drawn only if there is arc in it*/
#define SPLIT_ANGLE_GAP_LIMIT 60 /*With small gaps in the arc don't bother with splitting because there is nothing to skip.*/
/**********************

View File

@@ -31,7 +31,7 @@ typedef struct {
lv_blend_mode_t blend_mode : 2;
uint8_t round_start : 1;
uint8_t round_end : 1;
uint8_t raw_end : 1; /*Do not bother with perpendicular line ending is it's not visible for any reason*/
uint8_t raw_end : 1; /*Do not bother with perpendicular line ending if it's not visible for any reason*/
} lv_draw_line_dsc_t;
/**********************

View File

@@ -616,7 +616,7 @@ LV_ATTRIBUTE_FAST_MEM static lv_draw_mask_res_t line_mask_flat(lv_opa_t * mask_b
}
}
/*At the end of the mask if the limit line is smaller then the mask's y.
/*At the end of the mask if the limit line is smaller than the mask's y.
*Then the mask is in the "good" area*/
y_at_x = (int32_t)((int32_t)p->yx_steep * (abs_x + len)) >> 10;
if(p->yx_steep > 0) {
@@ -709,7 +709,7 @@ LV_ATTRIBUTE_FAST_MEM static lv_draw_mask_res_t line_mask_steep(lv_opa_t * mask_
{
int32_t k;
int32_t x_at_y;
/*At the beginning of the mask if the limit line is greater then the mask's y.
/*At the beginning of the mask if the limit line is greater than the mask's y.
*Then the mask is in the "wrong" area*/
x_at_y = (int32_t)((int32_t)p->xy_steep * abs_y) >> 10;
if(p->xy_steep > 0) x_at_y++;
@@ -722,7 +722,7 @@ LV_ATTRIBUTE_FAST_MEM static lv_draw_mask_res_t line_mask_steep(lv_opa_t * mask_
}
}
/*At the end of the mask if the limit line is smaller then the mask's y.
/*At the end of the mask if the limit line is smaller than the mask's y.
*Then the mask is in the "good" area*/
x_at_y = (int32_t)((int32_t)p->xy_steep * (abs_y)) >> 10;
if(x_at_y > abs_x + len) {

View File

@@ -279,7 +279,7 @@ LV_ATTRIBUTE_FAST_MEM uint8_t lv_draw_mask_get_cnt(void);
/**
* Check is there is any added draw mask
* Check if there is any added draw mask
* @param a an area to test for affecting masks.
* @return true: there is t least 1 draw mask; false: there are no draw masks
*/

View File

@@ -187,7 +187,7 @@ LV_ATTRIBUTE_FAST_MEM static void draw_bg(const lv_area_t * coords, const lv_are
blend_area.x1 = draw_area.x1;
blend_area.x2 = draw_area.x2;
/*There is an other mask too. Draw line by line. */
/*There is another mask too. Draw line by line. */
if(mask_any) {
for(h = draw_area.y1; h <= draw_area.y2; h++) {
blend_area.y1 = h;
@@ -334,7 +334,7 @@ LV_ATTRIBUTE_FAST_MEM static void draw_bg_img(const lv_area_t * coords, const lv
lv_img_header_t header;
lv_res_t res = lv_img_decoder_get_info(dsc->bg_img_src, &header);
if(res != LV_RES_OK) {
LV_LOG_WARN("Coudn't read the background image");
LV_LOG_WARN("Couldn't read the background image");
return;
}
@@ -860,7 +860,7 @@ LV_ATTRIBUTE_FAST_MEM static void draw_shadow(const lv_area_t * coords, const lv
/**
* Calculate a blurred corner
* @param coords Coordinates of the shadow
* @param sh_buf a buffer to store the result. It's size should be `(sw + r)^2 * 2`
* @param sh_buf a buffer to store the result. Its size should be `(sw + r)^2 * 2`
* @param sw shadow width
* @param r radius
*/

View File

@@ -69,7 +69,7 @@ extern lv_style_prop_t LV_STYLE_FLEX_GROW;
**********************/
/**
* Initialize a felx layout the default values
* Initialize a flex layout the default values
* @param flex pointer to a flex layout descriptor
*/
void lv_flex_init(void);
@@ -82,7 +82,7 @@ void lv_flex_init(void);
void lv_obj_set_flex_flow(lv_obj_t * obj, lv_flex_flow_t flow);
/**
* Set how to place (where to align) the items an tracks
* Set how to place (where to align) the items and tracks
* @param flex pointer: to a flex layout descriptor
* @param main_place where to place the items on main axis (in their track). Any value of `lv_flex_align_t`.
* @param cross_place where to place the item in their track on the cross axis. `LV_FLEX_ALIGN_START/END/CENTER`

View File

@@ -1,5 +1,5 @@
/**
* @file lv_theme_defau.c
* @file lv_theme_default.c
*
*/

View File

@@ -19,7 +19,7 @@ extern "C" {
/*Testing of dependencies*/
#if LV_USE_IMG == 0
#error "lv_animing: lv_img is required. Enable it in lv_conf.h (LV_USE_IMG 1)"
#error "lv_animimg: lv_img is required. Enable it in lv_conf.h (LV_USE_IMG 1)"
#endif
/*********************

View File

@@ -930,7 +930,7 @@ static void draw_series_line(lv_obj_t * obj, const lv_area_t * clip_area)
if(i != 0) {
if(crowded_mode) {
if(ser->y_points[p_prev] != LV_CHART_POINT_NONE && ser->y_points[p_act] != LV_CHART_POINT_NONE) {
/*Draw only one vertical line between the min an max y values on the same x value*/
/*Draw only one vertical line between the min and max y-values on the same x-value*/
y_max = LV_MAX(y_max, p2.y);
y_min = LV_MIN(y_min, p2.y);
if(p1.x != p2.x) {

View File

@@ -306,7 +306,7 @@ void lv_chart_set_x_start_point(lv_obj_t * obj, lv_chart_series_t * ser, uint16_
* Get the next series.
* @param chart pointer to a chart
* @param ser the previous series or NULL to get the first
* @return the next series or NULL if thre is no more.
* @return the next series or NULL if there is no more.
*/
lv_chart_series_t * lv_chart_get_series_next(const lv_obj_t * chart, const lv_chart_series_t * ser);

View File

@@ -218,9 +218,9 @@ lv_keyboard_mode_t lv_keyboard_get_mode(const lv_obj_t * obj)
/**
* Default keyboard event to add characters to the Text area and change the map.
* If a custom `event_cb` is added to the keyboard this function be called from it to handle the
* If a custom `event_cb` is added to the keyboard this function can be called from it to handle the
* button clicks
* @param kb pointer to a keyboard
* @param kb pointer to a keyboard
* @param event the triggering event
*/
void lv_keyboard_def_event_cb(lv_event_t * e)

View File

@@ -125,9 +125,9 @@ static inline const char ** lv_keyboard_get_map_array(const lv_obj_t * kb)
/**
* Default keyboard event to add characters to the Text area and change the map.
* If a custom `event_cb` is added to the keyboard this function be called from it to handle the
* If a custom `event_cb` is added to the keyboard this function can be called from it to handle the
* button clicks
* @param kb pointer to a keyboard
* @param kb pointer to a keyboard
* @param event the triggering event
*/
void lv_keyboard_def_event_cb(lv_event_t * e);

View File

@@ -112,7 +112,7 @@ void lv_gpu_stm32_dma2d_fill(lv_color_t * buf, lv_coord_t buf_w, lv_color_t colo
* @param buf a buffer which should be filled using a mask
* @param buf_w width of the buffer in pixels
* @param color fill color
* @param mask 0..255 values describing the opacity of the corresponding pixel. It's width is `fill_w`
* @param mask 0..255 values describing the opacity of the corresponding pixel. Its width is `fill_w`
* @param opa overall opacity. 255 in `mask` should mean this opacity.
* @param fill_w width to fill in pixels (<= buf_w)
* @param fill_h height to fill in pixels

View File

@@ -57,7 +57,7 @@ void lv_gpu_stm32_dma2d_fill(lv_color_t * buf, lv_coord_t buf_w, lv_color_t colo
* @param buf a buffer which should be filled using a mask
* @param buf_w width of the buffer in pixels
* @param color fill color
* @param mask 0..255 values describing the opacity of the corresponding pixel. It's width is `fill_w`
* @param mask 0..255 values describing the opacity of the corresponding pixel. Its width is `fill_w`
* @param opa overall opacity. 255 in `mask` should mean this opacity.
* @param fill_w width to fill in pixels (<= buf_w)
* @param fill_h height to fill in pixels

View File

@@ -64,7 +64,7 @@
# endif
#endif
/*Swap the 2 bytes of RGB565 color. Useful if the display has a 8 bit interface (e.g. SPI)*/
/*Swap the 2 bytes of RGB565 color. Useful if the display has an 8-bit interface (e.g. SPI)*/
#ifndef LV_COLOR_16_SWAP
# ifdef CONFIG_LV_COLOR_16_SWAP
# define LV_COLOR_16_SWAP CONFIG_LV_COLOR_16_SWAP
@@ -84,7 +84,7 @@
# endif
#endif
/*Images pixels with this color will not be drawn if they are chroma keyed)*/
/*Images pixels with this color will not be drawn if they are chroma keyed)*/
#ifndef LV_COLOR_CHROMA_KEY
# ifdef CONFIG_LV_COLOR_CHROMA_KEY
# define LV_COLOR_CHROMA_KEY CONFIG_LV_COLOR_CHROMA_KEY
@@ -167,7 +167,7 @@
HAL SETTINGS
*====================*/
/*Default display refresh period. LVG will redraw changed ares with this period time*/
/*Default display refresh period. LVG will redraw changed areas with this period time*/
#ifndef LV_DISP_DEF_REFR_PERIOD
# ifdef CONFIG_LV_DISP_DEF_REFR_PERIOD
# define LV_DISP_DEF_REFR_PERIOD CONFIG_LV_DISP_DEF_REFR_PERIOD
@@ -512,7 +512,7 @@ e.g. "stm32f769xx.h" or "stm32f429xx.h"*/
# endif
#endif
/*1: Show the used memory and the memory fragmentation in the left bottom corner
/*1: Show the used memory and the memory fragmentation in the left bottom corner
* Requires LV_MEM_CUSTOM = 0*/
#ifndef LV_USE_MEM_MONITOR
# ifdef CONFIG_LV_USE_MEM_MONITOR
@@ -580,7 +580,7 @@ e.g. "stm32f769xx.h" or "stm32f429xx.h"*/
#endif
/*Garbage Collector settings
*Used if lvgl is binded to higher level language and the memory is managed by that language*/
*Used if lvgl is bound to higher level language and the memory is managed by that language*/
#ifndef LV_ENABLE_GC
# ifdef CONFIG_LV_ENABLE_GC
# define LV_ENABLE_GC CONFIG_LV_ENABLE_GC
@@ -675,7 +675,7 @@ e.g. "stm32f769xx.h" or "stm32f429xx.h"*/
# endif
#endif
/*Complier prefix for a big array declaration in RAM*/
/*Compiler prefix for a big array declaration in RAM*/
#ifndef LV_ATTRIBUTE_LARGE_RAM_ARRAY
# ifdef CONFIG_LV_ATTRIBUTE_LARGE_RAM_ARRAY
# define LV_ATTRIBUTE_LARGE_RAM_ARRAY CONFIG_LV_ATTRIBUTE_LARGE_RAM_ARRAY
@@ -894,7 +894,7 @@ e.g. "stm32f769xx.h" or "stm32f429xx.h"*/
# ifdef CONFIG_LV_FONT_DEJAVU_16_PERSIAN_HEBREW
# define LV_FONT_DEJAVU_16_PERSIAN_HEBREW CONFIG_LV_FONT_DEJAVU_16_PERSIAN_HEBREW
# else
# define LV_FONT_DEJAVU_16_PERSIAN_HEBREW 0 /*Hebrew, Arabic, Perisan letters and all their forms*/
# define LV_FONT_DEJAVU_16_PERSIAN_HEBREW 0 /*Hebrew, Arabic, Persian letters and all their forms*/
# endif
#endif
#ifndef LV_FONT_SIMSUN_16_CJK
@@ -1047,7 +1047,7 @@ e.g. "stm32f769xx.h" or "stm32f429xx.h"*/
#endif
/*Support bidirectional texts. Allows mixing Left-to-Right and Right-to-Left texts.
*The direction will be processed according to the Unicode Bidirectioanl Algorithm:
*The direction will be processed according to the Unicode Bidirectional Algorithm:
*https://www.w3.org/International/articles/inline-bidi-markup/uba-basics*/
#ifndef LV_USE_BIDI
# ifdef CONFIG_LV_USE_BIDI
@@ -1475,7 +1475,7 @@ e.g. "stm32f769xx.h" or "stm32f429xx.h"*/
#endif
#endif /*LV_USE_THEME_DEFAULT*/
/*An very simple them that is a good starting point for a custom theme*/
/*A very simple theme that is a good starting point for a custom theme*/
#ifndef LV_USE_THEME_BASIC
# ifdef CONFIG_LV_USE_THEME_BASIC
# define LV_USE_THEME_BASIC CONFIG_LV_USE_THEME_BASIC
@@ -1536,7 +1536,7 @@ e.g. "stm32f769xx.h" or "stm32f429xx.h"*/
LV_EXPORT_CONST_INT(LV_DPI_DEF);
/*If running without lv_conf.h add typdesf with default value*/
/*If running without lv_conf.h add typedefs with default value*/
#if defined(LV_CONF_SKIP)
# if defined(_MSC_VER) && !defined(_CRT_SECURE_NO_WARNINGS) /*Disable warnings for Visual Studio*/

View File

@@ -1,4 +1,4 @@
/** * @file lv_conf_kconfig.h * Configs that needs special handling when LVGL is used with Kconfig */
/** * @file lv_conf_kconfig.h * Configs that need special handling when LVGL is used with Kconfig */
#ifndef LV_CONF_KCONFIG_H
#define LV_CONF_KCONFIG_H

View File

@@ -45,7 +45,7 @@ typedef int32_t (*lv_anim_path_cb_t)(const struct _lv_anim_t *);
* First parameter is the variable to animate.
* Second parameter is the value to set.
* Compatible with `lv_xxx_set_yyy(obj, value)` functions
* The `x` in `_xcb_t` means its not a fully generic prototype because
* The `x` in `_xcb_t` means it's not a fully generic prototype because
* it doesn't receive `lv_anim_t *` as its first argument*/
typedef void (*lv_anim_exec_xcb_t)(void *, int32_t);
@@ -169,7 +169,7 @@ static inline void lv_anim_set_values(lv_anim_t * a, int32_t start, int32_t end)
/**
* Similar to `lv_anim_set_exec_cb` but `lv_anim_custom_exec_cb_t` receives
* `lv_anim_t * ` as its first parameter instead of `void *`.
* This function might be used when LVGL is binded to other languages because
* This function might be used when LVGL is bound to other languages because
* it's more consistent to have `lv_anim_t *` as first parameter.
* The variable to animate can be stored in the animation's `user_sata`
* @param a pointer to an initialized `lv_anim_t` variable
@@ -184,7 +184,7 @@ static inline void lv_anim_set_custom_exec_cb(lv_anim_t * a, lv_anim_custom_exec
/**
* Set the path (curve) of the animation.
* @param a pointer to an initialized `lv_anim_t` variable
* @param path_cb a function the get the current value of the animation.
* @param path_cb a function to set the current value of the animation.
*/
static inline void lv_anim_set_path_cb(lv_anim_t * a, lv_anim_path_cb_t path_cb)
{
@@ -304,7 +304,7 @@ static inline uint32_t lv_anim_get_delay(lv_anim_t * a)
/**
* Get the user_data field of the animation
* @param a pointer to an initialized `lv_anim_t` variable
* @return the pointer to the costom user_data of the animation
* @return the pointer to the custom user_data of the animation
*/
#if LV_USE_USER_DATA
static inline void * lv_anim_get_user_data(lv_anim_t * a)
@@ -323,7 +323,7 @@ static inline void * lv_anim_get_user_data(lv_anim_t * a)
bool lv_anim_del(void * var, lv_anim_exec_xcb_t exec_cb);
/**
* Delete all the animations animation
* Delete all the animations
*/
void lv_anim_del_all(void);
@@ -344,7 +344,7 @@ lv_anim_t * lv_anim_get(void * var, lv_anim_exec_xcb_t exec_cb);
* @param a pointer to an animation.
* @param exec_cb a function pointer which is animating 'var',
* or NULL to ignore it and delete all the animations of 'var
* @return true: at least 1 animation is deleted, false: no animation is deleted
* @return true: at least 1 animation is deleted, false: no animation is deleted
*/
static inline bool lv_anim_custom_del(lv_anim_t * a, lv_anim_custom_exec_cb_t exec_cb)
{

View File

@@ -134,7 +134,7 @@ bool _lv_area_intersect(lv_area_t * res_p, const lv_area_t * a1_p, const lv_area
res_p->x2 = LV_MIN(a1_p->x2, a2_p->x2);
res_p->y2 = LV_MIN(a1_p->y2, a2_p->y2);
/*If x1 or y1 greater then x2 or y2 then the areas union is empty*/
/*If x1 or y1 greater than x2 or y2 then the areas union is empty*/
bool union_ok = true;
if((res_p->x1 > res_p->x2) || (res_p->y1 > res_p->y2)) {
union_ok = false;

View File

@@ -38,7 +38,7 @@ typedef void (*lv_async_cb_t)(void *);
* Call an asynchronous function the next time lv_timer_handler() is run. This function is likely to return
* **before** the call actually happens!
* @param async_xcb a callback which is the task itself.
* (the 'x' in the argument name indicates that its not a fully generic function because it not follows
* (the 'x' in the argument name indicates that it's not a fully generic function because it not follows
* the `func_name(object, callback, ...)` convention)
* @param user_data custom parameter
*/

View File

@@ -599,7 +599,7 @@ static lv_base_dir_t bracket_process(const char * txt, uint32_t next_pos, uint32
/*Is the letter an opening bracket?*/
for(i = 0; bracket_left[i] != '\0'; i++) {
if(bracket_left[i] == letter) {
/*If so find it's matching closing bracket.
/*If so find its matching closing bracket.
*If a char with base dir. direction is found then the brackets will have `base_dir` direction*/
uint32_t txt_i = next_pos;
while(txt_i < len) {

View File

@@ -283,8 +283,8 @@ typedef struct {
/**
* Initialize a style
* @param style pointer to a style to initialize
* @note Do not call `lv_style_init` on styles that are already have some properties
* because this function won't free the used memory just set a default state for the style.
* @note Do not call `lv_style_init` on styles that already have some properties
* because this function won't free the used memory, just sets a default state for the style.
* In other words be sure to initialize styles only once!
*/
void lv_style_init(lv_style_t * style);
@@ -323,8 +323,8 @@ bool lv_style_remove_prop(lv_style_t * style, lv_style_prop_t prop);
* This function shouldn't be used directly by the user.
* Instead use `lv_style_set_<prop_name>()`. E.g. `lv_style_set_bg_color()`
* @param style pointer to style
* @param prop the ID of a property (e.g. `LV_STLYE_BG_COLOR`)
* @param value `lv_style_value_t` variable in which a filed is set according to the type of `prop`
* @param prop the ID of a property (e.g. `LV_STYLE_BG_COLOR`)
* @param value `lv_style_value_t` variable in which a field is set according to the type of `prop`
*/
void lv_style_set_prop(lv_style_t * style, lv_style_prop_t prop, lv_style_value_t value);
@@ -333,7 +333,7 @@ void lv_style_set_prop(lv_style_t * style, lv_style_prop_t prop, lv_style_value_
* @param style pointer to a style
* @param prop the ID of a property
* @param value pointer to a `lv_style_value_t` variable to store the value
* @return LV_RES_INV: the property wsn't found in the style (`value` is unchanged)
* @return LV_RES_INV: the property wasn't found in the style (`value` is unchanged)
* LV_RES_OK: the property was fond, and `value` is set accordingly
* @note For performance reasons there are no sanity check on `style`
*/
@@ -345,7 +345,7 @@ lv_res_t lv_style_get_prop(lv_style_t * style, lv_style_prop_t prop, lv_style_va
* @param style pointer to a style
* @param prop the ID of a property
* @param value pointer to a `lv_style_value_t` variable to store the value
* @return LV_RES_INV: the property wsn't found in the style (`value` is unchanged)
* @return LV_RES_INV: the property wasn't found in the style (`value` is unchanged)
* LV_RES_OK: the property was fond, and `value` is set accordingly
* @note For performance reasons there are no sanity check on `style`
* @note This function is the same as ::lv_style_get_prop but inlined. Use it only on performance critical places

View File

@@ -154,7 +154,7 @@ lv_timer_t * lv_timer_create_basic(void)
/**
* Create a new lv_timer
* @param timer_xcb a callback which is the timer itself. It will be called periodically.
* (the 'x' in the argument name indicates that its not a fully generic function because it not follows
* (the 'x' in the argument name indicates that it's not a fully generic function because it not follows
* the `func_name(object, callback, ...)` convention)
* @param period call period in ms unit
* @param user_data custom parameter
@@ -289,7 +289,7 @@ lv_timer_t * lv_timer_get_next(lv_timer_t * timer)
**********************/
/**
* Execute timer if its the priority is appropriate
* Execute timer if its priority is appropriate
* @param timer pointer to lv_timer
* @return true: execute, false: not executed
*/

View File

@@ -80,7 +80,7 @@ lv_timer_t * lv_timer_create_basic(void);
/**
* Create a new lv_timer
* @param timer_xcb a callback to call periodically.
* (the 'x' in the argument name indicates that its not a fully generic function because it not follows
* (the 'x' in the argument name indicates that it's not a fully generic function because it not follows
* the `func_name(object, callback, ...)` convention)
* @param period call period in ms unit
* @param user_data custom parameter

View File

@@ -204,7 +204,7 @@ static uint32_t lv_txt_get_next_word(const char * txt, const lv_font_t * font,
i = i_next;
i_next = i_next_next;
letter = letter_next;
continue; /*Skip the letter is it is part of a command*/
continue; /*Skip the letter if it is part of a command*/
}
}

View File

@@ -226,7 +226,7 @@ extern uint32_t (*_lv_txt_encoded_next)(const char *, uint32_t *);
extern uint32_t (*_lv_txt_encoded_prev)(const char *, uint32_t *);
/**
* Convert a letter index (in an the encoded text) to byte index.
* Convert a letter index (in the encoded text) to byte index.
* E.g. in UTF-8 "AÁRT" index of 'R' is 2 but start at byte 3 because 'Á' is 2 bytes long
* @param txt a '\0' terminated UTF-8 string
* @param enc_id letter index

View File

@@ -30,8 +30,8 @@ extern "C" {
/** Searches base[0] to base[n - 1] for an item that matches *key.
*
* @note The function cmp must return negative if its first
* argument (the search key) is less that its second (a table entry),
* @note The function cmp must return negative if it's first
* argument (the search key) is less that it's second (a table entry),
* zero if equal, and positive if greater.
*
* @note Items in the array must be in ascending order.

View File

@@ -58,7 +58,7 @@ const lv_obj_class_t lv_arc_class = {
**********************/
/**
* Create a arc object
* Create an arc object
* @param par pointer to an object, it will be the parent of the new arc
* @return pointer to the created arc
*/
@@ -244,7 +244,7 @@ void lv_arc_set_mode(lv_obj_t * obj, lv_arc_mode_t type)
/**
* Set a new value on the arc
* @param arc pointer to a arc object
* @param arc pointer to an arc object
* @param value new value
*/
void lv_arc_set_value(lv_obj_t * obj, int16_t value)
@@ -265,7 +265,7 @@ void lv_arc_set_value(lv_obj_t * obj, int16_t value)
}
/**
* Set minimum and the maximum values of a arc
* Set minimum and the maximum values of an arc
* @param arc pointer to the arc object
* @param min minimum value
* @param max maximum value
@@ -293,7 +293,7 @@ void lv_arc_set_range(lv_obj_t * obj, int16_t min, int16_t max)
/**
* Set the threshold of arc knob increments
* position.
* @param arc pointer to a arc object
* @param arc pointer to an arc object
* @param threshold increment threshold
*/
void lv_arc_set_change_rate(lv_obj_t * obj, uint16_t rate)
@@ -354,8 +354,8 @@ uint16_t lv_arc_get_bg_angle_end(lv_obj_t * obj)
/**
* Get the value of a arc
* @param arc pointer to a arc object
* Get the value of an arc
* @param arc pointer to an arc object
* @return the value of the arc
*/
int16_t lv_arc_get_value(const lv_obj_t * obj)
@@ -365,8 +365,8 @@ int16_t lv_arc_get_value(const lv_obj_t * obj)
}
/**
* Get the minimum value of a arc
* @param arc pointer to a arc object
* Get the minimum value of an arc
* @param arc pointer to an arc object
* @return the minimum value of the arc
*/
int16_t lv_arc_get_min_value(const lv_obj_t * obj)
@@ -376,8 +376,8 @@ int16_t lv_arc_get_min_value(const lv_obj_t * obj)
}
/**
* Get the maximum value of a arc
* @param arc pointer to a arc object
* Get the maximum value of an arc
* @param arc pointer to an arc object
* @return the maximum value of the arc
*/
int16_t lv_arc_get_max_value(const lv_obj_t * obj)
@@ -388,7 +388,7 @@ int16_t lv_arc_get_max_value(const lv_obj_t * obj)
/**
* Get whether the arc is type or not.
* @param arc pointer to a arc object
* @param arc pointer to an arc object
* @return arc type
*/
lv_arc_mode_t lv_arc_get_mode(const lv_obj_t * obj)
@@ -508,8 +508,8 @@ static void lv_arc_event(const lv_obj_class_t * class_p, lv_event_t * e)
int16_t delta_angle = angle - last_angle_rel;
/*Do not allow big jumps.
*It's mainly to avoid jumping to the opposite end if the "dead" range between min. an max. is crossed.
*Check which was closer on the last valid press (arc->min_close) and prefer that end*/
*It's mainly to avoid jumping to the opposite end if the "dead" range between min. and max. is crossed.
*Check which end was closer on the last valid press (arc->min_close) and prefer that end*/
if(LV_ABS(delta_angle) > 280) {
if(arc->min_close) angle = 0;
else angle = deg_range;
@@ -552,7 +552,7 @@ static void lv_arc_event(const lv_obj_class_t * class_p, lv_event_t * e)
}
}
/*Don1't let the elapsed time to big while sitting on an end point*/
/*Don't let the elapsed time become too big while sitting on an end point*/
if(new_value ==arc->min_value || new_value ==arc->max_value) {
arc->last_tick = lv_tick_get(); /*Cache timestamp for the next iteration*/
}
@@ -783,7 +783,7 @@ static void get_knob_area(lv_obj_t * obj, const lv_point_t * center, lv_coord_t
/**
* Used internally to update arc angles after a value change
* @param arc pointer to a arc object
* @param arc pointer to an arc object
*/
static void value_update(lv_obj_t * obj)
{

View File

@@ -69,7 +69,7 @@ typedef enum {
**********************/
/**
* Create a arc objects
* Create an arc object
* @param par pointer to an object, it will be the parent of the new arc
* @return pointer to the created arc
*/
@@ -143,13 +143,13 @@ void lv_arc_set_mode(lv_obj_t * arc, lv_arc_mode_t type);
/**
* Set a new value on the arc
* @param arc pointer to a arc object
* @param arc pointer to an arc object
* @param value new value
*/
void lv_arc_set_value(lv_obj_t * arc, int16_t value);
/**
* Set minimum and the maximum values of a arc
* Set minimum and the maximum values of an arc
* @param arc pointer to the arc object
* @param min minimum value
* @param max maximum value
@@ -157,8 +157,8 @@ void lv_arc_set_value(lv_obj_t * arc, int16_t value);
void lv_arc_set_range(lv_obj_t * arc, int16_t min, int16_t max);
/**
* Set a change rate to limit the speed how fast the arc should reache the pressed point.
* @param arc pointer to a arc object
* Set a change rate to limit the speed how fast the arc should reach the pressed point.
* @param arc pointer to an arc object
* @param rate the change rate
*/
void lv_arc_set_change_rate(lv_obj_t * arc, uint16_t rate);
@@ -196,29 +196,29 @@ uint16_t lv_arc_get_bg_angle_start(lv_obj_t * obj);
uint16_t lv_arc_get_bg_angle_end(lv_obj_t * obj);
/**
* Get the value of a arc
* @param arc pointer to a arc object
* Get the value of an arc
* @param arc pointer to an arc object
* @return the value of the arc
*/
int16_t lv_arc_get_value(const lv_obj_t * obj);
/**
* Get the minimum value of a arc
* @param arc pointer to a arc object
* Get the minimum value of an arc
* @param arc pointer to an arc object
* @return the minimum value of the arc
*/
int16_t lv_arc_get_min_value(const lv_obj_t * obj);
/**
* Get the maximum value of a arc
* @param arc pointer to a arc object
* Get the maximum value of an arc
* @param arc pointer to an arc object
* @return the maximum value of the arc
*/
int16_t lv_arc_get_max_value(const lv_obj_t * obj);
/**
* Get whether the arc is type or not.
* @param arc pointer to a arc object
* @param arc pointer to an arc object
* @return arc's mode
*/
lv_arc_mode_t lv_arc_get_mode(const lv_obj_t * obj);

View File

@@ -19,7 +19,7 @@
*********************/
#define MY_CLASS &lv_bar_class
/** hor. pad and ver. pad cannot make the indicator smaller then this [px]*/
/** hor. pad and ver. pad cannot make the indicator smaller than this [px]*/
#define LV_BAR_SIZE_MIN 4
#define LV_BAR_IS_ANIMATING(anim_struct) (((anim_struct).anim_state) != LV_BAR_ANIM_STATE_INV)
@@ -95,7 +95,7 @@ void lv_bar_set_value(lv_obj_t * obj, int32_t value, lv_anim_enable_t anim)
if(bar->cur_value == value) return;
value = LV_CLAMP(bar->min_value, value, bar->max_value);
value = value < bar->start_value ? bar->start_value : value; /*Can't be smaller then the left value*/
value = value < bar->start_value ? bar->start_value : value; /*Can't be smaller than the left value*/
if(bar->cur_value == value) return;
lv_bar_set_value_with_anim(obj, value, &bar->cur_value, &bar->cur_value_anim, anim);
@@ -108,7 +108,7 @@ void lv_bar_set_start_value(lv_obj_t * obj, int32_t value, lv_anim_enable_t anim
lv_bar_t * bar = (lv_bar_t *)obj;
value = LV_CLAMP(bar->min_value, value, bar->max_value);
value = value > bar->cur_value ? bar->cur_value : value; /*Can't be greater then the right value*/
value = value > bar->cur_value ? bar->cur_value : value; /*Can't be greater than the right value*/
if(bar->start_value == value) return;
lv_bar_set_value_with_anim(obj, value, &bar->start_value, &bar->start_value_anim, anim);

View File

@@ -361,7 +361,7 @@ static void lv_btnmatrix_constructor(const lv_obj_class_t * class_p, lv_obj_t *
lv_btnmatrix_set_map(obj, lv_btnmatrix_def_map);
LV_TRACE_OBJ_CREATE("finshed");
LV_TRACE_OBJ_CREATE("finished");
}
static void lv_btnmatrix_destructor(const lv_obj_class_t * class_p, lv_obj_t * obj)
@@ -373,7 +373,7 @@ static void lv_btnmatrix_destructor(const lv_obj_class_t * class_p, lv_obj_t * o
lv_mem_free(btnm->ctrl_bits);
btnm->button_areas = NULL;
btnm->ctrl_bits = NULL;
LV_TRACE_OBJ_CREATE("finshed");
LV_TRACE_OBJ_CREATE("finished");
}
static void lv_btnmatrix_event(const lv_obj_class_t * class_p, lv_event_t * e)
@@ -940,7 +940,7 @@ static void invalidate_button_area(const lv_obj_t * obj, uint16_t btn_idx)
lv_obj_get_coords(obj, &obj_area);
/*The buttons might have outline and shadow so make the invalidation larger with the gaps between the buttons.
*It assumes that the outline or shadow is smaller then the gaps*/
*It assumes that the outline or shadow is smaller than the gaps*/
lv_coord_t row_gap = lv_obj_get_style_pad_row(obj, LV_PART_MAIN);
lv_coord_t col_gap = lv_obj_get_style_pad_column(obj, LV_PART_MAIN);

View File

@@ -159,10 +159,10 @@ void lv_btnmatrix_set_btn_width(lv_obj_t * obj, uint16_t btn_id, uint8_t width);
/**
* Make the button matrix like a selector widget (only one button may be checked at a time).
* `LV_BTNMATRIX_CTRL_CHECKABLE` must be enabled on the buttons to be selected useing
* `LV_BTNMATRIX_CTRL_CHECKABLE` must be enabled on the buttons to be selected using
* `lv_btnmatrix_set_ctrl()` or `lv_btnmatrix_set_btn_ctrl_all()`.
* @param obj pointer to a button matrix object
* @param en: whether "one check" mode is enabled
* @param en whether "one check" mode is enabled
*/
void lv_btnmatrix_set_one_checked(lv_obj_t * obj, bool en);

View File

@@ -78,7 +78,7 @@ lv_obj_t * lv_dropdown_create(lv_obj_t * parent);
* If set to `NULL` the selected option's text will be displayed on the button.
* If set to a specific text then that text will be shown regardless the selected option.
* @param obj pointer to a drop-down list object
* @param txt the text as a string (Only it's pointer is saved)
* @param txt the text as a string (Only its pointer is saved)
*/
void lv_dropdown_set_text(lv_obj_t * obj, const char * txt);

View File

@@ -489,7 +489,7 @@ static void lv_img_event(const lv_obj_class_t * class_p, lv_event_t * e)
angle += img->angle;
/*If the object is exactly image sized (not cropped, not mosaic) and transformed
*perform hit test on it's transformed area*/
*perform hit test on its transformed area*/
if(img->w == lv_obj_get_width(obj) && img->h == lv_obj_get_height(obj) &&
(zoom != LV_IMG_ZOOM_NONE || angle != 0 || img->pivot.x != img->w / 2 || img->pivot.y != img->h / 2)) {

View File

@@ -138,7 +138,7 @@ void lv_img_set_zoom(lv_obj_t * obj, uint16_t zoom);
/**
* Enable/disable anti-aliasing for the transformations (rotate, zoom) or not.
* The qualitiy is better with anti-aliasing looks better but slower.
* The quality is better with anti-aliasing looks better but slower.
* @param obj pointer to an image object
* @param antialias true: anti-aliased; false: not anti-aliased
*/

View File

@@ -481,7 +481,7 @@ uint32_t lv_label_get_letter_on(const lv_obj_t * obj, lv_point_t * pos_in)
/*Handle the recolor command*/
if((flag & LV_TEXT_FLAG_RECOLOR) != 0) {
if(_lv_txt_is_cmd(&cmd_state, bidi_txt[i]) != false) {
continue; /*Skip the letter is it is part of a command*/
continue; /*Skip the letter if it is part of a command*/
}
}
@@ -583,7 +583,7 @@ bool lv_label_is_char_under_pos(const lv_obj_t * obj, lv_point_t * pos)
/*Handle the recolor command*/
if((flag & LV_TEXT_FLAG_RECOLOR) != 0) {
if(_lv_txt_is_cmd(&cmd_state, txt[i]) != false) {
continue; /*Skip the letter is it is part of a command*/
continue; /*Skip the letter if it is part of a command*/
}
}
last_x = x;
@@ -856,7 +856,7 @@ static void draw_main(lv_event_t * e)
lv_txt_get_size(&size, label->text, label_draw_dsc.font, label_draw_dsc.letter_space, label_draw_dsc.line_space,
LV_COORD_MAX, flag);
/*Draw the text again on label to the original to make an circular effect */
/*Draw the text again on label to the original to make a circular effect */
if(size.x > lv_area_get_width(&txt_coords)) {
label_draw_dsc.ofs_x = label->offset.x + size.x +
lv_font_get_glyph_width(label_draw_dsc.font, ' ', ' ') * LV_LABEL_WAIT_CHAR_COUNT;
@@ -865,7 +865,7 @@ static void draw_main(lv_event_t * e)
lv_draw_label(&txt_coords, &txt_clip, &label_draw_dsc, label->text, hint);
}
/*Draw the text again below the original to make an circular effect */
/*Draw the text again below the original to make a circular effect */
if(size.y > lv_area_get_height(&txt_coords)) {
label_draw_dsc.ofs_x = label->offset.x;
label_draw_dsc.ofs_y = label->offset.y + size.y + lv_font_get_line_height(label_draw_dsc.font);
@@ -876,7 +876,7 @@ static void draw_main(lv_event_t * e)
}
/**
* Refresh the label with its text stored in its labelended data
* Refresh the label with its text stored in its extended data
* @param label pointer to a label object
*/
static void lv_label_refr_text(lv_obj_t * obj)

View File

@@ -83,7 +83,7 @@ extern const lv_obj_class_t lv_label_class;
/**
* Create a label objects
* @param parent pointer to an object, it will be the parent of the new labely.
* @param parent pointer to an object, it will be the parent of the new label.
* @return pointer to the created button
*/
lv_obj_t * lv_label_create(lv_obj_t * parent);
@@ -109,7 +109,7 @@ void lv_label_set_text_fmt(lv_obj_t * obj, const char * fmt, ...) LV_FORMAT_ATTR
/**
* Set a static text. It will not be saved by the label so the 'text' variable
* has to be 'alive' while the label exist.
* has to be 'alive' while the label exists.
* @param label pointer to a label object
* @param text pointer to a text. NULL to refresh with the current text.
*/

View File

@@ -5,7 +5,7 @@
/**
* TODO Remove these instructions
* Search an replace: templ -> object short name with lower case(e.g. btn, label etc)
* Search and replace: templ -> object short name with lower case(e.g. btn, label etc)
* TEMPL -> object short name with upper case (e.g. BTN, LABEL etc.)
*
* You can remove the defined() clause from the #if statement below. This exists because

View File

@@ -5,7 +5,7 @@
/**
* TODO Remove these instructions
* Search an replace: templ -> object short name with lower case(e.g. btn, label etc)
* Search and replace: templ -> object short name with lower case(e.g. btn, label etc)
* TEMPL -> object short name with upper case (e.g. BTN, LABEL etc.)
*
*/