lv_label.h

lv_label_set_text

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

void lv_label_set_text(lv_obj_t *obj, const char *text)

lv_label_set_text_fmt

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

void lv_label_set_text_fmt(lv_obj_t *obj, const char *fmt,...)

lv_label_set_text_vfmt

Set a new formatted text for a label. Memory will be allocated to store the text by the label. Example:

va_list args;
va_start(args, fmt);
lv_label_set_text_vfmt(label1, fmt, args);
va_end(args);

void lv_label_set_text_vfmt(lv_obj_t *obj, const char *fmt, va_list args)

lv_label_set_text_static

Set a static text. It will not be saved by the label so the 'text' variable has to be 'alive' while the label exists.

void lv_label_set_text_static(lv_obj_t *obj, const char *text)

lv_label_set_long_mode

Set the behavior of the label with text longer than the object size

void lv_label_set_long_mode(lv_obj_t *obj, lv_label_long_mode_t long_mode)

lv_label_set_max_lines

Set the maximum number of lines that the label should display in LV_LABEL_LONG_MODE_WRAP and LV_LABEL_LONG_MODE_DOTS mode.

void lv_label_set_max_lines(lv_obj_t *obj, int32_t lines)

lv_label_set_text_selection_start

Set where text selection should start

void lv_label_set_text_selection_start(lv_obj_t *obj, uint32_t index)

lv_label_set_text_selection_end

Set where text selection should end

void lv_label_set_text_selection_end(lv_obj_t *obj, uint32_t index)

lv_label_set_recolor

Enable the recoloring by in-line commands

void lv_label_set_recolor(lv_obj_t *obj, bool en)

lv_label_set_translation_tag

Assign a translation tag for this label. Memory will be allocated to store the tag by the label. The label text will automatically update when the language is changed via lv_translation_set_language.

void lv_label_set_translation_tag(lv_obj_t *obj, const char *tag)

lv_label_get_text

Get the text of a label

char * lv_label_get_text(const lv_obj_t *obj)

Returns: char * — the text of the label

lv_label_get_long_mode

Get the long mode of a label

lv_label_long_mode_t lv_label_get_long_mode(const lv_obj_t *obj)

Returns: lv_label_long_mode_t — the current long mode

lv_label_get_max_lines

Get the maximum number of lines that a label should display

int32_t lv_label_get_max_lines(const lv_obj_t *obj)

Returns: int32_t — the maximum number of lines, if positive

lv_label_get_letter_pos

Get the relative x and y coordinates of a letter

void lv_label_get_letter_pos(const lv_obj_t *obj, uint32_t char_id, lv_point_t *pos)

lv_label_get_letter_on

Get the index of letter on a relative point of a label.

uint32_t lv_label_get_letter_on(const lv_obj_t *obj, lv_point_t *pos_in, bool bidi)

Returns: uint32_t — The index of the letter on the 'pos_p' point (E.g. on 0;0 is the 0. letter if aligned to the left) Expressed in character index and not byte index (different in UTF-8)

lv_label_get_text_selection_start

Get the selection start index.

uint32_t lv_label_get_text_selection_start(const lv_obj_t *obj)

Returns: uint32_t — selection start index. LV_LABEL_TEXT_SELECTION_OFF if nothing is selected.

lv_label_get_text_selection_end

Get the selection end index.

uint32_t lv_label_get_text_selection_end(const lv_obj_t *obj)

Returns: uint32_t — selection end index. LV_LABEL_TXT_SEL_OFF if nothing is selected.

lv_label_get_recolor

Get the recoloring attribute.

bool lv_label_get_recolor(const lv_obj_t *obj)

Returns: bool — true: recoloring is enabled, false: recoloring is disabled

lv_label_create

Create a label object

lv_obj_t * lv_label_create(lv_obj_t *parent)

Returns: lv_obj_t * — pointer to the created button

lv_label_is_char_under_pos

Check if a character is drawn under a point.

bool lv_label_is_char_under_pos(const lv_obj_t *obj, lv_point_t *pos)

Returns: bool — whether a character is drawn under the point

lv_label_bind_text

Bind an integer, string, or pointer Subject to a Label.

lv_observer_t * lv_label_bind_text(lv_obj_t *obj, lv_subject_t *subject, const char *fmt)

Returns: lv_observer_t * — pointer to newly-created Observer

lv_label_ins_text

Insert a text to a label. The label text cannot be static.

void lv_label_ins_text(lv_obj_t *obj, uint32_t pos, const char *txt)

lv_label_cut_text

Delete characters from a label. The label text cannot be static.

void lv_label_cut_text(lv_obj_t *obj, uint32_t pos, uint32_t cnt)