lv_obj.h

Go to the documentation of this file.

 
#ifndef LV_OBJ_H
#define LV_OBJ_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*********************
 *      INCLUDES
 *********************/
#include "../lv_conf_internal.h"
 
#include <stddef.h>
#include <stdbool.h>
#include "../misc/lv_style.h"
#include "../misc/lv_types.h"
#include "../misc/lv_area.h"
#include "../misc/lv_color.h"
#include "../misc/lv_assert.h"
#include "../hal/lv_hal.h"
 
/*********************
 *      DEFINES
 *********************/
 
/**********************
 *      TYPEDEFS
 **********************/
 
struct _lv_obj_t;
 
enum {
    LV_STATE_DEFAULT     =  0x0000,
    LV_STATE_CHECKED     =  0x0001,
    LV_STATE_FOCUSED     =  0x0002,
    LV_STATE_FOCUS_KEY   =  0x0004,
    LV_STATE_EDITED      =  0x0008,
    LV_STATE_HOVERED     =  0x0010,
    LV_STATE_PRESSED     =  0x0020,
    LV_STATE_SCROLLED    =  0x0040,
    LV_STATE_DISABLED    =  0x0080,
 
    LV_STATE_USER_1      =  0x1000,
    LV_STATE_USER_2      =  0x2000,
    LV_STATE_USER_3      =  0x4000,
    LV_STATE_USER_4      =  0x8000,
 
    LV_STATE_ANY = 0xFFFF,    
};
 
typedef uint16_t lv_state_t;
 
enum {
    LV_PART_MAIN         = 0x000000,   
    LV_PART_SCROLLBAR    = 0x010000,   
    LV_PART_INDICATOR    = 0x020000,   
    LV_PART_KNOB         = 0x030000,   
    LV_PART_SELECTED     = 0x040000,   
    LV_PART_ITEMS        = 0x050000,   
    LV_PART_TICKS        = 0x060000,   
    LV_PART_CURSOR       = 0x070000,   
    LV_PART_CUSTOM_FIRST = 0x080000,    
    LV_PART_ANY          = 0x0F0000,    
};
 
typedef uint32_t lv_part_t;
 
enum {
    LV_OBJ_FLAG_HIDDEN          = (1L << 0),  
    LV_OBJ_FLAG_CLICKABLE       = (1L << 1),  
    LV_OBJ_FLAG_CLICK_FOCUSABLE = (1L << 2),  
    LV_OBJ_FLAG_CHECKABLE       = (1L << 3),  
    LV_OBJ_FLAG_SCROLLABLE      = (1L << 4),  
    LV_OBJ_FLAG_SCROLL_ELASTIC  = (1L << 5),  
    LV_OBJ_FLAG_SCROLL_MOMENTUM = (1L << 6),  
    LV_OBJ_FLAG_SCROLL_ONE      = (1L << 7),  
    LV_OBJ_FLAG_SCROLL_CHAIN_HOR = (1L << 8), 
    LV_OBJ_FLAG_SCROLL_CHAIN_VER = (1L << 9), 
    LV_OBJ_FLAG_SCROLL_CHAIN     = (LV_OBJ_FLAG_SCROLL_CHAIN_HOR | LV_OBJ_FLAG_SCROLL_CHAIN_VER),
    LV_OBJ_FLAG_SCROLL_ON_FOCUS = (1L << 10),  
    LV_OBJ_FLAG_SCROLL_WITH_ARROW  = (1L << 11), 
    LV_OBJ_FLAG_SNAPPABLE       = (1L << 12), 
    LV_OBJ_FLAG_PRESS_LOCK      = (1L << 13), 
    LV_OBJ_FLAG_EVENT_BUBBLE    = (1L << 14), 
    LV_OBJ_FLAG_GESTURE_BUBBLE  = (1L << 15), 
    LV_OBJ_FLAG_ADV_HITTEST     = (1L << 16), 
    LV_OBJ_FLAG_IGNORE_LAYOUT   = (1L << 17), 
    LV_OBJ_FLAG_FLOATING        = (1L << 18), 
    LV_OBJ_FLAG_OVERFLOW_VISIBLE = (1L << 19), 
    LV_OBJ_FLAG_LAYOUT_1        = (1L << 23), 
    LV_OBJ_FLAG_LAYOUT_2        = (1L << 24), 
    LV_OBJ_FLAG_WIDGET_1        = (1L << 25), 
    LV_OBJ_FLAG_WIDGET_2        = (1L << 26), 
    LV_OBJ_FLAG_USER_1          = (1L << 27), 
    LV_OBJ_FLAG_USER_2          = (1L << 28), 
    LV_OBJ_FLAG_USER_3          = (1L << 29), 
    LV_OBJ_FLAG_USER_4          = (1L << 30), 
};
 
 
typedef uint32_t lv_obj_flag_t;
 
typedef enum {
    LV_OBJ_DRAW_PART_RECTANGLE,  
    LV_OBJ_DRAW_PART_BORDER_POST,
    LV_OBJ_DRAW_PART_SCROLLBAR,  
} lv_obj_draw_part_type_t;
 
#include "lv_obj_tree.h"
#include "lv_obj_pos.h"
#include "lv_obj_scroll.h"
#include "lv_obj_style.h"
#include "lv_obj_draw.h"
#include "lv_obj_class.h"
#include "lv_event.h"
#include "lv_group.h"
 
extern const lv_obj_class_t lv_obj_class;
 
typedef struct {
    struct _lv_obj_t ** children;       
    uint32_t child_cnt;                 
    lv_group_t * group_p;
 
    struct _lv_event_dsc_t * event_dsc; 
    lv_point_t scroll;                  
    lv_coord_t ext_click_pad;           
    lv_coord_t ext_draw_size;           
    lv_scrollbar_mode_t scrollbar_mode : 2; 
    lv_scroll_snap_t scroll_snap_x : 2;     
    lv_scroll_snap_t scroll_snap_y : 2;     
    lv_dir_t scroll_dir : 4;                
    uint8_t event_dsc_cnt : 6;              
    uint8_t layer_type : 2;    
} _lv_obj_spec_attr_t;
 
typedef struct _lv_obj_t {
    const lv_obj_class_t * class_p;
    struct _lv_obj_t * parent;
    _lv_obj_spec_attr_t * spec_attr;
    _lv_obj_style_t * styles;
#if LV_USE_USER_DATA
    void * user_data;
#endif
    lv_area_t coords;
    lv_obj_flag_t flags;
    lv_state_t state;
    uint16_t layout_inv : 1;
    uint16_t scr_layout_inv : 1;
    uint16_t skip_trans : 1;
    uint16_t style_cnt  : 6;
    uint16_t h_layout   : 1;
    uint16_t w_layout   : 1;
} lv_obj_t;
 
 
/**********************
 * GLOBAL PROTOTYPES
 **********************/
 
void lv_init(void);
 
#if LV_ENABLE_GC || !LV_MEM_CUSTOM
 
void lv_deinit(void);
 
#endif
 
bool lv_is_initialized(void);
 
lv_obj_t * lv_obj_create(lv_obj_t * parent);
 
 
/*=====================
 * Setter functions
 *====================*/
 
void lv_obj_add_flag(lv_obj_t * obj, lv_obj_flag_t f);
 
void lv_obj_clear_flag(lv_obj_t * obj, lv_obj_flag_t f);
 
 
void lv_obj_add_state(lv_obj_t * obj, lv_state_t state);
 
void lv_obj_clear_state(lv_obj_t * obj, lv_state_t state);
 
#if LV_USE_USER_DATA
static inline void lv_obj_set_user_data(lv_obj_t * obj, void * user_data)
{
    obj->user_data = user_data;
}
#endif
 
/*=======================
 * Getter functions
 *======================*/
 
bool lv_obj_has_flag(const lv_obj_t * obj, lv_obj_flag_t f);
 
bool lv_obj_has_flag_any(const lv_obj_t * obj, lv_obj_flag_t f);
 
lv_state_t lv_obj_get_state(const lv_obj_t * obj);
 
bool lv_obj_has_state(const lv_obj_t * obj, lv_state_t state);
 
void * lv_obj_get_group(const lv_obj_t * obj);
 
#if LV_USE_USER_DATA
static inline void * lv_obj_get_user_data(lv_obj_t * obj)
{
    return obj->user_data;
}
#endif
 
/*=======================
 * Other functions
 *======================*/
 
void lv_obj_allocate_spec_attr(lv_obj_t * obj);
 
bool lv_obj_check_type(const lv_obj_t * obj, const lv_obj_class_t * class_p);
 
bool lv_obj_has_class(const lv_obj_t * obj, const lv_obj_class_t * class_p);
 
const lv_obj_class_t * lv_obj_get_class(const lv_obj_t * obj);
 
bool lv_obj_is_valid(const lv_obj_t * obj);
 
static inline lv_coord_t lv_obj_dpx(const lv_obj_t * obj, lv_coord_t n)
{
    return _LV_DPX_CALC(lv_disp_get_dpi(lv_obj_get_disp(obj)), n);
}
 
/**********************
 *      MACROS
 **********************/
 
#if LV_USE_ASSERT_OBJ
#  define LV_ASSERT_OBJ(obj_p, obj_class)                                                               \
    do {                                                                                                \
        LV_ASSERT_MSG(obj_p != NULL, "The object is NULL");                                             \
        LV_ASSERT_MSG(lv_obj_has_class(obj_p, obj_class) == true, "Incompatible object type.");         \
        LV_ASSERT_MSG(lv_obj_is_valid(obj_p)  == true, "The object is invalid, deleted or corrupted?"); \
    } while(0)
# else
#  define LV_ASSERT_OBJ(obj_p, obj_class) do{}while(0)
#endif
 
#if LV_USE_LOG && LV_LOG_TRACE_OBJ_CREATE
#  define LV_TRACE_OBJ_CREATE(...) LV_LOG_TRACE(__VA_ARGS__)
#else
#  define LV_TRACE_OBJ_CREATE(...)
#endif
 
 
#ifdef __cplusplus
} /*extern "C"*/
#endif
 
#endif /*LV_OBJ_H*/