lv_label.h

Go to the documentation of this file.

 
#ifndef LV_LABEL_H
#define LV_LABEL_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*********************
 *      INCLUDES
 *********************/
#include "../lv_conf_internal.h"
 
#if LV_USE_LABEL != 0
 
#include <stdarg.h>
#include "../core/lv_obj.h"
#include "../font/lv_font.h"
#include "../font/lv_symbol_def.h"
#include "../misc/lv_txt.h"
#include "../draw/lv_draw.h"
 
/*********************
 *      DEFINES
 *********************/
#define LV_LABEL_WAIT_CHAR_COUNT        3
#define LV_LABEL_DOT_NUM 3
#define LV_LABEL_POS_LAST 0xFFFF
#define LV_LABEL_TEXT_SELECTION_OFF LV_DRAW_LABEL_NO_TXT_SEL
 
LV_EXPORT_CONST_INT(LV_LABEL_DOT_NUM);
LV_EXPORT_CONST_INT(LV_LABEL_POS_LAST);
LV_EXPORT_CONST_INT(LV_LABEL_TEXT_SELECTION_OFF);
 
/**********************
 *      TYPEDEFS
 **********************/
 
enum {
    LV_LABEL_LONG_WRAP,             
    LV_LABEL_LONG_DOT,              
    LV_LABEL_LONG_SCROLL,           
    LV_LABEL_LONG_SCROLL_CIRCULAR,  
    LV_LABEL_LONG_CLIP,             
};
typedef uint8_t lv_label_long_mode_t;
 
typedef struct {
    lv_obj_t obj;
    char * text;
    union {
        char * tmp_ptr; /*Pointer to the allocated memory containing the character replaced by dots*/
        char tmp[LV_LABEL_DOT_NUM + 1]; /*Directly store the characters if <=4 characters*/
    } dot;
    uint32_t dot_end;  /*The real text length, used in dot mode*/
 
#if LV_LABEL_LONG_TXT_HINT
    lv_draw_label_hint_t hint;
#endif
 
#if LV_LABEL_TEXT_SELECTION
    uint32_t sel_start;
    uint32_t sel_end;
#endif
 
    lv_point_t offset; /*Text draw position offset*/
    lv_label_long_mode_t long_mode : 3; /*Determine what to do with the long texts*/
    uint8_t static_txt : 1;             /*Flag to indicate the text is static*/
    uint8_t recolor : 1;                /*Enable in-line letter re-coloring*/
    uint8_t expand : 1;                 /*Ignore real width (used by the library with LV_LABEL_LONG_SCROLL)*/
    uint8_t dot_tmp_alloc : 1;         /*1: dot is allocated, 0: dot directly holds up to 4 chars*/
} lv_label_t;
 
extern const lv_obj_class_t lv_label_class;
 
/**********************
 * GLOBAL PROTOTYPES
 **********************/
 
lv_obj_t * lv_label_create(lv_obj_t * parent);
 
/*=====================
 * Setter functions
 *====================*/
 
void lv_label_set_text(lv_obj_t * obj, const char * text);
 
void lv_label_set_text_fmt(lv_obj_t * obj, const char * fmt, ...) LV_FORMAT_ATTRIBUTE(2, 3);
 
void lv_label_set_text_static(lv_obj_t * obj, const char * text);
 
void lv_label_set_long_mode(lv_obj_t * obj, lv_label_long_mode_t long_mode);
 
void lv_label_set_recolor(lv_obj_t * obj, bool en);
 
void lv_label_set_text_sel_start(lv_obj_t * obj, uint32_t index);
 
void lv_label_set_text_sel_end(lv_obj_t * obj, uint32_t index);
 
/*=====================
 * Getter functions
 *====================*/
 
char * lv_label_get_text(const lv_obj_t * obj);
 
lv_label_long_mode_t lv_label_get_long_mode(const lv_obj_t * obj);
 
bool lv_label_get_recolor(const lv_obj_t * obj);
 
void lv_label_get_letter_pos(const lv_obj_t * obj, uint32_t char_id, lv_point_t * pos);
 
uint32_t lv_label_get_letter_on(const lv_obj_t * obj, lv_point_t * pos_in);
 
bool lv_label_is_char_under_pos(const lv_obj_t * obj, lv_point_t * pos);
 
uint32_t lv_label_get_text_selection_start(const lv_obj_t * obj);
 
uint32_t lv_label_get_text_selection_end(const lv_obj_t * obj);
 
/*=====================
 * Other functions
 *====================*/
 
void lv_label_ins_text(lv_obj_t * obj, uint32_t pos, const char * txt);
 
void lv_label_cut_text(lv_obj_t * obj, uint32_t pos, uint32_t cnt);
 
/**********************
 *      MACROS
 **********************/
 
#endif /*LV_USE_LABEL*/
 
#ifdef __cplusplus
} /*extern "C"*/
#endif
 
#endif /*LV_LABEL_H*/