lv_fragment.h

API reference for lv_fragment.h

Report on GitHub

Public header for Fragment

Summary

22Functions

2Structs

1Typedefs

Functions

others/fragment/lv_fragment.h:205function

lv_fragment_manager_get_stack_size

Get stack size of this fragment manager

size_t lv_fragment_manager_get_stack_size(lv_fragment_manager_t *manager)

Name	Type	Description
`manager`	`lv_fragment_manager_t *`	Fragment manager instance

Returns: size_t — Stack size of this fragment manager

others/fragment/lv_fragment.h:212function

lv_fragment_manager_get_top

Get top most fragment instance

lv_fragment_t * lv_fragment_manager_get_top(lv_fragment_manager_t *manager)

Name	Type	Description
`manager`	`lv_fragment_manager_t *`	Fragment manager instance

Returns: lv_fragment_t * — Top most fragment instance

others/fragment/lv_fragment.h:227function

lv_fragment_manager_get_parent_fragment

Get parent fragment

lv_fragment_t * lv_fragment_manager_get_parent_fragment(lv_fragment_manager_t *manager)

Name	Type	Description
`manager`	`lv_fragment_manager_t *`	Fragment manager instance

Returns: lv_fragment_t * — Parent fragment instance

others/fragment/lv_fragment.h:249function

lv_fragment_get_manager

Get associated manager of this fragment

lv_fragment_manager_t * lv_fragment_get_manager(lv_fragment_t *fragment)

Name	Type	Description
`fragment`	`lv_fragment_t *`	Fragment instance

Returns: lv_fragment_manager_t * — Fragment manager instance

others/fragment/lv_fragment.h:256function

lv_fragment_get_container

Get container object of this fragment

lv_obj_t *const  * lv_fragment_get_container(lv_fragment_t *fragment)

Name	Type	Description
`fragment`	`lv_fragment_t *`	Fragment instance

Returns: lv_obj_t *const * — Reference to container object

others/fragment/lv_fragment.h:263function

lv_fragment_get_parent

Get parent fragment of this fragment

lv_fragment_t * lv_fragment_get_parent(lv_fragment_t *fragment)

Name	Type	Description
`fragment`	`lv_fragment_t *`	Fragment instance

Returns: lv_fragment_t * — Parent fragment

Structs

struct

_lv_fragment_t

Member	Type	Description
`cls`	`const lv_fragment_class_t *`	Class of this fragment
`managed`	`lv_fragment_managed_states_t *`	Managed fragment states. If not null, then this fragment is managed.
`child_manager`	`lv_fragment_manager_t *`	Child fragment manager
`obj`	`lv_obj_t *`	lv_obj returned by create_obj_cb

struct

_lv_fragment_class_t

Member	Type	Description
`constructor_cb`	`void()(lv_fragment_t self, void *args)`	Constructor function for fragment class
`destructor_cb`	`void()(lv_fragment_t self)`	Destructor function for fragment class
`attached_cb`	`void()(lv_fragment_t self)`	Fragment attached to manager
`detached_cb`	`void()(lv_fragment_t self)`	Fragment detached from manager
`create_obj_cb`	`lv_obj_t ()(lv_fragment_t self, lv_obj_t container)`	Create objects
`obj_created_cb`	`void()(lv_fragment_t self, lv_obj_t *obj)`
`obj_will_delete_cb`	`void()(lv_fragment_t self, lv_obj_t *obj)`	Called before objects in the fragment will be deleted.
`obj_deleted_cb`	`void()(lv_fragment_t self, lv_obj_t *obj)`	Called when the object created by fragment received `LV_EVENT_DELETE` event
`event_cb`	`bool()(lv_fragment_t self, int code, void *userdata)`	Handle event
`instance_size`	`size_t`	REQUIRED: Allocation size of fragment

Typedefs

others/fragment/lv_fragment.h:28typedef

lv_fragment_manager_t

typedef struct _lv_fragment_manager_t lv_fragment_manager_t

Used by 13 functions

lv_fragment_manager_delete — param manager
lv_fragment_manager_create_obj — param manager
lv_fragment_manager_delete_obj — param manager
lv_fragment_manager_add — param manager
lv_fragment_manager_remove — param manager
lv_fragment_manager_push — param manager
lv_fragment_manager_pop — param manager
lv_fragment_manager_replace — param manager
lv_fragment_manager_send_event — param manager
lv_fragment_manager_get_stack_size — param manager
lv_fragment_manager_get_top — param manager
lv_fragment_manager_find_by_container — param manager
lv_fragment_manager_get_parent_fragment — param manager