lv_indev.h

lv_indev_set_type

Set the type of an input device

void lv_indev_set_type(lv_indev_t *indev, lv_indev_type_t indev_type)

lv_indev_set_read_cb

Set a callback function to read input device data to the indev

void lv_indev_set_read_cb(lv_indev_t *indev, lv_indev_read_cb_t read_cb)

lv_indev_set_user_data

Set user data to the indev

void lv_indev_set_user_data(lv_indev_t *indev, void *user_data)

lv_indev_set_driver_data

Set driver data to the indev

void lv_indev_set_driver_data(lv_indev_t *indev, void *driver_data)

lv_indev_set_display

Assign a display to the indev

void lv_indev_set_display(lv_indev_t *indev, struct _lv_display_t *disp)

lv_indev_set_long_press_time

Set long press time to indev

void lv_indev_set_long_press_time(lv_indev_t *indev, uint16_t long_press_time)

lv_indev_set_long_press_repeat_time

Set long press repeat time to indev

void lv_indev_set_long_press_repeat_time(lv_indev_t *indev, uint16_t long_press_repeat_time)

lv_indev_set_double_click_time

Set double click time to indev

void lv_indev_set_double_click_time(lv_indev_t *indev, uint16_t double_click_time)

lv_indev_set_scroll_limit

Set scroll limit to the input device

void lv_indev_set_scroll_limit(lv_indev_t *indev, uint8_t scroll_limit)

lv_indev_set_scroll_throw

Set scroll throw slow-down to the indev. Greater value means faster slow-down

void lv_indev_set_scroll_throw(lv_indev_t *indev, uint8_t scroll_throw)

lv_indev_set_gesture_min_velocity

Set the minimum velocity threshold for gesture detection. The difference between consecutive points must exceed this value (in pixels) for the movement to be considered fast enough to trigger a gesture.

void lv_indev_set_gesture_min_velocity(lv_indev_t *indev, uint8_t min_velocity)

lv_indev_set_gesture_min_distance

Set the minimum distance threshold for gesture detection. The total distance from the first point to the current point must exceed this value (in pixels) for the movement to be considered large enough to trigger a gesture.

void lv_indev_set_gesture_min_distance(lv_indev_t *indev, uint8_t min_distance)

lv_indev_set_cursor

Set a cursor for a pointer input device (for LV_INPUT_TYPE_POINTER and LV_INPUT_TYPE_BUTTON)

void lv_indev_set_cursor(lv_indev_t *indev, lv_obj_t *cur_obj)

lv_indev_set_group

Set a destination group for a keypad or encoder input device

void lv_indev_set_group(lv_indev_t *indev, lv_group_t *group)

lv_indev_set_button_points

Set the an array of points for LV_INDEV_TYPE_BUTTON. These points will be assigned to the buttons to press a specific point on the screen

void lv_indev_set_button_points(lv_indev_t *indev, const lv_point_t points[])

lv_indev_set_mode

Set the input device's event model: event-driven mode or timer mode.

void lv_indev_set_mode(lv_indev_t *indev, lv_indev_mode_t mode)

lv_indev_set_key_remap_cb

Set key remapping callback (LV_INDEV_TYPE_KEYPAD)

void lv_indev_set_key_remap_cb(lv_indev_t *indev, lv_indev_key_remap_cb_t remap_cb)

lv_indev_set_ccw

Set Counter-Clock-Wise (CCW) rotation processing for an indev

void lv_indev_set_ccw(lv_indev_t *indev)

lv_indev_set_external_data

Attaches external user data and destructor callback to an indev.

Associates custom user data with an LVGL indev and specifies a destructor function that will be automatically invoked when the indev is deleted to properly clean up the associated resources.

void lv_indev_set_external_data(lv_indev_t *indev, void *data, void(*free_cb)(void *data))

lv_indev_get_next

Get the next input device.

lv_indev_t * lv_indev_get_next(lv_indev_t *indev)

Returns: lv_indev_t * — the next input device or NULL if there are no more.

lv_indev_get_type

Get the type of an input device

lv_indev_type_t lv_indev_get_type(const lv_indev_t *indev)

Returns: lv_indev_type_t — the type of the input device from lv_hal_indev_type_t (LV_INDEV_TYPE_...)

lv_indev_get_read_cb

Get the callback function to read input device data to the indev

lv_indev_read_cb_t lv_indev_get_read_cb(lv_indev_t *indev)

Returns: lv_indev_read_cb_t — Pointer to callback function to read input device data or NULL if indev is NULL

lv_indev_get_state

Get the indev state

lv_indev_state_t lv_indev_get_state(const lv_indev_t *indev)

Returns: lv_indev_state_t — Indev state or LV_INDEV_STATE_RELEASED if indev is NULL

lv_indev_get_group

Get the indev assigned group

lv_group_t * lv_indev_get_group(const lv_indev_t *indev)

Returns: lv_group_t * — Pointer to indev assigned group or NULL if indev is NULL

lv_indev_get_display

Get a pointer to the assigned display of the indev

lv_display_t * lv_indev_get_display(const lv_indev_t *indev)

Returns: lv_display_t * — pointer to the assigned display or NULL if indev is NULL

lv_indev_get_user_data

Get a pointer to the user data of the indev

void * lv_indev_get_user_data(const lv_indev_t *indev)

Returns: void * — pointer to the user data or NULL if indev is NULL

lv_indev_get_driver_data

Get a pointer to the driver data of the indev

void * lv_indev_get_driver_data(const lv_indev_t *indev)

Returns: void * — pointer to the driver data or NULL if indev is NULL

lv_indev_get_press_moved

Get whether indev is moved while pressed

bool lv_indev_get_press_moved(const lv_indev_t *indev)

Returns: bool — true: indev is moved while pressed; false: indev is not moved while pressed

lv_indev_get_point

Get the last point of an input device (for LV_INDEV_TYPE_POINTER and LV_INDEV_TYPE_BUTTON)

void lv_indev_get_point(const lv_indev_t *indev, lv_point_t *point)

lv_indev_get_gesture_dir

Get the current gesture direct

lv_dir_t lv_indev_get_gesture_dir(const lv_indev_t *indev)

Returns: lv_dir_t — current gesture direct

lv_indev_get_key

Get the last pressed key of an input device (for LV_INDEV_TYPE_KEYPAD)

uint32_t lv_indev_get_key(const lv_indev_t *indev)

Returns: uint32_t — the last pressed key (0 on error)

lv_indev_get_short_click_streak

Get the counter for consecutive clicks within a short distance and time. The counter is updated before LV_EVENT_SHORT_CLICKED is fired.

uint8_t lv_indev_get_short_click_streak(const lv_indev_t *indev)

Returns: uint8_t — short click streak counter

lv_indev_get_scroll_dir

Check the current scroll direction of an input device (for LV_INDEV_TYPE_POINTER and LV_INDEV_TYPE_BUTTON)

lv_dir_t lv_indev_get_scroll_dir(const lv_indev_t *indev)

Returns: lv_dir_t — LV_DIR_NONE: no scrolling now LV_DIR_HOR/VER

lv_indev_get_scroll_obj

Get the currently scrolled object (for LV_INDEV_TYPE_POINTER and LV_INDEV_TYPE_BUTTON)

lv_obj_t * lv_indev_get_scroll_obj(const lv_indev_t *indev)

Returns: lv_obj_t * — pointer to the currently scrolled object or NULL if no scrolling by this indev

lv_indev_get_vect

Get the movement vector of an input device (for LV_INDEV_TYPE_POINTER and LV_INDEV_TYPE_BUTTON)

void lv_indev_get_vect(const lv_indev_t *indev, lv_point_t *point)

lv_indev_get_cursor

Get the cursor object of an input device (for LV_INDEV_TYPE_POINTER only)

lv_obj_t * lv_indev_get_cursor(lv_indev_t *indev)

Returns: lv_obj_t * — pointer to the cursor object

lv_indev_get_active_obj

Gets a pointer to the currently active object in the currently processed input device.

lv_obj_t * lv_indev_get_active_obj(void)

Returns: lv_obj_t * — pointer to currently active object or NULL if no active object

lv_indev_get_read_timer

Get a pointer to the indev read timer to modify its parameters with lv_timer_... functions.

lv_timer_t * lv_indev_get_read_timer(lv_indev_t *indev)

Returns: lv_timer_t * — pointer to the indev read refresher timer. (NULL on error)

lv_indev_get_mode

Get the input device's running mode.

lv_indev_mode_t lv_indev_get_mode(lv_indev_t *indev)

Returns: lv_indev_mode_t — the running mode for the specified input device.

lv_indev_get_event_count

Get the number of event attached to an indev

uint32_t lv_indev_get_event_count(lv_indev_t *indev)

Returns: uint32_t — number of events

lv_indev_get_event_dsc

Get an event descriptor for an event

lv_event_dsc_t * lv_indev_get_event_dsc(lv_indev_t *indev, uint32_t index)

Returns: lv_event_dsc_t * — the event descriptor

lv_indev_get_ccw

Get Counter-Clock-Wise (CCW) rotation processing for an indev

bool lv_indev_get_ccw(const lv_indev_t *indev)

Returns: bool — True if CCW processing is set for an indev, false if indev is NULL or CCW processing is not set.

lv_indev_create

Create an indev

lv_indev_t * lv_indev_create(void)

Returns: lv_indev_t * — Pointer to the created indev or NULL when allocation failed

lv_indev_delete

Remove the provided input device. Make sure not to use the provided input device afterwards anymore.

void lv_indev_delete(lv_indev_t *indev)

lv_indev_read

Read data from an input device.

void lv_indev_read(lv_indev_t *indev)

lv_indev_read_timer_cb

Called periodically to read the input devices

void lv_indev_read_timer_cb(lv_timer_t *timer)

lv_indev_enable

Enable or disable one or all input devices (default enabled)

void lv_indev_enable(lv_indev_t *indev, bool enable)

lv_indev_active

Get the currently processed input device. Can be used in action functions too.

lv_indev_t * lv_indev_active(void)

Returns: lv_indev_t * — pointer to the currently processed input device or NULL if no input device processing right now

lv_indev_reset

Reset one or all input devices

void lv_indev_reset(lv_indev_t *indev, lv_obj_t *obj)

lv_indev_stop_processing

Touch and key related events are sent to the input device first and to the widget after that. If this functions called in an indev event, the event won't be sent to the widget.

void lv_indev_stop_processing(lv_indev_t *indev)

lv_indev_reset_long_press

Reset the long press state of an input device

void lv_indev_reset_long_press(lv_indev_t *indev)

lv_indev_wait_release

Do nothing until the next release

void lv_indev_wait_release(lv_indev_t *indev)

lv_indev_search_obj

Search the most top, clickable object by a point

lv_obj_t * lv_indev_search_obj(lv_obj_t *obj, lv_point_t *point)

Returns: lv_obj_t * — pointer to the found object or NULL if there was no suitable object

lv_indev_add_event_cb

Add an event handler to the indev

lv_event_dsc_t * lv_indev_add_event_cb(lv_indev_t *indev, lv_event_cb_t event_cb, lv_event_code_t filter, void *user_data)

Returns: lv_event_dsc_t * — the event descriptor or NULL if the event couldn't be created

lv_indev_remove_event

Remove an event

bool lv_indev_remove_event(lv_indev_t *indev, uint32_t index)

Returns: bool — true: and event was removed; false: no event was removed

lv_indev_remove_event_cb_with_user_data

Remove an event_cb with user_data

uint32_t lv_indev_remove_event_cb_with_user_data(lv_indev_t *indev, lv_event_cb_t event_cb, void *user_data)

Returns: uint32_t — the count of the event removed

lv_indev_send_event

Send an event to an indev

lv_result_t lv_indev_send_event(lv_indev_t *indev, lv_event_code_t code, void *param)

Returns: lv_result_t — LV_RESULT_OK: indev wasn't deleted in the event.

lv_indev_clear_ccw

Clear Counter-Clock-Wise (CCW) rotation processing for an indev

void lv_indev_clear_ccw(lv_indev_t *indev)