lv_group.h
API reference for lv_group.h
Functions
lv_group_set_default
Set default group. New Widgets will be added to this group if it's enabled in their class with add_to_def_group = true.
void lv_group_set_default(lv_group_t *group)| Name | Type | Description |
|---|---|---|
group | lv_group_t * | pointer to a group (can be NULL) |
lv_group_set_focus_cb
Set a function for a group which will be called when a new Widget has focus.
void lv_group_set_focus_cb(lv_group_t *group, lv_group_focus_cb_t focus_cb)| Name | Type | Description |
|---|---|---|
group | lv_group_t * | pointer to a group |
focus_cb | lv_group_focus_cb_t | the call back function or NULL if unused |
lv_group_set_edge_cb
Set a function for a group which will be called when a focus edge is reached
void lv_group_set_edge_cb(lv_group_t *group, lv_group_edge_cb_t edge_cb)| Name | Type | Description |
|---|---|---|
group | lv_group_t * | pointer to a group |
edge_cb | lv_group_edge_cb_t | the call back function or NULL if unused |
lv_group_set_refocus_policy
Set whether the next or previous Widget in a group gets focus when Widget that has focus is deleted.
void lv_group_set_refocus_policy(lv_group_t *group, lv_group_refocus_policy_t policy)| Name | Type | Description |
|---|---|---|
group | lv_group_t * | pointer to a group |
policy | lv_group_refocus_policy_t | new refocus policy enum |
lv_group_set_editing
Manually set the current mode (edit or navigate).
void lv_group_set_editing(lv_group_t *group, bool edit)| Name | Type | Description |
|---|---|---|
group | lv_group_t * | pointer to group |
edit | bool | true: edit mode; false: navigate mode |
lv_group_set_wrap
Set whether moving focus to next/previous Widget will allow wrapping from first->last or last->first Widget.
void lv_group_set_wrap(lv_group_t *group, bool en)| Name | Type | Description |
|---|---|---|
group | lv_group_t * | pointer to group |
en | bool | true: wrapping enabled; false: wrapping disabled |
lv_group_set_external_data
Attaches external user data and destructor callback to a group.
Associates custom user data with an LVGL group and specifies a destructor function that will be automatically invoked when the group is deleted to properly clean up the associated resources.
void lv_group_set_external_data(lv_group_t *group, void *data, void(*free_cb)(void *data))| Name | Type | Description |
|---|---|---|
group | lv_group_t * | Pointer to a group |
data | void * | User-defined data pointer to associate with a group |
free_cb | void(*)(void *data) | Callback function for cleaning up ext_data when group is deleted. Receives ext_data as parameter. NULL means no cleanup required. |
lv_group_set_user_data
Set user data to the group
void lv_group_set_user_data(lv_group_t *group, void *user_data)| Name | Type | Description |
|---|---|---|
group | lv_group_t * | pointer to a group |
user_data | void * | pointer to user data |
Enums
lv_key_t
Predefined keys to control which Widget has focus via lv_group_send(group, c)
| Name | Value |
|---|---|
LV_KEY_UP | 17 |
LV_KEY_DOWN | 18 |
LV_KEY_RIGHT | 19 |
LV_KEY_LEFT | 20 |
LV_KEY_ESC | 27 |
LV_KEY_DEL | 127 |
LV_KEY_BACKSPACE | 8 |
LV_KEY_ENTER | 10 |
LV_KEY_NEXT | 9 |
LV_KEY_PREV | 11 |
LV_KEY_HOME | 2 |
LV_KEY_END | 3 |
lv_group_refocus_policy_t
| Name | Value |
|---|---|
LV_GROUP_REFOCUS_POLICY_NEXT | 0 |
LV_GROUP_REFOCUS_POLICY_PREV | 1 |
Used by 1 function
lv_group_set_refocus_policy— parampolicy
Typedefs
lv_group_focus_cb_t
typedef void(* lv_group_focus_cb_t) (lv_group_t *)Used by 1 function
lv_group_set_focus_cb— paramfocus_cb
lv_group_edge_cb_t
typedef void(* lv_group_edge_cb_t) (lv_group_t *, bool)Used by 1 function
lv_group_set_edge_cb— paramedge_cb
Dependencies
How is this guide?
Last updated on