fdo-mirrors/libinput
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/libinput/libinput.git synced 2026-05-07 20:08:19 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc/user: document sticky vs timeout based drag lock a bit better

Browse source 
Part-of: <https://gitlab.freedesktop.org/libinput/libinput/-/merge_requests/1447>
This commit is contained in:
Peter Hutterer 2026-03-16 09:39:57 +10:00 • committed by Marge Bot
parent 1c4040ffa3
commit f97d0e6db1
1 changed files with 11 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
doc/user/tapping.rst
View file

@ -59,13 +59,16 @@ tap-and-drag enabled by default.
middle-click drag, tap with three fingers followed by a middle-click drag, tap with three fingers followed by a
single-finger drag. single-finger drag.
Also optional is a feature called "drag lock". With drag lock disabled, lifting Also optional is a feature called "drag lock". With drag lock **disabled**,
the finger will stop any drag process. When enabled, the drag lifting the finger will stop any drag process. When **enabled**, the drag
process continues even after lifting a finger but can be ended process continues even after lifting a finger, allowing the user to
with an additional tap. If timeout-based drag-locks are enabled reset the finger position and keep moving without releasing the drag.
the drag process will also automatically end once the finger has
been lifted for an implementation-specific timeout. Drag lock can be libinput supports two variations of this drag lock: "sticky" and "timeout".
enabled and disabled with **libinput_device_config_tap_set_drag_lock_enabled()**. In sticky mode, the drag lock must be ended with an explicit additional tap.
In timeout mode, the drag lock ends automatically if no finger was put back on
the touchpad within a timeout. Drag lock can be enabled and disabled with
**libinput_device_config_tap_set_drag_lock_enabled()**.
Note that drag lock only applies if tap-and-drag is enabled. Note that drag lock only applies if tap-and-drag is enabled.
.. figure:: tap-n-drag.svg .. figure:: tap-n-drag.svg
@ -81,11 +84,7 @@ position can be reset by lifting and quickly setting it down again on the
touchpad (d). This will be interpreted as continuing move and is especially touchpad (d). This will be interpreted as continuing move and is especially
useful on small touchpads or with slow pointer acceleration. useful on small touchpads or with slow pointer acceleration.
If drag lock is enabled, the release of the mouse buttons after the finger If drag lock is enabled, the release of the mouse buttons after the finger
release (e) is triggered by a timeout. To release the button immediately, release (e) is triggered by a timeout (if in timeout mode) or by tapping again (f).
simply tap again (f).
If drag lock is enabled in sticky mode there is no timeout after
releasing a finger and an extra tap is required to release the button.
If two fingers are supported by the hardware, a second finger can be used to If two fingers are supported by the hardware, a second finger can be used to
drag while the first is held in-place. drag while the first is held in-place.