lv_group.h

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)

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)

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)

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)

lv_group_set_editing

Manually set the current mode (edit or navigate).

void lv_group_set_editing(lv_group_t *group, bool edit)

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)

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))

lv_group_set_user_data

Set user data to the group

void lv_group_set_user_data(lv_group_t *group, void *user_data)

lv_group_get_default

Get default group.

lv_group_t * lv_group_get_default(void)

Returns: lv_group_t * — pointer to the default group

lv_group_get_focused

Get Widget that has focus, or NULL if there isn't one.

lv_obj_t * lv_group_get_focused(const lv_group_t *group)

Returns: lv_obj_t * — pointer to Widget with focus

lv_group_get_focus_cb

Get focus callback function of a group.

lv_group_focus_cb_t lv_group_get_focus_cb(const lv_group_t *group)

Returns: lv_group_focus_cb_t — the call back function or NULL if not set

lv_group_get_edge_cb

Get edge callback function of a group.

lv_group_edge_cb_t lv_group_get_edge_cb(const lv_group_t *group)

Returns: lv_group_edge_cb_t — the call back function or NULL if not set

lv_group_get_editing

Get current mode (edit or navigate).

bool lv_group_get_editing(const lv_group_t *group)

Returns: bool — true: edit mode; false: navigate mode

lv_group_get_wrap

Get whether moving focus to next/previous Widget will allow wrapping from first->last or last->first Widget.

bool lv_group_get_wrap(lv_group_t *group)

lv_group_get_obj_count

Get number of Widgets in group.

uint32_t lv_group_get_obj_count(lv_group_t *group)

Returns: uint32_t — number of Widgets in the group

lv_group_get_obj_by_index

Get nth Widget within group.

lv_obj_t * lv_group_get_obj_by_index(lv_group_t *group, uint32_t index)

Returns: lv_obj_t * — pointer to Widget

lv_group_get_count

Get the number of groups.

uint32_t lv_group_get_count(void)

Returns: uint32_t — number of groups

lv_group_get_user_data

Get a pointer to the user data of the group

void * lv_group_get_user_data(const lv_group_t *group)

Returns: void * — pointer to the user data or NULL if group is NULL

lv_group_create

Create new Widget group.

lv_group_t * lv_group_create(void)

Returns: lv_group_t * — pointer to the new Widget group

lv_group_delete

Delete group object.

void lv_group_delete(lv_group_t *group)

lv_group_add_obj

Add an Widget to group.

void lv_group_add_obj(lv_group_t *group, lv_obj_t *obj)

lv_group_swap_obj

Swap 2 Widgets in group. Widgets must be in the same group.

void lv_group_swap_obj(lv_obj_t *obj1, lv_obj_t *obj2)

lv_group_remove_obj

Remove a Widget from its group.

void lv_group_remove_obj(lv_obj_t *obj)

lv_group_remove_all_objs

Remove all Widgets from a group.

void lv_group_remove_all_objs(lv_group_t *group)

lv_group_focus_obj

Focus on a Widget (defocus the current).

void lv_group_focus_obj(lv_obj_t *obj)

lv_group_focus_next

Focus on next Widget in a group (defocus the current).

void lv_group_focus_next(lv_group_t *group)

lv_group_focus_prev

Focus on previous Widget in a group (defocus the current).

void lv_group_focus_prev(lv_group_t *group)

lv_group_focus_freeze

Do not allow changing focus from current Widget.

void lv_group_focus_freeze(lv_group_t *group, bool en)

lv_group_send_data

Send a control character to Widget that has focus in a group.

lv_result_t lv_group_send_data(lv_group_t *group, uint32_t c)

Returns: lv_result_t — result of Widget with focus in group.

lv_group_by_index

Get a group by its index.

lv_group_t * lv_group_by_index(uint32_t index)

Returns: lv_group_t * — pointer to the group