lv_group.h

API reference for lv_group.h

Report on GitHub
See Also: Private HeaderThis header has a companion private implementation with internal data structures.lv_group_private.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)
Parameters
NameTypeDescription
grouplv_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)
Parameters
NameTypeDescription
grouplv_group_t *pointer to a group
focus_cblv_group_focus_cb_tthe 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)
Parameters
NameTypeDescription
grouplv_group_t *pointer to a group
edge_cblv_group_edge_cb_tthe 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)
Parameters
NameTypeDescription
grouplv_group_t *pointer to a group
policylv_group_refocus_policy_tnew 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)
Parameters
NameTypeDescription
grouplv_group_t *pointer to group
editbooltrue: 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)
Parameters
NameTypeDescription
grouplv_group_t *pointer to group
enbooltrue: 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))
Parameters
NameTypeDescription
grouplv_group_t *Pointer to a group
datavoid *User-defined data pointer to associate with a group
free_cbvoid(*)(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)
Parameters
NameTypeDescription
grouplv_group_t *pointer to a group
user_datavoid *pointer to user data

Enums

lv_key_t

Predefined keys to control which Widget has focus via lv_group_send(group, c)

NameValue
LV_KEY_UP17
LV_KEY_DOWN18
LV_KEY_RIGHT19
LV_KEY_LEFT20
LV_KEY_ESC27
LV_KEY_DEL127
LV_KEY_BACKSPACE8
LV_KEY_ENTER10
LV_KEY_NEXT9
LV_KEY_PREV11
LV_KEY_HOME2
LV_KEY_END3

lv_group_refocus_policy_t

NameValue
LV_GROUP_REFOCUS_POLICY_NEXT0
LV_GROUP_REFOCUS_POLICY_PREV1
Used by 1 function
  • lv_group_set_refocus_policy — param policy

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 — param focus_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 — param edge_cb

Dependencies

Indirect dependencies

How is this guide?

Last updated on

On this page