emacs-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

master f975398 2/2: Improve documentation of wheel events


From: Po Lu
Subject: master f975398 2/2: Improve documentation of wheel events
Date: Sat, 27 Nov 2021 07:49:17 -0500 (EST)

branch: master
commit f97539876af597e2497bfde68a68878166406302
Author: Po Lu <luangruo@yahoo.com>
Commit: Po Lu <luangruo@yahoo.com>

    Improve documentation of wheel events
    
    * doc/lispref/commands.texi (Misc Events): Add missing
    parameters to `wheel-up' and `wheel-down'.
---
 doc/lispref/commands.texi | 16 ++++++++++------
 1 file changed, 10 insertions(+), 6 deletions(-)

diff --git a/doc/lispref/commands.texi b/doc/lispref/commands.texi
index c12a97c..86f8468 100644
--- a/doc/lispref/commands.texi
+++ b/doc/lispref/commands.texi
@@ -1995,15 +1995,19 @@ frame has already been made visible, Emacs has no work 
to do.
 
 @cindex @code{wheel-up} event
 @cindex @code{wheel-down} event
-@item (wheel-up @var{position})
-@itemx (wheel-down @var{position})
+@item (wheel-up @var{position} @var{clicks} @var{lines} @var{pixel-delta})
+@itemx (wheel-down @var{position} @var{clicks} @var{lines} @var{pixel-delta})
 These kinds of event are generated by moving a mouse wheel.  The
 @var{position} element is a mouse position list (@pxref{Click
 Events}), specifying the position of the mouse cursor when the event
-occurred.  The event may have additional arguments after
-@var{position}.  The third argument after @var{position}, if present,
-is a pair of the form @w{@code{(@var{x} . @var{y})}}, where @var{x}
-and @var{y} are the number of pixels to scroll by in each axis.
+occurred.
+
+@var{clicks}, if present, is the number of times in quick succession
+the wheel has been moved.  @xref{Repeat Events}.  @var{lines}, if
+present and not @code{nil}, is the number of screen lines that should
+be scrolled.  @var{pixel-delta}, if present, is a pair of the form
+@w{@code{(@var{x} . @var{y})}}, where @var{x} and @var{y} are the
+number of pixels to scroll by in each axis.
 
 @cindex pixel-resolution wheel events
 You can use @var{x} and @var{y} to determine how much the mouse wheel



reply via email to

[Prev in Thread] Current Thread [Next in Thread]