lv_textarea.h

Go to the documentation of this file.

 
#ifndef LV_TEXTAREA_H
#define LV_TEXTAREA_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*********************
 *      INCLUDES
 *********************/
#include "../lv_conf_internal.h"
 
#if LV_USE_TEXTAREA != 0
 
/*Testing of dependencies*/
#if LV_USE_LABEL == 0
#error "lv_ta: lv_label is required. Enable it in lv_conf.h (LV_USE_LABEL 1)"
#endif
 
#include "../core/lv_obj.h"
#include "lv_label.h"
 
/*********************
 *      DEFINES
 *********************/
#define LV_TEXTAREA_CURSOR_LAST (0x7FFF) /*Put the cursor after the last character*/
 
LV_EXPORT_CONST_INT(LV_TEXTAREA_CURSOR_LAST);
 
/**********************
 *      TYPEDEFS
 **********************/
 
/*Data of text area*/
typedef struct {
    lv_obj_t obj;
    lv_obj_t * label;            /*Label of the text area*/
    char * placeholder_txt;      /*Place holder label. only visible if text is an empty string*/
    char * pwd_tmp;              /*Used to store the original text in password mode*/
    char * pwd_bullet;           /*Replacement characters displayed in password mode*/
    const char * accepted_chars; /*Only these characters will be accepted. NULL: accept all*/
    uint32_t max_length;         /*The max. number of characters. 0: no limit*/
    uint16_t pwd_show_time;      /*Time to show characters in password mode before change them to '*'*/
    struct {
        lv_coord_t valid_x;        /*Used when stepping up/down to a shorter line.
                                    *(Used by the library)*/
        uint32_t pos;              /*The current cursor position
                                    *(0: before 1st letter; 1: before 2nd letter ...)*/
        lv_area_t area;            /*Cursor area relative to the Text Area*/
        uint32_t txt_byte_pos;     /*Byte index of the letter after (on) the cursor*/
        uint8_t show : 1;          /*Cursor is visible now or not (Handled by the library)*/
        uint8_t click_pos : 1;     /*1: Enable positioning the cursor by clicking the text area*/
    } cursor;
#if LV_LABEL_TEXT_SELECTION
    uint32_t sel_start;  /*Temporary values for text selection*/
    uint32_t sel_end;
    uint8_t text_sel_in_prog : 1; /*User is in process of selecting*/
    uint8_t text_sel_en : 1;      /*Text can be selected on this text area*/
#endif
    uint8_t pwd_mode : 1; /*Replace characters with '*'*/
    uint8_t one_line : 1; /*One line mode (ignore line breaks)*/
} lv_textarea_t;
 
extern const lv_obj_class_t lv_textarea_class;
 
enum {
    LV_PART_TEXTAREA_PLACEHOLDER = LV_PART_CUSTOM_FIRST,
};
 
/**********************
 * GLOBAL PROTOTYPES
 **********************/
 
lv_obj_t * lv_textarea_create(lv_obj_t * parent);
 
/*======================
 * Add/remove functions
 *=====================*/
 
void lv_textarea_add_char(lv_obj_t * obj, uint32_t c);
 
void lv_textarea_add_text(lv_obj_t * obj, const char * txt);
 
void lv_textarea_del_char(lv_obj_t * obj);
 
void lv_textarea_del_char_forward(lv_obj_t * obj);
 
/*=====================
 * Setter functions
 *====================*/
 
void lv_textarea_set_text(lv_obj_t * obj, const char * txt);
 
void lv_textarea_set_placeholder_text(lv_obj_t * obj, const char * txt);
 
void lv_textarea_set_cursor_pos(lv_obj_t * obj, int32_t pos);
 
void lv_textarea_set_cursor_click_pos(lv_obj_t * obj, bool en);
 
void lv_textarea_set_password_mode(lv_obj_t * obj, bool en);
 
void lv_textarea_set_password_bullet(lv_obj_t * obj, const char * bullet);
 
void lv_textarea_set_one_line(lv_obj_t * obj, bool en);
 
void lv_textarea_set_accepted_chars(lv_obj_t * obj, const char * list);
 
void lv_textarea_set_max_length(lv_obj_t * obj, uint32_t num);
 
void lv_textarea_set_insert_replace(lv_obj_t * obj, const char * txt);
 
void lv_textarea_set_text_selection(lv_obj_t * obj, bool en);
 
void lv_textarea_set_password_show_time(lv_obj_t * obj, uint16_t time);
 
void lv_textarea_set_align(lv_obj_t * obj, lv_text_align_t align);
 
/*=====================
 * Getter functions
 *====================*/
 
const char * lv_textarea_get_text(const lv_obj_t * obj);
 
const char * lv_textarea_get_placeholder_text(lv_obj_t * obj);
 
lv_obj_t * lv_textarea_get_label(const lv_obj_t * obj);
 
uint32_t lv_textarea_get_cursor_pos(const lv_obj_t * obj);
 
bool lv_textarea_get_cursor_click_pos(lv_obj_t * obj);
 
bool lv_textarea_get_password_mode(const lv_obj_t * obj);
 
const char * lv_textarea_get_password_bullet(lv_obj_t * obj);
 
bool lv_textarea_get_one_line(const lv_obj_t * obj);
 
const char * lv_textarea_get_accepted_chars(lv_obj_t * obj);
 
uint32_t lv_textarea_get_max_length(lv_obj_t * obj);
 
bool lv_textarea_text_is_selected(const lv_obj_t * obj);
 
bool lv_textarea_get_text_selection(lv_obj_t * obj);
 
uint16_t lv_textarea_get_password_show_time(lv_obj_t * obj);
 
/*=====================
 * Other functions
 *====================*/
 
void lv_textarea_clear_selection(lv_obj_t * obj);
 
void lv_textarea_cursor_right(lv_obj_t * obj);
 
void lv_textarea_cursor_left(lv_obj_t * obj);
 
void lv_textarea_cursor_down(lv_obj_t * obj);
 
void lv_textarea_cursor_up(lv_obj_t * obj);
 
/**********************
 *      MACROS
 **********************/
 
#endif /*LV_USE_TEXTAREA_H*/
 
#ifdef __cplusplus
} /*extern "C"*/
#endif
 
#endif /*LV_TEXTAREA_H*/