lv_fragment.h

Go to the documentation of this file.

 
#ifndef LV_FRAGMENT_H
#define LV_FRAGMENT_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*********************
 *      INCLUDES
 *********************/
#include "../../../lv_conf_internal.h"
 
#if LV_USE_FRAGMENT
 
#include "../../../core/lv_obj.h"
 
/*********************
 *      DEFINES
 *********************/
 
/**********************
 *      TYPEDEFS
 **********************/
 
typedef struct _lv_fragment_manager_t lv_fragment_manager_t;
 
typedef struct _lv_fragment_t lv_fragment_t;
typedef struct _lv_fragment_class_t lv_fragment_class_t;
typedef struct _lv_fragment_managed_states_t lv_fragment_managed_states_t;
 
struct _lv_fragment_t {
    const lv_fragment_class_t * cls;
    lv_fragment_managed_states_t * managed;
    lv_fragment_manager_t * child_manager;
    lv_obj_t * obj;
 
};
 
struct _lv_fragment_class_t {
    void (*constructor_cb)(lv_fragment_t * self, void * args);
 
    void (*destructor_cb)(lv_fragment_t * self);
 
    void (*attached_cb)(lv_fragment_t * self);
 
    void (*detached_cb)(lv_fragment_t * self);
 
    lv_obj_t * (*create_obj_cb)(lv_fragment_t * self, lv_obj_t * container);
 
    void (*obj_created_cb)(lv_fragment_t * self, lv_obj_t * obj);
 
    void (*obj_will_delete_cb)(lv_fragment_t * self, lv_obj_t * obj);
 
    void (*obj_deleted_cb)(lv_fragment_t * self, lv_obj_t * obj);
 
    bool (*event_cb)(lv_fragment_t * self, int code, void * userdata);
 
    size_t instance_size;
};
 
typedef struct _lv_fragment_managed_states_t  {
    const lv_fragment_class_t * cls;
    lv_fragment_manager_t * manager;
    lv_obj_t * const * container;
    lv_fragment_t * instance;
    bool obj_created;
    bool destroying_obj;
    bool in_stack;
} lv_fragment_managed_states_t;
 
/**********************
 * GLOBAL PROTOTYPES
 **********************/
 
lv_fragment_manager_t * lv_fragment_manager_create(lv_fragment_t * parent);
 
void lv_fragment_manager_del(lv_fragment_manager_t * manager);
 
void lv_fragment_manager_create_obj(lv_fragment_manager_t * manager);
 
void lv_fragment_manager_del_obj(lv_fragment_manager_t * manager);
 
void lv_fragment_manager_add(lv_fragment_manager_t * manager, lv_fragment_t * fragment, lv_obj_t * const * container);
 
void lv_fragment_manager_remove(lv_fragment_manager_t * manager, lv_fragment_t * fragment);
 
void lv_fragment_manager_push(lv_fragment_manager_t * manager, lv_fragment_t * fragment, lv_obj_t * const * container);
 
bool lv_fragment_manager_pop(lv_fragment_manager_t * manager);
 
void lv_fragment_manager_replace(lv_fragment_manager_t * manager, lv_fragment_t * fragment,
                                 lv_obj_t * const * container);
 
bool lv_fragment_manager_send_event(lv_fragment_manager_t * manager, int code, void * userdata);
 
size_t lv_fragment_manager_get_stack_size(lv_fragment_manager_t * manager);
 
lv_fragment_t * lv_fragment_manager_get_top(lv_fragment_manager_t * manager);
 
lv_fragment_t * lv_fragment_manager_find_by_container(lv_fragment_manager_t * manager, const lv_obj_t * container);
 
lv_fragment_t * lv_fragment_manager_get_parent_fragment(lv_fragment_manager_t * manager);
 
 
lv_fragment_t * lv_fragment_create(const lv_fragment_class_t * cls, void * args);
 
void lv_fragment_del(lv_fragment_t * fragment);
 
lv_fragment_manager_t * lv_fragment_get_manager(lv_fragment_t * fragment);
 
lv_obj_t * const * lv_fragment_get_container(lv_fragment_t * fragment);
 
lv_fragment_t * lv_fragment_get_parent(lv_fragment_t * fragment);
 
lv_obj_t * lv_fragment_create_obj(lv_fragment_t * fragment, lv_obj_t * container);
 
void lv_fragment_del_obj(lv_fragment_t * fragment);
 
void lv_fragment_recreate_obj(lv_fragment_t * fragment);
 
 
/**********************
 *      MACROS
 **********************/
 
#endif /*LV_USE_FRAGMENT*/
 
#ifdef __cplusplus
} /*extern "C"*/
#endif
 
#endif /*LV_FRAGMENT_H*/