# lv_textarea.h (/api/widgets/textarea/lv_textarea_h) Functions [#functions] lv_textarea_set_text [#lv_textarea_set_text] Set the text of a text area ```c title=" " lineNumbers=1 void lv_textarea_set_text(lv_obj_t *obj, const char *txt) ``` Parameters | Name | Type | Description | | ----- | ------------------------------------------------ | ----------------------------- | | `obj` | | pointer to a text area object | | `txt` | `const char *` | pointer to the text | lv_textarea_set_placeholder_text [#lv_textarea_set_placeholder_text] Set the placeholder text of a text area ```c title=" " lineNumbers=1 void lv_textarea_set_placeholder_text(lv_obj_t *obj, const char *txt) ``` Parameters | Name | Type | Description | | ----- | ------------------------------------------------ | ----------------------------- | | `obj` | | pointer to a text area object | | `txt` | `const char *` | pointer to the text | lv_textarea_set_cursor_pos [#lv_textarea_set_cursor_pos] Set the cursor position ```c title=" " lineNumbers=1 void lv_textarea_set_cursor_pos(lv_obj_t *obj, int32_t pos) ``` Parameters | Name | Type | Description | | ----- | ------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------- | | `obj` | | pointer to a text area object | | `pos` | | the new cursor position in character index \< 0 : index from the end of the text LV\_TEXTAREA\_CURSOR\_LAST: go after the last character | lv_textarea_set_cursor_click_pos [#lv_textarea_set_cursor_click_pos] Enable/Disable the positioning of the cursor by clicking the text on the text area. ```c title=" " lineNumbers=1 void lv_textarea_set_cursor_click_pos(lv_obj_t *obj, bool en) ``` Parameters | Name | Type | Description | | ----- | ------------------------------------------------ | -------------------------------------------- | | `obj` | | pointer to a text area object | | `en` | | true: enable click positions; false: disable | lv_textarea_set_password_mode [#lv_textarea_set_password_mode] Enable/Disable password mode ```c title=" " lineNumbers=1 void lv_textarea_set_password_mode(lv_obj_t *obj, bool en) ``` Parameters | Name | Type | Description | | ----- | ------------------------------------------------ | ----------------------------- | | `obj` | | pointer to a text area object | | `en` | | true: enable, false: disable | lv_textarea_set_password_bullet [#lv_textarea_set_password_bullet] Set the replacement characters to show in password mode ```c title=" " lineNumbers=1 void lv_textarea_set_password_bullet(lv_obj_t *obj, const char *bullet) ``` Parameters | Name | Type | Description | | -------- | ------------------------------------------------ | ------------------------------- | | `obj` | | pointer to a text area object | | `bullet` | `const char *` | pointer to the replacement text | lv_textarea_set_one_line [#lv_textarea_set_one_line] Configure the text area to one line or back to normal ```c title=" " lineNumbers=1 void lv_textarea_set_one_line(lv_obj_t *obj, bool en) ``` Parameters | Name | Type | Description | | ----- | ------------------------------------------------ | ----------------------------- | | `obj` | | pointer to a text area object | | `en` | | true: one line, false: normal | lv_textarea_set_accepted_chars [#lv_textarea_set_accepted_chars] Set a list of characters. Only these characters will be accepted by the text area ```c title=" " lineNumbers=1 void lv_textarea_set_accepted_chars(lv_obj_t *obj, const char *list) ``` Parameters | Name | Type | Description | | ------ | ------------------------------------------------ | -------------------------------------------------------------- | | `obj` | | pointer to a text area object | | `list` | `const char *` | list of characters. A copy is saved. Example: "+-.,0123456789" | lv_textarea_set_accepted_chars_static [#lv_textarea_set_accepted_chars_static] Set a list of characters. Only these characters will be accepted by the text area ```c title=" " lineNumbers=1 void lv_textarea_set_accepted_chars_static(lv_obj_t *obj, const char *list) ``` Parameters | Name | Type | Description | | ------ | ------------------------------------------------ | ------------------------------------------------------------------------ | | `obj` | | pointer to a text area object | | `list` | `const char *` | list of characters. Only the pointer is saved. Example: "+-.,0123456789" | lv_textarea_set_max_length [#lv_textarea_set_max_length] Set max length of a Text Area. ```c title=" " lineNumbers=1 void lv_textarea_set_max_length(lv_obj_t *obj, uint32_t num) ``` Parameters | Name | Type | Description | | ----- | ------------------------------------------------ | --------------------------------------------------------------------------------- | | `obj` | | pointer to a text area object | | `num` | | the maximal number of characters can be added (`lv_textarea_set_text` ignores it) | lv_textarea_set_insert_replace [#lv_textarea_set_insert_replace] In `LV_EVENT_INSERT` the text which planned to be inserted can be replaced by another text. It can be used to add automatic formatting to the text area. ```c title=" " lineNumbers=1 void lv_textarea_set_insert_replace(lv_obj_t *obj, const char *txt) ``` Parameters | Name | Type | Description | | ----- | ------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------- | | `obj` | | pointer to a text area object | | `txt` | `const char *` | pointer to a new string to insert. If `""` no text will be added. The variable must be live after the `event_cb` exists. (Should be `global` or `static`) | lv_textarea_set_text_selection [#lv_textarea_set_text_selection] Enable/disable selection mode. ```c title=" " lineNumbers=1 void lv_textarea_set_text_selection(lv_obj_t *obj, bool en) ``` Parameters | Name | Type | Description | | ----- | ------------------------------------------------ | ---------------------------------------------- | | `obj` | | pointer to a text area object | | `en` | | true or false to enable/disable selection mode | lv_textarea_set_password_show_time [#lv_textarea_set_password_show_time] Set how long show the password before changing it to '\*' ```c title=" " lineNumbers=1 void lv_textarea_set_password_show_time(lv_obj_t *obj, uint32_t time) ``` Parameters | Name | Type | Description | | ------ | ------------------------------------------------ | ----------------------------------------------- | | `obj` | | pointer to a text area object | | `time` | | show time in milliseconds. 0: hide immediately. | lv_textarea_set_align [#lv_textarea_set_align] \> **Deprecated:** Use the normal text\_align style property instead Set the label's alignment. It sets where the label is aligned (in one line mode it can be smaller than the text area) and how the lines of the area align in case of multiline text area ```c title=" " lineNumbers=1 void lv_textarea_set_align(lv_obj_t *obj, lv_text_align_t align) ``` Parameters | Name | Type | Description | | ------- | ------------------------------------------------ | ------------------------------------------------------ | | `obj` | | pointer to a text area object | | `align` | | the align mode from | lv_textarea_get_text [#lv_textarea_get_text] Get the text of a text area. In password mode it gives the real text (not '\*'s). ```c title=" " lineNumbers=1 const char * lv_textarea_get_text(const lv_obj_t *obj) ``` Parameters | Name | Type | Description | | ----- | ------------------------------------------------------ | ----------------------------- | | `obj` | | pointer to a text area object | **Returns:** `const char *` — pointer to the text lv_textarea_get_placeholder_text [#lv_textarea_get_placeholder_text] Get the placeholder text of a text area ```c title=" " lineNumbers=1 const char * lv_textarea_get_placeholder_text(lv_obj_t *obj) ``` Parameters | Name | Type | Description | | ----- | ------------------------------------------------ | ----------------------------- | | `obj` | | pointer to a text area object | **Returns:** `const char *` — pointer to the text lv_textarea_get_label [#lv_textarea_get_label] Get the label of a text area ```c title=" " lineNumbers=1 lv_obj_t * lv_textarea_get_label(const lv_obj_t *obj) ``` Parameters | Name | Type | Description | | ----- | ------------------------------------------------------ | ----------------------------- | | `obj` | | pointer to a text area object | **Returns:** — pointer to the label object lv_textarea_get_cursor_pos [#lv_textarea_get_cursor_pos] Get the current cursor position in character index ```c title=" " lineNumbers=1 uint32_t lv_textarea_get_cursor_pos(const lv_obj_t *obj) ``` Parameters | Name | Type | Description | | ----- | ------------------------------------------------------ | ----------------------------- | | `obj` | | pointer to a text area object | **Returns:** — the cursor position lv_textarea_get_cursor_click_pos [#lv_textarea_get_cursor_click_pos] Get whether the cursor click positioning is enabled or not. ```c title=" " lineNumbers=1 bool lv_textarea_get_cursor_click_pos(lv_obj_t *obj) ``` Parameters | Name | Type | Description | | ----- | ------------------------------------------------ | ----------------------------- | | `obj` | | pointer to a text area object | **Returns:** — true: enable click positions; false: disable lv_textarea_get_password_mode [#lv_textarea_get_password_mode] Get the password mode attribute ```c title=" " lineNumbers=1 bool lv_textarea_get_password_mode(const lv_obj_t *obj) ``` Parameters | Name | Type | Description | | ----- | ------------------------------------------------------ | ----------------------------- | | `obj` | | pointer to a text area object | **Returns:** — true: password mode is enabled, false: disabled lv_textarea_get_password_bullet [#lv_textarea_get_password_bullet] Get the replacement characters to show in password mode ```c title=" " lineNumbers=1 const char * lv_textarea_get_password_bullet(lv_obj_t *obj) ``` Parameters | Name | Type | Description | | ----- | ------------------------------------------------ | ----------------------------- | | `obj` | | pointer to a text area object | **Returns:** `const char *` — pointer to the replacement text lv_textarea_get_one_line [#lv_textarea_get_one_line] Get the one line configuration attribute ```c title=" " lineNumbers=1 bool lv_textarea_get_one_line(const lv_obj_t *obj) ``` Parameters | Name | Type | Description | | ----- | ------------------------------------------------------ | ----------------------------- | | `obj` | | pointer to a text area object | **Returns:** — true: one line configuration is enabled, false: disabled lv_textarea_get_accepted_chars [#lv_textarea_get_accepted_chars] Get a list of accepted characters. ```c title=" " lineNumbers=1 const char * lv_textarea_get_accepted_chars(lv_obj_t *obj) ``` Parameters | Name | Type | Description | | ----- | ------------------------------------------------ | ----------------------------- | | `obj` | | pointer to a text area object | **Returns:** `const char *` — list of accented characters. lv_textarea_get_max_length [#lv_textarea_get_max_length] Get max length of a Text Area. ```c title=" " lineNumbers=1 uint32_t lv_textarea_get_max_length(lv_obj_t *obj) ``` Parameters | Name | Type | Description | | ----- | ------------------------------------------------ | ----------------------------- | | `obj` | | pointer to a text area object | **Returns:** — the maximal number of characters to be add lv_textarea_get_text_selection [#lv_textarea_get_text_selection] Find whether selection mode is enabled. ```c title=" " lineNumbers=1 bool lv_textarea_get_text_selection(lv_obj_t *obj) ``` Parameters | Name | Type | Description | | ----- | ------------------------------------------------ | ----------------------------- | | `obj` | | pointer to a text area object | **Returns:** — true: selection mode is enabled, false: disabled lv_textarea_get_password_show_time [#lv_textarea_get_password_show_time] Set how long show the password before changing it to '\*' ```c title=" " lineNumbers=1 uint32_t lv_textarea_get_password_show_time(lv_obj_t *obj) ``` Parameters | Name | Type | Description | | ----- | ------------------------------------------------ | ----------------------------- | | `obj` | | pointer to a text area object | **Returns:** — show time in milliseconds. 0: hide immediately. lv_textarea_get_current_char [#lv_textarea_get_current_char] Get a the character from the current cursor position ```c title=" " lineNumbers=1 uint32_t lv_textarea_get_current_char(lv_obj_t *obj) ``` Parameters | Name | Type | Description | | ----- | ------------------------------------------------ | ----------------------------- | | `obj` | | pointer to a text area object | **Returns:** — a the character or 0 lv_textarea_create [#lv_textarea_create] Create a text area object ```c title=" " lineNumbers=1 lv_obj_t * lv_textarea_create(lv_obj_t *parent) ``` Parameters | Name | Type | Description | | -------- | ------------------------------------------------ | ---------------------------------------------------------------- | | `parent` | | pointer to an object, it will be the parent of the new text area | **Returns:** — pointer to the created text area lv_textarea_add_char [#lv_textarea_add_char] Insert a character to the current cursor position. To add a wide char, e.g. 'Á' use ‘lv\_text\_encoded\_conv\_wc('Á’)‘ ```c title=" " lineNumbers=1 void lv_textarea_add_char(lv_obj_t *obj, uint32_t c) ``` Parameters | Name | Type | Description | | ----- | ------------------------------------------------ | ----------------------------- | | `obj` | | pointer to a text area object | | `c` | | a character (e.g. 'a’) | lv_textarea_add_text [#lv_textarea_add_text] Insert a text to the current cursor position ```c title=" " lineNumbers=1 void lv_textarea_add_text(lv_obj_t *obj, const char *txt) ``` Parameters | Name | Type | Description | | ----- | ------------------------------------------------ | ---------------------------------- | | `obj` | | pointer to a text area object | | `txt` | `const char *` | a '\0' terminated string to insert | lv_textarea_delete_char [#lv_textarea_delete_char] Delete a the left character from the current cursor position ```c title=" " lineNumbers=1 void lv_textarea_delete_char(lv_obj_t *obj) ``` Parameters | Name | Type | Description | | ----- | ------------------------------------------------ | ----------------------------- | | `obj` | | pointer to a text area object | lv_textarea_delete_char_forward [#lv_textarea_delete_char_forward] Delete the right character from the current cursor position ```c title=" " lineNumbers=1 void lv_textarea_delete_char_forward(lv_obj_t *obj) ``` Parameters | Name | Type | Description | | ----- | ------------------------------------------------ | ----------------------------- | | `obj` | | pointer to a text area object | lv_textarea_text_is_selected [#lv_textarea_text_is_selected] Find whether text is selected or not. ```c title=" " lineNumbers=1 bool lv_textarea_text_is_selected(const lv_obj_t *obj) ``` Parameters | Name | Type | Description | | ----- | ------------------------------------------------------ | ----------------------------- | | `obj` | | pointer to a text area object | **Returns:** — whether text is selected or not lv_textarea_clear_selection [#lv_textarea_clear_selection] Clear the selection on the text area. ```c title=" " lineNumbers=1 void lv_textarea_clear_selection(lv_obj_t *obj) ``` Parameters | Name | Type | Description | | ----- | ------------------------------------------------ | ----------------------------- | | `obj` | | pointer to a text area object | lv_textarea_cursor_right [#lv_textarea_cursor_right] Move the cursor one character right ```c title=" " lineNumbers=1 void lv_textarea_cursor_right(lv_obj_t *obj) ``` Parameters | Name | Type | Description | | ----- | ------------------------------------------------ | ----------------------------- | | `obj` | | pointer to a text area object | lv_textarea_cursor_left [#lv_textarea_cursor_left] Move the cursor one character left ```c title=" " lineNumbers=1 void lv_textarea_cursor_left(lv_obj_t *obj) ``` Parameters | Name | Type | Description | | ----- | ------------------------------------------------ | ----------------------------- | | `obj` | | pointer to a text area object | lv_textarea_cursor_down [#lv_textarea_cursor_down] Move the cursor one line down ```c title=" " lineNumbers=1 void lv_textarea_cursor_down(lv_obj_t *obj) ``` Parameters | Name | Type | Description | | ----- | ------------------------------------------------ | ----------------------------- | | `obj` | | pointer to a text area object | lv_textarea_cursor_up [#lv_textarea_cursor_up] Move the cursor one line up ```c title=" " lineNumbers=1 void lv_textarea_cursor_up(lv_obj_t *obj) ``` Parameters | Name | Type | Description | | ----- | ------------------------------------------------ | ----------------------------- | | `obj` | | pointer to a text area object | Enums [#enums] \_lv_property_textarea_id_t [#_lv_property_textarea_id_t] | Name | Value | | ----------------------------------------- | ------------------------------------------------------------------ | | `LV_PROPERTY_TEXTAREA_TEXT` | `(LV_PROPERTY_TEXTAREA_START + ((int) 0 )) \| (( 7 ) << 28 )` | | `LV_PROPERTY_TEXTAREA_PLACEHOLDER_TEXT` | `(LV_PROPERTY_TEXTAREA_START + ((int) 1 )) \| (( 7 ) << 28 )` | | `LV_PROPERTY_TEXTAREA_CURSOR_POS` | `(LV_PROPERTY_TEXTAREA_START + ((int) 2 )) \| (( 1 ) << 28 )` | | `LV_PROPERTY_TEXTAREA_CURSOR_CLICK_POS` | `(LV_PROPERTY_TEXTAREA_START + ((int) 3 )) \| (( 1 ) << 28 )` | | `LV_PROPERTY_TEXTAREA_PASSWORD_MODE` | `(LV_PROPERTY_TEXTAREA_START + ((int) 4 )) \| (( 1 ) << 28 )` | | `LV_PROPERTY_TEXTAREA_PASSWORD_BULLET` | `(LV_PROPERTY_TEXTAREA_START + ((int) 5 )) \| (( 7 ) << 28 )` | | `LV_PROPERTY_TEXTAREA_ONE_LINE` | `(LV_PROPERTY_TEXTAREA_START + ((int) 6 )) \| (( 11 ) << 28 )` | | `LV_PROPERTY_TEXTAREA_ACCEPTED_CHARS` | `(LV_PROPERTY_TEXTAREA_START + ((int) 7 )) \| (( 7 ) << 28 )` | | `LV_PROPERTY_TEXTAREA_MAX_LENGTH` | `(LV_PROPERTY_TEXTAREA_START + ((int) 8 )) \| (( 1 ) << 28 )` | | `LV_PROPERTY_TEXTAREA_TEXT_SELECTION` | `(LV_PROPERTY_TEXTAREA_START + ((int) 9 )) \| (( 11 ) << 28 )` | | `LV_PROPERTY_TEXTAREA_PASSWORD_SHOW_TIME` | `(LV_PROPERTY_TEXTAREA_START + ((int) 10 )) \| (( 1 ) << 28 )` | | `LV_PROPERTY_TEXTAREA_LABEL` | `(LV_PROPERTY_TEXTAREA_START + ((int) 11 )) \| (( 8 ) << 28 )` | | `LV_PROPERTY_TEXTAREA_TEXT_IS_SELECTED` | `(LV_PROPERTY_TEXTAREA_START + ((int) 12 )) \| (( 1 ) << 28 )` | | `LV_PROPERTY_TEXTAREA_CURRENT_CHAR` | `(LV_PROPERTY_TEXTAREA_START + ((int) 13 )) \| (( 1 ) << 28 )` | | `LV_PROPERTY_TEXTAREA_END` | | Macros [#macros] LV_TEXTAREA_CURSOR_LAST [#lv_textarea_cursor_last] ```c title=" " lineNumbers=1 #define LV_TEXTAREA_CURSOR_LAST (0x7FFF) /*Put the cursor after the last character*/ ``` LV_PART_TEXTAREA_PLACEHOLDER [#lv_part_textarea_placeholder] ```c title=" " lineNumbers=1 #define LV_PART_TEXTAREA_PLACEHOLDER LV_PART_CUSTOM_FIRST ``` Variables [#variables] lv_textarea_class [#lv_textarea_class] ```c title=" " lineNumbers=1 const lv_obj_class_t lv_textarea_class ``` Dependencies [#dependencies]