path: root/doc
diff options
authorPeter Hutterer <>2015-06-16 13:52:02 +1000
committerPeter Hutterer <>2015-06-16 13:52:02 +1000
commit2b99363a1ff948917a1a81c18d6079fb4a8cd4c2 (patch)
tree79bba625edcd0e82e30fa302475124d8bacee5ed /doc
parent99aa1f5dc3593826e512460a5c914a87a3a7c16a (diff)
parent8025b374d564f4a30b089e5cf6fd65e0c6af8da2 (diff)
Merge branch 'master' into tablet-support
Diffstat (limited to 'doc')
1 files changed, 18 insertions, 2 deletions
diff --git a/doc/scrolling.dox b/doc/scrolling.dox
index 94aa8158..1ecd0333 100644
--- a/doc/scrolling.dox
+++ b/doc/scrolling.dox
@@ -2,12 +2,24 @@
@page scrolling Scrolling
libinput supports three different types of scrolling methods: @ref
-twofinger_scrolling, @ref edge_scrolling and @ref button_scrolling. Some devices
-support multiple methods, though only one can be enabled at a time. See
+twofinger_scrolling, @ref edge_scrolling and @ref button_scrolling. Some
+devices support multiple methods, though only one can be enabled at a time.
+As a general overview:
+- touchpad devices with physical buttons below the touchpad support edge and
+ two-finger scrolling
+- touchpad devices without physical buttons (@ref clickpad_softbuttons
+ "clickpads") support two-finger scrolling only
+- pointing sticks provide on-button scrolling by default
+- mice and other pointing devices support on-button scrolling but it is not
+ enabled by default
+A device may differ from the above based on its capabilities. See
libinput_device_config_scroll_set_method() for documentation on how to
switch methods and libinput_device_config_scroll_get_methods() for
documentation on how to query a device for available scroll methods.
+@section horizontal_scrolling Horizontal scrolling
Scroll movements provide vertical and horizontal directions, each
scroll event contains both directions where applicable, see
libinput_event_pointer_get_axis_value(). libinput does not provide separate
@@ -55,6 +67,10 @@ a designated button is held down. For example, Lenovo devices provide a
<a href="">pointing stick</a> that emulates
scroll events when the trackstick's middle mouse button is held down.
+@note On-button scrolling is enabled by default for pointing sticks. This
+prevents middle-button dragging; all motion events while the middle button is
+down are converted to scroll events.
@image html button-scrolling.svg "Button scrolling"
The button may be changed with