lv_msg.h

Go to the documentation of this file.

 
#ifndef LV_MSG_H
#define LV_MSG_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*********************
 *      INCLUDES
 *********************/
#include "../../../core/lv_obj.h"
#if LV_USE_MSG
 
/*********************
 *      DEFINES
 *********************/
 
/**********************
 *      TYPEDEFS
 **********************/
 
typedef struct {
    uint32_t id;            /*Identifier of the message*/
    void * user_data;       /*Set the the user_data set in `lv_msg_subscribe`*/
    void * _priv_data;      /*Used internally*/
    const void * payload;   /*Pointer to the data of the message*/
} lv_msg_t;
 
typedef void (*lv_msg_subscribe_cb_t)(void * s, lv_msg_t * msg);
 
typedef void (*lv_msg_request_cb_t)(void * r, uint32_t msg_id);
 
/**********************
 * GLOBAL PROTOTYPES
 **********************/
 
void lv_msg_init(void);
 
void * lv_msg_subsribe(uint32_t msg_id, lv_msg_subscribe_cb_t cb, void * user_data);
 
void * lv_msg_subsribe_obj(uint32_t msg_id, lv_obj_t * obj, void * user_data);
 
void lv_msg_unsubscribe(void * s);
 
void lv_msg_send(uint32_t msg_id, const void * payload);
 
uint32_t lv_msg_get_id(lv_msg_t * m);
 
const void * lv_msg_get_payload(lv_msg_t * m);
 
void * lv_msg_get_user_data(lv_msg_t * m);
 
lv_msg_t * lv_event_get_msg(lv_event_t * e);
 
/*Fix typo*/
static inline void * lv_msg_subscribe(uint32_t msg_id, lv_msg_subscribe_cb_t cb, void * user_data)
{
    return lv_msg_subsribe(msg_id, cb, user_data);
}
 
static inline void * lv_msg_subscribe_obj(uint32_t msg_id, lv_obj_t * obj, void * user_data)
{
    return lv_msg_subsribe_obj(msg_id, obj, user_data);
}
 
/**********************
 * GLOBAL VARIABLES
 **********************/
 
extern lv_event_code_t LV_EVENT_MSG_RECEIVED;
 
/**********************
 *      MACROS
 **********************/
 
#endif /*LV_USE_MSG*/
 
#ifdef __cplusplus
} /*extern "C"*/
#endif
 
#endif /*LV_MSG_H*/