lv_btnmatrix.h

Go to the documentation of this file.

 
#ifndef LV_BTNMATRIX_H
#define LV_BTNMATRIX_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*********************
 *      INCLUDES
 *********************/
#include "../lv_conf_internal.h"
 
#if LV_USE_BTNMATRIX != 0
 
#include "../core/lv_obj.h"
 
/*********************
 *      DEFINES
 *********************/
#define LV_BTNMATRIX_BTN_NONE 0xFFFF
LV_EXPORT_CONST_INT(LV_BTNMATRIX_BTN_NONE);
 
/**********************
 *      TYPEDEFS
 **********************/
 
enum {
    _LV_BTNMATRIX_WIDTH     = 0x0007,      
    LV_BTNMATRIX_CTRL_HIDDEN     = 0x0008, 
    LV_BTNMATRIX_CTRL_NO_REPEAT  = 0x0010, 
    LV_BTNMATRIX_CTRL_DISABLED   = 0x0020, 
    LV_BTNMATRIX_CTRL_CHECKABLE  = 0x0040, 
    LV_BTNMATRIX_CTRL_CHECKED    = 0x0080, 
    LV_BTNMATRIX_CTRL_CLICK_TRIG = 0x0100, 
    LV_BTNMATRIX_CTRL_POPOVER    = 0x0200, 
    LV_BTNMATRIX_CTRL_RECOLOR    = 0x1000, 
    _LV_BTNMATRIX_CTRL_RESERVED  = 0x2000, 
    LV_BTNMATRIX_CTRL_CUSTOM_1   = 0x4000, 
    LV_BTNMATRIX_CTRL_CUSTOM_2   = 0x8000, 
};
 
typedef uint16_t lv_btnmatrix_ctrl_t;
 
typedef bool (*lv_btnmatrix_btn_draw_cb_t)(lv_obj_t * btnm, uint32_t btn_id, const lv_area_t * draw_area,
                                           const lv_area_t * clip_area);
 
/*Data of button matrix*/
typedef struct {
    lv_obj_t obj;
    const char ** map_p;                              /*Pointer to the current map*/
    lv_area_t * button_areas;                         /*Array of areas of buttons*/
    lv_btnmatrix_ctrl_t * ctrl_bits;                       /*Array of control bytes*/
    uint16_t btn_cnt;                                 /*Number of button in 'map_p'(Handled by the library)*/
    uint16_t row_cnt;                                 /*Number of rows in 'map_p'(Handled by the library)*/
    uint16_t btn_id_sel;    /*Index of the active button (being pressed/released etc) or LV_BTNMATRIX_BTN_NONE*/
    uint8_t one_check : 1;  /*Single button toggled at once*/
} lv_btnmatrix_t;
 
extern const lv_obj_class_t lv_btnmatrix_class;
 
typedef enum {
    LV_BTNMATRIX_DRAW_PART_BTN,    
} lv_btnmatrix_draw_part_type_t;
 
/**********************
 * GLOBAL PROTOTYPES
 **********************/
 
lv_obj_t * lv_btnmatrix_create(lv_obj_t * parent);
 
/*=====================
 * Setter functions
 *====================*/
 
void lv_btnmatrix_set_map(lv_obj_t * obj, const char * map[]);
 
void lv_btnmatrix_set_ctrl_map(lv_obj_t * obj, const lv_btnmatrix_ctrl_t ctrl_map[]);
 
void lv_btnmatrix_set_selected_btn(lv_obj_t * obj, uint16_t btn_id);
 
void lv_btnmatrix_set_btn_ctrl(lv_obj_t * obj, uint16_t btn_id, lv_btnmatrix_ctrl_t ctrl);
 
void lv_btnmatrix_clear_btn_ctrl(lv_obj_t * obj, uint16_t btn_id, lv_btnmatrix_ctrl_t ctrl);
 
void lv_btnmatrix_set_btn_ctrl_all(lv_obj_t * obj, lv_btnmatrix_ctrl_t ctrl);
 
void lv_btnmatrix_clear_btn_ctrl_all(lv_obj_t * obj, lv_btnmatrix_ctrl_t ctrl);
 
void lv_btnmatrix_set_btn_width(lv_obj_t * obj, uint16_t btn_id, uint8_t width);
 
void lv_btnmatrix_set_one_checked(lv_obj_t * obj, bool en);
 
/*=====================
 * Getter functions
 *====================*/
 
const char ** lv_btnmatrix_get_map(const lv_obj_t * obj);
 
uint16_t lv_btnmatrix_get_selected_btn(const lv_obj_t * obj);
 
const char * lv_btnmatrix_get_btn_text(const lv_obj_t * obj, uint16_t btn_id);
 
bool lv_btnmatrix_has_btn_ctrl(lv_obj_t * obj, uint16_t btn_id, lv_btnmatrix_ctrl_t ctrl);
 
bool lv_btnmatrix_get_one_checked(const lv_obj_t * obj);
 
/**********************
 *      MACROS
 **********************/
 
#endif /*LV_USE_BTNMATRIX*/
 
#ifdef __cplusplus
} /*extern "C"*/
#endif
 
#endif /*LV_BTNMATRIX_H*/