lv_span.h

lv_span_set_text

Set a new text for a span. Memory will be allocated to store the text by the span. As the spangroup is not passed a redraw (invalidation) can't be triggered automatically. Therefore lv_spangroup_refresh(spangroup) needs to be called manually,

void lv_span_set_text(lv_span_t *span, const char *text)

lv_span_set_text_fmt

Set a new text for a span using a printf-like formatting string. Memory will be allocated to store the text by the span. As the spangroup is not passed a redraw (invalidation) can't be triggered automatically. Therefore lv_spangroup_refresh(spangroup) needs to be called manually,

void lv_span_set_text_fmt(lv_span_t *span, const char *fmt,...)

lv_span_set_text_static

Set a static text. It will not be saved by the span so the 'text' variable has to be 'alive' while the span exist. As the spangroup is not passed a redraw (invalidation) can't be triggered automatically. Therefore lv_spangroup_refresh(spangroup) needs to be called manually,

void lv_span_set_text_static(lv_span_t *span, const char *text)

lv_spangroup_set_span_text

Set a new text for a span. Memory will be allocated to store the text by the span.

void lv_spangroup_set_span_text(lv_obj_t *obj, lv_span_t *span, const char *text)

lv_spangroup_set_span_text_static

Set a new text for a span. Memory will be allocated to store the text by the span.

void lv_spangroup_set_span_text_static(lv_obj_t *obj, lv_span_t *span, const char *text)

lv_spangroup_set_span_text_fmt

Set a new text for a span using a printf-like formatting string. Memory will be allocated to store the text by the span.

void lv_spangroup_set_span_text_fmt(lv_obj_t *obj, lv_span_t *span, const char *fmt,...)

lv_spangroup_set_span_style

Copy all style properties of style to the bbuilt-in static style of the span.

void lv_spangroup_set_span_style(lv_obj_t *obj, lv_span_t *span, const lv_style_t *style)

lv_spangroup_set_align

DEPRECATED. Use the text_align style property instead Set the align of the spangroup.

void lv_spangroup_set_align(lv_obj_t *obj, lv_text_align_t align)

lv_spangroup_set_overflow

Set the overflow of the spangroup.

void lv_spangroup_set_overflow(lv_obj_t *obj, lv_span_overflow_t overflow)

lv_spangroup_set_indent

Set the indent of the spangroup.

void lv_spangroup_set_indent(lv_obj_t *obj, int32_t indent)

lv_spangroup_set_mode

DEPRECATED, set the width to LV_SIZE_CONTENT or fixed value to control expanding/wrapping" Set the mode of the spangroup.

void lv_spangroup_set_mode(lv_obj_t *obj, lv_span_mode_t mode)

lv_spangroup_set_max_lines

Set maximum lines of the spangroup.

void lv_spangroup_set_max_lines(lv_obj_t *obj, int32_t lines)

lv_span_get_style

Get a pointer to the style of a span's built-in style. Any lv_style_set_... functions can be applied on the returned style.

lv_style_t * lv_span_get_style(lv_span_t *span)

Returns: lv_style_t * — pointer to the style. (valid as long as the span is valid)

lv_span_get_text

Get a pointer to the text of a span

const char * lv_span_get_text(lv_span_t *span)

Returns: const char * — pointer to the text

lv_spangroup_get_child

Get a spangroup child by its index.

lv_span_t * lv_spangroup_get_child(const lv_obj_t *obj, int32_t id)

Returns: lv_span_t * — The child span at index id, or NULL if the ID does not exist

lv_spangroup_get_span_count

Get number of spans

uint32_t lv_spangroup_get_span_count(const lv_obj_t *obj)

Returns: uint32_t — the span count of the spangroup.

lv_spangroup_get_align

Get the align of the spangroup.

lv_text_align_t lv_spangroup_get_align(lv_obj_t *obj)

Returns: lv_text_align_t — the align value.

lv_spangroup_get_overflow

Get the overflow of the spangroup.

lv_span_overflow_t lv_spangroup_get_overflow(lv_obj_t *obj)

Returns: lv_span_overflow_t — the overflow value.

lv_spangroup_get_indent

Get the indent of the spangroup.

int32_t lv_spangroup_get_indent(lv_obj_t *obj)

Returns: int32_t — the indent value.

lv_spangroup_get_mode

Get the mode of the spangroup.

lv_span_mode_t lv_spangroup_get_mode(lv_obj_t *obj)

lv_spangroup_get_max_lines

Get maximum lines of the spangroup.

int32_t lv_spangroup_get_max_lines(lv_obj_t *obj)

Returns: int32_t — the max lines value.

lv_spangroup_get_max_line_height

Get max line height of all span in the spangroup.

int32_t lv_spangroup_get_max_line_height(lv_obj_t *obj)

lv_spangroup_get_expand_width

Get the text content width when all span of spangroup on a line.

uint32_t lv_spangroup_get_expand_width(lv_obj_t *obj, uint32_t max_width)

Returns: uint32_t — text content width or max_width.

lv_spangroup_get_expand_height

Get the text content height with width fixed.

int32_t lv_spangroup_get_expand_height(lv_obj_t *obj, int32_t width)

lv_spangroup_get_span_coords

Get the span's coords in the spangroup.

lv_span_coords_t lv_spangroup_get_span_coords(lv_obj_t *obj, const lv_span_t *span)

Returns: lv_span_coords_t — the span's coords in the spangroup.

+--------+
|Heading +--->------------------+
|  Pos   |   |     Heading      |
+--------+---+------------------+
|                               |
|                               |
|                               |
|            Middle   +--------+|
|                     |Trailing||
|                   +-|  Pos   ||
|                   | +--------+|
+-------------------v-----------+
|     Trailing      |
+-------------------+

lv_spangroup_get_span_by_point

Get the span object by point.

lv_span_t * lv_spangroup_get_span_by_point(lv_obj_t *obj, const lv_point_t *p)

Returns: lv_span_t * — pointer to the span under the point or NULL if not found.

lv_span_stack_init

void lv_span_stack_init(void)

lv_span_stack_deinit

void lv_span_stack_deinit(void)

lv_spangroup_create

Create a spangroup object

lv_obj_t * lv_spangroup_create(lv_obj_t *parent)

Returns: lv_obj_t * — pointer to the created spangroup

lv_spangroup_add_span

Create a span string descriptor and add to spangroup.

lv_span_t * lv_spangroup_add_span(lv_obj_t *obj)

Returns: lv_span_t * — pointer to the created span.

lv_spangroup_delete_span

Remove the span from the spangroup and free memory.

void lv_spangroup_delete_span(lv_obj_t *obj, lv_span_t *span)

lv_spangroup_refresh

Update the mode of the spangroup.

void lv_spangroup_refresh(lv_obj_t *obj)

lv_spangroup_bind_span_text

Bind an integer, string, or pointer Subject to a Spangroup's Span.

lv_observer_t * lv_spangroup_bind_span_text(lv_obj_t *obj, lv_span_t *span, lv_subject_t *subject, const char *fmt)

Returns: lv_observer_t * — pointer to newly-created Observer