You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
245 lines
9.2 KiB
245 lines
9.2 KiB
/**
|
|
* @file lv_event.h
|
|
*
|
|
*/
|
|
|
|
#ifndef LV_EVENT_H
|
|
#define LV_EVENT_H
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/*********************
|
|
* INCLUDES
|
|
*********************/
|
|
#include <stdbool.h>
|
|
#include <stdint.h>
|
|
#include "lv_types.h"
|
|
#include "../lv_conf_internal.h"
|
|
|
|
#include "lv_array.h"
|
|
|
|
/*********************
|
|
* DEFINES
|
|
*********************/
|
|
|
|
/**********************
|
|
* TYPEDEFS
|
|
**********************/
|
|
|
|
typedef void (*lv_event_cb_t)(lv_event_t * e);
|
|
|
|
typedef struct {
|
|
lv_event_cb_t cb;
|
|
void * user_data;
|
|
uint32_t filter;
|
|
} lv_event_dsc_t;
|
|
|
|
/**
|
|
* Type of event being sent to the object.
|
|
*/
|
|
typedef enum {
|
|
LV_EVENT_ALL = 0,
|
|
|
|
/** Input device events*/
|
|
LV_EVENT_PRESSED, /**< The object has been pressed*/
|
|
LV_EVENT_PRESSING, /**< The object is being pressed (called continuously while pressing)*/
|
|
LV_EVENT_PRESS_LOST, /**< The object is still being pressed but slid cursor/finger off of the object */
|
|
LV_EVENT_SHORT_CLICKED, /**< The object was pressed for a short period of time, then released it. Not called if scrolled.*/
|
|
LV_EVENT_LONG_PRESSED, /**< Object has been pressed for at least `long_press_time`. Not called if scrolled.*/
|
|
LV_EVENT_LONG_PRESSED_REPEAT, /**< Called after `long_press_time` in every `long_press_repeat_time` ms. Not called if scrolled.*/
|
|
LV_EVENT_CLICKED, /**< Called on release if not scrolled (regardless to long press)*/
|
|
LV_EVENT_RELEASED, /**< Called in every cases when the object has been released*/
|
|
LV_EVENT_SCROLL_BEGIN, /**< Scrolling begins. The event parameter is a pointer to the animation of the scroll. Can be modified*/
|
|
LV_EVENT_SCROLL_THROW_BEGIN,
|
|
LV_EVENT_SCROLL_END, /**< Scrolling ends*/
|
|
LV_EVENT_SCROLL, /**< Scrolling*/
|
|
LV_EVENT_GESTURE, /**< A gesture is detected. Get the gesture with `lv_indev_get_gesture_dir(lv_indev_active());` */
|
|
LV_EVENT_KEY, /**< A key is sent to the object. Get the key with `lv_indev_get_key(lv_indev_active());`*/
|
|
LV_EVENT_ROTARY, /**< An encoder or wheel was rotated. Get the rotation count with `lv_event_get_rotary_diff(e);`*/
|
|
LV_EVENT_FOCUSED, /**< The object is focused*/
|
|
LV_EVENT_DEFOCUSED, /**< The object is defocused*/
|
|
LV_EVENT_LEAVE, /**< The object is defocused but still selected*/
|
|
LV_EVENT_HIT_TEST, /**< Perform advanced hit-testing*/
|
|
LV_EVENT_INDEV_RESET, /**< Indev has been reset*/
|
|
|
|
/** Drawing events*/
|
|
LV_EVENT_COVER_CHECK, /**< Check if the object fully covers an area. The event parameter is `lv_cover_check_info_t *`.*/
|
|
LV_EVENT_REFR_EXT_DRAW_SIZE, /**< Get the required extra draw area around the object (e.g. for shadow). The event parameter is `int32_t *` to store the size.*/
|
|
LV_EVENT_DRAW_MAIN_BEGIN, /**< Starting the main drawing phase*/
|
|
LV_EVENT_DRAW_MAIN, /**< Perform the main drawing*/
|
|
LV_EVENT_DRAW_MAIN_END, /**< Finishing the main drawing phase*/
|
|
LV_EVENT_DRAW_POST_BEGIN, /**< Starting the post draw phase (when all children are drawn)*/
|
|
LV_EVENT_DRAW_POST, /**< Perform the post draw phase (when all children are drawn)*/
|
|
LV_EVENT_DRAW_POST_END, /**< Finishing the post draw phase (when all children are drawn)*/
|
|
LV_EVENT_DRAW_TASK_ADDED, /**< Adding a draw task */
|
|
|
|
/** Special events*/
|
|
LV_EVENT_VALUE_CHANGED, /**< The object's value has changed (i.e. slider moved)*/
|
|
LV_EVENT_INSERT, /**< A text is inserted to the object. The event data is `char *` being inserted.*/
|
|
LV_EVENT_REFRESH, /**< Notify the object to refresh something on it (for the user)*/
|
|
LV_EVENT_READY, /**< A process has finished*/
|
|
LV_EVENT_CANCEL, /**< A process has been cancelled */
|
|
|
|
/** Other events*/
|
|
LV_EVENT_CREATE, /**< Object is being created*/
|
|
LV_EVENT_DELETE, /**< Object is being deleted*/
|
|
LV_EVENT_CHILD_CHANGED, /**< Child was removed, added, or its size, position were changed */
|
|
LV_EVENT_CHILD_CREATED, /**< Child was created, always bubbles up to all parents*/
|
|
LV_EVENT_CHILD_DELETED, /**< Child was deleted, always bubbles up to all parents*/
|
|
LV_EVENT_SCREEN_UNLOAD_START, /**< A screen unload started, fired immediately when scr_load is called*/
|
|
LV_EVENT_SCREEN_LOAD_START, /**< A screen load started, fired when the screen change delay is expired*/
|
|
LV_EVENT_SCREEN_LOADED, /**< A screen was loaded*/
|
|
LV_EVENT_SCREEN_UNLOADED, /**< A screen was unloaded*/
|
|
LV_EVENT_SIZE_CHANGED, /**< Object coordinates/size have changed*/
|
|
LV_EVENT_STYLE_CHANGED, /**< Object's style has changed*/
|
|
LV_EVENT_LAYOUT_CHANGED, /**< The children position has changed due to a layout recalculation*/
|
|
LV_EVENT_GET_SELF_SIZE, /**< Get the internal size of a widget*/
|
|
|
|
/** Events of optional LVGL components*/
|
|
LV_EVENT_INVALIDATE_AREA,
|
|
LV_EVENT_RESOLUTION_CHANGED,
|
|
LV_EVENT_COLOR_FORMAT_CHANGED,
|
|
LV_EVENT_REFR_REQUEST,
|
|
LV_EVENT_REFR_START,
|
|
LV_EVENT_REFR_READY,
|
|
LV_EVENT_RENDER_START,
|
|
LV_EVENT_RENDER_READY,
|
|
LV_EVENT_FLUSH_START,
|
|
LV_EVENT_FLUSH_FINISH,
|
|
LV_EVENT_FLUSH_WAIT_START,
|
|
LV_EVENT_FLUSH_WAIT_FINISH,
|
|
|
|
LV_EVENT_VSYNC,
|
|
|
|
_LV_EVENT_LAST, /** Number of default events*/
|
|
|
|
LV_EVENT_PREPROCESS = 0x8000, /** This is a flag that can be set with an event so it's processed
|
|
before the class default event processing */
|
|
} lv_event_code_t;
|
|
|
|
typedef lv_array_t lv_event_list_t;
|
|
|
|
struct _lv_event_t {
|
|
void * current_target;
|
|
void * original_target;
|
|
lv_event_code_t code;
|
|
void * user_data;
|
|
void * param;
|
|
lv_event_t * prev;
|
|
uint8_t deleted : 1;
|
|
uint8_t stop_processing : 1;
|
|
uint8_t stop_bubbling : 1;
|
|
};
|
|
|
|
/**
|
|
* @brief Event callback.
|
|
* Events are used to notify the user of some action being taken on the object.
|
|
* For details, see ::lv_event_t.
|
|
*/
|
|
|
|
/**********************
|
|
* GLOBAL PROTOTYPES
|
|
**********************/
|
|
|
|
void _lv_event_push(lv_event_t * e);
|
|
|
|
void _lv_event_pop(lv_event_t * e);
|
|
|
|
lv_result_t lv_event_send(lv_event_list_t * list, lv_event_t * e, bool preprocess);
|
|
|
|
lv_event_dsc_t * lv_event_add(lv_event_list_t * list, lv_event_cb_t cb, lv_event_code_t filter, void * user_data);
|
|
bool lv_event_remove_dsc(lv_event_list_t * list, lv_event_dsc_t * dsc);
|
|
|
|
uint32_t lv_event_get_count(lv_event_list_t * list);
|
|
|
|
lv_event_dsc_t * lv_event_get_dsc(lv_event_list_t * list, uint32_t index);
|
|
|
|
lv_event_cb_t lv_event_dsc_get_cb(lv_event_dsc_t * dsc);
|
|
|
|
void * lv_event_dsc_get_user_data(lv_event_dsc_t * dsc);
|
|
|
|
bool lv_event_remove(lv_event_list_t * list, uint32_t index);
|
|
|
|
void lv_event_remove_all(lv_event_list_t * list);
|
|
|
|
/**
|
|
* Get the object originally targeted by the event. It's the same even if the event is bubbled.
|
|
* @param e pointer to the event descriptor
|
|
* @return the target of the event_code
|
|
*/
|
|
void * lv_event_get_target(lv_event_t * e);
|
|
|
|
/**
|
|
* Get the current target of the event. It's the object which event handler being called.
|
|
* If the event is not bubbled it's the same as "normal" target.
|
|
* @param e pointer to the event descriptor
|
|
* @return pointer to the current target of the event_code
|
|
*/
|
|
void * lv_event_get_current_target(lv_event_t * e);
|
|
|
|
/**
|
|
* Get the event code of an event
|
|
* @param e pointer to the event descriptor
|
|
* @return the event code. (E.g. `LV_EVENT_CLICKED`, `LV_EVENT_FOCUSED`, etc)
|
|
*/
|
|
lv_event_code_t lv_event_get_code(lv_event_t * e);
|
|
|
|
/**
|
|
* Get the parameter passed when the event was sent
|
|
* @param e pointer to the event descriptor
|
|
* @return pointer to the parameter
|
|
*/
|
|
void * lv_event_get_param(lv_event_t * e);
|
|
|
|
/**
|
|
* Get the user_data passed when the event was registered on the object
|
|
* @param e pointer to the event descriptor
|
|
* @return pointer to the user_data
|
|
*/
|
|
void * lv_event_get_user_data(lv_event_t * e);
|
|
|
|
/**
|
|
* Stop the event from bubbling.
|
|
* This is only valid when called in the middle of an event processing chain.
|
|
* @param e pointer to the event descriptor
|
|
*/
|
|
void lv_event_stop_bubbling(lv_event_t * e);
|
|
|
|
/**
|
|
* Stop processing this event.
|
|
* This is only valid when called in the middle of an event processing chain.
|
|
* @param e pointer to the event descriptor
|
|
*/
|
|
void lv_event_stop_processing(lv_event_t * e);
|
|
|
|
/**
|
|
* Register a new, custom event ID.
|
|
* It can be used the same way as e.g. `LV_EVENT_CLICKED` to send custom events
|
|
* @return the new event id
|
|
* @example
|
|
* uint32_t LV_EVENT_MINE = 0;
|
|
* ...
|
|
* e = lv_event_register_id();
|
|
* ...
|
|
* lv_obj_send_event(obj, LV_EVENT_MINE, &some_data);
|
|
*/
|
|
uint32_t lv_event_register_id(void);
|
|
|
|
/**
|
|
* Nested events can be called and one of them might belong to an object that is being deleted.
|
|
* Mark this object's `event_temp_data` deleted to know that its `lv_obj_send_event` should return `LV_RESULT_INVALID`
|
|
* @param target pointer to an event target which was deleted
|
|
*/
|
|
void _lv_event_mark_deleted(void * target);
|
|
|
|
/**********************
|
|
* MACROS
|
|
**********************/
|
|
|
|
#ifdef __cplusplus
|
|
} /*extern "C"*/
|
|
#endif
|
|
|
|
#endif /*LV_EVENT_H*/
|
|
|