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