mirror of
https://github.com/lvgl/lvgl.git
synced 2025-01-14 06:42:58 +08:00
135 lines
3.4 KiB
C
135 lines
3.4 KiB
C
/**
|
|
* @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 33 /*0x1B*/
|
|
#define LV_GROUP_KEY_ENTER 10 /*0x0A, '\n'*/
|
|
#define LV_GROUP_KEY_NEXT 9 /*0x09, '\t'*/
|
|
#define LV_GROUP_KEY_PREV 11 /*0x0B, '*/
|
|
|
|
#if LV_GROUP != 0
|
|
/**********************
|
|
* TYPEDEFS
|
|
**********************/
|
|
typedef struct _lv_group_t
|
|
{
|
|
lv_ll_t obj_ll;
|
|
lv_obj_t ** obj_focus;
|
|
void (*style_mod)(lv_style_t * style);
|
|
lv_style_t style_tmp;
|
|
uint8_t frozen:1;
|
|
}lv_group_t;
|
|
|
|
/**********************
|
|
* GLOBAL PROTOTYPES
|
|
**********************/
|
|
|
|
/**
|
|
* Create a new object group
|
|
* @return pointer to the new object group
|
|
*/
|
|
lv_group_t * lv_group_create(void);
|
|
|
|
/**
|
|
* 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_cb the style modifier function pointer
|
|
*/
|
|
void lv_group_set_style_mod_cb(lv_group_t * group, void (*style_cb)(lv_style_t * style));
|
|
|
|
/**
|
|
* 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);
|
|
|
|
/**********************
|
|
* MACROS
|
|
**********************/
|
|
|
|
#endif /*LV_GROUP != 0*/
|
|
|
|
#ifdef __cplusplus
|
|
} /* extern "C" */
|
|
#endif
|
|
|
|
#endif /*LV_GROUP_H*/
|