lv_keyboard.h

Go to the documentation of this file.

 
#ifndef LV_KEYBOARD_H
#define LV_KEYBOARD_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*********************
 *      INCLUDES
 *********************/
#include "../../../widgets/lv_btnmatrix.h"
 
#if LV_USE_KEYBOARD
 
/*Testing of dependencies*/
#if LV_USE_BTNMATRIX == 0
#error "lv_kb: lv_btnm is required. Enable it in lv_conf.h (LV_USE_BTNMATRIX  1) "
#endif
 
#if LV_USE_TEXTAREA == 0
#error "lv_kb: lv_ta is required. Enable it in lv_conf.h (LV_USE_TEXTAREA  1) "
#endif
 
/*********************
 *      DEFINES
 *********************/
#define LV_KEYBOARD_CTRL_BTN_FLAGS (LV_BTNMATRIX_CTRL_NO_REPEAT | LV_BTNMATRIX_CTRL_CLICK_TRIG | LV_BTNMATRIX_CTRL_CHECKED)
 
/**********************
 *      TYPEDEFS
 **********************/
 
enum {
    LV_KEYBOARD_MODE_TEXT_LOWER,
    LV_KEYBOARD_MODE_TEXT_UPPER,
    LV_KEYBOARD_MODE_SPECIAL,
    LV_KEYBOARD_MODE_NUMBER,
    LV_KEYBOARD_MODE_USER_1,
    LV_KEYBOARD_MODE_USER_2,
    LV_KEYBOARD_MODE_USER_3,
    LV_KEYBOARD_MODE_USER_4,
};
typedef uint8_t lv_keyboard_mode_t;
 
/*Data of keyboard*/
typedef struct {
    lv_btnmatrix_t btnm;
    lv_obj_t * ta;              /*Pointer to the assigned text area*/
    lv_keyboard_mode_t mode;    /*Key map type*/
    uint8_t popovers : 1;       /*Show button titles in popovers on press*/
} lv_keyboard_t;
 
extern const lv_obj_class_t lv_keyboard_class;
 
/**********************
 * GLOBAL PROTOTYPES
 **********************/
 
lv_obj_t * lv_keyboard_create(lv_obj_t * parent);
 
/*=====================
 * Setter functions
 *====================*/
 
void lv_keyboard_set_textarea(lv_obj_t * kb, lv_obj_t * ta);
 
void lv_keyboard_set_mode(lv_obj_t * kb, lv_keyboard_mode_t mode);
 
void lv_keyboard_set_popovers(lv_obj_t * kb, bool en);
 
void lv_keyboard_set_map(lv_obj_t * kb, lv_keyboard_mode_t mode, const char * map[],
                         const lv_btnmatrix_ctrl_t ctrl_map[]);
 
/*=====================
 * Getter functions
 *====================*/
 
lv_obj_t * lv_keyboard_get_textarea(const lv_obj_t * kb);
 
lv_keyboard_mode_t lv_keyboard_get_mode(const lv_obj_t * kb);
 
bool lv_btnmatrix_get_popovers(const lv_obj_t * obj);
 
static inline const char ** lv_keyboard_get_map_array(const lv_obj_t * kb)
{
    return lv_btnmatrix_get_map(kb);
}
 
static inline uint16_t lv_keyboard_get_selected_btn(const lv_obj_t * obj)
{
    return lv_btnmatrix_get_selected_btn(obj);
}
 
static inline const char * lv_keyboard_get_btn_text(const lv_obj_t * obj, uint16_t btn_id)
{
    return lv_btnmatrix_get_btn_text(obj, btn_id);
}
 
/*=====================
 * Other functions
 *====================*/
 
void lv_keyboard_def_event_cb(lv_event_t * e);
 
/**********************
 *      MACROS
 **********************/
 
#endif  /*LV_USE_KEYBOARD*/
 
#ifdef __cplusplus
} /*extern "C"*/
#endif
 
#endif /*LV_KEYBOARD_H*/