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