lv_table.h

Go to the documentation of this file.

 
#ifndef LV_TABLE_H
#define LV_TABLE_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*********************
 *      INCLUDES
 *********************/
#include "../lv_conf_internal.h"
 
#if LV_USE_TABLE != 0
 
/*Testing of dependencies*/
#if LV_USE_LABEL == 0
#error "lv_table: 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_TABLE_CELL_NONE 0XFFFF
LV_EXPORT_CONST_INT(LV_TABLE_CELL_NONE);
 
/**********************
 *      TYPEDEFS
 **********************/
 
enum {
    LV_TABLE_CELL_CTRL_MERGE_RIGHT = 1 << 0,
    LV_TABLE_CELL_CTRL_TEXT_CROP   = 1 << 1,
    LV_TABLE_CELL_CTRL_CUSTOM_1    = 1 << 4,
    LV_TABLE_CELL_CTRL_CUSTOM_2    = 1 << 5,
    LV_TABLE_CELL_CTRL_CUSTOM_3    = 1 << 6,
    LV_TABLE_CELL_CTRL_CUSTOM_4    = 1 << 7,
};
 
typedef uint8_t  lv_table_cell_ctrl_t;
 
/*Data of table*/
typedef struct {
    lv_obj_t obj;
    uint16_t col_cnt;
    uint16_t row_cnt;
    char ** cell_data;
    lv_coord_t * row_h;
    lv_coord_t * col_w;
    uint16_t col_act;
    uint16_t row_act;
} lv_table_t;
 
extern const lv_obj_class_t lv_table_class;
 
typedef enum {
    LV_TABLE_DRAW_PART_CELL,       
} lv_table_draw_part_type_t;
 
/**********************
 * GLOBAL PROTOTYPES
 **********************/
 
lv_obj_t * lv_table_create(lv_obj_t * parent);
 
/*=====================
 * Setter functions
 *====================*/
 
void lv_table_set_cell_value(lv_obj_t * obj, uint16_t row, uint16_t col, const char * txt);
 
void lv_table_set_cell_value_fmt(lv_obj_t * obj, uint16_t row, uint16_t col, const char * fmt, ...);
 
void lv_table_set_row_cnt(lv_obj_t * obj, uint16_t row_cnt);
 
void lv_table_set_col_cnt(lv_obj_t * obj, uint16_t col_cnt);
 
void lv_table_set_col_width(lv_obj_t * obj, uint16_t col_id, lv_coord_t w);
 
void lv_table_add_cell_ctrl(lv_obj_t * obj, uint16_t row, uint16_t col, lv_table_cell_ctrl_t ctrl);
 
 
void lv_table_clear_cell_ctrl(lv_obj_t * obj, uint16_t row, uint16_t col, lv_table_cell_ctrl_t ctrl);
 
/*=====================
 * Getter functions
 *====================*/
 
const char * lv_table_get_cell_value(lv_obj_t * obj, uint16_t row, uint16_t col);
 
uint16_t lv_table_get_row_cnt(lv_obj_t * obj);
 
uint16_t lv_table_get_col_cnt(lv_obj_t * obj);
 
lv_coord_t lv_table_get_col_width(lv_obj_t * obj, uint16_t col);
 
bool lv_table_has_cell_ctrl(lv_obj_t * obj, uint16_t row, uint16_t col, lv_table_cell_ctrl_t ctrl);
 
void lv_table_get_selected_cell(lv_obj_t * obj, uint16_t * row, uint16_t * col);
 
/**********************
 *      MACROS
 **********************/
 
#endif /*LV_USE_TABLE*/
 
#ifdef __cplusplus
} /*extern "C"*/
#endif
 
#endif /*LV_TABLE_H*/