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