lv_span.h

Go to the documentation of this file.

 
#ifndef LV_SPAN_H
#define LV_SPAN_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*********************
 *      INCLUDES
 *********************/
#include "../../../lvgl.h"
 
#if LV_USE_SPAN != 0
 
/*********************
 *      DEFINES
 *********************/
#ifndef LV_SPAN_SNIPPET_STACK_SIZE
#define LV_SPAN_SNIPPET_STACK_SIZE 64
#endif
 
/**********************
 *      TYPEDEFS
 **********************/
enum {
    LV_SPAN_OVERFLOW_CLIP,
    LV_SPAN_OVERFLOW_ELLIPSIS,
};
typedef uint8_t lv_span_overflow_t;
 
enum {
    LV_SPAN_MODE_FIXED,     
    LV_SPAN_MODE_EXPAND,    
    LV_SPAN_MODE_BREAK,     
};
typedef uint8_t lv_span_mode_t;
 
typedef struct {
    char * txt;             /* a pointer to display text */
    lv_obj_t * spangroup;   /* a pointer to spangroup */
    lv_style_t style;       /* display text style */
    uint8_t static_flag : 1;/* the text is static flag */
} lv_span_t;
 
typedef struct {
    lv_obj_t obj;
    int32_t lines;
    lv_coord_t indent;      /* first line indent */
    lv_coord_t cache_w;     /* the cache automatically calculates the width */
    lv_coord_t cache_h;     /* similar cache_w */
    lv_ll_t  child_ll;
    uint8_t mode : 2;       /* details see lv_span_mode_t */
    uint8_t overflow : 1;   /* details see lv_span_overflow_t */
    uint8_t refresh : 1;    /* the spangroup need refresh cache_w and cache_h */
} lv_spangroup_t;
 
extern const lv_obj_class_t lv_spangroup_class;
 
/**********************
 * GLOBAL PROTOTYPES
 **********************/
 
lv_obj_t * lv_spangroup_create(lv_obj_t * par);
 
lv_span_t * lv_spangroup_new_span(lv_obj_t * obj);
 
void lv_spangroup_del_span(lv_obj_t * obj, lv_span_t * span);
 
/*=====================
 * Setter functions
 *====================*/
 
void lv_span_set_text(lv_span_t * span, const char * text);
 
void lv_span_set_text_static(lv_span_t * span, const char * text);
 
void lv_spangroup_set_align(lv_obj_t * obj, lv_text_align_t align);
 
void lv_spangroup_set_overflow(lv_obj_t * obj, lv_span_overflow_t overflow);
 
void lv_spangroup_set_indent(lv_obj_t * obj, lv_coord_t indent);
 
void lv_spangroup_set_mode(lv_obj_t * obj, lv_span_mode_t mode);
 
void lv_spangroup_set_lines(lv_obj_t * obj, int32_t lines);
 
/*=====================
 * Getter functions
 *====================*/
 
lv_span_t * lv_spangroup_get_child(const lv_obj_t * obj, int32_t id);
 
uint32_t lv_spangroup_get_child_cnt(const lv_obj_t * obj);
 
lv_text_align_t lv_spangroup_get_align(lv_obj_t * obj);
 
lv_span_overflow_t lv_spangroup_get_overflow(lv_obj_t * obj);
 
lv_coord_t lv_spangroup_get_indent(lv_obj_t * obj);
 
lv_span_mode_t lv_spangroup_get_mode(lv_obj_t * obj);
 
int32_t lv_spangroup_get_lines(lv_obj_t * obj);
 
lv_coord_t lv_spangroup_get_max_line_h(lv_obj_t * obj);
 
uint32_t lv_spangroup_get_expand_width(lv_obj_t * obj, uint32_t max_width);
 
lv_coord_t lv_spangroup_get_expand_height(lv_obj_t * obj, lv_coord_t width);
 
 
/*=====================
 * Other functions
 *====================*/
 
void lv_spangroup_refr_mode(lv_obj_t * obj);
 
/**********************
 *      MACROS
 **********************/
 
#endif /*LV_USE_SPAN*/
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /*LV_SPAN_H*/