lvgl/lv_objx/lv_kb.h

/**
 * @file lv_kb.h
 * 
 */

#ifndef LV_KB_H
#define LV_KB_H

#ifdef __cplusplus
extern "C" {
#endif

/*********************
 *      INCLUDES
 *********************/
#include "lv_conf.h"
#if USE_LV_KB != 0

#include "../lv_obj/lv_obj.h"
#include "lv_btnm.h"

/*********************
 *      DEFINES
 *********************/

/**********************
 *      TYPEDEFS
 **********************/

typedef enum {
    LV_KB_MODE_TEXT,
    LV_KB_MODE_NUM,
}lv_kb_mode_t;


/*Data of keyboard*/
typedef struct {
    lv_btnm_ext_t btnm;     /*Ext. of ancestor*/
    /*New data for this type */
    lv_obj_t *ta;               /*Pointer to the assigned text area*/
    lv_kb_mode_t mode;          /*Key map type*/
    uint8_t cur_mng    :1;      /*1: automatically show/hide cursor when a text area is assigned or left*/
    lv_action_t  ok_action;     /*Called when the "Ok" button is clicked*/
    lv_action_t  close_action;  /*Called when the "Hide" button is clicked*/
}lv_kb_ext_t;

/**********************
 * GLOBAL PROTOTYPES
 **********************/

/*-----------------
 * Create function
 *-----------------*/

/**
 * Create a keyboard objects
 * @param par pointer to an object, it will be the parent of the new keyboard
 * @param copy pointer to a keyboard object, if not NULL then the new object will be copied from it
 * @return pointer to the created keyboard
 */
lv_obj_t * lv_kb_create(lv_obj_t * par, lv_obj_t * copy);

/*=====================
 * Setter functions
 *====================*/

/**
 * Assign a Text Area to the Keyboard. The pressed characters will be put there.
 * @param kb pointer to a Keyboard object
 * @param ta pointer to a Text Area object to write there
 */
void lv_kb_set_ta(lv_obj_t * kb, lv_obj_t * ta);

/**
 * Set a new a mode (text or number map)
 * @param kb pointer to a Keyboard object
 * @param mode the mode from 'lv_kb_mode_t'
 */
void lv_kb_set_mode(lv_obj_t * kb, lv_kb_mode_t mode);

/**
 * Automatically hide or show the cursor of the current Text Area
 * @param kb pointer to a Keyboard object
 * @param en true: show cursor on the current text area, false: hide cursor
 */
void lv_kb_set_cursor_manage(lv_obj_t * kb, bool en);

/**
 * Set call back to call when the "Ok" button is pressed
 * @param kb pointer to Keyboard object
 * @param action a callback with 'lv_action_t' type
 */
void lv_kb_set_ok_action(lv_obj_t * kb, lv_action_t action);

/**
 * Set call back to call when the "Hide" button is pressed
 * @param kb pointer to Keyboard object
 * @param action a callback with 'lv_action_t' type
 */
void lv_kb_set_close_action(lv_obj_t * kb, lv_action_t action);

/**
 * Set the style of a keyboards's background
 * @param kb pointer to a keyboard object
 * @param bg pointer to the background style
 */
static inline void lv_kb_set_style(lv_obj_t *kb, lv_style_t * bg)
{
    lv_btnm_set_style(kb, bg);
}

/**
 * Set styles of the buttons is each state. Use NULL for any style to leave it unchanged.
 * @param kb pointer to keyboard object
 * @param rel pointer to a style for releases state
 * @param pr  pointer to a style for pressed state
 * @param tgl_rel pointer to a style for toggled releases state
 * @param tgl_pr pointer to a style for toggled pressed state
 * @param ina pointer to a style for inactive state
 */
static inline void lv_kb_set_style_btn(lv_obj_t *kb, lv_style_t *rel, lv_style_t *pr,
                                                     lv_style_t *tgl_rel, lv_style_t *tgl_pr,
                                                     lv_style_t *ina)
{
    lv_btnm_set_style_btn(kb, rel, pr, tgl_rel, tgl_pr, ina);
}

/*=====================
 * Getter functions
 *====================*/

/**
 * Assign a Text Area to the Keyboard. The pressed characters will be put there.
 * @param kb pointer to a Keyboard object
 * @return pointer to the assigned Text Area object
 */
lv_obj_t * lv_kb_get_ta(lv_obj_t * kb);

/**
 * Set a new a mode (text or number map)
 * @param kb pointer to a Keyboard object
 * @return the current mode from 'lv_kb_mode_t'
 */
lv_kb_mode_t lv_kb_get_mode(lv_obj_t * kb);

/**
 * Get the current cursor manage mode.
 * @param kb pointer to a Keyboard object
 * @return true: show cursor on the current text area, false: hide cursor
 */
bool lv_kb_get_cursor_manage(lv_obj_t * kb, bool en);

/**
 * Get the callback to call when the "Ok" button is pressed
 * @param kb pointer to Keyboard object
 * @return the ok callback
 */
lv_action_t lv_kb_get_ok_action(lv_obj_t * kb, lv_action_t action);

/**
 * Get the callback to call when the "Hide" button is pressed
 * @param kb pointer to Keyboard object
 * @return the close callback
 */
lv_action_t lv_kb_get_close_action(lv_obj_t * kb, lv_action_t action);

/**
 * Get the style of a keyboard
 * @param kb pointer to a keyboard object
 * @return pointer to the background style
 */
static inline lv_style_t * lv_kb_get_style_bg(lv_obj_t *kb)
{
    return lv_btnm_get_style_bg(kb);
}

/**
 * Get the style of the buttons of keyboard
 * @param kb pointer to a keyboard object
 * @param state style in this state (LV_BTN_STATE_PR or LV_BTN_STATE_REL)
 * @return pointer the button style in the given state
 */
static inline lv_style_t * lv_kb_kb_style_btn(lv_obj_t *kb, lv_btn_state_t state)
{
    return lv_btnm_get_style_btn(kb, state);
}

/**********************
 *      MACROS
 **********************/

#endif  /*USE_LV_KB*/

#ifdef __cplusplus
} /* extern "C" */
#endif

#endif  /*LV_KB_H*/