summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorfvogel <fvogelnew1@free.fr>2020-06-22 20:18:26 (GMT)
committerfvogel <fvogelnew1@free.fr>2020-06-22 20:18:26 (GMT)
commit55165a174e26d263f04f46f24e9b932df9ddc831 (patch)
treeaeec10fb3df6f0ffb98de40e827cc41087173128
parenta14c1017e3d7dae43070bf5415698952591bfb85 (diff)
downloadtk-55165a174e26d263f04f46f24e9b932df9ddc831.zip
tk-55165a174e26d263f04f46f24e9b932df9ddc831.tar.gz
tk-55165a174e26d263f04f46f24e9b932df9ddc831.tar.bz2
Document platform differences in vertical scrolling events. Add documentation of horizontal scrolling events, also with platform specificities.
-rw-r--r--doc/bind.n17
1 files changed, 15 insertions, 2 deletions
diff --git a/doc/bind.n b/doc/bind.n
index f3c3d92..87940e8 100644
--- a/doc/bind.n
+++ b/doc/bind.n
@@ -204,11 +204,24 @@ wheel, the system will generate \fBMouseWheel\fR events that the
application can use to scroll. The event is routed to the
window currently under the mouse pointer. When the event
is received you can use the \fB%D\fR substitution to get the
-\fIdelta\fR field for the event, which is a integer value describing how
+\fIdelta\fR field for the event, which is an integer value describing how
the mouse wheel has moved. The smallest value for which the
-system will report is defined by the OS. The sign of the
+system will report is defined by the OS. The sign of the
value determines which direction your widget should scroll. Positive
values should scroll up and negative values should scroll down.
+.RS
+.PP
+Horizontal scrolling uses \fBShift-MouseWheel\fR events, with positive
+\fB%D\fR \fIdelta\fR substitution indicating left scrolling and negative
+right scrolling.
+Only Windows and macOS Aqua typically fire \fBMouseWheel\fR and
+\fBShift-MouseWheel\fR events. On
+X11 vertical scrolling is rather supported through \fBButton-4\fR and
+\fBButton-5\fR events, and horizontal scrolling through \fBShift-Button-4\fR
+and \fBShift-Button-5\fR events. Horizontal scrolling events may fire from
+many different hardware units such as tilt wheels or touchpads. Horizontal
+scrolling can also be emulated by holding Shift and scrolling vertically.
+.RE
.IP "\fBKeyPress\fR, \fBKeyRelease\fR" 5
The \fBKeyPress\fR and \fBKeyRelease\fR events are generated
whenever a key is pressed or released. \fBKeyPress\fR and \fBKeyRelease\fR