fdo-mirrors/libinput
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/libinput/libinput.git synced 2026-06-10 00:58:31 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: add HOLD_END to libinput_event_gesture_get_cancelled() doc

Browse source 
The implementation accepts LIBINPUT_EVENT_GESTURE_HOLD_END in
require_event_type() but the API documentation only listed SWIPE_END
and PINCH_END. This was likely missed when hold gesture support was
added.

Co-authored-by: Claude <noreply@anthropic.com>
Part-of: <https://gitlab.freedesktop.org/libinput/libinput/-/merge_requests/1469>
This commit is contained in:
Peter Hutterer 2026-04-17 12:01:46 +10:00 • committed by Marge Bot
parent 2da19a8802
commit 0e4492155f
1 changed files with 6 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
src/libinput.h
View file

@ -1994,12 +1994,14 @@ libinput_event_gesture_get_finger_count(struct libinput_event_gesture *event);
*
* Return if the gesture ended normally, or if it was cancelled.
* For gesture events that are not of type
* @ref LIBINPUT_EVENT_GESTURE_SWIPE_END or
* @ref LIBINPUT_EVENT_GESTURE_PINCH_END, this function returns 0.
* @ref LIBINPUT_EVENT_GESTURE_SWIPE_END,
* @ref LIBINPUT_EVENT_GESTURE_PINCH_END, or
* @ref LIBINPUT_EVENT_GESTURE_HOLD_END, this function returns 0.
*
* @note It is an application bug to call this function for events other than
* @ref LIBINPUT_EVENT_GESTURE_SWIPE_END or
* @ref LIBINPUT_EVENT_GESTURE_PINCH_END.
* @ref LIBINPUT_EVENT_GESTURE_SWIPE_END,
* @ref LIBINPUT_EVENT_GESTURE_PINCH_END, or
* @ref LIBINPUT_EVENT_GESTURE_HOLD_END.
*
* @return 0 or 1, with 1 indicating that the gesture was cancelled.
*/