API Widgets Label

lv_label.h

API reference for lv_label.h

Report on GitHub

See Also: Private HeaderThis header has a companion private implementation with internal data structures.lv_label_private.h

Summary

Functions

widgets/label/lv_label.h:91function

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)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to a label object
`text`	`const char *`	'\0' terminated character string. NULL to refresh with the current text.

If LV_USE_ARABIC_PERSIAN_CHARS is enabled the text will be modified to have the correct Arabic characters in it.

widgets/label/lv_label.h:103function

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,...)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to a label object
`fmt`	`const char *`	`printf`-like format string Example: `lv_label_set_text_fmt(label1, "%d user", user_num);`
`...`

If LV_USE_ARABIC_PERSIAN_CHARS is enabled the text will be modified to have the correct Arabic characters in it.

widgets/label/lv_label.h:120function

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)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to a label object
`fmt`	`const char *`	`printf`-like format string
`args`	`va_list`	variadic arguments list

It ignores LV_USE_ARABIC_PERSIAN_CHARS

widgets/label/lv_label.h:129function

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)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to a label object
`text`	`const char *`	pointer to a text. NULL to refresh with the current text.

It ignores LV_USE_ARABIC_PERSIAN_CHARS

widgets/label/lv_label.h:137function

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)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to a label object
`long_mode`	`lv_label_long_mode_t`	the new mode from 'lv_label_long_mode' enum. In LV_LONG_WRAP/DOT/SCROLL/SCROLL_CIRC the size of the label should be set AFTER this function

widgets/label/lv_label.h:144function

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)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to a label object
`index`	`uint32_t`	character index from where selection should start. `LV_LABEL_TEXT_SELECTION_OFF` for no selection

widgets/label/lv_label.h:151function

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)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to a label object
`index`	`uint32_t`	character index where selection should end. `LV_LABEL_TEXT_SELECTION_OFF` for no selection

widgets/label/lv_label.h:159function

lv_label_set_recolor

Enable the recoloring by in-line commands

void lv_label_set_recolor(lv_obj_t *obj, bool en)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to a label object
`en`	`bool`	true: enable recoloring, false: disable Example: "This is a #ff0000 red# word"

widgets/label/lv_label.h:169function

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)

Name	Type	Description
`obj`	`lv_obj_t *`	pointer to a label object
`tag`	`const char *`	'\0' terminated character string.

Enums

widgets/label/lv_label.h:49enum

lv_label_long_mode_t

Long mode behaviors. Used in 'lv_label_ext_t'

Name	Description
`LV_LABEL_LONG_MODE_WRAP`	Keep the object width, wrap lines longer than object width and expand the object height
`LV_LABEL_LONG_MODE_DOTS`	Keep the size and write dots at the end if the text is too long
`LV_LABEL_LONG_MODE_SCROLL`	Keep the size and roll the text back and forth
`LV_LABEL_LONG_MODE_SCROLL_CIRCULAR`	Keep the size and roll the text circularly
`LV_LABEL_LONG_MODE_CLIP`	Keep the size and clip the text out of it

Used by 1 function

lv_label_set_long_mode — param long_mode

widgets/label/lv_label.h:58enum

_lv_property_label_id_t

Name	Value
`LV_PROPERTY_LABEL_TEXT`	`(LV_PROPERTY_LABEL_START + ((int) 0 )) \| (( 7 ) << 28 )`
`LV_PROPERTY_LABEL_LONG_MODE`	`(LV_PROPERTY_LABEL_START + ((int) 1 )) \| (( 1 ) << 28 )`
`LV_PROPERTY_LABEL_TEXT_SELECTION_START`	`(LV_PROPERTY_LABEL_START + ((int) 2 )) \| (( 1 ) << 28 )`
`LV_PROPERTY_LABEL_TEXT_SELECTION_END`	`(LV_PROPERTY_LABEL_START + ((int) 3 )) \| (( 1 ) << 28 )`
`LV_PROPERTY_LABEL_END`

Macros

widgets/label/lv_label.h:31macro

LV_LABEL_DOT_NUM

#define LV_LABEL_DOT_NUM 3

widgets/label/lv_label.h:32macro

LV_LABEL_POS_LAST

#define LV_LABEL_POS_LAST 0xFFFF

widgets/label/lv_label.h:33macro

LV_LABEL_TEXT_SELECTION_OFF

#define LV_LABEL_TEXT_SELECTION_OFF LV_DRAW_LABEL_NO_TXT_SEL

widgets/label/lv_label.h:35macro

LV_LABEL_DEFAULT_TEXT

#define LV_LABEL_DEFAULT_TEXT "Text"

Variables

widgets/label/lv_label.h:67variable

lv_label_class

const lv_obj_class_t lv_label_class

Dependencies

Indirect dependencies

How is this guide?

Last updated on

Label

API reference for the label module

lv_label_private.h

API reference for lv_label_private.h