diff options
author | Richard M. Stallman <rms@gnu.org> | 1998-05-19 03:45:57 +0000 |
---|---|---|
committer | Richard M. Stallman <rms@gnu.org> | 1998-05-19 03:45:57 +0000 |
commit | 9deac83199cdbd5d3231f35022f6129fb8a3edf5 (patch) | |
tree | d2f242286e0073005277ce19dd43d4b0bf300c4c /lispref/commands.texi | |
parent | 7a1297f918acdca3438f6393fac1928af2357c58 (diff) | |
download | emacs-9deac83199cdbd5d3231f35022f6129fb8a3edf5.tar.gz |
*** empty log message ***
Diffstat (limited to 'lispref/commands.texi')
-rw-r--r-- | lispref/commands.texi | 72 |
1 files changed, 65 insertions, 7 deletions
diff --git a/lispref/commands.texi b/lispref/commands.texi index 29e43d4dfc7..49c9d3c16e3 100644 --- a/lispref/commands.texi +++ b/lispref/commands.texi @@ -332,6 +332,10 @@ Prompt. @item F A file name. The file need not exist. Completion, Default, Prompt. +@item i +An irrelevant argument. This code always supplies @code{nil} as +the argument's value. No I/O. + @item k A key sequence (@pxref{Keymap Terminology}). This keeps reading events until a command (or undefined command) is found in the current key @@ -408,6 +412,16 @@ Minibuffer}. Prompt. @cindex evaluated expression argument A Lisp form is read as with @kbd{x}, but then evaluated so that its value becomes the argument for the command. Prompt. + +@item z +A coding system name (a symbol). If the user enters null input, the +argument value is @code{nil}. @xref{Coding Systems}. Completion, +Existing, Prompt. + +@item Z +A coding system name (a symbol)---but only if this command has a prefix +argument. With no prefix argument, @samp{Z} provides @code{nil} as the +argument value. Completion, Existing, Prompt. @end table @node Interactive Examples @@ -758,8 +772,15 @@ are characters or symbols; mouse events are always lists. This section describes the representation and meaning of input events in detail. @defun eventp object -This function returns non-@code{nil} if @var{object} is an input event. -A symbol +This function returns non-@code{nil} if @var{object} is an input event +or event type. + +Note that any symbol might be used as an event or an event type. +@code{eventp} cannot distinguish whether a symbol is intended by Lisp +code to be used as an event. Instead, it distinguishes whether the +symbol has actually been used in an event that has been read as input in +the current Emacs session. If a symbol has not yet been so used, +@code{eventp} returns @code{nil}. @end defun @menu @@ -1314,6 +1335,36 @@ want to. This kind of event indicates that the user deiconified @var{frame} using the window manager. Its standard definition is @code{ignore}; since the frame has already been made visible, Emacs has no work to do. + +@cindex @code{mouse-wheel} event +@item (mouse-wheel @var{position} @var{delta}) +This kind of event is generated by moving a wheel on a mouse (such as +the MS Intellimouse). Its effect is typically a kind of scroll or zoom. + +The element @var{delta} describes the amount and direction of the wheel +rotation. Its absolute value is the number of increments by which the +wheel was rotated. A negative @var{delta} indicates that the wheel was +rotated backwards, towards the user, and a positive @var{delta} +indicates that the wheel was rotated forward, away from the user. + +The element @var{position} is a list describing the position of the +event, in the same format as used in a mouse-click event. + +This kind of event is generated only on some kinds of systems. + +@cindex @code{drag-n-drop} event +@item (drag-n-drop @var{position} @var{files}) +This kind of event is generated when a group of files is +selected in an application outside of Emacs, and then dragged and +dropped onto an Emacs frame. + +The element @var{position} is a list describing the position of the +event, in the same format as used in a mouse-click event, and +@var{files} is the list of file names that were dragged and dropped. +The usual way to handle this event is by visiting these files. + +This kind of event is generated, at present, only on some kinds of +systems. @end table If one of these events arrives in the middle of a key sequence---that @@ -1559,7 +1610,7 @@ by not storing keyboard events in strings. Here is how to do that: @itemize @bullet @item Use vectors instead of strings for key sequences, when you plan to use -them for anything other than as arguments @code{lookup-key} and +them for anything other than as arguments to @code{lookup-key} and @code{define-key}. For example, you can use @code{read-key-sequence-vector} instead of @code{read-key-sequence}, and @code{this-command-keys-vector} instead of @code{this-command-keys}. @@ -1776,8 +1827,8 @@ this Emacs session. This includes key sequences read from the terminal and key sequences read from keyboard macros being executed. @end defvar -@tindex num-nonmacro-input-events @defvar num-nonmacro-input-events +@tindex num-nonmacro-input-events This variable holds the total number of input events received so far from the terminal---not counting those generated by keyboard macros. @end defvar @@ -1803,6 +1854,12 @@ If @code{cursor-in-echo-area} is non-@code{nil}, then @code{read-event} moves the cursor temporarily to the echo area, to the end of any message displayed there. Otherwise @code{read-event} does not move the cursor. +If @code{read-event} gets an event is defined as a help character, in +some cases @code{read-event} processes the event directly without +returning. @xref{Help Functions}. Certain other events, called +@dfn{special events}, are also processed directly within +@code{read-event} (@pxref{Special Events}). + Here is what happens if you call @code{read-event} and then press the right-arrow function key: @@ -2506,9 +2563,10 @@ the command to be considered complex. @defvar command-history This variable's value is a list of recent complex commands, each represented as a form to evaluate. It continues to accumulate all -complex commands for the duration of the editing session, but all but -the first (most recent) thirty elements are deleted when a garbage -collection takes place (@pxref{Garbage Collection}). +complex commands for the duration of the editing session, but when it +reaches the maximum size (specified by the variable +@code{history-length}), the oldest elements are deleted as new ones are +added. @example @group |