lv_group.h

Go to the documentation of this file.

 
#ifndef LV_GROUP_H
#define LV_GROUP_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*********************
 *      INCLUDES
 *********************/
 
#include "../lv_conf_internal.h"
 
#include <stdint.h>
#include <stdbool.h>
#include "../misc/lv_ll.h"
#include "../misc/lv_types.h"
 
/*********************
 *      DEFINES
 *********************/
/*Predefined keys to control the focused object via lv_group_send(group, c)*/
 
enum {
    LV_KEY_UP        = 17,  /*0x11*/
    LV_KEY_DOWN      = 18,  /*0x12*/
    LV_KEY_RIGHT     = 19,  /*0x13*/
    LV_KEY_LEFT      = 20,  /*0x14*/
    LV_KEY_ESC       = 27,  /*0x1B*/
    LV_KEY_DEL       = 127, /*0x7F*/
    LV_KEY_BACKSPACE = 8,   /*0x08*/
    LV_KEY_ENTER     = 10,  /*0x0A, '\n'*/
    LV_KEY_NEXT      = 9,   /*0x09, '\t'*/
    LV_KEY_PREV      = 11,  /*0x0B, '*/
    LV_KEY_HOME      = 2,   /*0x02, STX*/
    LV_KEY_END       = 3,   /*0x03, ETX*/
};
typedef uint8_t lv_key_t;
 
/**********************
 *      TYPEDEFS
 **********************/
 
struct _lv_obj_t;
struct _lv_group_t;
 
typedef void (*lv_group_focus_cb_t)(struct _lv_group_t *);
typedef void (*lv_group_edge_cb_t)(struct _lv_group_t *, bool);
 
typedef struct _lv_group_t {
    lv_ll_t obj_ll;        
    struct _lv_obj_t ** obj_focus; 
    lv_group_focus_cb_t focus_cb;              
    lv_group_edge_cb_t  edge_cb;               
#if LV_USE_USER_DATA
    void * user_data;
#endif
 
    uint8_t frozen : 1;         
    uint8_t editing : 1;        
    uint8_t refocus_policy : 1; 
    uint8_t wrap : 1;           
} lv_group_t;
 
 
typedef enum {
    LV_GROUP_REFOCUS_POLICY_NEXT = 0,
    LV_GROUP_REFOCUS_POLICY_PREV = 1
} lv_group_refocus_policy_t;
 
/**********************
 * GLOBAL PROTOTYPES
 **********************/
 
void _lv_group_init(void);
 
lv_group_t * lv_group_create(void);
 
void lv_group_del(lv_group_t * group);
 
void lv_group_set_default(lv_group_t * group);
 
lv_group_t * lv_group_get_default(void);
 
void lv_group_add_obj(lv_group_t * group, struct _lv_obj_t * obj);
 
void lv_group_swap_obj(struct _lv_obj_t * obj1, struct _lv_obj_t * obj2);
 
void lv_group_remove_obj(struct _lv_obj_t * obj);
 
void lv_group_remove_all_objs(lv_group_t * group);
 
void lv_group_focus_obj(struct _lv_obj_t * obj);
 
void lv_group_focus_next(lv_group_t * group);
 
void lv_group_focus_prev(lv_group_t * group);
 
void lv_group_focus_freeze(lv_group_t * group, bool en);
 
lv_res_t lv_group_send_data(lv_group_t * group, uint32_t c);
 
void lv_group_set_focus_cb(lv_group_t * group, lv_group_focus_cb_t focus_cb);
 
void lv_group_set_edge_cb(lv_group_t * group, lv_group_edge_cb_t edge_cb);
 
 
void lv_group_set_refocus_policy(lv_group_t * group, lv_group_refocus_policy_t policy);
 
void lv_group_set_editing(lv_group_t * group, bool edit);
 
void lv_group_set_wrap(lv_group_t * group, bool en);
 
struct _lv_obj_t * lv_group_get_focused(const lv_group_t * group);
 
lv_group_focus_cb_t lv_group_get_focus_cb(const lv_group_t * group);
 
lv_group_edge_cb_t lv_group_get_edge_cb(const lv_group_t * group);
 
bool lv_group_get_editing(const lv_group_t * group);
 
bool lv_group_get_wrap(lv_group_t * group);
 
uint32_t lv_group_get_obj_count(lv_group_t * group);
 
/**********************
 *      MACROS
 **********************/
 
#ifdef __cplusplus
} /*extern "C"*/
#endif
 
#endif /*LV_GROUP_H*/