Mercurial > emacs
annotate lispref/commands.texi @ 83059:af4a10a1bd55
Revert patch-93, that was the real culprit. Reapply patch-97.
src/keyboard.c (read_avail_input): Don't BLOCK_INPUT.
src/xterm.c (XTread_socket): Don't try to handle a new event if the
input buffer is full.
git-archimport-id: lorentey@elte.hu--2004/emacs--multi-tty--0--patch-99
author | Karoly Lorentey <lorentey@elte.hu> |
---|---|
date | Wed, 25 Feb 2004 03:29:37 +0000 |
parents | 2171cb453271 |
children | 2b5c4bf61459 |
rev | line source |
---|---|
6260 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
27189 | 3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999 |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48731
diff
changeset
|
4 @c Free Software Foundation, Inc. |
6260 | 5 @c See the file elisp.texi for copying conditions. |
6 @setfilename ../info/commands | |
7 @node Command Loop, Keymaps, Minibuffers, Top | |
8 @chapter Command Loop | |
9 @cindex editor command loop | |
10 @cindex command loop | |
11 | |
12 When you run Emacs, it enters the @dfn{editor command loop} almost | |
13 immediately. This loop reads key sequences, executes their definitions, | |
14 and displays the results. In this chapter, we describe how these things | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48731
diff
changeset
|
15 are done, and the subroutines that allow Lisp programs to do them. |
6260 | 16 |
17 @menu | |
18 * Command Overview:: How the command loop reads commands. | |
19 * Defining Commands:: Specifying how a function should read arguments. | |
20 * Interactive Call:: Calling a command, so that it will read arguments. | |
21 * Command Loop Info:: Variables set by the command loop for you to examine. | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
22 * Adjusting Point:: Adjustment of point after a command. |
6260 | 23 * Input Events:: What input looks like when you read it. |
24 * Reading Input:: How to read input events from the keyboard or mouse. | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
25 * Special Events:: Events processed immediately and individually. |
6260 | 26 * Waiting:: Waiting for user input or elapsed time. |
27 * Quitting:: How @kbd{C-g} works. How to catch or defer quitting. | |
28 * Prefix Command Arguments:: How the commands to set prefix args work. | |
29 * Recursive Editing:: Entering a recursive edit, | |
30 and why you usually shouldn't. | |
31 * Disabling Commands:: How the command loop handles disabled commands. | |
32 * Command History:: How the command history is set up, and how accessed. | |
33 * Keyboard Macros:: How keyboard macros are implemented. | |
34 @end menu | |
35 | |
36 @node Command Overview | |
37 @section Command Loop Overview | |
38 | |
39 The first thing the command loop must do is read a key sequence, which | |
40 is a sequence of events that translates into a command. It does this by | |
41 calling the function @code{read-key-sequence}. Your Lisp code can also | |
42 call this function (@pxref{Key Sequence Input}). Lisp programs can also | |
43 do input at a lower level with @code{read-event} (@pxref{Reading One | |
44 Event}) or discard pending input with @code{discard-input} | |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
45 (@pxref{Event Input Misc}). |
6260 | 46 |
47 The key sequence is translated into a command through the currently | |
48 active keymaps. @xref{Key Lookup}, for information on how this is done. | |
49 The result should be a keyboard macro or an interactively callable | |
50 function. If the key is @kbd{M-x}, then it reads the name of another | |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
51 command, which it then calls. This is done by the command |
6260 | 52 @code{execute-extended-command} (@pxref{Interactive Call}). |
53 | |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
54 To execute a command requires first reading the arguments for it. |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
55 This is done by calling @code{command-execute} (@pxref{Interactive |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
56 Call}). For commands written in Lisp, the @code{interactive} |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
57 specification says how to read the arguments. This may use the prefix |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
58 argument (@pxref{Prefix Command Arguments}) or may read with prompting |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
59 in the minibuffer (@pxref{Minibuffers}). For example, the command |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
60 @code{find-file} has an @code{interactive} specification which says to |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
61 read a file name using the minibuffer. The command's function body does |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
62 not use the minibuffer; if you call this command from Lisp code as a |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
63 function, you must supply the file name string as an ordinary Lisp |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
64 function argument. |
6260 | 65 |
66 If the command is a string or vector (i.e., a keyboard macro) then | |
67 @code{execute-kbd-macro} is used to execute it. You can call this | |
68 function yourself (@pxref{Keyboard Macros}). | |
69 | |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
70 To terminate the execution of a running command, type @kbd{C-g}. This |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
71 character causes @dfn{quitting} (@pxref{Quitting}). |
6260 | 72 |
73 @defvar pre-command-hook | |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
74 The editor command loop runs this normal hook before each command. At |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
75 that time, @code{this-command} contains the command that is about to |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
76 run, and @code{last-command} describes the previous command. |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
77 @xref{Hooks}. |
6260 | 78 @end defvar |
79 | |
80 @defvar post-command-hook | |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
81 The editor command loop runs this normal hook after each command |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
82 (including commands terminated prematurely by quitting or by errors), |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
83 and also when the command loop is first entered. At that time, |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
84 @code{this-command} describes the command that just ran, and |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
85 @code{last-command} describes the command before that. @xref{Hooks}. |
6260 | 86 @end defvar |
87 | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
88 Quitting is suppressed while running @code{pre-command-hook} and |
12098 | 89 @code{post-command-hook}. If an error happens while executing one of |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
90 these hooks, it terminates execution of the hook, and clears the hook |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
91 variable to @code{nil} so as to prevent an infinite loop of errors. |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
92 |
51912
3abd89560852
(Command Overview): Emacs server runs pre-command-hook and post-command-hook.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
93 A request coming into the Emacs server (@pxref{Emacs Server,,, |
3abd89560852
(Command Overview): Emacs server runs pre-command-hook and post-command-hook.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
94 emacs, The GNU Emacs Manual}) runs these two hooks just as a keyboard |
3abd89560852
(Command Overview): Emacs server runs pre-command-hook and post-command-hook.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
95 command does. |
3abd89560852
(Command Overview): Emacs server runs pre-command-hook and post-command-hook.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
96 |
6260 | 97 @node Defining Commands |
98 @section Defining Commands | |
99 @cindex defining commands | |
100 @cindex commands, defining | |
101 @cindex functions, making them interactive | |
102 @cindex interactive function | |
103 | |
104 A Lisp function becomes a command when its body contains, at top | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
105 level, a form that calls the special form @code{interactive}. This |
6260 | 106 form does nothing when actually executed, but its presence serves as a |
107 flag to indicate that interactive calling is permitted. Its argument | |
108 controls the reading of arguments for an interactive call. | |
109 | |
110 @menu | |
111 * Using Interactive:: General rules for @code{interactive}. | |
112 * Interactive Codes:: The standard letter-codes for reading arguments | |
113 in various ways. | |
114 * Interactive Examples:: Examples of how to read interactive arguments. | |
115 @end menu | |
116 | |
117 @node Using Interactive | |
118 @subsection Using @code{interactive} | |
119 | |
120 This section describes how to write the @code{interactive} form that | |
39210
c717c37b1a2c
(Using Interactive): Document interactive-form.
Eli Zaretskii <eliz@gnu.org>
parents:
38603
diff
changeset
|
121 makes a Lisp function an interactively-callable command, and how to |
39221
68b26e98aef6
Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents:
39210
diff
changeset
|
122 examine a commands's @code{interactive} form. |
6260 | 123 |
124 @defspec interactive arg-descriptor | |
125 @cindex argument descriptors | |
126 This special form declares that the function in which it appears is a | |
127 command, and that it may therefore be called interactively (via | |
128 @kbd{M-x} or by entering a key sequence bound to it). The argument | |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
129 @var{arg-descriptor} declares how to compute the arguments to the |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
130 command when the command is called interactively. |
6260 | 131 |
132 A command may be called from Lisp programs like any other function, but | |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
133 then the caller supplies the arguments and @var{arg-descriptor} has no |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
134 effect. |
6260 | 135 |
136 The @code{interactive} form has its effect because the command loop | |
137 (actually, its subroutine @code{call-interactively}) scans through the | |
138 function definition looking for it, before calling the function. Once | |
139 the function is called, all its body forms including the | |
140 @code{interactive} form are executed, but at this time | |
141 @code{interactive} simply returns @code{nil} without even evaluating its | |
142 argument. | |
143 @end defspec | |
144 | |
145 There are three possibilities for the argument @var{arg-descriptor}: | |
146 | |
147 @itemize @bullet | |
148 @item | |
149 It may be omitted or @code{nil}; then the command is called with no | |
150 arguments. This leads quickly to an error if the command requires one | |
151 or more arguments. | |
152 | |
153 @item | |
154 It may be a Lisp expression that is not a string; then it should be a | |
155 form that is evaluated to get a list of arguments to pass to the | |
156 command. | |
157 @cindex argument evaluation form | |
158 | |
10834
e79e5c9e7722
Warn that interactive should get point and mark only after minibuffer input.
Richard M. Stallman <rms@gnu.org>
parents:
8532
diff
changeset
|
159 If this expression reads keyboard input (this includes using the |
e79e5c9e7722
Warn that interactive should get point and mark only after minibuffer input.
Richard M. Stallman <rms@gnu.org>
parents:
8532
diff
changeset
|
160 minibuffer), keep in mind that the integer value of point or the mark |
e79e5c9e7722
Warn that interactive should get point and mark only after minibuffer input.
Richard M. Stallman <rms@gnu.org>
parents:
8532
diff
changeset
|
161 before reading input may be incorrect after reading input. This is |
e79e5c9e7722
Warn that interactive should get point and mark only after minibuffer input.
Richard M. Stallman <rms@gnu.org>
parents:
8532
diff
changeset
|
162 because the current buffer may be receiving subprocess output; |
e79e5c9e7722
Warn that interactive should get point and mark only after minibuffer input.
Richard M. Stallman <rms@gnu.org>
parents:
8532
diff
changeset
|
163 if subprocess output arrives while the command is waiting for input, |
e79e5c9e7722
Warn that interactive should get point and mark only after minibuffer input.
Richard M. Stallman <rms@gnu.org>
parents:
8532
diff
changeset
|
164 it could relocate point and the mark. |
e79e5c9e7722
Warn that interactive should get point and mark only after minibuffer input.
Richard M. Stallman <rms@gnu.org>
parents:
8532
diff
changeset
|
165 |
e79e5c9e7722
Warn that interactive should get point and mark only after minibuffer input.
Richard M. Stallman <rms@gnu.org>
parents:
8532
diff
changeset
|
166 Here's an example of what @emph{not} to do: |
e79e5c9e7722
Warn that interactive should get point and mark only after minibuffer input.
Richard M. Stallman <rms@gnu.org>
parents:
8532
diff
changeset
|
167 |
e79e5c9e7722
Warn that interactive should get point and mark only after minibuffer input.
Richard M. Stallman <rms@gnu.org>
parents:
8532
diff
changeset
|
168 @smallexample |
e79e5c9e7722
Warn that interactive should get point and mark only after minibuffer input.
Richard M. Stallman <rms@gnu.org>
parents:
8532
diff
changeset
|
169 (interactive |
e79e5c9e7722
Warn that interactive should get point and mark only after minibuffer input.
Richard M. Stallman <rms@gnu.org>
parents:
8532
diff
changeset
|
170 (list (region-beginning) (region-end) |
e79e5c9e7722
Warn that interactive should get point and mark only after minibuffer input.
Richard M. Stallman <rms@gnu.org>
parents:
8532
diff
changeset
|
171 (read-string "Foo: " nil 'my-history))) |
e79e5c9e7722
Warn that interactive should get point and mark only after minibuffer input.
Richard M. Stallman <rms@gnu.org>
parents:
8532
diff
changeset
|
172 @end smallexample |
e79e5c9e7722
Warn that interactive should get point and mark only after minibuffer input.
Richard M. Stallman <rms@gnu.org>
parents:
8532
diff
changeset
|
173 |
e79e5c9e7722
Warn that interactive should get point and mark only after minibuffer input.
Richard M. Stallman <rms@gnu.org>
parents:
8532
diff
changeset
|
174 @noindent |
e79e5c9e7722
Warn that interactive should get point and mark only after minibuffer input.
Richard M. Stallman <rms@gnu.org>
parents:
8532
diff
changeset
|
175 Here's how to avoid the problem, by examining point and the mark only |
e79e5c9e7722
Warn that interactive should get point and mark only after minibuffer input.
Richard M. Stallman <rms@gnu.org>
parents:
8532
diff
changeset
|
176 after reading the keyboard input: |
e79e5c9e7722
Warn that interactive should get point and mark only after minibuffer input.
Richard M. Stallman <rms@gnu.org>
parents:
8532
diff
changeset
|
177 |
e79e5c9e7722
Warn that interactive should get point and mark only after minibuffer input.
Richard M. Stallman <rms@gnu.org>
parents:
8532
diff
changeset
|
178 @smallexample |
e79e5c9e7722
Warn that interactive should get point and mark only after minibuffer input.
Richard M. Stallman <rms@gnu.org>
parents:
8532
diff
changeset
|
179 (interactive |
e79e5c9e7722
Warn that interactive should get point and mark only after minibuffer input.
Richard M. Stallman <rms@gnu.org>
parents:
8532
diff
changeset
|
180 (let ((string (read-string "Foo: " nil 'my-history))) |
e79e5c9e7722
Warn that interactive should get point and mark only after minibuffer input.
Richard M. Stallman <rms@gnu.org>
parents:
8532
diff
changeset
|
181 (list (region-beginning) (region-end) string))) |
e79e5c9e7722
Warn that interactive should get point and mark only after minibuffer input.
Richard M. Stallman <rms@gnu.org>
parents:
8532
diff
changeset
|
182 @end smallexample |
e79e5c9e7722
Warn that interactive should get point and mark only after minibuffer input.
Richard M. Stallman <rms@gnu.org>
parents:
8532
diff
changeset
|
183 |
6260 | 184 @item |
185 @cindex argument prompt | |
186 It may be a string; then its contents should consist of a code character | |
187 followed by a prompt (which some code characters use and some ignore). | |
188 The prompt ends either with the end of the string or with a newline. | |
189 Here is a simple example: | |
190 | |
191 @smallexample | |
192 (interactive "bFrobnicate buffer: ") | |
193 @end smallexample | |
194 | |
195 @noindent | |
196 The code letter @samp{b} says to read the name of an existing buffer, | |
197 with completion. The buffer name is the sole argument passed to the | |
198 command. The rest of the string is a prompt. | |
199 | |
200 If there is a newline character in the string, it terminates the prompt. | |
201 If the string does not end there, then the rest of the string should | |
202 contain another code character and prompt, specifying another argument. | |
203 You can specify any number of arguments in this way. | |
204 | |
205 @c Emacs 19 feature | |
206 The prompt string can use @samp{%} to include previous argument values | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
207 (starting with the first argument) in the prompt. This is done using |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
208 @code{format} (@pxref{Formatting Strings}). For example, here is how |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
209 you could read the name of an existing buffer followed by a new name to |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
210 give to that buffer: |
6260 | 211 |
212 @smallexample | |
213 @group | |
214 (interactive "bBuffer to rename: \nsRename buffer %s to: ") | |
215 @end group | |
216 @end smallexample | |
217 | |
39221
68b26e98aef6
Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents:
39210
diff
changeset
|
218 @cindex @samp{*} in @code{interactive} |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
219 @cindex read-only buffers in interactive |
6260 | 220 If the first character in the string is @samp{*}, then an error is |
221 signaled if the buffer is read-only. | |
222 | |
39221
68b26e98aef6
Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents:
39210
diff
changeset
|
223 @cindex @samp{@@} in @code{interactive} |
6260 | 224 @c Emacs 19 feature |
225 If the first character in the string is @samp{@@}, and if the key | |
226 sequence used to invoke the command includes any mouse events, then | |
227 the window associated with the first of those events is selected | |
228 before the command is run. | |
229 | |
230 You can use @samp{*} and @samp{@@} together; the order does not matter. | |
231 Actual reading of arguments is controlled by the rest of the prompt | |
232 string (starting with the first character that is not @samp{*} or | |
233 @samp{@@}). | |
234 @end itemize | |
235 | |
39221
68b26e98aef6
Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents:
39210
diff
changeset
|
236 @cindex examining the @code{interactive} form |
39210
c717c37b1a2c
(Using Interactive): Document interactive-form.
Eli Zaretskii <eliz@gnu.org>
parents:
38603
diff
changeset
|
237 @defun interactive-form function |
39221
68b26e98aef6
Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents:
39210
diff
changeset
|
238 This function returns the @code{interactive} form of @var{function}. If |
39210
c717c37b1a2c
(Using Interactive): Document interactive-form.
Eli Zaretskii <eliz@gnu.org>
parents:
38603
diff
changeset
|
239 @var{function} is a command (@pxref{Interactive Call}), the value is a |
c717c37b1a2c
(Using Interactive): Document interactive-form.
Eli Zaretskii <eliz@gnu.org>
parents:
38603
diff
changeset
|
240 list of the form @code{(interactive @var{spec})}, where @var{spec} is |
c717c37b1a2c
(Using Interactive): Document interactive-form.
Eli Zaretskii <eliz@gnu.org>
parents:
38603
diff
changeset
|
241 the descriptor specification used by the command's @code{interactive} |
54061
2171cb453271
(Using Interactive): Delete pxref to top of same node.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53519
diff
changeset
|
242 form to compute the function's arguments. If @var{function} is not a |
2171cb453271
(Using Interactive): Delete pxref to top of same node.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53519
diff
changeset
|
243 command, @code{interactive-form} returns @code{nil}. |
39210
c717c37b1a2c
(Using Interactive): Document interactive-form.
Eli Zaretskii <eliz@gnu.org>
parents:
38603
diff
changeset
|
244 @end defun |
c717c37b1a2c
(Using Interactive): Document interactive-form.
Eli Zaretskii <eliz@gnu.org>
parents:
38603
diff
changeset
|
245 |
6260 | 246 @node Interactive Codes |
247 @comment node-name, next, previous, up | |
248 @subsection Code Characters for @code{interactive} | |
249 @cindex interactive code description | |
250 @cindex description for interactive codes | |
251 @cindex codes, interactive, description of | |
252 @cindex characters for interactive codes | |
253 | |
254 The code character descriptions below contain a number of key words, | |
255 defined here as follows: | |
256 | |
257 @table @b | |
258 @item Completion | |
259 @cindex interactive completion | |
260 Provide completion. @key{TAB}, @key{SPC}, and @key{RET} perform name | |
261 completion because the argument is read using @code{completing-read} | |
262 (@pxref{Completion}). @kbd{?} displays a list of possible completions. | |
263 | |
264 @item Existing | |
265 Require the name of an existing object. An invalid name is not | |
266 accepted; the commands to exit the minibuffer do not exit if the current | |
267 input is not valid. | |
268 | |
269 @item Default | |
270 @cindex default argument string | |
271 A default value of some sort is used if the user enters no text in the | |
272 minibuffer. The default depends on the code character. | |
273 | |
274 @item No I/O | |
275 This code letter computes an argument without reading any input. | |
276 Therefore, it does not use a prompt string, and any prompt string you | |
277 supply is ignored. | |
278 | |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
279 Even though the code letter doesn't use a prompt string, you must follow |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
280 it with a newline if it is not the last code character in the string. |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
281 |
6260 | 282 @item Prompt |
283 A prompt immediately follows the code character. The prompt ends either | |
284 with the end of the string or with a newline. | |
285 | |
286 @item Special | |
287 This code character is meaningful only at the beginning of the | |
288 interactive string, and it does not look for a prompt or a newline. | |
289 It is a single, isolated character. | |
290 @end table | |
291 | |
292 @cindex reading interactive arguments | |
293 Here are the code character descriptions for use with @code{interactive}: | |
294 | |
295 @table @samp | |
296 @item * | |
297 Signal an error if the current buffer is read-only. Special. | |
298 | |
299 @item @@ | |
300 Select the window mentioned in the first mouse event in the key | |
301 sequence that invoked this command. Special. | |
302 | |
303 @item a | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
304 A function name (i.e., a symbol satisfying @code{fboundp}). Existing, |
6260 | 305 Completion, Prompt. |
306 | |
307 @item b | |
308 The name of an existing buffer. By default, uses the name of the | |
309 current buffer (@pxref{Buffers}). Existing, Completion, Default, | |
310 Prompt. | |
311 | |
312 @item B | |
313 A buffer name. The buffer need not exist. By default, uses the name of | |
314 a recently used buffer other than the current buffer. Completion, | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
315 Default, Prompt. |
6260 | 316 |
317 @item c | |
318 A character. The cursor does not move into the echo area. Prompt. | |
319 | |
320 @item C | |
321 A command name (i.e., a symbol satisfying @code{commandp}). Existing, | |
322 Completion, Prompt. | |
323 | |
324 @item d | |
325 @cindex position argument | |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
326 The position of point, as an integer (@pxref{Point}). No I/O. |
6260 | 327 |
328 @item D | |
329 A directory name. The default is the current default directory of the | |
54061
2171cb453271
(Using Interactive): Delete pxref to top of same node.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53519
diff
changeset
|
330 current buffer, @code{default-directory} (@pxref{File Name Expansion}). |
6260 | 331 Existing, Completion, Default, Prompt. |
332 | |
333 @item e | |
334 The first or next mouse event in the key sequence that invoked the command. | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
335 More precisely, @samp{e} gets events that are lists, so you can look at |
6260 | 336 the data in the lists. @xref{Input Events}. No I/O. |
337 | |
338 You can use @samp{e} more than once in a single command's interactive | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
339 specification. If the key sequence that invoked the command has |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
340 @var{n} events that are lists, the @var{n}th @samp{e} provides the |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
341 @var{n}th such event. Events that are not lists, such as function keys |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52626
diff
changeset
|
342 and @acronym{ASCII} characters, do not count where @samp{e} is concerned. |
6260 | 343 |
344 @item f | |
345 A file name of an existing file (@pxref{File Names}). The default | |
346 directory is @code{default-directory}. Existing, Completion, Default, | |
347 Prompt. | |
348 | |
349 @item F | |
350 A file name. The file need not exist. Completion, Default, Prompt. | |
351 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
352 @item i |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
353 An irrelevant argument. This code always supplies @code{nil} as |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
354 the argument's value. No I/O. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
355 |
6260 | 356 @item k |
357 A key sequence (@pxref{Keymap Terminology}). This keeps reading events | |
358 until a command (or undefined command) is found in the current key | |
359 maps. The key sequence argument is represented as a string or vector. | |
360 The cursor does not move into the echo area. Prompt. | |
361 | |
362 This kind of input is used by commands such as @code{describe-key} and | |
363 @code{global-set-key}. | |
364 | |
12067 | 365 @item K |
366 A key sequence, whose definition you intend to change. This works like | |
367 @samp{k}, except that it suppresses, for the last input event in the key | |
368 sequence, the conversions that are normally used (when necessary) to | |
369 convert an undefined key into a defined one. | |
370 | |
6260 | 371 @item m |
372 @cindex marker argument | |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
373 The position of the mark, as an integer. No I/O. |
6260 | 374 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
375 @item M |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
376 Arbitrary text, read in the minibuffer using the current buffer's input |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
377 method, and returned as a string (@pxref{Input Methods,,, emacs, The GNU |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
378 Emacs Manual}). Prompt. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
379 |
6260 | 380 @item n |
381 A number read with the minibuffer. If the input is not a number, the | |
382 user is asked to try again. The prefix argument, if any, is not used. | |
383 Prompt. | |
384 | |
385 @item N | |
386 @cindex raw prefix argument usage | |
13853
7c317c94b1f6
Changed interactive spec N.
Richard M. Stallman <rms@gnu.org>
parents:
13007
diff
changeset
|
387 The numeric prefix argument; but if there is no prefix argument, read a |
7c317c94b1f6
Changed interactive spec N.
Richard M. Stallman <rms@gnu.org>
parents:
13007
diff
changeset
|
388 number as with @kbd{n}. Requires a number. @xref{Prefix Command |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
389 Arguments}. Prompt. |
6260 | 390 |
391 @item p | |
392 @cindex numeric prefix argument usage | |
393 The numeric prefix argument. (Note that this @samp{p} is lower case.) | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
394 No I/O. |
6260 | 395 |
396 @item P | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
397 The raw prefix argument. (Note that this @samp{P} is upper case.) No |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
398 I/O. |
6260 | 399 |
400 @item r | |
401 @cindex region argument | |
402 Point and the mark, as two numeric arguments, smallest first. This is | |
403 the only code letter that specifies two successive arguments rather than | |
404 one. No I/O. | |
405 | |
406 @item s | |
407 Arbitrary text, read in the minibuffer and returned as a string | |
408 (@pxref{Text from Minibuffer}). Terminate the input with either | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
409 @kbd{C-j} or @key{RET}. (@kbd{C-q} may be used to include either of |
6260 | 410 these characters in the input.) Prompt. |
411 | |
412 @item S | |
413 An interned symbol whose name is read in the minibuffer. Any whitespace | |
414 character terminates the input. (Use @kbd{C-q} to include whitespace in | |
415 the string.) Other characters that normally terminate a symbol (e.g., | |
416 parentheses and brackets) do not do so here. Prompt. | |
417 | |
418 @item v | |
419 A variable declared to be a user option (i.e., satisfying the predicate | |
420 @code{user-variable-p}). @xref{High-Level Completion}. Existing, | |
421 Completion, Prompt. | |
422 | |
423 @item x | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
424 A Lisp object, specified with its read syntax, terminated with a |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
425 @kbd{C-j} or @key{RET}. The object is not evaluated. @xref{Object from |
6260 | 426 Minibuffer}. Prompt. |
427 | |
428 @item X | |
429 @cindex evaluated expression argument | |
430 A Lisp form is read as with @kbd{x}, but then evaluated so that its | |
431 value becomes the argument for the command. Prompt. | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
432 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
433 @item z |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
434 A coding system name (a symbol). If the user enters null input, the |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
435 argument value is @code{nil}. @xref{Coding Systems}. Completion, |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
436 Existing, Prompt. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
437 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
438 @item Z |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
439 A coding system name (a symbol)---but only if this command has a prefix |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
440 argument. With no prefix argument, @samp{Z} provides @code{nil} as the |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
441 argument value. Completion, Existing, Prompt. |
6260 | 442 @end table |
443 | |
444 @node Interactive Examples | |
445 @comment node-name, next, previous, up | |
446 @subsection Examples of Using @code{interactive} | |
447 @cindex examples of using @code{interactive} | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48731
diff
changeset
|
448 @cindex @code{interactive}, examples of using |
6260 | 449 |
450 Here are some examples of @code{interactive}: | |
451 | |
452 @example | |
453 @group | |
454 (defun foo1 () ; @r{@code{foo1} takes no arguments,} | |
455 (interactive) ; @r{just moves forward two words.} | |
456 (forward-word 2)) | |
457 @result{} foo1 | |
458 @end group | |
459 | |
460 @group | |
461 (defun foo2 (n) ; @r{@code{foo2} takes one argument,} | |
462 (interactive "p") ; @r{which is the numeric prefix.} | |
463 (forward-word (* 2 n))) | |
464 @result{} foo2 | |
465 @end group | |
466 | |
467 @group | |
468 (defun foo3 (n) ; @r{@code{foo3} takes one argument,} | |
469 (interactive "nCount:") ; @r{which is read with the Minibuffer.} | |
470 (forward-word (* 2 n))) | |
471 @result{} foo3 | |
472 @end group | |
473 | |
474 @group | |
475 (defun three-b (b1 b2 b3) | |
476 "Select three existing buffers. | |
477 Put them into three windows, selecting the last one." | |
478 @end group | |
479 (interactive "bBuffer1:\nbBuffer2:\nbBuffer3:") | |
480 (delete-other-windows) | |
481 (split-window (selected-window) 8) | |
482 (switch-to-buffer b1) | |
483 (other-window 1) | |
484 (split-window (selected-window) 8) | |
485 (switch-to-buffer b2) | |
486 (other-window 1) | |
487 (switch-to-buffer b3)) | |
488 @result{} three-b | |
489 @group | |
490 (three-b "*scratch*" "declarations.texi" "*mail*") | |
491 @result{} nil | |
492 @end group | |
493 @end example | |
494 | |
495 @node Interactive Call | |
496 @section Interactive Call | |
497 @cindex interactive call | |
498 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
499 After the command loop has translated a key sequence into a command it |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
500 invokes that command using the function @code{command-execute}. If the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
501 command is a function, @code{command-execute} calls |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
502 @code{call-interactively}, which reads the arguments and calls the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
503 command. You can also call these functions yourself. |
6260 | 504 |
52185
b047788c0a9c
(Interactive Call): commandp has new arg.
Richard M. Stallman <rms@gnu.org>
parents:
52138
diff
changeset
|
505 @defun commandp object &optional for-call-interactively |
6260 | 506 Returns @code{t} if @var{object} is suitable for calling interactively; |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48731
diff
changeset
|
507 that is, if @var{object} is a command. Otherwise, returns @code{nil}. |
6260 | 508 |
509 The interactively callable objects include strings and vectors (treated | |
510 as keyboard macros), lambda expressions that contain a top-level call to | |
12098 | 511 @code{interactive}, byte-code function objects made from such lambda |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
512 expressions, autoload objects that are declared as interactive |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
513 (non-@code{nil} fourth argument to @code{autoload}), and some of the |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
514 primitive functions. |
6260 | 515 |
52185
b047788c0a9c
(Interactive Call): commandp has new arg.
Richard M. Stallman <rms@gnu.org>
parents:
52138
diff
changeset
|
516 A symbol satisfies @code{commandp} if its function definition |
b047788c0a9c
(Interactive Call): commandp has new arg.
Richard M. Stallman <rms@gnu.org>
parents:
52138
diff
changeset
|
517 satisfies @code{commandp}. Keys and keymaps are not commands. |
b047788c0a9c
(Interactive Call): commandp has new arg.
Richard M. Stallman <rms@gnu.org>
parents:
52138
diff
changeset
|
518 Rather, they are used to look up commands (@pxref{Keymaps}). |
b047788c0a9c
(Interactive Call): commandp has new arg.
Richard M. Stallman <rms@gnu.org>
parents:
52138
diff
changeset
|
519 |
b047788c0a9c
(Interactive Call): commandp has new arg.
Richard M. Stallman <rms@gnu.org>
parents:
52138
diff
changeset
|
520 If @var{for-call-interactively} is non-@code{nil}, then |
b047788c0a9c
(Interactive Call): commandp has new arg.
Richard M. Stallman <rms@gnu.org>
parents:
52138
diff
changeset
|
521 @code{commandp} returns @code{t} only for objects that |
b047788c0a9c
(Interactive Call): commandp has new arg.
Richard M. Stallman <rms@gnu.org>
parents:
52138
diff
changeset
|
522 @code{call-interactively} could call---thus, not for keyboard macros. |
6260 | 523 |
524 See @code{documentation} in @ref{Accessing Documentation}, for a | |
525 realistic example of using @code{commandp}. | |
526 @end defun | |
527 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
528 @defun call-interactively command &optional record-flag keys |
6260 | 529 This function calls the interactively callable function @var{command}, |
530 reading arguments according to its interactive calling specifications. | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
531 An error is signaled if @var{command} is not a function or if it cannot |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
532 be called interactively (i.e., is not a command). Note that keyboard |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
533 macros (strings and vectors) are not accepted, even though they are |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
534 considered commands, because they are not functions. |
6260 | 535 |
536 @cindex record command history | |
537 If @var{record-flag} is non-@code{nil}, then this command and its | |
538 arguments are unconditionally added to the list @code{command-history}. | |
539 Otherwise, the command is added only if it uses the minibuffer to read | |
540 an argument. @xref{Command History}. | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
541 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
542 The argument @var{keys}, if given, specifies the sequence of events to |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
543 supply if the command inquires which events were used to invoke it. |
6260 | 544 @end defun |
545 | |
26288 | 546 @defun command-execute command &optional record-flag keys special |
6260 | 547 @cindex keyboard macro execution |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
548 This function executes @var{command}. The argument @var{command} must |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
549 satisfy the @code{commandp} predicate; i.e., it must be an interactively |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
550 callable function or a keyboard macro. |
6260 | 551 |
552 A string or vector as @var{command} is executed with | |
553 @code{execute-kbd-macro}. A function is passed to | |
554 @code{call-interactively}, along with the optional @var{record-flag}. | |
555 | |
556 A symbol is handled by using its function definition in its place. A | |
557 symbol with an @code{autoload} definition counts as a command if it was | |
558 declared to stand for an interactively callable function. Such a | |
559 definition is handled by loading the specified library and then | |
560 rechecking the definition of the symbol. | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
561 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
562 The argument @var{keys}, if given, specifies the sequence of events to |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
563 supply if the command inquires which events were used to invoke it. |
26288 | 564 |
565 The argument @var{special}, if given, means to ignore the prefix | |
566 argument and not clear it. This is used for executing special events | |
567 (@pxref{Special Events}). | |
6260 | 568 @end defun |
569 | |
570 @deffn Command execute-extended-command prefix-argument | |
571 @cindex read command name | |
572 This function reads a command name from the minibuffer using | |
573 @code{completing-read} (@pxref{Completion}). Then it uses | |
574 @code{command-execute} to call the specified command. Whatever that | |
575 command returns becomes the value of @code{execute-extended-command}. | |
576 | |
577 @cindex execute with prefix argument | |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
578 If the command asks for a prefix argument, it receives the value |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
579 @var{prefix-argument}. If @code{execute-extended-command} is called |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
580 interactively, the current raw prefix argument is used for |
6260 | 581 @var{prefix-argument}, and thus passed on to whatever command is run. |
582 | |
583 @c !!! Should this be @kindex? | |
584 @cindex @kbd{M-x} | |
585 @code{execute-extended-command} is the normal definition of @kbd{M-x}, | |
586 so it uses the string @w{@samp{M-x }} as a prompt. (It would be better | |
587 to take the prompt from the events used to invoke | |
588 @code{execute-extended-command}, but that is painful to implement.) A | |
589 description of the value of the prefix argument, if any, also becomes | |
590 part of the prompt. | |
591 | |
592 @example | |
593 @group | |
594 (execute-extended-command 1) | |
595 ---------- Buffer: Minibuffer ---------- | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
596 1 M-x forward-word RET |
6260 | 597 ---------- Buffer: Minibuffer ---------- |
598 @result{} t | |
599 @end group | |
600 @end example | |
601 @end deffn | |
602 | |
603 @defun interactive-p | |
16736
981e116b4ac6
Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents:
15764
diff
changeset
|
604 This function returns @code{t} if the containing function (the one whose |
981e116b4ac6
Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents:
15764
diff
changeset
|
605 code includes the call to @code{interactive-p}) was called |
981e116b4ac6
Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents:
15764
diff
changeset
|
606 interactively, with the function @code{call-interactively}. (It makes |
981e116b4ac6
Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents:
15764
diff
changeset
|
607 no difference whether @code{call-interactively} was called from Lisp or |
981e116b4ac6
Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents:
15764
diff
changeset
|
608 directly from the editor command loop.) If the containing function was |
981e116b4ac6
Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents:
15764
diff
changeset
|
609 called by Lisp evaluation (or with @code{apply} or @code{funcall}), then |
981e116b4ac6
Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents:
15764
diff
changeset
|
610 it was not called interactively. |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
611 @end defun |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
612 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
613 The most common use of @code{interactive-p} is for deciding whether to |
6260 | 614 print an informative message. As a special exception, |
615 @code{interactive-p} returns @code{nil} whenever a keyboard macro is | |
616 being run. This is to suppress the informative messages and speed | |
617 execution of the macro. | |
618 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
619 For example: |
6260 | 620 |
621 @example | |
622 @group | |
623 (defun foo () | |
624 (interactive) | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
625 (when (interactive-p) |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
626 (message "foo"))) |
6260 | 627 @result{} foo |
628 @end group | |
629 | |
630 @group | |
631 (defun bar () | |
632 (interactive) | |
633 (setq foobar (list (foo) (interactive-p)))) | |
634 @result{} bar | |
635 @end group | |
636 | |
637 @group | |
638 ;; @r{Type @kbd{M-x foo}.} | |
639 @print{} foo | |
640 @end group | |
641 | |
642 @group | |
643 ;; @r{Type @kbd{M-x bar}.} | |
644 ;; @r{This does not print anything.} | |
645 @end group | |
646 | |
647 @group | |
648 foobar | |
649 @result{} (nil t) | |
650 @end group | |
651 @end example | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
652 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
653 The other way to do this sort of job is to make the command take an |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
654 argument @code{print-message} which should be non-@code{nil} in an |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
655 interactive call, and use the @code{interactive} spec to make sure it is |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
656 non-@code{nil}. Here's how: |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
657 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
658 @example |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
659 (defun foo (&optional print-message) |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
660 (interactive "p") |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
661 (when print-message |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
662 (message "foo"))) |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
663 @end example |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
664 |
52138
b740243a935b
(Interactive Call): Minor clarification.
Richard M. Stallman <rms@gnu.org>
parents:
51912
diff
changeset
|
665 @noindent |
b740243a935b
(Interactive Call): Minor clarification.
Richard M. Stallman <rms@gnu.org>
parents:
51912
diff
changeset
|
666 Defined in this way, the function does display the message when |
b740243a935b
(Interactive Call): Minor clarification.
Richard M. Stallman <rms@gnu.org>
parents:
51912
diff
changeset
|
667 called from a keyboard macro. |
b740243a935b
(Interactive Call): Minor clarification.
Richard M. Stallman <rms@gnu.org>
parents:
51912
diff
changeset
|
668 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
669 The numeric prefix argument, provided by @samp{p}, is never @code{nil}. |
6260 | 670 |
671 @node Command Loop Info | |
672 @comment node-name, next, previous, up | |
673 @section Information from the Command Loop | |
674 | |
675 The editor command loop sets several Lisp variables to keep status | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48731
diff
changeset
|
676 records for itself and for commands that are run. |
6260 | 677 |
678 @defvar last-command | |
679 This variable records the name of the previous command executed by the | |
680 command loop (the one before the current command). Normally the value | |
681 is a symbol with a function definition, but this is not guaranteed. | |
682 | |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
683 The value is copied from @code{this-command} when a command returns to |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
684 the command loop, except when the command has specified a prefix |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
685 argument for the following command. |
12098 | 686 |
687 This variable is always local to the current terminal and cannot be | |
688 buffer-local. @xref{Multiple Displays}. | |
6260 | 689 @end defvar |
690 | |
22440
8a51f757af2c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
691 @defvar real-last-command |
8a51f757af2c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
692 This variable is set up by Emacs just like @code{last-command}, |
8a51f757af2c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
693 but never altered by Lisp programs. |
8a51f757af2c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
694 @end defvar |
8a51f757af2c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
695 |
6260 | 696 @defvar this-command |
697 @cindex current command | |
698 This variable records the name of the command now being executed by | |
699 the editor command loop. Like @code{last-command}, it is normally a symbol | |
700 with a function definition. | |
701 | |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
702 The command loop sets this variable just before running a command, and |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
703 copies its value into @code{last-command} when the command finishes |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
704 (unless the command specified a prefix argument for the following |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
705 command). |
6260 | 706 |
707 @cindex kill command repetition | |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
708 Some commands set this variable during their execution, as a flag for |
12098 | 709 whatever command runs next. In particular, the functions for killing text |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
710 set @code{this-command} to @code{kill-region} so that any kill commands |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
711 immediately following will know to append the killed text to the |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
712 previous kill. |
6260 | 713 @end defvar |
714 | |
715 If you do not want a particular command to be recognized as the previous | |
716 command in the case where it got an error, you must code that command to | |
717 prevent this. One way is to set @code{this-command} to @code{t} at the | |
718 beginning of the command, and set @code{this-command} back to its proper | |
719 value at the end, like this: | |
720 | |
721 @example | |
722 (defun foo (args@dots{}) | |
723 (interactive @dots{}) | |
724 (let ((old-this-command this-command)) | |
725 (setq this-command t) | |
726 @r{@dots{}do the work@dots{}} | |
727 (setq this-command old-this-command))) | |
728 @end example | |
729 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
730 @noindent |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
731 We do not bind @code{this-command} with @code{let} because that would |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
732 restore the old value in case of error---a feature of @code{let} which |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
733 in this case does precisely what we want to avoid. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
734 |
52185
b047788c0a9c
(Interactive Call): commandp has new arg.
Richard M. Stallman <rms@gnu.org>
parents:
52138
diff
changeset
|
735 @defvar this-original-command |
b047788c0a9c
(Interactive Call): commandp has new arg.
Richard M. Stallman <rms@gnu.org>
parents:
52138
diff
changeset
|
736 This has the same value as @code{this-command} except when command |
b047788c0a9c
(Interactive Call): commandp has new arg.
Richard M. Stallman <rms@gnu.org>
parents:
52138
diff
changeset
|
737 remapping occurs (@pxref{Remapping Commands}). In that case, |
b047788c0a9c
(Interactive Call): commandp has new arg.
Richard M. Stallman <rms@gnu.org>
parents:
52138
diff
changeset
|
738 @code{this-command} gives the command actually run (the result of |
b047788c0a9c
(Interactive Call): commandp has new arg.
Richard M. Stallman <rms@gnu.org>
parents:
52138
diff
changeset
|
739 remapping), and @code{this-original-command} gives the command that |
b047788c0a9c
(Interactive Call): commandp has new arg.
Richard M. Stallman <rms@gnu.org>
parents:
52138
diff
changeset
|
740 was specified to run but remapped into another command. |
b047788c0a9c
(Interactive Call): commandp has new arg.
Richard M. Stallman <rms@gnu.org>
parents:
52138
diff
changeset
|
741 @end defvar |
b047788c0a9c
(Interactive Call): commandp has new arg.
Richard M. Stallman <rms@gnu.org>
parents:
52138
diff
changeset
|
742 |
6260 | 743 @defun this-command-keys |
744 This function returns a string or vector containing the key sequence | |
745 that invoked the present command, plus any previous commands that | |
746 generated the prefix argument for this command. The value is a string | |
747 if all those events were characters. @xref{Input Events}. | |
748 | |
749 @example | |
750 @group | |
751 (this-command-keys) | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
752 ;; @r{Now use @kbd{C-u C-x C-e} to evaluate that.} |
6260 | 753 @result{} "^U^X^E" |
754 @end group | |
755 @end example | |
756 @end defun | |
757 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
758 @defun this-command-keys-vector |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
759 Like @code{this-command-keys}, except that it always returns the events |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
760 in a vector, so you don't need to deal with the complexities of storing |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
761 input events in a string (@pxref{Strings of Events}). |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
762 @end defun |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
763 |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23110
diff
changeset
|
764 @tindex clear-this-command-keys |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23110
diff
changeset
|
765 @defun clear-this-command-keys |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23110
diff
changeset
|
766 This function empties out the table of events for |
39221
68b26e98aef6
Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents:
39210
diff
changeset
|
767 @code{this-command-keys} to return, and also empties the records that |
68b26e98aef6
Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents:
39210
diff
changeset
|
768 the function @code{recent-keys} (@pxref{Recording Input}) will |
68b26e98aef6
Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents:
39210
diff
changeset
|
769 subsequently return. This is useful after reading a password, to |
68b26e98aef6
Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents:
39210
diff
changeset
|
770 prevent the password from echoing inadvertently as part of the next |
68b26e98aef6
Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents:
39210
diff
changeset
|
771 command in certain cases. |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23110
diff
changeset
|
772 @end defun |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23110
diff
changeset
|
773 |
6260 | 774 @defvar last-nonmenu-event |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
775 This variable holds the last input event read as part of a key sequence, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
776 not counting events resulting from mouse menus. |
6260 | 777 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
778 One use of this variable is for telling @code{x-popup-menu} where to pop |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
779 up a menu. It is also used internally by @code{y-or-n-p} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
780 (@pxref{Yes-or-No Queries}). |
6260 | 781 @end defvar |
782 | |
783 @defvar last-command-event | |
784 @defvarx last-command-char | |
785 This variable is set to the last input event that was read by the | |
786 command loop as part of a command. The principal use of this variable | |
787 is in @code{self-insert-command}, which uses it to decide which | |
788 character to insert. | |
789 | |
790 @example | |
791 @group | |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
792 last-command-event |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
793 ;; @r{Now use @kbd{C-u C-x C-e} to evaluate that.} |
6260 | 794 @result{} 5 |
795 @end group | |
796 @end example | |
797 | |
798 @noindent | |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52626
diff
changeset
|
799 The value is 5 because that is the @acronym{ASCII} code for @kbd{C-e}. |
6260 | 800 |
801 The alias @code{last-command-char} exists for compatibility with | |
802 Emacs version 18. | |
803 @end defvar | |
804 | |
805 @c Emacs 19 feature | |
806 @defvar last-event-frame | |
807 This variable records which frame the last input event was directed to. | |
808 Usually this is the frame that was selected when the event was | |
809 generated, but if that frame has redirected input focus to another | |
810 frame, the value is the frame to which the event was redirected. | |
811 @xref{Input Focus}. | |
812 @end defvar | |
813 | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
814 @node Adjusting Point |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
815 @section Adjusting Point After Commands |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
816 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
817 It is not easy to display a value of point in the middle of a sequence |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
818 of text that has the @code{display} or @code{composition} property. So |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
819 after a command finishes and returns to the command loop, if point is |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
820 within such a sequence, the command loop normally moves point to the |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
821 edge of the sequence. |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
822 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
823 A command can inhibit this feature by setting the variable |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
824 @code{disable-point-adjustment}: |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
825 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
826 @defvar disable-point-adjustment |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
827 @tindex disable-point-adjustment |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
828 If this variable is non-@code{nil} when a command returns to the command |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
829 loop, then the command loop does not check for text properties such as |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
830 @code{display} and @code{composition}, and does not move point out of |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
831 sequences that have these properties. |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
832 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
833 The command loop sets this variable to @code{nil} before each command, |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
834 so if a command sets it, the effect applies only to that command. |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
835 @end defvar |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
836 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
837 @defvar global-disable-point-adjustment |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
838 @tindex global-disable-point-adjustment |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
839 If you set this variable to a non-@code{nil} value, the feature of |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
840 moving point out of these sequences is completely turned off. |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
841 @end defvar |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
842 |
6260 | 843 @node Input Events |
844 @section Input Events | |
845 @cindex events | |
846 @cindex input events | |
847 | |
848 The Emacs command loop reads a sequence of @dfn{input events} that | |
849 represent keyboard or mouse activity. The events for keyboard activity | |
850 are characters or symbols; mouse events are always lists. This section | |
851 describes the representation and meaning of input events in detail. | |
852 | |
853 @defun eventp object | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
854 This function returns non-@code{nil} if @var{object} is an input event |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
855 or event type. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
856 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
857 Note that any symbol might be used as an event or an event type. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
858 @code{eventp} cannot distinguish whether a symbol is intended by Lisp |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
859 code to be used as an event. Instead, it distinguishes whether the |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
860 symbol has actually been used in an event that has been read as input in |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
861 the current Emacs session. If a symbol has not yet been so used, |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
862 @code{eventp} returns @code{nil}. |
6260 | 863 @end defun |
864 | |
865 @menu | |
866 * Keyboard Events:: Ordinary characters--keys with symbols on them. | |
867 * Function Keys:: Function keys--keys with names, not symbols. | |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
868 * Mouse Events:: Overview of mouse events. |
6260 | 869 * Click Events:: Pushing and releasing a mouse button. |
870 * Drag Events:: Moving the mouse before releasing the button. | |
871 * Button-Down Events:: A button was pushed and not yet released. | |
872 * Repeat Events:: Double and triple click (or drag, or down). | |
873 * Motion Events:: Just moving the mouse, not pushing a button. | |
874 * Focus Events:: Moving the mouse between frames. | |
12067 | 875 * Misc Events:: Other events window systems can generate. |
6260 | 876 * Event Examples:: Examples of the lists for mouse events. |
877 * Classifying Events:: Finding the modifier keys in an event symbol. | |
878 Event types. | |
879 * Accessing Events:: Functions to extract info from events. | |
880 * Strings of Events:: Special considerations for putting | |
881 keyboard character events in a string. | |
882 @end menu | |
883 | |
884 @node Keyboard Events | |
885 @subsection Keyboard Events | |
886 | |
887 There are two kinds of input you can get from the keyboard: ordinary | |
888 keys, and function keys. Ordinary keys correspond to characters; the | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
889 events they generate are represented in Lisp as characters. The event |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
890 type of a character event is the character itself (an integer); see |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
891 @ref{Classifying Events}. |
6260 | 892 |
893 @cindex modifier bits (of input character) | |
894 @cindex basic code (of input character) | |
895 An input character event consists of a @dfn{basic code} between 0 and | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
896 524287, plus any or all of these @dfn{modifier bits}: |
6260 | 897 |
898 @table @asis | |
899 @item meta | |
12098 | 900 The |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
901 @tex |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
902 @math{2^{27}} |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
903 @end tex |
27193 | 904 @ifnottex |
12098 | 905 2**27 |
27193 | 906 @end ifnottex |
12098 | 907 bit in the character code indicates a character |
6260 | 908 typed with the meta key held down. |
909 | |
910 @item control | |
12098 | 911 The |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
912 @tex |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
913 @math{2^{26}} |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
914 @end tex |
27193 | 915 @ifnottex |
12098 | 916 2**26 |
27193 | 917 @end ifnottex |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52626
diff
changeset
|
918 bit in the character code indicates a non-@acronym{ASCII} |
6260 | 919 control character. |
920 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
921 @sc{ascii} control characters such as @kbd{C-a} have special basic |
6260 | 922 codes of their own, so Emacs needs no special bit to indicate them. |
923 Thus, the code for @kbd{C-a} is just 1. | |
924 | |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52626
diff
changeset
|
925 But if you type a control combination not in @acronym{ASCII}, such as |
6260 | 926 @kbd{%} with the control key, the numeric value you get is the code |
12098 | 927 for @kbd{%} plus |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
928 @tex |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
929 @math{2^{26}} |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
930 @end tex |
27193 | 931 @ifnottex |
12098 | 932 2**26 |
27193 | 933 @end ifnottex |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52626
diff
changeset
|
934 (assuming the terminal supports non-@acronym{ASCII} |
6260 | 935 control characters). |
936 | |
937 @item shift | |
12098 | 938 The |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
939 @tex |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
940 @math{2^{25}} |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
941 @end tex |
27193 | 942 @ifnottex |
12098 | 943 2**25 |
27193 | 944 @end ifnottex |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52626
diff
changeset
|
945 bit in the character code indicates an @acronym{ASCII} control |
6260 | 946 character typed with the shift key held down. |
947 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
948 For letters, the basic code itself indicates upper versus lower case; |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
949 for digits and punctuation, the shift key selects an entirely different |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
950 character with a different basic code. In order to keep within the |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52626
diff
changeset
|
951 @acronym{ASCII} character set whenever possible, Emacs avoids using the |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
952 @tex |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
953 @math{2^{25}} |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
954 @end tex |
27193 | 955 @ifnottex |
12098 | 956 2**25 |
27193 | 957 @end ifnottex |
12098 | 958 bit for those characters. |
6260 | 959 |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52626
diff
changeset
|
960 However, @acronym{ASCII} provides no way to distinguish @kbd{C-A} from |
12098 | 961 @kbd{C-a}, so Emacs uses the |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
962 @tex |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
963 @math{2^{25}} |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
964 @end tex |
27193 | 965 @ifnottex |
12098 | 966 2**25 |
27193 | 967 @end ifnottex |
12098 | 968 bit in @kbd{C-A} and not in |
6260 | 969 @kbd{C-a}. |
970 | |
971 @item hyper | |
12098 | 972 The |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
973 @tex |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
974 @math{2^{24}} |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
975 @end tex |
27193 | 976 @ifnottex |
12098 | 977 2**24 |
27193 | 978 @end ifnottex |
12098 | 979 bit in the character code indicates a character |
6260 | 980 typed with the hyper key held down. |
981 | |
982 @item super | |
12098 | 983 The |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
984 @tex |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
985 @math{2^{23}} |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
986 @end tex |
27193 | 987 @ifnottex |
12098 | 988 2**23 |
27193 | 989 @end ifnottex |
12098 | 990 bit in the character code indicates a character |
6260 | 991 typed with the super key held down. |
992 | |
993 @item alt | |
12098 | 994 The |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
995 @tex |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
996 @math{2^{22}} |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
997 @end tex |
27193 | 998 @ifnottex |
12098 | 999 2**22 |
27193 | 1000 @end ifnottex |
12098 | 1001 bit in the character code indicates a character typed with |
6260 | 1002 the alt key held down. (On some terminals, the key labeled @key{ALT} |
1003 is actually the meta key.) | |
1004 @end table | |
1005 | |
12098 | 1006 It is best to avoid mentioning specific bit numbers in your program. |
1007 To test the modifier bits of a character, use the function | |
1008 @code{event-modifiers} (@pxref{Classifying Events}). When making key | |
1009 bindings, you can use the read syntax for characters with modifier bits | |
1010 (@samp{\C-}, @samp{\M-}, and so on). For making key bindings with | |
1011 @code{define-key}, you can use lists such as @code{(control hyper ?x)} to | |
1012 specify the characters (@pxref{Changing Key Bindings}). The function | |
1013 @code{event-convert-list} converts such a list into an event type | |
1014 (@pxref{Classifying Events}). | |
6260 | 1015 |
1016 @node Function Keys | |
1017 @subsection Function Keys | |
1018 | |
1019 @cindex function keys | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
1020 Most keyboards also have @dfn{function keys}---keys that have names or |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1021 symbols that are not characters. Function keys are represented in Emacs |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1022 Lisp as symbols; the symbol's name is the function key's label, in lower |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1023 case. For example, pressing a key labeled @key{F1} places the symbol |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1024 @code{f1} in the input stream. |
6260 | 1025 |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1026 The event type of a function key event is the event symbol itself. |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1027 @xref{Classifying Events}. |
6260 | 1028 |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
1029 Here are a few special cases in the symbol-naming convention for |
6260 | 1030 function keys: |
1031 | |
1032 @table @asis | |
1033 @item @code{backspace}, @code{tab}, @code{newline}, @code{return}, @code{delete} | |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52626
diff
changeset
|
1034 These keys correspond to common @acronym{ASCII} control characters that have |
6260 | 1035 special keys on most keyboards. |
1036 | |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52626
diff
changeset
|
1037 In @acronym{ASCII}, @kbd{C-i} and @key{TAB} are the same character. If the |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1038 terminal can distinguish between them, Emacs conveys the distinction to |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1039 Lisp programs by representing the former as the integer 9, and the |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1040 latter as the symbol @code{tab}. |
6260 | 1041 |
1042 Most of the time, it's not useful to distinguish the two. So normally | |
15764 | 1043 @code{function-key-map} (@pxref{Translating Input}) is set up to map |
1044 @code{tab} into 9. Thus, a key binding for character code 9 (the | |
1045 character @kbd{C-i}) also applies to @code{tab}. Likewise for the other | |
1046 symbols in this group. The function @code{read-char} likewise converts | |
1047 these events into characters. | |
6260 | 1048 |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52626
diff
changeset
|
1049 In @acronym{ASCII}, @key{BS} is really @kbd{C-h}. But @code{backspace} |
6260 | 1050 converts into the character code 127 (@key{DEL}), not into code 8 |
1051 (@key{BS}). This is what most users prefer. | |
1052 | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
1053 @item @code{left}, @code{up}, @code{right}, @code{down} |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
1054 Cursor arrow keys |
6260 | 1055 @item @code{kp-add}, @code{kp-decimal}, @code{kp-divide}, @dots{} |
1056 Keypad keys (to the right of the regular keyboard). | |
1057 @item @code{kp-0}, @code{kp-1}, @dots{} | |
1058 Keypad keys with digits. | |
1059 @item @code{kp-f1}, @code{kp-f2}, @code{kp-f3}, @code{kp-f4} | |
1060 Keypad PF keys. | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
1061 @item @code{kp-home}, @code{kp-left}, @code{kp-up}, @code{kp-right}, @code{kp-down} |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1062 Keypad arrow keys. Emacs normally translates these into the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1063 corresponding non-keypad keys @code{home}, @code{left}, @dots{} |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
1064 @item @code{kp-prior}, @code{kp-next}, @code{kp-end}, @code{kp-begin}, @code{kp-insert}, @code{kp-delete} |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
1065 Additional keypad duplicates of keys ordinarily found elsewhere. Emacs |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
1066 normally translates these into the like-named non-keypad keys. |
6260 | 1067 @end table |
1068 | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
1069 You can use the modifier keys @key{ALT}, @key{CTRL}, @key{HYPER}, |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
1070 @key{META}, @key{SHIFT}, and @key{SUPER} with function keys. The way to |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
1071 represent them is with prefixes in the symbol name: |
6260 | 1072 |
1073 @table @samp | |
1074 @item A- | |
1075 The alt modifier. | |
1076 @item C- | |
1077 The control modifier. | |
1078 @item H- | |
1079 The hyper modifier. | |
1080 @item M- | |
1081 The meta modifier. | |
1082 @item S- | |
1083 The shift modifier. | |
1084 @item s- | |
1085 The super modifier. | |
1086 @end table | |
1087 | |
1088 Thus, the symbol for the key @key{F3} with @key{META} held down is | |
8532 | 1089 @code{M-f3}. When you use more than one prefix, we recommend you |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1090 write them in alphabetical order; but the order does not matter in |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1091 arguments to the key-binding lookup and modification functions. |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1092 |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1093 @node Mouse Events |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1094 @subsection Mouse Events |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1095 |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1096 Emacs supports four kinds of mouse events: click events, drag events, |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1097 button-down events, and motion events. All mouse events are represented |
53297
4c4e0f5356bf
Replace all occurrences of @acronym{CAR} with @sc{car}, for
Luc Teirlinck <teirllm@auburn.edu>
parents:
53183
diff
changeset
|
1098 as lists. The @sc{car} of the list is the event type; this says which |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1099 mouse button was involved, and which modifier keys were used with it. |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1100 The event type can also distinguish double or triple button presses |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1101 (@pxref{Repeat Events}). The rest of the list elements give position |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1102 and time information. |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1103 |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1104 For key lookup, only the event type matters: two events of the same type |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1105 necessarily run the same command. The command can access the full |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1106 values of these events using the @samp{e} interactive code. |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1107 @xref{Interactive Codes}. |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1108 |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1109 A key sequence that starts with a mouse event is read using the keymaps |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1110 of the buffer in the window that the mouse was in, not the current |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1111 buffer. This does not imply that clicking in a window selects that |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1112 window or its buffer---that is entirely under the control of the command |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1113 binding of the key sequence. |
6260 | 1114 |
1115 @node Click Events | |
1116 @subsection Click Events | |
1117 @cindex click event | |
1118 @cindex mouse click event | |
1119 | |
1120 When the user presses a mouse button and releases it at the same | |
53136
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1121 location, that generates a @dfn{click} event. All mouse click event |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1122 share the same format: |
6260 | 1123 |
1124 @example | |
53136
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1125 (@var{event-type} @var{position} @var{click-count}) |
6260 | 1126 @end example |
1127 | |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1128 @table @asis |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1129 @item @var{event-type} |
6260 | 1130 This is a symbol that indicates which mouse button was used. It is |
1131 one of the symbols @code{mouse-1}, @code{mouse-2}, @dots{}, where the | |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1132 buttons are numbered left to right. |
6260 | 1133 |
1134 You can also use prefixes @samp{A-}, @samp{C-}, @samp{H-}, @samp{M-}, | |
1135 @samp{S-} and @samp{s-} for modifiers alt, control, hyper, meta, shift | |
1136 and super, just as you would with function keys. | |
1137 | |
1138 This symbol also serves as the event type of the event. Key bindings | |
1139 describe events by their types; thus, if there is a key binding for | |
1140 @code{mouse-1}, that binding would apply to all events whose | |
1141 @var{event-type} is @code{mouse-1}. | |
1142 | |
53136
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1143 @item @var{position} |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1144 This is the position where the mouse click occurred. The actual |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1145 format of @var{position} depends on what part of a window was clicked |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1146 on. The various formats are described below. |
6260 | 1147 |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1148 @item @var{click-count} |
6260 | 1149 This is the number of rapid repeated presses so far of the same mouse |
1150 button. @xref{Repeat Events}. | |
1151 @end table | |
1152 | |
53136
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1153 For mouse click events in the text area, mode line, header line, or in |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1154 the marginal areas, @var{position} has this form: |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1155 |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1156 @example |
53183
61e2da7a49f4
(Click Events): Click object may be an images.
Kim F. Storm <storm@cua.dk>
parents:
53136
diff
changeset
|
1157 (@var{window} @var{pos-or-area} (@var{x} . @var{y}) @var{timestamp} |
53519
ad9b61a60774
(Click Events): Describe new image and
Kim F. Storm <storm@cua.dk>
parents:
53303
diff
changeset
|
1158 @var{object} @var{text-pos} (@var{col} . @var{row}) |
ad9b61a60774
(Click Events): Describe new image and
Kim F. Storm <storm@cua.dk>
parents:
53303
diff
changeset
|
1159 @var{image} (@var{dx} . @var{dy}) (@var{width} . @var{height})) |
53136
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1160 @end example |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1161 |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1162 @table @asis |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1163 @item @var{window} |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1164 This is the window in which the click occurred. |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1165 |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1166 @item @var{pos-or-area} |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1167 This is the buffer position of the character clicked on in the text |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1168 area, or if clicked outside the text area, it is the window area in |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1169 which the click occurred. It is one of the symbols @code{mode-line}, |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1170 @code{header-line}, @code{vertical-line}, @code{left-margin}, |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1171 @code{right-margin}, @code{left-fringe}, or @code{right-fringe}. |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1172 |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1173 @item @var{x}, @var{y} |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1174 These are the pixel-denominated coordinates of the click, relative to |
53303
9e3a6298633c
Remove trailing whitespace.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53297
diff
changeset
|
1175 the top left corner of @var{window}, which is @code{(0 . 0)}. |
53136
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1176 For the mode or header line, @var{y} does not have meaningful data. |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1177 For the vertical line, @var{x} does not have meaningful data. |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1178 |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1179 @item @var{timestamp} |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1180 This is the time at which the event occurred, in milliseconds. |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1181 |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1182 @item @var{object} |
53183
61e2da7a49f4
(Click Events): Click object may be an images.
Kim F. Storm <storm@cua.dk>
parents:
53136
diff
changeset
|
1183 This is the object on which the click occurred. It is either |
53519
ad9b61a60774
(Click Events): Describe new image and
Kim F. Storm <storm@cua.dk>
parents:
53303
diff
changeset
|
1184 @code{nil} if there is no string property, or it has the form |
ad9b61a60774
(Click Events): Describe new image and
Kim F. Storm <storm@cua.dk>
parents:
53303
diff
changeset
|
1185 (@var{string} . @var{string-pos}) when there is a string-type text |
ad9b61a60774
(Click Events): Describe new image and
Kim F. Storm <storm@cua.dk>
parents:
53303
diff
changeset
|
1186 property at the click position. |
53136
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1187 |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1188 @item @var{string} |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1189 This is the string on which the click occurred, including any |
53303
9e3a6298633c
Remove trailing whitespace.
Luc Teirlinck <teirllm@auburn.edu>
parents:
53297
diff
changeset
|
1190 properties. |
53136
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1191 |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1192 @item @var{string-pos} |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1193 This is the position in the string on which the click occurred, |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1194 relevant if properties at the click need to be looked up. |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1195 |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1196 @item @var{text-pos} |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1197 For clicks on a marginal area or on a fringe, this is the buffer |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1198 position of the first visible character in the corresponding line in |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1199 the window. For other events, it is the current buffer position in |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1200 the window. |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1201 |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1202 @item @var{col}, @var{row} |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1203 These are the actual coordinates of the glyph under the @var{x}, |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1204 @var{y} position, possibly padded with default character width |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1205 glyphs if @var{x} is beyond the last glyph on the line. |
53183
61e2da7a49f4
(Click Events): Click object may be an images.
Kim F. Storm <storm@cua.dk>
parents:
53136
diff
changeset
|
1206 |
53519
ad9b61a60774
(Click Events): Describe new image and
Kim F. Storm <storm@cua.dk>
parents:
53303
diff
changeset
|
1207 @item @var{image} |
ad9b61a60774
(Click Events): Describe new image and
Kim F. Storm <storm@cua.dk>
parents:
53303
diff
changeset
|
1208 This is the image object on which the click occurred. It is either |
ad9b61a60774
(Click Events): Describe new image and
Kim F. Storm <storm@cua.dk>
parents:
53303
diff
changeset
|
1209 @code{nil} if there is no image at the position clicked on, or it is |
ad9b61a60774
(Click Events): Describe new image and
Kim F. Storm <storm@cua.dk>
parents:
53303
diff
changeset
|
1210 an image object as returned by @code{find-image} if click was in an image. |
ad9b61a60774
(Click Events): Describe new image and
Kim F. Storm <storm@cua.dk>
parents:
53303
diff
changeset
|
1211 |
53183
61e2da7a49f4
(Click Events): Click object may be an images.
Kim F. Storm <storm@cua.dk>
parents:
53136
diff
changeset
|
1212 @item @var{dx}, @var{dy} |
61e2da7a49f4
(Click Events): Click object may be an images.
Kim F. Storm <storm@cua.dk>
parents:
53136
diff
changeset
|
1213 These are the pixel-denominated coordinates of the click, relative to |
61e2da7a49f4
(Click Events): Click object may be an images.
Kim F. Storm <storm@cua.dk>
parents:
53136
diff
changeset
|
1214 the top left corner of @var{object}, which is @code{(0 . 0)}. If |
61e2da7a49f4
(Click Events): Click object may be an images.
Kim F. Storm <storm@cua.dk>
parents:
53136
diff
changeset
|
1215 @var{object} is @code{nil}, the coordinates are relative to the top |
61e2da7a49f4
(Click Events): Click object may be an images.
Kim F. Storm <storm@cua.dk>
parents:
53136
diff
changeset
|
1216 left corner of the character glyph clicked on. |
53136
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1217 @end table |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1218 |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1219 For mouse clicks on a scroll-bar, @var{position} has this form: |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1220 |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1221 @example |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1222 (@var{window} @var{area} (@var{portion} . @var{whole}) @var{timestamp} @var{part}) |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1223 @end example |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1224 |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1225 @table @asis |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1226 @item @var{window} |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1227 This is the window whose scroll-bar was clicked on. |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1228 |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1229 @item @var{area} |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1230 This is the scroll bar where the click occurred. It is one of the |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1231 symbols @code{vertical-scroll-bar} or @code{horizontal-scroll-bar}. |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1232 |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1233 @item @var{portion} |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1234 This is the distance of the click from the top or left end of |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1235 the scroll bar. |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1236 |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1237 @item @var{whole} |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1238 This is the length of the entire scroll bar. |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1239 |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1240 @item @var{timestamp} |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1241 This is the time at which the event occurred, in milliseconds. |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1242 |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1243 @item @var{part} |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1244 This is the part of the scroll-bar which was clicked on. It is one |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1245 of the symbols @code{above-handle}, @code{handle}, @code{below-handle}, |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1246 @code{up}, @code{down}, @code{top}, @code{bottom}, and @code{end-scroll}. |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1247 @end table |
6260 | 1248 |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
1249 In one special case, @var{buffer-pos} is a list containing a symbol (one |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
1250 of the symbols listed above) instead of just the symbol. This happens |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
1251 after the imaginary prefix keys for the event are inserted into the |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
1252 input stream. @xref{Key Sequence Input}. |
6260 | 1253 |
1254 @node Drag Events | |
1255 @subsection Drag Events | |
1256 @cindex drag event | |
1257 @cindex mouse drag event | |
1258 | |
1259 With Emacs, you can have a drag event without even changing your | |
1260 clothes. A @dfn{drag event} happens every time the user presses a mouse | |
1261 button and then moves the mouse to a different character position before | |
1262 releasing the button. Like all mouse events, drag events are | |
1263 represented in Lisp as lists. The lists record both the starting mouse | |
1264 position and the final position, like this: | |
1265 | |
1266 @example | |
1267 (@var{event-type} | |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1268 (@var{window1} @var{buffer-pos1} (@var{x1} . @var{y1}) @var{timestamp1}) |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1269 (@var{window2} @var{buffer-pos2} (@var{x2} . @var{y2}) @var{timestamp2}) |
6260 | 1270 @var{click-count}) |
1271 @end example | |
1272 | |
1273 For a drag event, the name of the symbol @var{event-type} contains the | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1274 prefix @samp{drag-}. For example, dragging the mouse with button 2 held |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1275 down generates a @code{drag-mouse-2} event. The second and third |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1276 elements of the event give the starting and ending position of the drag. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1277 Aside from that, the data have the same meanings as in a click event |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1278 (@pxref{Click Events}). You can access the second element of any mouse |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1279 event in the same way, with no need to distinguish drag events from |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1280 others. |
6260 | 1281 |
1282 The @samp{drag-} prefix follows the modifier key prefixes such as | |
1283 @samp{C-} and @samp{M-}. | |
1284 | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
1285 If @code{read-key-sequence} receives a drag event that has no key |
6260 | 1286 binding, and the corresponding click event does have a binding, it |
1287 changes the drag event into a click event at the drag's starting | |
1288 position. This means that you don't have to distinguish between click | |
1289 and drag events unless you want to. | |
1290 | |
1291 @node Button-Down Events | |
1292 @subsection Button-Down Events | |
1293 @cindex button-down event | |
1294 | |
1295 Click and drag events happen when the user releases a mouse button. | |
1296 They cannot happen earlier, because there is no way to distinguish a | |
1297 click from a drag until the button is released. | |
1298 | |
1299 If you want to take action as soon as a button is pressed, you need to | |
1300 handle @dfn{button-down} events.@footnote{Button-down is the | |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1301 conservative antithesis of drag.} These occur as soon as a button is |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
1302 pressed. They are represented by lists that look exactly like click |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1303 events (@pxref{Click Events}), except that the @var{event-type} symbol |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1304 name contains the prefix @samp{down-}. The @samp{down-} prefix follows |
6260 | 1305 modifier key prefixes such as @samp{C-} and @samp{M-}. |
1306 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1307 The function @code{read-key-sequence} ignores any button-down events |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1308 that don't have command bindings; therefore, the Emacs command loop |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1309 ignores them too. This means that you need not worry about defining |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1310 button-down events unless you want them to do something. The usual |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1311 reason to define a button-down event is so that you can track mouse |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1312 motion (by reading motion events) until the button is released. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1313 @xref{Motion Events}. |
6260 | 1314 |
1315 @node Repeat Events | |
1316 @subsection Repeat Events | |
1317 @cindex repeat events | |
1318 @cindex double-click events | |
1319 @cindex triple-click events | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
1320 @cindex mouse events, repeated |
6260 | 1321 |
1322 If you press the same mouse button more than once in quick succession | |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1323 without moving the mouse, Emacs generates special @dfn{repeat} mouse |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1324 events for the second and subsequent presses. |
6260 | 1325 |
1326 The most common repeat events are @dfn{double-click} events. Emacs | |
1327 generates a double-click event when you click a button twice; the event | |
1328 happens when you release the button (as is normal for all click | |
1329 events). | |
1330 | |
1331 The event type of a double-click event contains the prefix | |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1332 @samp{double-}. Thus, a double click on the second mouse button with |
6260 | 1333 @key{meta} held down comes to the Lisp program as |
1334 @code{M-double-mouse-2}. If a double-click event has no binding, the | |
1335 binding of the corresponding ordinary click event is used to execute | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48731
diff
changeset
|
1336 it. Thus, you need not pay attention to the double click feature |
6260 | 1337 unless you really want to. |
1338 | |
1339 When the user performs a double click, Emacs generates first an ordinary | |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1340 click event, and then a double-click event. Therefore, you must design |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1341 the command binding of the double click event to assume that the |
6260 | 1342 single-click command has already run. It must produce the desired |
1343 results of a double click, starting from the results of a single click. | |
1344 | |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1345 This is convenient, if the meaning of a double click somehow ``builds |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1346 on'' the meaning of a single click---which is recommended user interface |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1347 design practice for double clicks. |
6260 | 1348 |
1349 If you click a button, then press it down again and start moving the | |
1350 mouse with the button held down, then you get a @dfn{double-drag} event | |
1351 when you ultimately release the button. Its event type contains | |
1352 @samp{double-drag} instead of just @samp{drag}. If a double-drag event | |
1353 has no binding, Emacs looks for an alternate binding as if the event | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
1354 were an ordinary drag. |
6260 | 1355 |
1356 Before the double-click or double-drag event, Emacs generates a | |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1357 @dfn{double-down} event when the user presses the button down for the |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1358 second time. Its event type contains @samp{double-down} instead of just |
6260 | 1359 @samp{down}. If a double-down event has no binding, Emacs looks for an |
1360 alternate binding as if the event were an ordinary button-down event. | |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1361 If it finds no binding that way either, the double-down event is |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1362 ignored. |
6260 | 1363 |
1364 To summarize, when you click a button and then press it again right | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
1365 away, Emacs generates a down event and a click event for the first |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
1366 click, a double-down event when you press the button again, and finally |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
1367 either a double-click or a double-drag event. |
6260 | 1368 |
1369 If you click a button twice and then press it again, all in quick | |
1370 succession, Emacs generates a @dfn{triple-down} event, followed by | |
1371 either a @dfn{triple-click} or a @dfn{triple-drag}. The event types of | |
1372 these events contain @samp{triple} instead of @samp{double}. If any | |
1373 triple event has no binding, Emacs uses the binding that it would use | |
1374 for the corresponding double event. | |
1375 | |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1376 If you click a button three or more times and then press it again, the |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1377 events for the presses beyond the third are all triple events. Emacs |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1378 does not have separate event types for quadruple, quintuple, etc.@: |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1379 events. However, you can look at the event list to find out precisely |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1380 how many times the button was pressed. |
6260 | 1381 |
1382 @defun event-click-count event | |
1383 This function returns the number of consecutive button presses that led | |
1384 up to @var{event}. If @var{event} is a double-down, double-click or | |
1385 double-drag event, the value is 2. If @var{event} is a triple event, | |
1386 the value is 3 or greater. If @var{event} is an ordinary mouse event | |
1387 (not a repeat event), the value is 1. | |
1388 @end defun | |
1389 | |
38603
13029a808e20
(Repeat Events): Add description of double-click-fuzz.
Gerd Moellmann <gerd@gnu.org>
parents:
27301
diff
changeset
|
1390 @defvar double-click-fuzz |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1391 To generate repeat events, successive mouse button presses must be at |
38603
13029a808e20
(Repeat Events): Add description of double-click-fuzz.
Gerd Moellmann <gerd@gnu.org>
parents:
27301
diff
changeset
|
1392 approximately the same screen position. The value of |
13029a808e20
(Repeat Events): Add description of double-click-fuzz.
Gerd Moellmann <gerd@gnu.org>
parents:
27301
diff
changeset
|
1393 @code{double-click-fuzz} specifies the maximum number of pixels the |
13029a808e20
(Repeat Events): Add description of double-click-fuzz.
Gerd Moellmann <gerd@gnu.org>
parents:
27301
diff
changeset
|
1394 mouse may be moved between two successive clicks to make a |
13029a808e20
(Repeat Events): Add description of double-click-fuzz.
Gerd Moellmann <gerd@gnu.org>
parents:
27301
diff
changeset
|
1395 double-click. |
13029a808e20
(Repeat Events): Add description of double-click-fuzz.
Gerd Moellmann <gerd@gnu.org>
parents:
27301
diff
changeset
|
1396 @end defvar |
13029a808e20
(Repeat Events): Add description of double-click-fuzz.
Gerd Moellmann <gerd@gnu.org>
parents:
27301
diff
changeset
|
1397 |
13029a808e20
(Repeat Events): Add description of double-click-fuzz.
Gerd Moellmann <gerd@gnu.org>
parents:
27301
diff
changeset
|
1398 @defvar double-click-time |
13029a808e20
(Repeat Events): Add description of double-click-fuzz.
Gerd Moellmann <gerd@gnu.org>
parents:
27301
diff
changeset
|
1399 To generate repeat events, the number of milliseconds between |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1400 successive button presses must be less than the value of |
6260 | 1401 @code{double-click-time}. Setting @code{double-click-time} to |
1402 @code{nil} disables multi-click detection entirely. Setting it to | |
1403 @code{t} removes the time limit; Emacs then detects multi-clicks by | |
1404 position only. | |
1405 @end defvar | |
1406 | |
1407 @node Motion Events | |
1408 @subsection Motion Events | |
1409 @cindex motion event | |
1410 @cindex mouse motion events | |
1411 | |
1412 Emacs sometimes generates @dfn{mouse motion} events to describe motion | |
1413 of the mouse without any button activity. Mouse motion events are | |
1414 represented by lists that look like this: | |
1415 | |
1416 @example | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1417 (mouse-movement (@var{window} @var{buffer-pos} (@var{x} . @var{y}) @var{timestamp})) |
6260 | 1418 @end example |
1419 | |
1420 The second element of the list describes the current position of the | |
1421 mouse, just as in a click event (@pxref{Click Events}). | |
1422 | |
1423 The special form @code{track-mouse} enables generation of motion events | |
1424 within its body. Outside of @code{track-mouse} forms, Emacs does not | |
1425 generate events for mere motion of the mouse, and these events do not | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1426 appear. @xref{Mouse Tracking}. |
6260 | 1427 |
1428 @node Focus Events | |
1429 @subsection Focus Events | |
1430 @cindex focus event | |
1431 | |
1432 Window systems provide general ways for the user to control which window | |
1433 gets keyboard input. This choice of window is called the @dfn{focus}. | |
1434 When the user does something to switch between Emacs frames, that | |
1435 generates a @dfn{focus event}. The normal definition of a focus event, | |
1436 in the global keymap, is to select a new frame within Emacs, as the user | |
1437 would expect. @xref{Input Focus}. | |
1438 | |
1439 Focus events are represented in Lisp as lists that look like this: | |
1440 | |
1441 @example | |
1442 (switch-frame @var{new-frame}) | |
1443 @end example | |
1444 | |
1445 @noindent | |
1446 where @var{new-frame} is the frame switched to. | |
1447 | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
1448 Most X window managers are set up so that just moving the mouse into a |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
1449 window is enough to set the focus there. Emacs appears to do this, |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
1450 because it changes the cursor to solid in the new frame. However, there |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
1451 is no need for the Lisp program to know about the focus change until |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
1452 some other kind of input arrives. So Emacs generates a focus event only |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
1453 when the user actually types a keyboard key or presses a mouse button in |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
1454 the new frame; just moving the mouse between frames does not generate a |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
1455 focus event. |
6260 | 1456 |
1457 A focus event in the middle of a key sequence would garble the | |
1458 sequence. So Emacs never generates a focus event in the middle of a key | |
1459 sequence. If the user changes focus in the middle of a key | |
1460 sequence---that is, after a prefix key---then Emacs reorders the events | |
1461 so that the focus event comes either before or after the multi-event key | |
1462 sequence, and not within it. | |
1463 | |
12067 | 1464 @node Misc Events |
1465 @subsection Miscellaneous Window System Events | |
1466 | |
1467 A few other event types represent occurrences within the window system. | |
1468 | |
1469 @table @code | |
1470 @cindex @code{delete-frame} event | |
1471 @item (delete-frame (@var{frame})) | |
1472 This kind of event indicates that the user gave the window manager | |
1473 a command to delete a particular window, which happens to be an Emacs frame. | |
1474 | |
1475 The standard definition of the @code{delete-frame} event is to delete @var{frame}. | |
1476 | |
1477 @cindex @code{iconify-frame} event | |
1478 @item (iconify-frame (@var{frame})) | |
1479 This kind of event indicates that the user iconified @var{frame} using | |
13007 | 1480 the window manager. Its standard definition is @code{ignore}; since the |
1481 frame has already been iconified, Emacs has no work to do. The purpose | |
1482 of this event type is so that you can keep track of such events if you | |
1483 want to. | |
12067 | 1484 |
12285
1aad1cc93e3f
make-frame-visible event was misdescribed as deiconify-frame.
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
1485 @cindex @code{make-frame-visible} event |
1aad1cc93e3f
make-frame-visible event was misdescribed as deiconify-frame.
Richard M. Stallman <rms@gnu.org>
parents:
12282
diff
changeset
|
1486 @item (make-frame-visible (@var{frame})) |
12067 | 1487 This kind of event indicates that the user deiconified @var{frame} using |
1488 the window manager. Its standard definition is @code{ignore}; since the | |
13007 | 1489 frame has already been made visible, Emacs has no work to do. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1490 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1491 @cindex @code{mouse-wheel} event |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1492 @item (mouse-wheel @var{position} @var{delta}) |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1493 This kind of event is generated by moving a wheel on a mouse (such as |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1494 the MS Intellimouse). Its effect is typically a kind of scroll or zoom. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1495 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1496 The element @var{delta} describes the amount and direction of the wheel |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1497 rotation. Its absolute value is the number of increments by which the |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1498 wheel was rotated. A negative @var{delta} indicates that the wheel was |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1499 rotated backwards, towards the user, and a positive @var{delta} |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1500 indicates that the wheel was rotated forward, away from the user. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1501 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1502 The element @var{position} is a list describing the position of the |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1503 event, in the same format as used in a mouse-click event. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1504 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1505 This kind of event is generated only on some kinds of systems. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1506 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1507 @cindex @code{drag-n-drop} event |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1508 @item (drag-n-drop @var{position} @var{files}) |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1509 This kind of event is generated when a group of files is |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1510 selected in an application outside of Emacs, and then dragged and |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1511 dropped onto an Emacs frame. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1512 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1513 The element @var{position} is a list describing the position of the |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1514 event, in the same format as used in a mouse-click event, and |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1515 @var{files} is the list of file names that were dragged and dropped. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1516 The usual way to handle this event is by visiting these files. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1517 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1518 This kind of event is generated, at present, only on some kinds of |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1519 systems. |
12067 | 1520 @end table |
1521 | |
12098 | 1522 If one of these events arrives in the middle of a key sequence---that |
1523 is, after a prefix key---then Emacs reorders the events so that this | |
1524 event comes either before or after the multi-event key sequence, not | |
1525 within it. | |
1526 | |
6260 | 1527 @node Event Examples |
1528 @subsection Event Examples | |
1529 | |
1530 If the user presses and releases the left mouse button over the same | |
1531 location, that generates a sequence of events like this: | |
1532 | |
1533 @smallexample | |
1534 (down-mouse-1 (#<window 18 on NEWS> 2613 (0 . 38) -864320)) | |
1535 (mouse-1 (#<window 18 on NEWS> 2613 (0 . 38) -864180)) | |
1536 @end smallexample | |
1537 | |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1538 While holding the control key down, the user might hold down the |
6260 | 1539 second mouse button, and drag the mouse from one line to the next. |
1540 That produces two events, as shown here: | |
1541 | |
1542 @smallexample | |
1543 (C-down-mouse-2 (#<window 18 on NEWS> 3440 (0 . 27) -731219)) | |
1544 (C-drag-mouse-2 (#<window 18 on NEWS> 3440 (0 . 27) -731219) | |
1545 (#<window 18 on NEWS> 3510 (0 . 28) -729648)) | |
1546 @end smallexample | |
1547 | |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1548 While holding down the meta and shift keys, the user might press the |
6260 | 1549 second mouse button on the window's mode line, and then drag the mouse |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1550 into another window. That produces a pair of events like these: |
6260 | 1551 |
1552 @smallexample | |
1553 (M-S-down-mouse-2 (#<window 18 on NEWS> mode-line (33 . 31) -457844)) | |
1554 (M-S-drag-mouse-2 (#<window 18 on NEWS> mode-line (33 . 31) -457844) | |
1555 (#<window 20 on carlton-sanskrit.tex> 161 (33 . 3) | |
1556 -453816)) | |
1557 @end smallexample | |
1558 | |
1559 @node Classifying Events | |
1560 @subsection Classifying Events | |
1561 @cindex event type | |
1562 | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
1563 Every event has an @dfn{event type}, which classifies the event for |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
1564 key binding purposes. For a keyboard event, the event type equals the |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
1565 event value; thus, the event type for a character is the character, and |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
1566 the event type for a function key symbol is the symbol itself. For |
53297
4c4e0f5356bf
Replace all occurrences of @acronym{CAR} with @sc{car}, for
Luc Teirlinck <teirllm@auburn.edu>
parents:
53183
diff
changeset
|
1567 events that are lists, the event type is the symbol in the @sc{car} of |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
1568 the list. Thus, the event type is always a symbol or a character. |
6260 | 1569 |
1570 Two events of the same type are equivalent where key bindings are | |
1571 concerned; thus, they always run the same command. That does not | |
1572 necessarily mean they do the same things, however, as some commands look | |
1573 at the whole event to decide what to do. For example, some commands use | |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1574 the location of a mouse event to decide where in the buffer to act. |
6260 | 1575 |
1576 Sometimes broader classifications of events are useful. For example, | |
1577 you might want to ask whether an event involved the @key{META} key, | |
1578 regardless of which other key or mouse button was used. | |
1579 | |
1580 The functions @code{event-modifiers} and @code{event-basic-type} are | |
1581 provided to get such information conveniently. | |
1582 | |
1583 @defun event-modifiers event | |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1584 This function returns a list of the modifiers that @var{event} has. The |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1585 modifiers are symbols; they include @code{shift}, @code{control}, |
6260 | 1586 @code{meta}, @code{alt}, @code{hyper} and @code{super}. In addition, |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1587 the modifiers list of a mouse event symbol always contains one of |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1588 @code{click}, @code{drag}, and @code{down}. |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1589 |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1590 The argument @var{event} may be an entire event object, or just an event |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1591 type. |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1592 |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1593 Here are some examples: |
6260 | 1594 |
1595 @example | |
1596 (event-modifiers ?a) | |
1597 @result{} nil | |
1598 (event-modifiers ?\C-a) | |
1599 @result{} (control) | |
1600 (event-modifiers ?\C-%) | |
1601 @result{} (control) | |
1602 (event-modifiers ?\C-\S-a) | |
1603 @result{} (control shift) | |
1604 (event-modifiers 'f5) | |
1605 @result{} nil | |
1606 (event-modifiers 's-f5) | |
1607 @result{} (super) | |
1608 (event-modifiers 'M-S-f5) | |
1609 @result{} (meta shift) | |
1610 (event-modifiers 'mouse-1) | |
1611 @result{} (click) | |
1612 (event-modifiers 'down-mouse-1) | |
1613 @result{} (down) | |
1614 @end example | |
1615 | |
1616 The modifiers list for a click event explicitly contains @code{click}, | |
1617 but the event symbol name itself does not contain @samp{click}. | |
1618 @end defun | |
1619 | |
1620 @defun event-basic-type event | |
1621 This function returns the key or mouse button that @var{event} | |
1622 describes, with all modifiers removed. For example: | |
1623 | |
1624 @example | |
1625 (event-basic-type ?a) | |
1626 @result{} 97 | |
1627 (event-basic-type ?A) | |
1628 @result{} 97 | |
1629 (event-basic-type ?\C-a) | |
1630 @result{} 97 | |
1631 (event-basic-type ?\C-\S-a) | |
1632 @result{} 97 | |
1633 (event-basic-type 'f5) | |
1634 @result{} f5 | |
1635 (event-basic-type 's-f5) | |
1636 @result{} f5 | |
1637 (event-basic-type 'M-S-f5) | |
1638 @result{} f5 | |
1639 (event-basic-type 'down-mouse-1) | |
1640 @result{} mouse-1 | |
1641 @end example | |
1642 @end defun | |
1643 | |
1644 @defun mouse-movement-p object | |
1645 This function returns non-@code{nil} if @var{object} is a mouse movement | |
1646 event. | |
1647 @end defun | |
1648 | |
12098 | 1649 @defun event-convert-list list |
1650 This function converts a list of modifier names and a basic event type | |
1651 to an event type which specifies all of them. For example, | |
1652 | |
1653 @example | |
1654 (event-convert-list '(control ?a)) | |
1655 @result{} 1 | |
1656 (event-convert-list '(control meta ?a)) | |
1657 @result{} -134217727 | |
1658 (event-convert-list '(control super f1)) | |
1659 @result{} C-s-f1 | |
1660 @end example | |
1661 @end defun | |
1662 | |
6260 | 1663 @node Accessing Events |
1664 @subsection Accessing Events | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
1665 @cindex mouse events, accessing the data |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
1666 @cindex accessing data of mouse events |
6260 | 1667 |
1668 This section describes convenient functions for accessing the data in | |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1669 a mouse button or motion event. |
6260 | 1670 |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1671 These two functions return the starting or ending position of a |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1672 mouse-button event, as a list of this form: |
6260 | 1673 |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1674 @example |
53183
61e2da7a49f4
(Click Events): Click object may be an images.
Kim F. Storm <storm@cua.dk>
parents:
53136
diff
changeset
|
1675 (@var{window} @var{pos-or-area} (@var{x} . @var{y}) @var{timestamp} |
53519
ad9b61a60774
(Click Events): Describe new image and
Kim F. Storm <storm@cua.dk>
parents:
53303
diff
changeset
|
1676 @var{object} @var{text-pos} (@var{col} . @var{row}) |
ad9b61a60774
(Click Events): Describe new image and
Kim F. Storm <storm@cua.dk>
parents:
53303
diff
changeset
|
1677 @var{image} (@var{dx} . @var{dy}) (@var{width} . @var{height})) |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1678 @end example |
6260 | 1679 |
1680 @defun event-start event | |
1681 This returns the starting position of @var{event}. | |
1682 | |
1683 If @var{event} is a click or button-down event, this returns the | |
1684 location of the event. If @var{event} is a drag event, this returns the | |
1685 drag's starting position. | |
1686 @end defun | |
1687 | |
1688 @defun event-end event | |
1689 This returns the ending position of @var{event}. | |
1690 | |
1691 If @var{event} is a drag event, this returns the position where the user | |
1692 released the mouse button. If @var{event} is a click or button-down | |
1693 event, the value is actually the starting position, which is the only | |
1694 position such events have. | |
1695 @end defun | |
1696 | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
1697 @cindex mouse position list, accessing |
53136
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1698 These seven functions take a position list as described above, and |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1699 return various parts of it. |
6260 | 1700 |
1701 @defun posn-window position | |
1702 Return the window that @var{position} is in. | |
1703 @end defun | |
1704 | |
53136
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1705 @defun posn-area position |
53183
61e2da7a49f4
(Click Events): Click object may be an images.
Kim F. Storm <storm@cua.dk>
parents:
53136
diff
changeset
|
1706 Return the window area recorded in @var{position}. It returns @code{nil} |
53136
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1707 when the event occurred in the text area of the window; otherwise, it |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1708 is a symbol identifying the area in which the the event occurred. |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1709 @end defun |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1710 |
6260 | 1711 @defun posn-point position |
53136
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1712 Return the buffer position in @var{position}. When the event occurred |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1713 in the text area of the window, in a marginal area, or on a fringe, |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1714 this is an integer specifying a buffer position. Otherwise, the value |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1715 is undefined. |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1716 @end defun |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1717 |
6260 | 1718 @defun posn-x-y position |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
1719 Return the pixel-based x and y coordinates in @var{position}, as a cons |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
1720 cell @code{(@var{x} . @var{y})}. |
6260 | 1721 @end defun |
1722 | |
1723 @defun posn-col-row position | |
53136
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1724 Return the row and column (in units of frame default characters) of |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1725 @var{position}, as a cons cell @code{(@var{col} . @var{row})}. These |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1726 are computed from the @var{x} and @var{y} values actually found in |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1727 @var{position}. |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1728 @end defun |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1729 |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1730 @defun posn-actual-col-row position |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1731 Return the actual row and column in @var{position}, as a cons cell |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1732 @code{(@var{col} . @var{row})}. The values are the actual row number |
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1733 in the window, and the actual character number in that row. Return |
53183
61e2da7a49f4
(Click Events): Click object may be an images.
Kim F. Storm <storm@cua.dk>
parents:
53136
diff
changeset
|
1734 @code{nil} if @var{position} does not include the actual positions; in that |
53136
fb4a34f4191c
(Click Events): Describe enhancements to event
Kim F. Storm <storm@cua.dk>
parents:
52978
diff
changeset
|
1735 case, @code{posn-col-row} can be used to get approximate values. |
6260 | 1736 @end defun |
1737 | |
53519
ad9b61a60774
(Click Events): Describe new image and
Kim F. Storm <storm@cua.dk>
parents:
53303
diff
changeset
|
1738 @defun posn-string position |
ad9b61a60774
(Click Events): Describe new image and
Kim F. Storm <storm@cua.dk>
parents:
53303
diff
changeset
|
1739 Return the string object in @var{position}, either @code{nil}, or a |
ad9b61a60774
(Click Events): Describe new image and
Kim F. Storm <storm@cua.dk>
parents:
53303
diff
changeset
|
1740 cons cell @code{(@var{string} . @var{string-pos})}. |
ad9b61a60774
(Click Events): Describe new image and
Kim F. Storm <storm@cua.dk>
parents:
53303
diff
changeset
|
1741 @end defun |
ad9b61a60774
(Click Events): Describe new image and
Kim F. Storm <storm@cua.dk>
parents:
53303
diff
changeset
|
1742 |
ad9b61a60774
(Click Events): Describe new image and
Kim F. Storm <storm@cua.dk>
parents:
53303
diff
changeset
|
1743 @defun posn-image position |
ad9b61a60774
(Click Events): Describe new image and
Kim F. Storm <storm@cua.dk>
parents:
53303
diff
changeset
|
1744 Return the image object in @var{position}, either @code{nil}, or an |
ad9b61a60774
(Click Events): Describe new image and
Kim F. Storm <storm@cua.dk>
parents:
53303
diff
changeset
|
1745 image @code{(image ...)}. |
ad9b61a60774
(Click Events): Describe new image and
Kim F. Storm <storm@cua.dk>
parents:
53303
diff
changeset
|
1746 @end defun |
ad9b61a60774
(Click Events): Describe new image and
Kim F. Storm <storm@cua.dk>
parents:
53303
diff
changeset
|
1747 |
53183
61e2da7a49f4
(Click Events): Click object may be an images.
Kim F. Storm <storm@cua.dk>
parents:
53136
diff
changeset
|
1748 @defun posn-object position |
53519
ad9b61a60774
(Click Events): Describe new image and
Kim F. Storm <storm@cua.dk>
parents:
53303
diff
changeset
|
1749 Return the image or string object in @var{position}, either |
ad9b61a60774
(Click Events): Describe new image and
Kim F. Storm <storm@cua.dk>
parents:
53303
diff
changeset
|
1750 @code{nil}, an image @code{(image ...)}, or a cons cell |
ad9b61a60774
(Click Events): Describe new image and
Kim F. Storm <storm@cua.dk>
parents:
53303
diff
changeset
|
1751 @code{(@var{string} . @var{string-pos})}. |
53183
61e2da7a49f4
(Click Events): Click object may be an images.
Kim F. Storm <storm@cua.dk>
parents:
53136
diff
changeset
|
1752 @end defun |
61e2da7a49f4
(Click Events): Click object may be an images.
Kim F. Storm <storm@cua.dk>
parents:
53136
diff
changeset
|
1753 |
61e2da7a49f4
(Click Events): Click object may be an images.
Kim F. Storm <storm@cua.dk>
parents:
53136
diff
changeset
|
1754 @defun posn-object-x-y position |
61e2da7a49f4
(Click Events): Click object may be an images.
Kim F. Storm <storm@cua.dk>
parents:
53136
diff
changeset
|
1755 Return the pixel-based x and y coordinates relative to the upper left |
53519
ad9b61a60774
(Click Events): Describe new image and
Kim F. Storm <storm@cua.dk>
parents:
53303
diff
changeset
|
1756 corner of the object in @var{position} as a cons cell @code{(@var{dx} |
ad9b61a60774
(Click Events): Describe new image and
Kim F. Storm <storm@cua.dk>
parents:
53303
diff
changeset
|
1757 . @var{dy})}. If the @var{position} is a buffer position, return the |
ad9b61a60774
(Click Events): Describe new image and
Kim F. Storm <storm@cua.dk>
parents:
53303
diff
changeset
|
1758 relative position in the character at that position. |
ad9b61a60774
(Click Events): Describe new image and
Kim F. Storm <storm@cua.dk>
parents:
53303
diff
changeset
|
1759 @end defun |
ad9b61a60774
(Click Events): Describe new image and
Kim F. Storm <storm@cua.dk>
parents:
53303
diff
changeset
|
1760 |
ad9b61a60774
(Click Events): Describe new image and
Kim F. Storm <storm@cua.dk>
parents:
53303
diff
changeset
|
1761 @defun posn-object-width-height position |
ad9b61a60774
(Click Events): Describe new image and
Kim F. Storm <storm@cua.dk>
parents:
53303
diff
changeset
|
1762 Return the pixel width and height of the object in @var{position} as a |
ad9b61a60774
(Click Events): Describe new image and
Kim F. Storm <storm@cua.dk>
parents:
53303
diff
changeset
|
1763 cons cell @code{(@var{width} . @var{height})}. If the @var{position} |
ad9b61a60774
(Click Events): Describe new image and
Kim F. Storm <storm@cua.dk>
parents:
53303
diff
changeset
|
1764 is a buffer position, return the size of the character at that position. |
53183
61e2da7a49f4
(Click Events): Click object may be an images.
Kim F. Storm <storm@cua.dk>
parents:
53136
diff
changeset
|
1765 @end defun |
61e2da7a49f4
(Click Events): Click object may be an images.
Kim F. Storm <storm@cua.dk>
parents:
53136
diff
changeset
|
1766 |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
1767 @cindex mouse event, timestamp |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
1768 @cindex timestamp of a mouse event |
53183
61e2da7a49f4
(Click Events): Click object may be an images.
Kim F. Storm <storm@cua.dk>
parents:
53136
diff
changeset
|
1769 @defun posn-timestamp |
61e2da7a49f4
(Click Events): Click object may be an images.
Kim F. Storm <storm@cua.dk>
parents:
53136
diff
changeset
|
1770 Return the timestamp in @var{position}. This is the time at which the |
61e2da7a49f4
(Click Events): Click object may be an images.
Kim F. Storm <storm@cua.dk>
parents:
53136
diff
changeset
|
1771 event occurred, in milliseconds. |
6260 | 1772 @end defun |
1773 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1774 These functions are useful for decoding scroll bar events. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1775 |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
1776 @defun scroll-bar-event-ratio event |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
1777 This function returns the fractional vertical position of a scroll bar |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
1778 event within the scroll bar. The value is a cons cell |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
1779 @code{(@var{portion} . @var{whole})} containing two integers whose ratio |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
1780 is the fractional position. |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
1781 @end defun |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
1782 |
6260 | 1783 @defun scroll-bar-scale ratio total |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
1784 This function multiplies (in effect) @var{ratio} by @var{total}, |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
1785 rounding the result to an integer. The argument @var{ratio} is not a |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
1786 number, but rather a pair @code{(@var{num} . @var{denom})}---typically a |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
1787 value returned by @code{scroll-bar-event-ratio}. |
6260 | 1788 |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1789 This function is handy for scaling a position on a scroll bar into a |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1790 buffer position. Here's how to do that: |
6260 | 1791 |
1792 @example | |
1793 (+ (point-min) | |
1794 (scroll-bar-scale | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
1795 (posn-x-y (event-start event)) |
6260 | 1796 (- (point-max) (point-min)))) |
1797 @end example | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
1798 |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1799 Recall that scroll bar events have two integers forming a ratio, in place |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
1800 of a pair of x and y coordinates. |
6260 | 1801 @end defun |
1802 | |
1803 @node Strings of Events | |
1804 @subsection Putting Keyboard Events in Strings | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
1805 @cindex keyboard events in strings |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
1806 @cindex strings with keyboard events |
6260 | 1807 |
1808 In most of the places where strings are used, we conceptualize the | |
1809 string as containing text characters---the same kind of characters found | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
1810 in buffers or files. Occasionally Lisp programs use strings that |
6260 | 1811 conceptually contain keyboard characters; for example, they may be key |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1812 sequences or keyboard macro definitions. However, storing keyboard |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1813 characters in a string is a complex matter, for reasons of historical |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1814 compatibility, and it is not always possible. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1815 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1816 We recommend that new programs avoid dealing with these complexities |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1817 by not storing keyboard events in strings. Here is how to do that: |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1818 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1819 @itemize @bullet |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1820 @item |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1821 Use vectors instead of strings for key sequences, when you plan to use |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1822 them for anything other than as arguments to @code{lookup-key} and |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1823 @code{define-key}. For example, you can use |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1824 @code{read-key-sequence-vector} instead of @code{read-key-sequence}, and |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1825 @code{this-command-keys-vector} instead of @code{this-command-keys}. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1826 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1827 @item |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1828 Use vectors to write key sequence constants containing meta characters, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1829 even when passing them directly to @code{define-key}. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1830 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1831 @item |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1832 When you have to look at the contents of a key sequence that might be a |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1833 string, use @code{listify-key-sequence} (@pxref{Event Input Misc}) |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1834 first, to convert it to a list. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1835 @end itemize |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1836 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1837 The complexities stem from the modifier bits that keyboard input |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1838 characters can include. Aside from the Meta modifier, none of these |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1839 modifier bits can be included in a string, and the Meta modifier is |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1840 allowed only in special cases. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1841 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1842 The earliest GNU Emacs versions represented meta characters as codes |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1843 in the range of 128 to 255. At that time, the basic character codes |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1844 ranged from 0 to 127, so all keyboard character codes did fit in a |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1845 string. Many Lisp programs used @samp{\M-} in string constants to stand |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1846 for meta characters, especially in arguments to @code{define-key} and |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1847 similar functions, and key sequences and sequences of events were always |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1848 represented as strings. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1849 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1850 When we added support for larger basic character codes beyond 127, and |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1851 additional modifier bits, we had to change the representation of meta |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1852 characters. Now the flag that represents the Meta modifier in a |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1853 character is |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1854 @tex |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1855 @math{2^{27}} |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1856 @end tex |
27193 | 1857 @ifnottex |
12098 | 1858 2**27 |
27193 | 1859 @end ifnottex |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1860 and such numbers cannot be included in a string. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1861 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1862 To support programs with @samp{\M-} in string constants, there are |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1863 special rules for including certain meta characters in a string. |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1864 Here are the rules for interpreting a string as a sequence of input |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1865 characters: |
6260 | 1866 |
1867 @itemize @bullet | |
1868 @item | |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1869 If the keyboard character value is in the range of 0 to 127, it can go |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1870 in the string unchanged. |
6260 | 1871 |
1872 @item | |
12098 | 1873 The meta variants of those characters, with codes in the range of |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1874 @tex |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1875 @math{2^{27}} |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1876 @end tex |
27193 | 1877 @ifnottex |
12098 | 1878 2**27 |
27193 | 1879 @end ifnottex |
12098 | 1880 to |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1881 @tex |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1882 @math{2^{27} + 127}, |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1883 @end tex |
27193 | 1884 @ifnottex |
12098 | 1885 2**27+127, |
27193 | 1886 @end ifnottex |
12098 | 1887 can also go in the string, but you must change their |
1888 numeric values. You must set the | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1889 @tex |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1890 @math{2^{7}} |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1891 @end tex |
27193 | 1892 @ifnottex |
12098 | 1893 2**7 |
27193 | 1894 @end ifnottex |
12098 | 1895 bit instead of the |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1896 @tex |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
1897 @math{2^{27}} |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1898 @end tex |
27193 | 1899 @ifnottex |
12098 | 1900 2**27 |
27193 | 1901 @end ifnottex |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1902 bit, resulting in a value between 128 and 255. Only a unibyte string |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1903 can include these codes. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1904 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1905 @item |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52626
diff
changeset
|
1906 Non-@acronym{ASCII} characters above 256 can be included in a multibyte string. |
6260 | 1907 |
1908 @item | |
1909 Other keyboard character events cannot fit in a string. This includes | |
1910 keyboard events in the range of 128 to 255. | |
1911 @end itemize | |
1912 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1913 Functions such as @code{read-key-sequence} that construct strings of |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1914 keyboard input characters follow these rules: they construct vectors |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1915 instead of strings, when the events won't fit in a string. |
6260 | 1916 |
1917 When you use the read syntax @samp{\M-} in a string, it produces a | |
1918 code in the range of 128 to 255---the same code that you get if you | |
1919 modify the corresponding keyboard event to put it in the string. Thus, | |
1920 meta events in strings work consistently regardless of how they get into | |
1921 the strings. | |
1922 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1923 However, most programs would do well to avoid these issues by |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1924 following the recommendations at the beginning of this section. |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1925 |
6260 | 1926 @node Reading Input |
1927 @section Reading Input | |
1928 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1929 The editor command loop reads key sequences using the function |
6260 | 1930 @code{read-key-sequence}, which uses @code{read-event}. These and other |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1931 functions for event input are also available for use in Lisp programs. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1932 See also @code{momentary-string-display} in @ref{Temporary Displays}, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1933 and @code{sit-for} in @ref{Waiting}. @xref{Terminal Input}, for |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1934 functions and variables for controlling terminal input modes and |
15764 | 1935 debugging terminal input. @xref{Translating Input}, for features you |
1936 can use for translating or modifying input events while reading them. | |
6260 | 1937 |
1938 For higher-level input facilities, see @ref{Minibuffers}. | |
1939 | |
1940 @menu | |
1941 * Key Sequence Input:: How to read one key sequence. | |
1942 * Reading One Event:: How to read just one event. | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23110
diff
changeset
|
1943 * Invoking the Input Method:: How reading an event uses the input method. |
6260 | 1944 * Quoted Character Input:: Asking the user to specify a character. |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
1945 * Event Input Misc:: How to reread or throw away input events. |
6260 | 1946 @end menu |
1947 | |
1948 @node Key Sequence Input | |
1949 @subsection Key Sequence Input | |
1950 @cindex key sequence input | |
1951 | |
1952 The command loop reads input a key sequence at a time, by calling | |
1953 @code{read-key-sequence}. Lisp programs can also call this function; | |
1954 for example, @code{describe-key} uses it to read the key to describe. | |
1955 | |
1956 @defun read-key-sequence prompt | |
1957 @cindex key sequence | |
1958 This function reads a key sequence and returns it as a string or | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
1959 vector. It keeps reading events until it has accumulated a complete key |
6260 | 1960 sequence; that is, enough to specify a non-prefix command using the |
1961 currently active keymaps. | |
1962 | |
1963 If the events are all characters and all can fit in a string, then | |
1964 @code{read-key-sequence} returns a string (@pxref{Strings of Events}). | |
1965 Otherwise, it returns a vector, since a vector can hold all kinds of | |
1966 events---characters, symbols, and lists. The elements of the string or | |
1967 vector are the events in the key sequence. | |
1968 | |
1969 The argument @var{prompt} is either a string to be displayed in the echo | |
1970 area as a prompt, or @code{nil}, meaning not to display a prompt. | |
1971 | |
1972 In the example below, the prompt @samp{?} is displayed in the echo area, | |
1973 and the user types @kbd{C-x C-f}. | |
1974 | |
1975 @example | |
1976 (read-key-sequence "?") | |
1977 | |
1978 @group | |
1979 ---------- Echo Area ---------- | |
1980 ?@kbd{C-x C-f} | |
1981 ---------- Echo Area ---------- | |
1982 | |
1983 @result{} "^X^F" | |
1984 @end group | |
1985 @end example | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1986 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1987 The function @code{read-key-sequence} suppresses quitting: @kbd{C-g} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1988 typed while reading with this function works like any other character, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1989 and does not set @code{quit-flag}. @xref{Quitting}. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1990 @end defun |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1991 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1992 @defun read-key-sequence-vector prompt |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1993 This is like @code{read-key-sequence} except that it always |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1994 returns the key sequence as a vector, never as a string. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1995 @xref{Strings of Events}. |
6260 | 1996 @end defun |
1997 | |
1998 @cindex upper case key sequence | |
1999 @cindex downcasing in @code{lookup-key} | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
2000 If an input character is an upper-case letter and has no key binding, |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
2001 but its lower-case equivalent has one, then @code{read-key-sequence} |
6260 | 2002 converts the character to lower case. Note that @code{lookup-key} does |
2003 not perform case conversion in this way. | |
2004 | |
2005 The function @code{read-key-sequence} also transforms some mouse events. | |
2006 It converts unbound drag events into click events, and discards unbound | |
12098 | 2007 button-down events entirely. It also reshuffles focus events and |
2008 miscellaneous window events so that they never appear in a key sequence | |
2009 with any other events. | |
6260 | 2010 |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
2011 @cindex @code{header-line} prefix key |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
2012 @cindex @code{mode-line} prefix key |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
2013 @cindex @code{vertical-line} prefix key |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
2014 @cindex @code{horizontal-scroll-bar} prefix key |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
2015 @cindex @code{vertical-scroll-bar} prefix key |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
2016 @cindex @code{menu-bar} prefix key |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
2017 @cindex mouse events, in special parts of frame |
6260 | 2018 When mouse events occur in special parts of a window, such as a mode |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2019 line or a scroll bar, the event type shows nothing special---it is the |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2020 same symbol that would normally represent that combination of mouse |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2021 button and modifier keys. The information about the window part is kept |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2022 elsewhere in the event---in the coordinates. But |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2023 @code{read-key-sequence} translates this information into imaginary |
27301
8c79b30d8475
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
2024 ``prefix keys'', all of which are symbols: @code{header-line}, |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
2025 @code{horizontal-scroll-bar}, @code{menu-bar}, @code{mode-line}, |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
2026 @code{vertical-line}, and @code{vertical-scroll-bar}. You can define |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
2027 meanings for mouse clicks in special window parts by defining key |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
2028 sequences using these imaginary prefix keys. |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2029 |
6260 | 2030 For example, if you call @code{read-key-sequence} and then click the |
12098 | 2031 mouse on the window's mode line, you get two events, like this: |
6260 | 2032 |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2033 @example |
6260 | 2034 (read-key-sequence "Click on the mode line: ") |
2035 @result{} [mode-line | |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2036 (mouse-1 |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2037 (#<window 6 on NEWS> mode-line |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2038 (40 . 63) 5959987))] |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2039 @end example |
6260 | 2040 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2041 @defvar num-input-keys |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2042 @c Emacs 19 feature |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2043 This variable's value is the number of key sequences processed so far in |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2044 this Emacs session. This includes key sequences read from the terminal |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2045 and key sequences read from keyboard macros being executed. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2046 @end defvar |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2047 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2048 @defvar num-nonmacro-input-events |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2049 This variable holds the total number of input events received so far |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2050 from the terminal---not counting those generated by keyboard macros. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2051 @end defvar |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2052 |
6260 | 2053 @node Reading One Event |
2054 @subsection Reading One Event | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
2055 @cindex reading a single event |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
2056 @cindex event, reading only one |
6260 | 2057 |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
2058 The lowest level functions for command input are those that read a |
6260 | 2059 single event. |
2060 | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23110
diff
changeset
|
2061 @defun read-event &optional prompt inherit-input-method |
6260 | 2062 This function reads and returns the next event of command input, waiting |
2063 if necessary until an event is available. Events can come directly from | |
2064 the user or from a keyboard macro. | |
2065 | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23110
diff
changeset
|
2066 If the optional argument @var{prompt} is non-@code{nil}, it should be a |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23110
diff
changeset
|
2067 string to display in the echo area as a prompt. Otherwise, |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23110
diff
changeset
|
2068 @code{read-event} does not display any message to indicate it is waiting |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23110
diff
changeset
|
2069 for input; instead, it prompts by echoing: it displays descriptions of |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23110
diff
changeset
|
2070 the events that led to or were read by the current command. @xref{The |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23110
diff
changeset
|
2071 Echo Area}. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23110
diff
changeset
|
2072 |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23110
diff
changeset
|
2073 If @var{inherit-input-method} is non-@code{nil}, then the current input |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23110
diff
changeset
|
2074 method (if any) is employed to make it possible to enter a |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52626
diff
changeset
|
2075 non-@acronym{ASCII} character. Otherwise, input method handling is disabled |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23110
diff
changeset
|
2076 for reading this event. |
23110
0d84817a4973
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
2077 |
6260 | 2078 If @code{cursor-in-echo-area} is non-@code{nil}, then @code{read-event} |
2079 moves the cursor temporarily to the echo area, to the end of any message | |
2080 displayed there. Otherwise @code{read-event} does not move the cursor. | |
2081 | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2082 If @code{read-event} gets an event that is defined as a help character, in |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2083 some cases @code{read-event} processes the event directly without |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2084 returning. @xref{Help Functions}. Certain other events, called |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2085 @dfn{special events}, are also processed directly within |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2086 @code{read-event} (@pxref{Special Events}). |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2087 |
6260 | 2088 Here is what happens if you call @code{read-event} and then press the |
2089 right-arrow function key: | |
2090 | |
2091 @example | |
2092 @group | |
2093 (read-event) | |
2094 @result{} right | |
2095 @end group | |
2096 @end example | |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2097 @end defun |
6260 | 2098 |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23110
diff
changeset
|
2099 @defun read-char &optional prompt inherit-input-method |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23110
diff
changeset
|
2100 This function reads and returns a character of command input. If the |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23110
diff
changeset
|
2101 user generates an event which is not a character (i.e. a mouse click or |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23110
diff
changeset
|
2102 function key event), @code{read-char} signals an error. The arguments |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23110
diff
changeset
|
2103 work as in @code{read-event}. |
6260 | 2104 |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52626
diff
changeset
|
2105 In the first example, the user types the character @kbd{1} (@acronym{ASCII} |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2106 code 49). The second example shows a keyboard macro definition that |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2107 calls @code{read-char} from the minibuffer using @code{eval-expression}. |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2108 @code{read-char} reads the keyboard macro's very next character, which |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2109 is @kbd{1}. Then @code{eval-expression} displays its return value in |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2110 the echo area. |
6260 | 2111 |
2112 @example | |
2113 @group | |
2114 (read-char) | |
2115 @result{} 49 | |
2116 @end group | |
2117 | |
2118 @group | |
12098 | 2119 ;; @r{We assume here you use @kbd{M-:} to evaluate this.} |
6260 | 2120 (symbol-function 'foo) |
12098 | 2121 @result{} "^[:(read-char)^M1" |
6260 | 2122 @end group |
2123 @group | |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2124 (execute-kbd-macro 'foo) |
6260 | 2125 @print{} 49 |
2126 @result{} nil | |
2127 @end group | |
2128 @end example | |
2129 @end defun | |
2130 | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23110
diff
changeset
|
2131 @defun read-char-exclusive &optional prompt inherit-input-method |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23110
diff
changeset
|
2132 This function reads and returns a character of command input. If the |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23110
diff
changeset
|
2133 user generates an event which is not a character, |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23110
diff
changeset
|
2134 @code{read-char-exclusive} ignores it and reads another event, until it |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23110
diff
changeset
|
2135 gets a character. The arguments work as in @code{read-event}. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23110
diff
changeset
|
2136 @end defun |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23110
diff
changeset
|
2137 |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23110
diff
changeset
|
2138 @node Invoking the Input Method |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23110
diff
changeset
|
2139 @subsection Invoking the Input Method |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23110
diff
changeset
|
2140 |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23110
diff
changeset
|
2141 The event-reading functions invoke the current input method, if any |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23110
diff
changeset
|
2142 (@pxref{Input Methods}). If the value of @code{input-method-function} |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23110
diff
changeset
|
2143 is non-@code{nil}, it should be a function; when @code{read-event} reads |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23110
diff
changeset
|
2144 a printing character (including @key{SPC}) with no modifier bits, it |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23110
diff
changeset
|
2145 calls that function, passing the character as an argument. |
22843
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22440
diff
changeset
|
2146 |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22440
diff
changeset
|
2147 @defvar input-method-function |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22440
diff
changeset
|
2148 If this is non-@code{nil}, its value specifies the current input method |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22440
diff
changeset
|
2149 function. |
23110
0d84817a4973
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
2150 |
52626 | 2151 @strong{Warning:} don't bind this variable with @code{let}. It is often |
23110
0d84817a4973
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
2152 buffer-local, and if you bind it around reading input (which is exactly |
0d84817a4973
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
2153 when you @emph{would} bind it), switching buffers asynchronously while |
0d84817a4973
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
2154 Emacs is waiting will cause the value to be restored in the wrong |
0d84817a4973
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22843
diff
changeset
|
2155 buffer. |
22843
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22440
diff
changeset
|
2156 @end defvar |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22440
diff
changeset
|
2157 |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22440
diff
changeset
|
2158 The input method function should return a list of events which should |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22440
diff
changeset
|
2159 be used as input. (If the list is @code{nil}, that means there is no |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22440
diff
changeset
|
2160 input, so @code{read-event} waits for another event.) These events are |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
2161 processed before the events in @code{unread-command-events} |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26288
diff
changeset
|
2162 (@pxref{Event Input Misc}). Events |
22843
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22440
diff
changeset
|
2163 returned by the input method function are not passed to the input method |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22440
diff
changeset
|
2164 function again, even if they are printing characters with no modifier |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22440
diff
changeset
|
2165 bits. |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22440
diff
changeset
|
2166 |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22440
diff
changeset
|
2167 If the input method function calls @code{read-event} or |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22440
diff
changeset
|
2168 @code{read-key-sequence}, it should bind @code{input-method-function} to |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22440
diff
changeset
|
2169 @code{nil} first, to prevent recursion. |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22440
diff
changeset
|
2170 |
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22440
diff
changeset
|
2171 The input method function is not called when reading the second and |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23110
diff
changeset
|
2172 subsequent events of a key sequence. Thus, these characters are not |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23110
diff
changeset
|
2173 subject to input method processing. The input method function should |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23110
diff
changeset
|
2174 test the values of @code{overriding-local-map} and |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23110
diff
changeset
|
2175 @code{overriding-terminal-local-map}; if either of these variables is |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23110
diff
changeset
|
2176 non-@code{nil}, the input method should put its argument into a list and |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
23110
diff
changeset
|
2177 return that list with no further processing. |
22843
63f6e25f0cbd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22440
diff
changeset
|
2178 |
6260 | 2179 @node Quoted Character Input |
2180 @subsection Quoted Character Input | |
2181 @cindex quoted character input | |
2182 | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
2183 You can use the function @code{read-quoted-char} to ask the user to |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
2184 specify a character, and allow the user to specify a control or meta |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
2185 character conveniently, either literally or as an octal character code. |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
2186 The command @code{quoted-insert} uses this function. |
6260 | 2187 |
2188 @defun read-quoted-char &optional prompt | |
2189 @cindex octal character input | |
2190 @cindex control characters, reading | |
2191 @cindex nonprinting characters, reading | |
2192 This function is like @code{read-char}, except that if the first | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2193 character read is an octal digit (0-7), it reads any number of octal |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2194 digits (but stopping if a non-octal digit is found), and returns the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2195 character represented by that numeric character code. |
6260 | 2196 |
2197 Quitting is suppressed when the first character is read, so that the | |
2198 user can enter a @kbd{C-g}. @xref{Quitting}. | |
2199 | |
2200 If @var{prompt} is supplied, it specifies a string for prompting the | |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2201 user. The prompt string is always displayed in the echo area, followed |
6260 | 2202 by a single @samp{-}. |
2203 | |
2204 In the following example, the user types in the octal number 177 (which | |
2205 is 127 in decimal). | |
2206 | |
2207 @example | |
2208 (read-quoted-char "What character") | |
2209 | |
2210 @group | |
2211 ---------- Echo Area ---------- | |
2212 What character-@kbd{177} | |
2213 ---------- Echo Area ---------- | |
2214 | |
2215 @result{} 127 | |
2216 @end group | |
2217 @end example | |
2218 @end defun | |
2219 | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
2220 @need 2000 |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2221 @node Event Input Misc |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2222 @subsection Miscellaneous Event Input Features |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2223 |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2224 This section describes how to ``peek ahead'' at events without using |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2225 them up, how to check for pending input, and how to discard pending |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2226 input. See also the function @code{read-passwd} (@pxref{Reading a |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
2227 Password}). |
6260 | 2228 |
2229 @defvar unread-command-events | |
2230 @cindex next input | |
2231 @cindex peeking at input | |
2232 This variable holds a list of events waiting to be read as command | |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2233 input. The events are used in the order they appear in the list, and |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2234 removed one by one as they are used. |
6260 | 2235 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2236 The variable is needed because in some cases a function reads an event |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2237 and then decides not to use it. Storing the event in this variable |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2238 causes it to be processed normally, by the command loop or by the |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2239 functions to read command input. |
6260 | 2240 |
2241 @cindex prefix argument unreading | |
2242 For example, the function that implements numeric prefix arguments reads | |
2243 any number of digits. When it finds a non-digit event, it must unread | |
2244 the event so that it can be read normally by the command loop. | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48731
diff
changeset
|
2245 Likewise, incremental search uses this feature to unread events with no |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2246 special meaning in a search, because these events should exit the search |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2247 and then execute normally. |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2248 |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
2249 The reliable and easy way to extract events from a key sequence so as to |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
2250 put them in @code{unread-command-events} is to use |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2251 @code{listify-key-sequence} (@pxref{Strings of Events}). |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2252 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2253 Normally you add events to the front of this list, so that the events |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2254 most recently unread will be reread first. |
6260 | 2255 @end defvar |
2256 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2257 @defun listify-key-sequence key |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2258 This function converts the string or vector @var{key} to a list of |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2259 individual events, which you can put in @code{unread-command-events}. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2260 @end defun |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2261 |
6260 | 2262 @defvar unread-command-char |
2263 This variable holds a character to be read as command input. | |
2264 A value of -1 means ``empty''. | |
2265 | |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2266 This variable is mostly obsolete now that you can use |
6260 | 2267 @code{unread-command-events} instead; it exists only to support programs |
2268 written for Emacs versions 18 and earlier. | |
2269 @end defvar | |
2270 | |
2271 @defun input-pending-p | |
2272 @cindex waiting for command key input | |
2273 This function determines whether any command input is currently | |
2274 available to be read. It returns immediately, with value @code{t} if | |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2275 there is available input, @code{nil} otherwise. On rare occasions it |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2276 may return @code{t} when no input is available. |
6260 | 2277 @end defun |
2278 | |
2279 @defvar last-input-event | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2280 @defvarx last-input-char |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2281 This variable records the last terminal input event read, whether |
6260 | 2282 as part of a command or explicitly by a Lisp program. |
2283 | |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2284 In the example below, the Lisp program reads the character @kbd{1}, |
52978
1a5c50faf357
Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents:
52626
diff
changeset
|
2285 @acronym{ASCII} code 49. It becomes the value of @code{last-input-event}, |
12098 | 2286 while @kbd{C-e} (we assume @kbd{C-x C-e} command is used to evaluate |
2287 this expression) remains the value of @code{last-command-event}. | |
6260 | 2288 |
2289 @example | |
2290 @group | |
2291 (progn (print (read-char)) | |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2292 (print last-command-event) |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2293 last-input-event) |
6260 | 2294 @print{} 49 |
2295 @print{} 5 | |
2296 @result{} 49 | |
2297 @end group | |
2298 @end example | |
2299 | |
2300 The alias @code{last-input-char} exists for compatibility with | |
2301 Emacs version 18. | |
2302 @end defvar | |
2303 | |
2304 @defun discard-input | |
2305 @cindex flush input | |
2306 @cindex discard input | |
2307 @cindex terminate keyboard macro | |
2308 This function discards the contents of the terminal input buffer and | |
2309 cancels any keyboard macro that might be in the process of definition. | |
2310 It returns @code{nil}. | |
2311 | |
2312 In the following example, the user may type a number of characters right | |
2313 after starting the evaluation of the form. After the @code{sleep-for} | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48731
diff
changeset
|
2314 finishes sleeping, @code{discard-input} discards any characters typed |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2315 during the sleep. |
6260 | 2316 |
2317 @example | |
2318 (progn (sleep-for 2) | |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2319 (discard-input)) |
6260 | 2320 @result{} nil |
2321 @end example | |
2322 @end defun | |
2323 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2324 @node Special Events |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2325 @section Special Events |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2326 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2327 @cindex special events |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2328 Special events are handled at a very low level---as soon as they are |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2329 read. The @code{read-event} function processes these events itself, and |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2330 never returns them. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2331 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2332 Events that are handled in this way do not echo, they are never grouped |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2333 into key sequences, and they never appear in the value of |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2334 @code{last-command-event} or @code{(this-command-keys)}. They do not |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2335 discard a numeric argument, they cannot be unread with |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2336 @code{unread-command-events}, they may not appear in a keyboard macro, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2337 and they are not recorded in a keyboard macro while you are defining |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2338 one. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2339 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2340 These events do, however, appear in @code{last-input-event} immediately |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2341 after they are read, and this is the way for the event's definition to |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2342 find the actual event. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2343 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2344 The events types @code{iconify-frame}, @code{make-frame-visible} and |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2345 @code{delete-frame} are normally handled in this way. The keymap which |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2346 defines how to handle special events---and which events are special---is |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2347 in the variable @code{special-event-map} (@pxref{Active Keymaps}). |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2348 |
6260 | 2349 @node Waiting |
2350 @section Waiting for Elapsed Time or Input | |
2351 @cindex pausing | |
2352 @cindex waiting | |
2353 | |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2354 The wait functions are designed to wait for a certain amount of time |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2355 to pass or until there is input. For example, you may wish to pause in |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2356 the middle of a computation to allow the user time to view the display. |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2357 @code{sit-for} pauses and updates the screen, and returns immediately if |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2358 input comes in, while @code{sleep-for} pauses without updating the |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2359 screen. |
6260 | 2360 |
51912
3abd89560852
(Command Overview): Emacs server runs pre-command-hook and post-command-hook.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
2361 @defun sit-for seconds &optional nodisp |
6260 | 2362 This function performs redisplay (provided there is no pending input |
2363 from the user), then waits @var{seconds} seconds, or until input is | |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2364 available. The value is @code{t} if @code{sit-for} waited the full |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48731
diff
changeset
|
2365 time with no input arriving (see @code{input-pending-p} in @ref{Event |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2366 Input Misc}). Otherwise, the value is @code{nil}. |
6260 | 2367 |
12098 | 2368 The argument @var{seconds} need not be an integer. If it is a floating |
2369 point number, @code{sit-for} waits for a fractional number of seconds. | |
2370 Some systems support only a whole number of seconds; on these systems, | |
2371 @var{seconds} is rounded down. | |
2372 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
2373 The expression @code{(sit-for 0)} is a convenient way to request a |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
2374 redisplay, without any delay. @xref{Forcing Redisplay}. |
6260 | 2375 |
2376 If @var{nodisp} is non-@code{nil}, then @code{sit-for} does not | |
2377 redisplay, but it still returns as soon as input is available (or when | |
2378 the timeout elapses). | |
2379 | |
12067 | 2380 Iconifying or deiconifying a frame makes @code{sit-for} return, because |
2381 that generates an event. @xref{Misc Events}. | |
2382 | |
6260 | 2383 The usual purpose of @code{sit-for} is to give the user time to read |
2384 text that you display. | |
51912
3abd89560852
(Command Overview): Emacs server runs pre-command-hook and post-command-hook.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
2385 |
3abd89560852
(Command Overview): Emacs server runs pre-command-hook and post-command-hook.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
2386 It is also possible to call @code{sit-for} with three arguments, |
3abd89560852
(Command Overview): Emacs server runs pre-command-hook and post-command-hook.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
2387 as @code{(sit-for @var{seconds} @var{millisec} @var{nodisp})}, |
3abd89560852
(Command Overview): Emacs server runs pre-command-hook and post-command-hook.
Richard M. Stallman <rms@gnu.org>
parents:
49600
diff
changeset
|
2388 but that is considered obsolete. |
6260 | 2389 @end defun |
2390 | |
2391 @defun sleep-for seconds &optional millisec | |
2392 This function simply pauses for @var{seconds} seconds without updating | |
2393 the display. It pays no attention to available input. It returns | |
2394 @code{nil}. | |
2395 | |
12098 | 2396 The argument @var{seconds} need not be an integer. If it is a floating |
2397 point number, @code{sleep-for} waits for a fractional number of seconds. | |
2398 Some systems support only a whole number of seconds; on these systems, | |
2399 @var{seconds} is rounded down. | |
2400 | |
6260 | 2401 The optional argument @var{millisec} specifies an additional waiting |
2402 period measured in milliseconds. This adds to the period specified by | |
12098 | 2403 @var{seconds}. If the system doesn't support waiting fractions of a |
2404 second, you get an error if you specify nonzero @var{millisec}. | |
6260 | 2405 |
2406 Use @code{sleep-for} when you wish to guarantee a delay. | |
2407 @end defun | |
2408 | |
2409 @xref{Time of Day}, for functions to get the current time. | |
2410 | |
2411 @node Quitting | |
2412 @section Quitting | |
2413 @cindex @kbd{C-g} | |
2414 @cindex quitting | |
45191
60dbe3b230eb
(Quitting): Add an index entry containing the word ``interrupt''.
Eli Zaretskii <eliz@gnu.org>
parents:
44675
diff
changeset
|
2415 @cindex interrupt Lisp functions |
6260 | 2416 |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
2417 Typing @kbd{C-g} while a Lisp function is running causes Emacs to |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
2418 @dfn{quit} whatever it is doing. This means that control returns to the |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
2419 innermost active command loop. |
6260 | 2420 |
2421 Typing @kbd{C-g} while the command loop is waiting for keyboard input | |
2422 does not cause a quit; it acts as an ordinary input character. In the | |
2423 simplest case, you cannot tell the difference, because @kbd{C-g} | |
2424 normally runs the command @code{keyboard-quit}, whose effect is to quit. | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2425 However, when @kbd{C-g} follows a prefix key, they combine to form an |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2426 undefined key. The effect is to cancel the prefix key as well as any |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2427 prefix argument. |
6260 | 2428 |
2429 In the minibuffer, @kbd{C-g} has a different definition: it aborts out | |
2430 of the minibuffer. This means, in effect, that it exits the minibuffer | |
2431 and then quits. (Simply quitting would return to the command loop | |
2432 @emph{within} the minibuffer.) The reason why @kbd{C-g} does not quit | |
2433 directly when the command reader is reading input is so that its meaning | |
2434 can be redefined in the minibuffer in this way. @kbd{C-g} following a | |
2435 prefix key is not redefined in the minibuffer, and it has its normal | |
2436 effect of canceling the prefix key and prefix argument. This too | |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2437 would not be possible if @kbd{C-g} always quit directly. |
6260 | 2438 |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
2439 When @kbd{C-g} does directly quit, it does so by setting the variable |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2440 @code{quit-flag} to @code{t}. Emacs checks this variable at appropriate |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2441 times and quits if it is not @code{nil}. Setting @code{quit-flag} |
6260 | 2442 non-@code{nil} in any way thus causes a quit. |
2443 | |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2444 At the level of C code, quitting cannot happen just anywhere; only at the |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
2445 special places that check @code{quit-flag}. The reason for this is |
6260 | 2446 that quitting at other places might leave an inconsistency in Emacs's |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48731
diff
changeset
|
2447 internal state. Because quitting is delayed until a safe place, quitting |
6260 | 2448 cannot make Emacs crash. |
2449 | |
2450 Certain functions such as @code{read-key-sequence} or | |
2451 @code{read-quoted-char} prevent quitting entirely even though they wait | |
2452 for input. Instead of quitting, @kbd{C-g} serves as the requested | |
2453 input. In the case of @code{read-key-sequence}, this serves to bring | |
2454 about the special behavior of @kbd{C-g} in the command loop. In the | |
2455 case of @code{read-quoted-char}, this is so that @kbd{C-q} can be used | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48731
diff
changeset
|
2456 to quote a @kbd{C-g}. |
6260 | 2457 |
45191
60dbe3b230eb
(Quitting): Add an index entry containing the word ``interrupt''.
Eli Zaretskii <eliz@gnu.org>
parents:
44675
diff
changeset
|
2458 @cindex prevent quitting |
6260 | 2459 You can prevent quitting for a portion of a Lisp function by binding |
2460 the variable @code{inhibit-quit} to a non-@code{nil} value. Then, | |
2461 although @kbd{C-g} still sets @code{quit-flag} to @code{t} as usual, the | |
2462 usual result of this---a quit---is prevented. Eventually, | |
2463 @code{inhibit-quit} will become @code{nil} again, such as when its | |
2464 binding is unwound at the end of a @code{let} form. At that time, if | |
2465 @code{quit-flag} is still non-@code{nil}, the requested quit happens | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
2466 immediately. This behavior is ideal when you wish to make sure that |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
2467 quitting does not happen within a ``critical section'' of the program. |
6260 | 2468 |
2469 @cindex @code{read-quoted-char} quitting | |
2470 In some functions (such as @code{read-quoted-char}), @kbd{C-g} is | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
2471 handled in a special way that does not involve quitting. This is done |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2472 by reading the input with @code{inhibit-quit} bound to @code{t}, and |
6260 | 2473 setting @code{quit-flag} to @code{nil} before @code{inhibit-quit} |
2474 becomes @code{nil} again. This excerpt from the definition of | |
2475 @code{read-quoted-char} shows how this is done; it also shows that | |
2476 normal quitting is permitted after the first character of input. | |
2477 | |
2478 @example | |
2479 (defun read-quoted-char (&optional prompt) | |
2480 "@dots{}@var{documentation}@dots{}" | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2481 (let ((message-log-max nil) done (first t) (code 0) char) |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2482 (while (not done) |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2483 (let ((inhibit-quit first) |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2484 @dots{}) |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2485 (and prompt (message "%s-" prompt)) |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2486 (setq char (read-event)) |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2487 (if inhibit-quit (setq quit-flag nil))) |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2488 @r{@dots{}set the variable @code{code}@dots{}}) |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
2489 code)) |
6260 | 2490 @end example |
2491 | |
2492 @defvar quit-flag | |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2493 If this variable is non-@code{nil}, then Emacs quits immediately, unless |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2494 @code{inhibit-quit} is non-@code{nil}. Typing @kbd{C-g} ordinarily sets |
6260 | 2495 @code{quit-flag} non-@code{nil}, regardless of @code{inhibit-quit}. |
2496 @end defvar | |
2497 | |
2498 @defvar inhibit-quit | |
2499 This variable determines whether Emacs should quit when @code{quit-flag} | |
2500 is set to a value other than @code{nil}. If @code{inhibit-quit} is | |
2501 non-@code{nil}, then @code{quit-flag} has no special effect. | |
2502 @end defvar | |
2503 | |
2504 @deffn Command keyboard-quit | |
2505 This function signals the @code{quit} condition with @code{(signal 'quit | |
2506 nil)}. This is the same thing that quitting does. (See @code{signal} | |
2507 in @ref{Errors}.) | |
2508 @end deffn | |
2509 | |
2510 You can specify a character other than @kbd{C-g} to use for quitting. | |
2511 See the function @code{set-input-mode} in @ref{Terminal Input}. | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48731
diff
changeset
|
2512 |
6260 | 2513 @node Prefix Command Arguments |
2514 @section Prefix Command Arguments | |
2515 @cindex prefix argument | |
2516 @cindex raw prefix argument | |
2517 @cindex numeric prefix argument | |
2518 | |
2519 Most Emacs commands can use a @dfn{prefix argument}, a number | |
2520 specified before the command itself. (Don't confuse prefix arguments | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
2521 with prefix keys.) The prefix argument is at all times represented by a |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
2522 value, which may be @code{nil}, meaning there is currently no prefix |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
2523 argument. Each command may use the prefix argument or ignore it. |
6260 | 2524 |
2525 There are two representations of the prefix argument: @dfn{raw} and | |
2526 @dfn{numeric}. The editor command loop uses the raw representation | |
2527 internally, and so do the Lisp variables that store the information, but | |
2528 commands can request either representation. | |
2529 | |
2530 Here are the possible values of a raw prefix argument: | |
2531 | |
2532 @itemize @bullet | |
2533 @item | |
2534 @code{nil}, meaning there is no prefix argument. Its numeric value is | |
2535 1, but numerous commands make a distinction between @code{nil} and the | |
2536 integer 1. | |
2537 | |
2538 @item | |
2539 An integer, which stands for itself. | |
2540 | |
2541 @item | |
2542 A list of one element, which is an integer. This form of prefix | |
2543 argument results from one or a succession of @kbd{C-u}'s with no | |
2544 digits. The numeric value is the integer in the list, but some | |
2545 commands make a distinction between such a list and an integer alone. | |
2546 | |
2547 @item | |
2548 The symbol @code{-}. This indicates that @kbd{M--} or @kbd{C-u -} was | |
2549 typed, without following digits. The equivalent numeric value is | |
2550 @minus{}1, but some commands make a distinction between the integer | |
2551 @minus{}1 and the symbol @code{-}. | |
2552 @end itemize | |
2553 | |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2554 We illustrate these possibilities by calling the following function with |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2555 various prefixes: |
6260 | 2556 |
2557 @example | |
2558 @group | |
2559 (defun display-prefix (arg) | |
2560 "Display the value of the raw prefix arg." | |
2561 (interactive "P") | |
2562 (message "%s" arg)) | |
2563 @end group | |
2564 @end example | |
2565 | |
2566 @noindent | |
2567 Here are the results of calling @code{display-prefix} with various | |
2568 raw prefix arguments: | |
2569 | |
2570 @example | |
2571 M-x display-prefix @print{} nil | |
2572 | |
2573 C-u M-x display-prefix @print{} (4) | |
2574 | |
2575 C-u C-u M-x display-prefix @print{} (16) | |
2576 | |
2577 C-u 3 M-x display-prefix @print{} 3 | |
2578 | |
2579 M-3 M-x display-prefix @print{} 3 ; @r{(Same as @code{C-u 3}.)} | |
2580 | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48731
diff
changeset
|
2581 C-u - M-x display-prefix @print{} - |
6260 | 2582 |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2583 M-- M-x display-prefix @print{} - ; @r{(Same as @code{C-u -}.)} |
6260 | 2584 |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48731
diff
changeset
|
2585 C-u - 7 M-x display-prefix @print{} -7 |
6260 | 2586 |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2587 M-- 7 M-x display-prefix @print{} -7 ; @r{(Same as @code{C-u -7}.)} |
6260 | 2588 @end example |
2589 | |
2590 Emacs uses two variables to store the prefix argument: | |
2591 @code{prefix-arg} and @code{current-prefix-arg}. Commands such as | |
2592 @code{universal-argument} that set up prefix arguments for other | |
2593 commands store them in @code{prefix-arg}. In contrast, | |
2594 @code{current-prefix-arg} conveys the prefix argument to the current | |
2595 command, so setting it has no effect on the prefix arguments for future | |
2596 commands. | |
2597 | |
2598 Normally, commands specify which representation to use for the prefix | |
2599 argument, either numeric or raw, in the @code{interactive} declaration. | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
2600 (@xref{Using Interactive}.) Alternatively, functions may look at the |
6260 | 2601 value of the prefix argument directly in the variable |
2602 @code{current-prefix-arg}, but this is less clean. | |
2603 | |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2604 @defun prefix-numeric-value arg |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2605 This function returns the numeric meaning of a valid raw prefix argument |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2606 value, @var{arg}. The argument may be a symbol, a number, or a list. |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
2607 If it is @code{nil}, the value 1 is returned; if it is @code{-}, the |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
2608 value @minus{}1 is returned; if it is a number, that number is returned; |
53297
4c4e0f5356bf
Replace all occurrences of @acronym{CAR} with @sc{car}, for
Luc Teirlinck <teirllm@auburn.edu>
parents:
53183
diff
changeset
|
2609 if it is a list, the @sc{car} of that list (which should be a number) is |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
2610 returned. |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2611 @end defun |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2612 |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2613 @defvar current-prefix-arg |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2614 This variable holds the raw prefix argument for the @emph{current} |
16736
981e116b4ac6
Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents:
15764
diff
changeset
|
2615 command. Commands may examine it directly, but the usual method for |
981e116b4ac6
Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents:
15764
diff
changeset
|
2616 accessing it is with @code{(interactive "P")}. |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2617 @end defvar |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2618 |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2619 @defvar prefix-arg |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2620 The value of this variable is the raw prefix argument for the |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2621 @emph{next} editing command. Commands such as @code{universal-argument} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2622 that specify prefix arguments for the following command work by setting |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2623 this variable. |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2624 @end defvar |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2625 |
22440
8a51f757af2c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
2626 @defvar last-prefix-arg |
8a51f757af2c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
2627 The raw prefix argument value used by the previous command. |
8a51f757af2c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
2628 @end defvar |
8a51f757af2c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
2629 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2630 The following commands exist to set up prefix arguments for the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2631 following command. Do not call them for any other reason. |
6260 | 2632 |
2633 @deffn Command universal-argument | |
2634 This command reads input and specifies a prefix argument for the | |
2635 following command. Don't call this command yourself unless you know | |
2636 what you are doing. | |
2637 @end deffn | |
2638 | |
2639 @deffn Command digit-argument arg | |
2640 This command adds to the prefix argument for the following command. The | |
2641 argument @var{arg} is the raw prefix argument as it was before this | |
2642 command; it is used to compute the updated prefix argument. Don't call | |
2643 this command yourself unless you know what you are doing. | |
2644 @end deffn | |
2645 | |
2646 @deffn Command negative-argument arg | |
2647 This command adds to the numeric argument for the next command. The | |
2648 argument @var{arg} is the raw prefix argument as it was before this | |
2649 command; its value is negated to form the new prefix argument. Don't | |
2650 call this command yourself unless you know what you are doing. | |
2651 @end deffn | |
2652 | |
2653 @node Recursive Editing | |
2654 @section Recursive Editing | |
2655 @cindex recursive command loop | |
2656 @cindex recursive editing level | |
2657 @cindex command loop, recursive | |
2658 | |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2659 The Emacs command loop is entered automatically when Emacs starts up. |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2660 This top-level invocation of the command loop never exits; it keeps |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2661 running as long as Emacs does. Lisp programs can also invoke the |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2662 command loop. Since this makes more than one activation of the command |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2663 loop, we call it @dfn{recursive editing}. A recursive editing level has |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2664 the effect of suspending whatever command invoked it and permitting the |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2665 user to do arbitrary editing before resuming that command. |
6260 | 2666 |
2667 The commands available during recursive editing are the same ones | |
2668 available in the top-level editing loop and defined in the keymaps. | |
2669 Only a few special commands exit the recursive editing level; the others | |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2670 return to the recursive editing level when they finish. (The special |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2671 commands for exiting are always available, but they do nothing when |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2672 recursive editing is not in progress.) |
6260 | 2673 |
2674 All command loops, including recursive ones, set up all-purpose error | |
2675 handlers so that an error in a command run from the command loop will | |
2676 not exit the loop. | |
2677 | |
2678 @cindex minibuffer input | |
2679 Minibuffer input is a special kind of recursive editing. It has a few | |
2680 special wrinkles, such as enabling display of the minibuffer and the | |
2681 minibuffer window, but fewer than you might suppose. Certain keys | |
2682 behave differently in the minibuffer, but that is only because of the | |
2683 minibuffer's local map; if you switch windows, you get the usual Emacs | |
2684 commands. | |
2685 | |
2686 @cindex @code{throw} example | |
2687 @kindex exit | |
2688 @cindex exit recursive editing | |
2689 @cindex aborting | |
2690 To invoke a recursive editing level, call the function | |
2691 @code{recursive-edit}. This function contains the command loop; it also | |
2692 contains a call to @code{catch} with tag @code{exit}, which makes it | |
2693 possible to exit the recursive editing level by throwing to @code{exit} | |
2694 (@pxref{Catch and Throw}). If you throw a value other than @code{t}, | |
2695 then @code{recursive-edit} returns normally to the function that called | |
2696 it. The command @kbd{C-M-c} (@code{exit-recursive-edit}) does this. | |
2697 Throwing a @code{t} value causes @code{recursive-edit} to quit, so that | |
2698 control returns to the command loop one level up. This is called | |
2699 @dfn{aborting}, and is done by @kbd{C-]} (@code{abort-recursive-edit}). | |
2700 | |
2701 Most applications should not use recursive editing, except as part of | |
2702 using the minibuffer. Usually it is more convenient for the user if you | |
2703 change the major mode of the current buffer temporarily to a special | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
2704 major mode, which should have a command to go back to the previous mode. |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
2705 (The @kbd{e} command in Rmail uses this technique.) Or, if you wish to |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
2706 give the user different text to edit ``recursively'', create and select |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
2707 a new buffer in a special mode. In this mode, define a command to |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
2708 complete the processing and go back to the previous buffer. (The |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
2709 @kbd{m} command in Rmail does this.) |
6260 | 2710 |
2711 Recursive edits are useful in debugging. You can insert a call to | |
2712 @code{debug} into a function definition as a sort of breakpoint, so that | |
2713 you can look around when the function gets there. @code{debug} invokes | |
2714 a recursive edit but also provides the other features of the debugger. | |
2715 | |
2716 Recursive editing levels are also used when you type @kbd{C-r} in | |
2717 @code{query-replace} or use @kbd{C-x q} (@code{kbd-macro-query}). | |
2718 | |
2719 @defun recursive-edit | |
2720 @cindex suspend evaluation | |
2721 This function invokes the editor command loop. It is called | |
2722 automatically by the initialization of Emacs, to let the user begin | |
2723 editing. When called from a Lisp program, it enters a recursive editing | |
2724 level. | |
2725 | |
2726 In the following example, the function @code{simple-rec} first | |
2727 advances point one word, then enters a recursive edit, printing out a | |
2728 message in the echo area. The user can then do any editing desired, and | |
2729 then type @kbd{C-M-c} to exit and continue executing @code{simple-rec}. | |
2730 | |
2731 @example | |
2732 (defun simple-rec () | |
2733 (forward-word 1) | |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2734 (message "Recursive edit in progress") |
6260 | 2735 (recursive-edit) |
2736 (forward-word 1)) | |
2737 @result{} simple-rec | |
2738 (simple-rec) | |
2739 @result{} nil | |
2740 @end example | |
2741 @end defun | |
2742 | |
2743 @deffn Command exit-recursive-edit | |
2744 This function exits from the innermost recursive edit (including | |
2745 minibuffer input). Its definition is effectively @code{(throw 'exit | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48731
diff
changeset
|
2746 nil)}. |
6260 | 2747 @end deffn |
2748 | |
2749 @deffn Command abort-recursive-edit | |
2750 This function aborts the command that requested the innermost recursive | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48731
diff
changeset
|
2751 edit (including minibuffer input), by signaling @code{quit} |
6260 | 2752 after exiting the recursive edit. Its definition is effectively |
2753 @code{(throw 'exit t)}. @xref{Quitting}. | |
2754 @end deffn | |
2755 | |
2756 @deffn Command top-level | |
2757 This function exits all recursive editing levels; it does not return a | |
2758 value, as it jumps completely out of any computation directly back to | |
2759 the main command loop. | |
2760 @end deffn | |
2761 | |
2762 @defun recursion-depth | |
2763 This function returns the current depth of recursive edits. When no | |
2764 recursive edit is active, it returns 0. | |
2765 @end defun | |
2766 | |
2767 @node Disabling Commands | |
2768 @section Disabling Commands | |
2769 @cindex disabled command | |
2770 | |
2771 @dfn{Disabling a command} marks the command as requiring user | |
2772 confirmation before it can be executed. Disabling is used for commands | |
2773 which might be confusing to beginning users, to prevent them from using | |
2774 the commands by accident. | |
2775 | |
2776 @kindex disabled | |
2777 The low-level mechanism for disabling a command is to put a | |
2778 non-@code{nil} @code{disabled} property on the Lisp symbol for the | |
2779 command. These properties are normally set up by the user's | |
25875 | 2780 init file (@pxref{Init File}) with Lisp expressions such as this: |
6260 | 2781 |
2782 @example | |
2783 (put 'upcase-region 'disabled t) | |
2784 @end example | |
2785 | |
2786 @noindent | |
25875 | 2787 For a few commands, these properties are present by default (you can |
2788 remove them in your init file if you wish). | |
6260 | 2789 |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2790 If the value of the @code{disabled} property is a string, the message |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2791 saying the command is disabled includes that string. For example: |
6260 | 2792 |
2793 @example | |
2794 (put 'delete-region 'disabled | |
2795 "Text deleted this way cannot be yanked back!\n") | |
2796 @end example | |
2797 | |
2798 @xref{Disabling,,, emacs, The GNU Emacs Manual}, for the details on | |
2799 what happens when a disabled command is invoked interactively. | |
2800 Disabling a command has no effect on calling it as a function from Lisp | |
2801 programs. | |
2802 | |
2803 @deffn Command enable-command command | |
2804 Allow @var{command} to be executed without special confirmation from now | |
25875 | 2805 on, and (if the user confirms) alter the user's init file (@pxref{Init |
2806 File}) so that this will apply to future sessions. | |
6260 | 2807 @end deffn |
2808 | |
2809 @deffn Command disable-command command | |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2810 Require special confirmation to execute @var{command} from now on, and |
25875 | 2811 (if the user confirms) alter the user's init file so that this |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
2812 will apply to future sessions. |
6260 | 2813 @end deffn |
2814 | |
2815 @defvar disabled-command-hook | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2816 When the user invokes a disabled command interactively, this normal hook |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2817 is run instead of the disabled command. The hook functions can use |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2818 @code{this-command-keys} to determine what the user typed to run the |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6557
diff
changeset
|
2819 command, and thus find the command itself. @xref{Hooks}. |
6260 | 2820 |
2821 By default, @code{disabled-command-hook} contains a function that asks | |
2822 the user whether to proceed. | |
2823 @end defvar | |
2824 | |
2825 @node Command History | |
2826 @section Command History | |
2827 @cindex command history | |
2828 @cindex complex command | |
2829 @cindex history of commands | |
2830 | |
2831 The command loop keeps a history of the complex commands that have | |
2832 been executed, to make it convenient to repeat these commands. A | |
2833 @dfn{complex command} is one for which the interactive argument reading | |
2834 uses the minibuffer. This includes any @kbd{M-x} command, any | |
12098 | 2835 @kbd{M-:} command, and any command whose @code{interactive} |
6260 | 2836 specification reads an argument from the minibuffer. Explicit use of |
2837 the minibuffer during the execution of the command itself does not cause | |
2838 the command to be considered complex. | |
2839 | |
2840 @defvar command-history | |
2841 This variable's value is a list of recent complex commands, each | |
2842 represented as a form to evaluate. It continues to accumulate all | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
2843 complex commands for the duration of the editing session, but when it |
48731
e156891cd394
Use xref for history list truncation.
Richard M. Stallman <rms@gnu.org>
parents:
45191
diff
changeset
|
2844 reaches the maximum size (@pxref{Minibuffer History}), the oldest |
e156891cd394
Use xref for history list truncation.
Richard M. Stallman <rms@gnu.org>
parents:
45191
diff
changeset
|
2845 elements are deleted as new ones are added. |
6260 | 2846 |
2847 @example | |
2848 @group | |
2849 command-history | |
2850 @result{} ((switch-to-buffer "chistory.texi") | |
2851 (describe-key "^X^[") | |
2852 (visit-tags-table "~/emacs/src/") | |
2853 (find-tag "repeat-complex-command")) | |
2854 @end group | |
2855 @end example | |
2856 @end defvar | |
2857 | |
2858 This history list is actually a special case of minibuffer history | |
2859 (@pxref{Minibuffer History}), with one special twist: the elements are | |
2860 expressions rather than strings. | |
2861 | |
2862 There are a number of commands devoted to the editing and recall of | |
2863 previous commands. The commands @code{repeat-complex-command}, and | |
2864 @code{list-command-history} are described in the user manual | |
2865 (@pxref{Repetition,,, emacs, The GNU Emacs Manual}). Within the | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2866 minibuffer, the usual minibuffer history commands are available. |
6260 | 2867 |
2868 @node Keyboard Macros | |
2869 @section Keyboard Macros | |
2870 @cindex keyboard macros | |
2871 | |
2872 A @dfn{keyboard macro} is a canned sequence of input events that can | |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2873 be considered a command and made the definition of a key. The Lisp |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2874 representation of a keyboard macro is a string or vector containing the |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2875 events. Don't confuse keyboard macros with Lisp macros |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2876 (@pxref{Macros}). |
6260 | 2877 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2878 @defun execute-kbd-macro kbdmacro &optional count |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2879 This function executes @var{kbdmacro} as a sequence of events. If |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2880 @var{kbdmacro} is a string or vector, then the events in it are executed |
6260 | 2881 exactly as if they had been input by the user. The sequence is |
2882 @emph{not} expected to be a single key sequence; normally a keyboard | |
2883 macro definition consists of several key sequences concatenated. | |
2884 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2885 If @var{kbdmacro} is a symbol, then its function definition is used in |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2886 place of @var{kbdmacro}. If that is another symbol, this process repeats. |
6260 | 2887 Eventually the result should be a string or vector. If the result is |
2888 not a symbol, string, or vector, an error is signaled. | |
2889 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2890 The argument @var{count} is a repeat count; @var{kbdmacro} is executed that |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2891 many times. If @var{count} is omitted or @code{nil}, @var{kbdmacro} is |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2892 executed once. If it is 0, @var{kbdmacro} is executed over and over until it |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48731
diff
changeset
|
2893 encounters an error or a failing search. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2894 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2895 @xref{Reading One Event}, for an example of using @code{execute-kbd-macro}. |
6260 | 2896 @end defun |
2897 | |
2898 @defvar executing-macro | |
2899 This variable contains the string or vector that defines the keyboard | |
2900 macro that is currently executing. It is @code{nil} if no macro is | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2901 currently executing. A command can test this variable so as to behave |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2902 differently when run from an executing macro. Do not set this variable |
6260 | 2903 yourself. |
2904 @end defvar | |
2905 | |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2906 @defvar defining-kbd-macro |
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2907 This variable indicates whether a keyboard macro is being defined. A |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2908 command can test this variable so as to behave differently while a macro |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
2909 is being defined. The commands @code{start-kbd-macro} and |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2910 @code{end-kbd-macro} set this variable---do not set it yourself. |
12067 | 2911 |
12098 | 2912 The variable is always local to the current terminal and cannot be |
12067 | 2913 buffer-local. @xref{Multiple Displays}. |
6557
74758cf67338
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6260
diff
changeset
|
2914 @end defvar |
6260 | 2915 |
12098 | 2916 @defvar last-kbd-macro |
2917 This variable is the definition of the most recently defined keyboard | |
2918 macro. Its value is a string or vector, or @code{nil}. | |
2919 | |
2920 The variable is always local to the current terminal and cannot be | |
2921 buffer-local. @xref{Multiple Displays}. | |
2922 @end defvar | |
2923 | |
39210
c717c37b1a2c
(Using Interactive): Document interactive-form.
Eli Zaretskii <eliz@gnu.org>
parents:
38603
diff
changeset
|
2924 @defvar kbd-macro-termination-hook |
c717c37b1a2c
(Using Interactive): Document interactive-form.
Eli Zaretskii <eliz@gnu.org>
parents:
38603
diff
changeset
|
2925 This normal hook (@pxref{Standard Hooks}) is run when a keyboard |
c717c37b1a2c
(Using Interactive): Document interactive-form.
Eli Zaretskii <eliz@gnu.org>
parents:
38603
diff
changeset
|
2926 macro terminates, regardless of what caused it to terminate (reaching |
c717c37b1a2c
(Using Interactive): Document interactive-form.
Eli Zaretskii <eliz@gnu.org>
parents:
38603
diff
changeset
|
2927 the macro end or an error which ended the macro prematurely). |
c717c37b1a2c
(Using Interactive): Document interactive-form.
Eli Zaretskii <eliz@gnu.org>
parents:
38603
diff
changeset
|
2928 @end defvar |
52401 | 2929 |
2930 @ignore | |
2931 arch-tag: e34944ad-7d5c-4980-be00-36a5fe54d4b1 | |
2932 @end ignore |