123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168 |
- /**
- * @file lv_group.h
- *
- */
- #ifndef LV_GROUP_H
- #define LV_GROUP_H
- #ifdef __cplusplus
- extern "C" {
- #endif
- /*********************
- * INCLUDES
- *********************/
- #include "../../lv_conf.h"
- #include "lv_obj.h"
- /*********************
- * DEFINES
- *********************/
- /*Predefined keys to control the focused object via lv_group_send(group, c)*/
- /*For compatibility in signal function define the keys regardless to LV_GROUP*/
- #define LV_GROUP_KEY_UP 17 /*0x11*/
- #define LV_GROUP_KEY_DOWN 18 /*0x12*/
- #define LV_GROUP_KEY_RIGHT 19 /*0x13*/
- #define LV_GROUP_KEY_LEFT 20 /*0x14*/
- #define LV_GROUP_KEY_ESC 27 /*0x1B*/
- #define LV_GROUP_KEY_ENTER 10 /*0x0A, '\n'*/
- #define LV_GROUP_KEY_NEXT 9 /*0x09, '\t'*/
- #define LV_GROUP_KEY_PREV 11 /*0x0B, '*/
- #define LV_GROUP_KEY_ENTER_LONG 14 /*0x0E, Sent by the library if ENTER is long pressed*/
- #if USE_LV_GROUP != 0
- /**********************
- * TYPEDEFS
- **********************/
- struct _lv_group_t;
- typedef void (*lv_group_style_mod_func_t)(lv_style_t *);
- typedef void (*lv_group_focus_cb_t)(struct _lv_group_t *);
- typedef struct _lv_group_t
- {
- lv_ll_t obj_ll; /*Linked list to store the objects in the group */
- lv_obj_t ** obj_focus; /*The object in focus*/
- lv_group_style_mod_func_t style_mod; /*A function which modifies the style of the focused object*/
- lv_group_focus_cb_t focus_cb; /*A function to call when a new object is focused (optional)*/
- lv_style_t style_tmp; /*Stores the modified style of the focused object */
- uint8_t frozen:1; /*1: can't focus to new object*/
- }lv_group_t;
- /**********************
- * GLOBAL PROTOTYPES
- **********************/
- /**
- * Create a new object group
- * @return pointer to the new object group
- */
- lv_group_t * lv_group_create(void);
- /**
- * Delete a group object
- * @param group pointer to a group
- */
- void lv_group_del(lv_group_t * group);
- /**
- * Add an object to a group
- * @param group pointer to a group
- * @param obj pointer to an object to add
- */
- void lv_group_add_obj(lv_group_t * group, lv_obj_t * obj);
- /**
- * Remove an object from its group
- * @param obj pointer to an object to remove
- */
- void lv_group_remove_obj(lv_obj_t * obj);
- /**
- * Focus on an object (defocus the current)
- * @param obj pointer to an object to focus on
- */
- void lv_group_focus_obj(lv_obj_t * obj);
- /**
- * Focus the next object in a group (defocus the current)
- * @param group pointer to a group
- */
- void lv_group_focus_next(lv_group_t * group);
- /**
- * Focus the previous object in a group (defocus the current)
- * @param group pointer to a group
- */
- void lv_group_focus_prev(lv_group_t * group);
- /**
- * Do not let to change the focus from the current object
- * @param group pointer to a group
- * @param en true: freeze, false: release freezing (normal mode)
- */
- void lv_group_focus_freeze(lv_group_t * group, bool en);
- /**
- * Send a control character to the focuses object of a group
- * @param group pointer to a group
- * @param c a character (use LV_GROUP_KEY_.. to navigate)
- */
- void lv_group_send_data(lv_group_t * group, uint32_t c);
- /**
- * Set a function for a group which will modify the object's style if it is in focus
- * @param group pointer to a group
- * @param style_mod_func the style modifier function pointer
- */
- void lv_group_set_style_mod_cb(lv_group_t * group,lv_group_style_mod_func_t style_mod_func);
- /**
- * Set a function for a group which will be called when a new object is focused
- * @param group pointer to a group
- * @param focus_cb the call back function or NULL if unused
- */
- void lv_group_set_focus_cb(lv_group_t * group, lv_group_focus_cb_t focus_cb);
- /**
- * Modify a style with the set 'style_mod' function. The input style remains unchanged.
- * @param group pointer to group
- * @param style pointer to a style to modify
- * @return a copy of the input style but modified with the 'style_mod' function
- */
- lv_style_t * lv_group_mod_style(lv_group_t * group, const lv_style_t * style);
- /**
- * Get the focused object or NULL if there isn't one
- * @param group pointer to a group
- * @return pointer to the focused object
- */
- lv_obj_t * lv_group_get_focused(lv_group_t * group);
- /**
- * Get a the style modifier function of a group
- * @param group pointer to a group
- * @return pointer to the style modifier function
- */
- lv_group_style_mod_func_t lv_group_get_style_mod_cb(lv_group_t * group);
- /**
- * Get the focus callback function of a group
- * @param group pointer to a group
- * @return the call back function or NULL if not set
- */
- lv_group_focus_cb_t lv_group_get_focus_cb(lv_group_t * group);
- /**********************
- * MACROS
- **********************/
- #endif /*USE_LV_GROUP != 0*/
- #ifdef __cplusplus
- } /* extern "C" */
- #endif
- #endif /*LV_GROUP_H*/
|