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