]> git.eshelyaron.com Git - emacs.git/commitdiff
; Document input-event-functions
authorPhillip Lord <phillip.lord@russet.org.uk>
Fri, 25 Jan 2019 08:59:06 +0000 (08:59 +0000)
committerPhillip Lord <phillip.lord@russet.org.uk>
Fri, 25 Jan 2019 08:59:06 +0000 (08:59 +0000)
doc/lispref/commands.texi
etc/NEWS

index 1eb580e1e0fdd049e93215ccf9fc7a8a3f19854b..fb5a827ad1234f9990791597d84a4e5f14662573 100644 (file)
@@ -256,7 +256,7 @@ It may be a Lisp expression that is not a string; then it should be a
 form that is evaluated to get a list of arguments to pass to the
 command.  Usually this form will call various functions to read input
 from the user, most often through the minibuffer (@pxref{Minibuffers})
-or directly from the keyboard (@pxref{Reading Input}).
+or directly from the keyboard (@pxref{Reading Input})
 
 Providing point or the mark as an argument value is also common, but
 if you do this @emph{and} read input (whether using the minibuffer or
@@ -2920,6 +2920,18 @@ this expression) remains the value of @code{last-command-event}.
 @end example
 @end defvar
 
+@defvar input-event-functions
+This variable holds a list of functions to call after Emacs reads an
+event, but before any commands are run. Each function recieves a
+single argument: the event that has been read.
+
+There are normally easier hooks to use than this; in particular
+@var{pre-command-hook} is run immediately before any command resulting
+from an event. However, not all events result in a command, including
+many mouse events and some keyboard events when an input-method is
+active (@pxref{Reading Input}).
+@end defvar
+
 @defmac while-no-input body@dots{}
 This construct runs the @var{body} forms and returns the value of the
 last one---but only if no input arrives.  If any input arrives during
index 4937fa0fe2d3941251b4db6368ba33cb28dada2d..c658406bc77a4a949c402cd2bb25487f35809c3a 100644 (file)
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -1204,6 +1204,7 @@ removed.
 
 ** 'lookup-key' can take a list of keymaps as argument.
 
++++
 ** New hook 'input-event-functions' run whenever a user-input is read.
 
 +++