Mercurial > emacs
annotate lispref/keymaps.texi @ 21212:73a8874d25ce
(vc-restore-buffer-context): Only try to restore mark if it is active.
author | André Spiegel <spiegel@gnu.org> |
---|---|
date | Wed, 18 Mar 1998 13:25:00 +0000 |
parents | 66d807bdc5b4 |
children | 90da2489c498 |
rev | line source |
---|---|
6558 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1998 Free Software Foundation, Inc. |
6558 | 4 @c See the file elisp.texi for copying conditions. |
5 @setfilename ../info/keymaps | |
6 @node Keymaps, Modes, Command Loop, Top | |
7 @chapter Keymaps | |
8 @cindex keymap | |
9 | |
10 The bindings between input events and commands are recorded in data | |
11 structures called @dfn{keymaps}. Each binding in a keymap associates | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
12 (or @dfn{binds}) an individual event type either to another keymap or to |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
13 a command. When an event type is bound to a keymap, that keymap is used |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
14 to look up the next input event; this continues until a command is |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
15 found. The whole process is called @dfn{key lookup}. |
6558 | 16 |
17 @menu | |
18 * Keymap Terminology:: Definitions of terms pertaining to keymaps. | |
19 * Format of Keymaps:: What a keymap looks like as a Lisp object. | |
20 * Creating Keymaps:: Functions to create and copy keymaps. | |
21 * Inheritance and Keymaps:: How one keymap can inherit the bindings | |
22 of another keymap. | |
23 * Prefix Keys:: Defining a key with a keymap as its definition. | |
24 * Active Keymaps:: Each buffer has a local keymap | |
25 to override the standard (global) bindings. | |
26 A minor mode can also override them. | |
27 * Key Lookup:: How extracting elements from keymaps works. | |
28 * Functions for Key Lookup:: How to request key lookup. | |
29 * Changing Key Bindings:: Redefining a key in a keymap. | |
30 * Key Binding Commands:: Interactive interfaces for redefining keys. | |
31 * Scanning Keymaps:: Looking through all keymaps, for printing help. | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
32 * Menu Keymaps:: Defining a menu as a keymap. |
6558 | 33 @end menu |
34 | |
35 @node Keymap Terminology | |
36 @section Keymap Terminology | |
37 @cindex key | |
38 @cindex keystroke | |
39 @cindex key binding | |
40 @cindex binding of a key | |
41 @cindex complete key | |
42 @cindex undefined key | |
43 | |
44 A @dfn{keymap} is a table mapping event types to definitions (which | |
45 can be any Lisp objects, though only certain types are meaningful for | |
46 execution by the command loop). Given an event (or an event type) and a | |
47 keymap, Emacs can get the event's definition. Events include ordinary | |
48 @sc{ASCII} characters, function keys, and mouse actions (@pxref{Input | |
49 Events}). | |
50 | |
51 A sequence of input events that form a unit is called a | |
52 @dfn{key sequence}, or @dfn{key} for short. A sequence of one event | |
53 is always a key sequence, and so are some multi-event sequences. | |
54 | |
55 A keymap determines a binding or definition for any key sequence. If | |
56 the key sequence is a single event, its binding is the definition of the | |
57 event in the keymap. The binding of a key sequence of more than one | |
58 event is found by an iterative process: the binding of the first event | |
59 is found, and must be a keymap; then the second event's binding is found | |
60 in that keymap, and so on until all the events in the key sequence are | |
61 used up. | |
62 | |
63 If the binding of a key sequence is a keymap, we call the key sequence | |
64 a @dfn{prefix key}. Otherwise, we call it a @dfn{complete key} (because | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
65 no more events can be added to it). If the binding is @code{nil}, |
6558 | 66 we call the key @dfn{undefined}. Examples of prefix keys are @kbd{C-c}, |
67 @kbd{C-x}, and @kbd{C-x 4}. Examples of defined complete keys are | |
68 @kbd{X}, @key{RET}, and @kbd{C-x 4 C-f}. Examples of undefined complete | |
69 keys are @kbd{C-x C-g}, and @kbd{C-c 3}. @xref{Prefix Keys}, for more | |
70 details. | |
71 | |
72 The rule for finding the binding of a key sequence assumes that the | |
73 intermediate bindings (found for the events before the last) are all | |
74 keymaps; if this is not so, the sequence of events does not form a | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
75 unit---it is not really one key sequence. In other words, removing one |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
76 or more events from the end of any valid key sequence must always yield |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
77 a prefix key. For example, @kbd{C-f C-n} is not a key sequence; |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
78 @kbd{C-f} is not a prefix key, so a longer sequence starting with |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
79 @kbd{C-f} cannot be a key sequence. |
6558 | 80 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
81 The set of possible multi-event key sequences depends on the bindings |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
82 for prefix keys; therefore, it can be different for different keymaps, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
83 and can change when bindings are changed. However, a one-event sequence |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
84 is always a key sequence, because it does not depend on any prefix keys |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
85 for its well-formedness. |
6558 | 86 |
87 At any time, several primary keymaps are @dfn{active}---that is, in | |
88 use for finding key bindings. These are the @dfn{global map}, which is | |
89 shared by all buffers; the @dfn{local keymap}, which is usually | |
90 associated with a specific major mode; and zero or more @dfn{minor mode | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
91 keymaps}, which belong to currently enabled minor modes. (Not all minor |
6558 | 92 modes have keymaps.) The local keymap bindings shadow (i.e., take |
93 precedence over) the corresponding global bindings. The minor mode | |
94 keymaps shadow both local and global keymaps. @xref{Active Keymaps}, | |
95 for details. | |
96 | |
97 @node Format of Keymaps | |
98 @section Format of Keymaps | |
99 @cindex format of keymaps | |
100 @cindex keymap format | |
101 @cindex full keymap | |
102 @cindex sparse keymap | |
103 | |
104 A keymap is a list whose @sc{car} is the symbol @code{keymap}. The | |
105 remaining elements of the list define the key bindings of the keymap. | |
106 Use the function @code{keymapp} (see below) to test whether an object is | |
107 a keymap. | |
108 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
109 Several kinds of elements may appear in a keymap, after the symbol |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
110 @code{keymap} that begins it: |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
111 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
112 @table @code |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
113 @item (@var{type} .@: @var{binding}) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
114 This specifies one binding, for events of type @var{type}. Each |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
115 ordinary binding applies to events of a particular @dfn{event type}, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
116 which is always a character or a symbol. @xref{Classifying Events}. |
6558 | 117 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
118 @item (t .@: @var{binding}) |
6558 | 119 @cindex default key binding |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
120 This specifies a @dfn{default key binding}; any event not bound by other |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
121 elements of the keymap is given @var{binding} as its binding. Default |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
122 bindings allow a keymap to bind all possible event types without having |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
123 to enumerate all of them. A keymap that has a default binding |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
124 completely masks any lower-precedence keymap. |
6558 | 125 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
126 @item @var{vector} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
127 If an element of a keymap is a vector, the vector counts as bindings for |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
128 all the @sc{ASCII} characters; vector element @var{n} is the binding for |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
129 the character with code @var{n}. This is a compact way to record lots |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
130 of bindings. A keymap with such a vector is called a @dfn{full keymap}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
131 Other keymaps are called @dfn{sparse keymaps}. |
6558 | 132 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
133 When a keymap contains a vector, it always defines a binding for each |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
134 @sc{ASCII} character, even if the vector contains @code{nil} for that |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
135 character. Such a binding of @code{nil} overrides any default binding |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
136 in the keymap. However, default bindings are still meaningful for |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
137 events that are not @sc{ASCII} characters. A binding of @code{nil} does |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
138 @emph{not} override lower-precedence keymaps; thus, if the local map |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
139 gives a binding of @code{nil}, Emacs uses the binding from the global |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
140 map. |
6558 | 141 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
142 @item @var{string} |
6558 | 143 @cindex keymap prompt string |
144 @cindex overall prompt string | |
145 @cindex prompt string of keymap | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
146 Aside from bindings, a keymap can also have a string as an element. |
6558 | 147 This is called the @dfn{overall prompt string} and makes it possible to |
148 use the keymap as a menu. @xref{Menu Keymaps}. | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
149 @end table |
6558 | 150 |
151 @cindex meta characters lookup | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
152 Keymaps do not directly record bindings for the meta characters. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
153 Instead, meta characters are regarded for |
6558 | 154 purposes of key lookup as sequences of two characters, the first of |
155 which is @key{ESC} (or whatever is currently the value of | |
156 @code{meta-prefix-char}). Thus, the key @kbd{M-a} is really represented | |
157 as @kbd{@key{ESC} a}, and its global binding is found at the slot for | |
158 @kbd{a} in @code{esc-map} (@pxref{Prefix Keys}). | |
159 | |
160 Here as an example is the local keymap for Lisp mode, a sparse | |
161 keymap. It defines bindings for @key{DEL} and @key{TAB}, plus @kbd{C-c | |
162 C-l}, @kbd{M-C-q}, and @kbd{M-C-x}. | |
163 | |
164 @example | |
165 @group | |
166 lisp-mode-map | |
167 @result{} | |
168 @end group | |
169 @group | |
170 (keymap | |
171 ;; @key{TAB} | |
172 (9 . lisp-indent-line) | |
173 @end group | |
174 @group | |
175 ;; @key{DEL} | |
176 (127 . backward-delete-char-untabify) | |
177 @end group | |
178 @group | |
179 (3 keymap | |
180 ;; @kbd{C-c C-l} | |
181 (12 . run-lisp)) | |
182 @end group | |
183 @group | |
184 (27 keymap | |
185 ;; @r{@kbd{M-C-q}, treated as @kbd{@key{ESC} C-q}} | |
186 (17 . indent-sexp) | |
187 ;; @r{@kbd{M-C-x}, treated as @kbd{@key{ESC} C-x}} | |
188 (24 . lisp-send-defun))) | |
189 @end group | |
190 @end example | |
191 | |
192 @defun keymapp object | |
193 This function returns @code{t} if @var{object} is a keymap, @code{nil} | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
194 otherwise. More precisely, this function tests for a list whose |
6558 | 195 @sc{car} is @code{keymap}. |
196 | |
197 @example | |
198 @group | |
199 (keymapp '(keymap)) | |
200 @result{} t | |
201 @end group | |
202 @group | |
203 (keymapp (current-global-map)) | |
204 @result{} t | |
205 @end group | |
206 @end example | |
207 @end defun | |
208 | |
209 @node Creating Keymaps | |
210 @section Creating Keymaps | |
211 @cindex creating keymaps | |
212 | |
213 Here we describe the functions for creating keymaps. | |
214 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
215 @c ??? This should come after make-sparse-keymap |
6558 | 216 @defun make-keymap &optional prompt |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
217 This function creates and returns a new full keymap (i.e., one |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
218 containing a vector of length 128 for defining all the @sc{ASCII} |
6558 | 219 characters). The new keymap initially binds all @sc{ASCII} characters |
220 to @code{nil}, and does not bind any other kind of event. | |
221 | |
222 @example | |
223 @group | |
224 (make-keymap) | |
225 @result{} (keymap [nil nil nil @dots{} nil nil]) | |
226 @end group | |
227 @end example | |
228 | |
229 If you specify @var{prompt}, that becomes the overall prompt string for | |
230 the keymap. The prompt string is useful for menu keymaps (@pxref{Menu | |
231 Keymaps}). | |
232 @end defun | |
233 | |
234 @defun make-sparse-keymap &optional prompt | |
235 This function creates and returns a new sparse keymap with no entries. | |
236 The new keymap does not bind any events. The argument @var{prompt} | |
237 specifies a prompt string, as in @code{make-keymap}. | |
238 | |
239 @example | |
240 @group | |
241 (make-sparse-keymap) | |
242 @result{} (keymap) | |
243 @end group | |
244 @end example | |
245 @end defun | |
246 | |
247 @defun copy-keymap keymap | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
248 This function returns a copy of @var{keymap}. Any keymaps that |
6558 | 249 appear directly as bindings in @var{keymap} are also copied recursively, |
250 and so on to any number of levels. However, recursive copying does not | |
251 take place when the definition of a character is a symbol whose function | |
252 definition is a keymap; the same symbol appears in the new copy. | |
253 @c Emacs 19 feature | |
254 | |
255 @example | |
256 @group | |
257 (setq map (copy-keymap (current-local-map))) | |
258 @result{} (keymap | |
259 @end group | |
260 @group | |
261 ;; @r{(This implements meta characters.)} | |
262 (27 keymap | |
263 (83 . center-paragraph) | |
264 (115 . center-line)) | |
265 (9 . tab-to-tab-stop)) | |
266 @end group | |
267 | |
268 @group | |
269 (eq map (current-local-map)) | |
270 @result{} nil | |
271 @end group | |
272 @group | |
273 (equal map (current-local-map)) | |
274 @result{} t | |
275 @end group | |
276 @end example | |
277 @end defun | |
278 | |
279 @node Inheritance and Keymaps | |
280 @section Inheritance and Keymaps | |
281 @cindex keymap inheritance | |
282 @cindex inheriting a keymap's bindings | |
283 | |
15766
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
284 A keymap can inherit the bindings of another keymap, which we call the |
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
285 @dfn{parent keymap}. Such a keymap looks like this: |
6558 | 286 |
287 @example | |
15766
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
288 (keymap @var{bindings}@dots{} . @var{parent-keymap}) |
6558 | 289 @end example |
290 | |
291 @noindent | |
292 The effect is that this keymap inherits all the bindings of | |
15766
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
293 @var{parent-keymap}, whatever they may be at the time a key is looked up, |
6558 | 294 but can add to them or override them with @var{bindings}. |
295 | |
15766
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
296 If you change the bindings in @var{parent-keymap} using @code{define-key} |
6558 | 297 or other key-binding functions, these changes are visible in the |
298 inheriting keymap unless shadowed by @var{bindings}. The converse is | |
299 not true: if you use @code{define-key} to change the inheriting keymap, | |
15766
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
300 that affects @var{bindings}, but has no effect on @var{parent-keymap}. |
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
301 |
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
302 The proper way to construct a keymap with a parent is to use |
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
303 @code{set-keymap-parent}; if you have code that directly constructs a |
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
304 keymap with a parent, please convert the program to use |
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
305 @code{set-keymap-parent} instead. |
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
306 |
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
307 @defun keymap-parent keymap |
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
308 This returns the parent keymap of @var{keymap}. If @var{keymap} |
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
309 has no parent, @code{keymap-parent} returns @code{nil}. |
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
310 @end defun |
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
311 |
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
312 @defun set-keymap-parent keymap parent |
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
313 This sets the parent keymap of @var{keymap} to @var{parent}, and returns |
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
314 @var{parent}. If @var{parent} is @code{nil}, this function gives |
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
315 @var{keymap} no parent at all. |
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
316 |
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
317 If @var{keymap} has submaps (bindings for prefix keys), they too receive |
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
318 new parent keymaps that reflect what @var{parent} specifies for those |
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
319 prefix keys. |
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
320 @end defun |
6558 | 321 |
322 Here is an example showing how to make a keymap that inherits | |
323 from @code{text-mode-map}: | |
324 | |
325 @example | |
15766
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
326 (let ((map (make-sparse-keymap))) |
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
327 (set-keymap-parent map text-mode-map) |
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
328 map) |
6558 | 329 @end example |
330 | |
331 @node Prefix Keys | |
332 @section Prefix Keys | |
333 @cindex prefix key | |
334 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
335 A @dfn{prefix key} is a key sequence whose binding is a keymap. The |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
336 keyamp defines what to do with key sequences that extend the prefix key. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
337 For example, @kbd{C-x} is a prefix key, and it uses a keymap that is |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
338 also stored in the variable @code{ctl-x-map}. This keymap defines |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
339 bindings for key sequences starting with @kbd{C-x}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
340 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
341 Here is a list of the standard prefix keys of Emacs and their keymaps: |
6558 | 342 |
343 @itemize @bullet | |
344 @item | |
345 @vindex esc-map | |
346 @findex ESC-prefix | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
347 @code{esc-map} is the global keymap for the @key{ESC} prefix key. Thus, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
348 the global definitions of all meta characters are actually found here. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
349 This map is also the function definition of @code{ESC-prefix}. |
6558 | 350 |
351 @item | |
352 @cindex @kbd{C-h} | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
353 @code{help-map} is the global definitions for the @kbd{C-h} prefix key. |
6558 | 354 |
355 @item | |
356 @cindex @kbd{C-c} | |
357 @vindex mode-specific-map | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
358 @code{mode-specific-map} is the global keymap for the prefix key |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
359 @kbd{C-c}. This map is actually global, not mode-specific, but its name |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
360 provides useful information about @kbd{C-c} in the output of @kbd{C-h b} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
361 (@code{display-bindings}), since the main use of this prefix key is for |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
362 mode-specific bindings. |
6558 | 363 |
364 @item | |
365 @cindex @kbd{C-x} | |
366 @vindex ctl-x-map | |
367 @findex Control-X-prefix | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
368 @code{ctl-x-map} is the global key map used for the @kbd{C-x} prefix |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
369 key. This map is found via the function definition of the symbol |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
370 @code{Control-X-prefix}. |
6558 | 371 |
372 @item | |
373 @cindex @kbd{C-x 4} | |
374 @vindex ctl-x-4-map | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
375 @code{ctl-x-4-map} is the global keymap used for the @kbd{C-x 4} prefix |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
376 key. |
6558 | 377 |
378 @c Emacs 19 feature | |
379 @item | |
380 @cindex @kbd{C-x 5} | |
381 @vindex ctl-x-5-map | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
382 @code{ctl-x-5-map} is the global keymap used for the @kbd{C-x 5} prefix |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
383 key. |
6558 | 384 |
385 @c Emacs 19 feature | |
386 @item | |
387 @cindex @kbd{C-x n} | |
388 @cindex @kbd{C-x r} | |
389 @cindex @kbd{C-x a} | |
390 The prefix keys @kbd{C-x n}, @kbd{C-x r} and @kbd{C-x a} use keymaps | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
391 that have no special names. |
6558 | 392 @end itemize |
393 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
394 The keymap binding of a prefix key is used for looking up the event |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
395 that follows the prefix key. (It may instead be a symbol whose function |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
396 definition is a keymap. The effect is the same, but the symbol serves |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
397 as a name for the prefix key.) Thus, the binding of @kbd{C-x} is the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
398 symbol @code{Control-X-prefix}, whose function definition is the keymap |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
399 for @kbd{C-x} commands. (The same keymap is also the value of |
6558 | 400 @code{ctl-x-map}.) |
401 | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
402 Prefix key definitions can appear in any active keymap. The |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
403 definitions of @kbd{C-c}, @kbd{C-x}, @kbd{C-h} and @key{ESC} as prefix |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
404 keys appear in the global map, so these prefix keys are always |
6558 | 405 available. Major and minor modes can redefine a key as a prefix by |
406 putting a prefix key definition for it in the local map or the minor | |
407 mode's map. @xref{Active Keymaps}. | |
408 | |
409 If a key is defined as a prefix in more than one active map, then its | |
410 various definitions are in effect merged: the commands defined in the | |
411 minor mode keymaps come first, followed by those in the local map's | |
412 prefix definition, and then by those from the global map. | |
413 | |
414 In the following example, we make @kbd{C-p} a prefix key in the local | |
415 keymap, in such a way that @kbd{C-p} is identical to @kbd{C-x}. Then | |
416 the binding for @kbd{C-p C-f} is the function @code{find-file}, just | |
417 like @kbd{C-x C-f}. The key sequence @kbd{C-p 6} is not found in any | |
418 active keymap. | |
419 | |
420 @example | |
421 @group | |
422 (use-local-map (make-sparse-keymap)) | |
423 @result{} nil | |
424 @end group | |
425 @group | |
426 (local-set-key "\C-p" ctl-x-map) | |
427 @result{} nil | |
428 @end group | |
429 @group | |
430 (key-binding "\C-p\C-f") | |
431 @result{} find-file | |
432 @end group | |
433 | |
434 @group | |
435 (key-binding "\C-p6") | |
436 @result{} nil | |
437 @end group | |
438 @end example | |
439 | |
440 @defun define-prefix-command symbol | |
441 @cindex prefix command | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
442 This function prepares @var{symbol} for use as a prefix key's binding: |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
443 it creates a full keymap and stores it as @var{symbol}'s function |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
444 definition. Subsequently binding a key sequence to @var{symbol} will |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
445 make that key sequence into a prefix key. |
6558 | 446 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
447 This function also sets @var{symbol} as a variable, with the keymap as |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
448 its value. It returns @var{symbol}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
449 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
450 @c In Emacs version 18, only the function definition of @var{symbol} was |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
451 @c set, not the value as a variable. |
6558 | 452 @end defun |
453 | |
454 @node Active Keymaps | |
455 @section Active Keymaps | |
456 @cindex active keymap | |
457 @cindex global keymap | |
458 @cindex local keymap | |
459 | |
460 Emacs normally contains many keymaps; at any given time, just a few of | |
461 them are @dfn{active} in that they participate in the interpretation | |
462 of user input. These are the global keymap, the current buffer's | |
463 local keymap, and the keymaps of any enabled minor modes. | |
464 | |
465 The @dfn{global keymap} holds the bindings of keys that are defined | |
466 regardless of the current buffer, such as @kbd{C-f}. The variable | |
467 @code{global-map} holds this keymap, which is always active. | |
468 | |
469 Each buffer may have another keymap, its @dfn{local keymap}, which may | |
470 contain new or overriding definitions for keys. The current buffer's | |
471 local keymap is always active except when @code{overriding-local-map} | |
472 overrides it. Text properties can specify an alternative local map for | |
473 certain parts of the buffer; see @ref{Special Properties}. | |
474 | |
475 Each minor mode may have a keymap; if it does, the keymap is active | |
476 when the minor mode is enabled. | |
477 | |
478 The variable @code{overriding-local-map}, if non-@code{nil}, specifies | |
479 another local keymap that overrides the buffer's local map and all the | |
480 minor mode keymaps. | |
481 | |
482 All the active keymaps are used together to determine what command to | |
483 execute when a key is entered. Emacs searches these maps one by one, in | |
484 order of decreasing precedence, until it finds a binding in one of the maps. | |
485 | |
486 Normally, Emacs @emph{first} searches for the key in the minor mode | |
487 maps (one map at a time); if they do not supply a binding for the key, | |
488 Emacs searches the local map; if that too has no binding, Emacs then | |
489 searches the global map. However, if @code{overriding-local-map} is | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
490 non-@code{nil}, Emacs searches that map first, before the global map. |
6558 | 491 |
492 The procedure for searching a single keymap is called | |
493 @dfn{key lookup}; see @ref{Key Lookup}. | |
494 | |
495 @cindex major mode keymap | |
496 Since every buffer that uses the same major mode normally uses the | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
497 same local keymap, you can think of the keymap as local to the mode. A |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
498 change to the local keymap of a buffer (using @code{local-set-key}, for |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
499 example) is seen also in the other buffers that share that keymap. |
6558 | 500 |
501 The local keymaps that are used for Lisp mode, C mode, and several | |
502 other major modes exist even if they have not yet been used. These | |
503 local maps are the values of the variables @code{lisp-mode-map}, | |
504 @code{c-mode-map}, and so on. For most other modes, which are less | |
505 frequently used, the local keymap is constructed only when the mode is | |
506 used for the first time in a session. | |
507 | |
508 The minibuffer has local keymaps, too; they contain various completion | |
509 and exit commands. @xref{Intro to Minibuffers}. | |
510 | |
511 @xref{Standard Keymaps}, for a list of standard keymaps. | |
512 | |
513 @defvar global-map | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
514 This variable contains the default global keymap that maps Emacs |
6558 | 515 keyboard input to commands. The global keymap is normally this keymap. |
516 The default global keymap is a full keymap that binds | |
517 @code{self-insert-command} to all of the printing characters. | |
518 | |
519 It is normal practice to change the bindings in the global map, but you | |
520 should not assign this variable any value other than the keymap it starts | |
521 out with. | |
522 @end defvar | |
523 | |
524 @defun current-global-map | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
525 This function returns the current global keymap. This is the |
6558 | 526 same as the value of @code{global-map} unless you change one or the |
527 other. | |
528 | |
529 @example | |
530 @group | |
531 (current-global-map) | |
532 @result{} (keymap [set-mark-command beginning-of-line @dots{} | |
533 delete-backward-char]) | |
534 @end group | |
535 @end example | |
536 @end defun | |
537 | |
538 @defun current-local-map | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
539 This function returns the current buffer's local keymap, or @code{nil} |
6558 | 540 if it has none. In the following example, the keymap for the |
541 @samp{*scratch*} buffer (using Lisp Interaction mode) is a sparse keymap | |
542 in which the entry for @key{ESC}, @sc{ASCII} code 27, is another sparse | |
543 keymap. | |
544 | |
545 @example | |
546 @group | |
547 (current-local-map) | |
548 @result{} (keymap | |
549 (10 . eval-print-last-sexp) | |
550 (9 . lisp-indent-line) | |
551 (127 . backward-delete-char-untabify) | |
552 @end group | |
553 @group | |
554 (27 keymap | |
555 (24 . eval-defun) | |
556 (17 . indent-sexp))) | |
557 @end group | |
558 @end example | |
559 @end defun | |
560 | |
561 @defun current-minor-mode-maps | |
562 This function returns a list of the keymaps of currently enabled minor modes. | |
563 @end defun | |
564 | |
565 @defun use-global-map keymap | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
566 This function makes @var{keymap} the new current global keymap. It |
6558 | 567 returns @code{nil}. |
568 | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
569 It is very unusual to change the global keymap. |
6558 | 570 @end defun |
571 | |
572 @defun use-local-map keymap | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
573 This function makes @var{keymap} the new local keymap of the current |
6558 | 574 buffer. If @var{keymap} is @code{nil}, then the buffer has no local |
575 keymap. @code{use-local-map} returns @code{nil}. Most major mode | |
576 commands use this function. | |
577 @end defun | |
578 | |
579 @c Emacs 19 feature | |
580 @defvar minor-mode-map-alist | |
581 This variable is an alist describing keymaps that may or may not be | |
582 active according to the values of certain variables. Its elements look | |
583 like this: | |
584 | |
585 @example | |
586 (@var{variable} . @var{keymap}) | |
587 @end example | |
588 | |
589 The keymap @var{keymap} is active whenever @var{variable} has a | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
590 non-@code{nil} value. Typically @var{variable} is the variable that |
6558 | 591 enables or disables a minor mode. @xref{Keymaps and Minor Modes}. |
592 | |
593 Note that elements of @code{minor-mode-map-alist} do not have the same | |
594 structure as elements of @code{minor-mode-alist}. The map must be the | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
595 @sc{cdr} of the element; a list with the map as the @sc{cadr} will not |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
596 do. |
6558 | 597 |
598 What's more, the keymap itself must appear in the @sc{cdr}. It does not | |
599 work to store a variable in the @sc{cdr} and make the map the value of | |
600 that variable. | |
601 | |
602 When more than one minor mode keymap is active, their order of priority | |
603 is the order of @code{minor-mode-map-alist}. But you should design | |
604 minor modes so that they don't interfere with each other. If you do | |
605 this properly, the order will not matter. | |
606 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
607 See @ref{Keymaps and Minor Modes}, for more information about minor |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
608 modes. See also @code{minor-mode-key-binding} (@pxref{Functions for Key |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
609 Lookup}). |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
610 @end defvar |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
611 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
612 @tindex minor-mode-overriding-map-alist |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
613 @defvar minor-mode-overriding-map-alist |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
614 This variable allows major modes to override the key bindings for |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
615 particular minor modes. The elements of this alist look like the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
616 elements of @code{minor-mode-map-alist}: @code{(@var{variable} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
617 . @var{keymap})}. If a variable has an element |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
618 @code{minor-mode-overriding-map-alist}. that map overrides the one in |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
619 @code{minor-mode-map-alist}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
620 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
621 @code{minor-mode-overriding-map-alist} is automatically local in all |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
622 buffers. |
6558 | 623 @end defvar |
624 | |
625 @defvar overriding-local-map | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
626 If non-@code{nil}, this variable holds a keymap to use instead of the |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
627 buffer's local keymap and instead of all the minor mode keymaps. This |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
628 keymap, if any, overrides all other maps that would have been active, |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
629 except for the current global map. |
6558 | 630 @end defvar |
631 | |
12599
284b8763066d
Document overriding-terminal-local-map.
Richard M. Stallman <rms@gnu.org>
parents:
12125
diff
changeset
|
632 @defvar overriding-terminal-local-map |
284b8763066d
Document overriding-terminal-local-map.
Richard M. Stallman <rms@gnu.org>
parents:
12125
diff
changeset
|
633 If non-@code{nil}, this variable holds a keymap to use instead of |
284b8763066d
Document overriding-terminal-local-map.
Richard M. Stallman <rms@gnu.org>
parents:
12125
diff
changeset
|
634 @code{overriding-local-map}, the buffer's local keymap and all the minor |
284b8763066d
Document overriding-terminal-local-map.
Richard M. Stallman <rms@gnu.org>
parents:
12125
diff
changeset
|
635 mode keymaps. |
284b8763066d
Document overriding-terminal-local-map.
Richard M. Stallman <rms@gnu.org>
parents:
12125
diff
changeset
|
636 |
284b8763066d
Document overriding-terminal-local-map.
Richard M. Stallman <rms@gnu.org>
parents:
12125
diff
changeset
|
637 This variable is always local to the current terminal and cannot be |
284b8763066d
Document overriding-terminal-local-map.
Richard M. Stallman <rms@gnu.org>
parents:
12125
diff
changeset
|
638 buffer-local. @xref{Multiple Displays}. It is used to implement |
284b8763066d
Document overriding-terminal-local-map.
Richard M. Stallman <rms@gnu.org>
parents:
12125
diff
changeset
|
639 incremental search mode. |
284b8763066d
Document overriding-terminal-local-map.
Richard M. Stallman <rms@gnu.org>
parents:
12125
diff
changeset
|
640 @end defvar |
284b8763066d
Document overriding-terminal-local-map.
Richard M. Stallman <rms@gnu.org>
parents:
12125
diff
changeset
|
641 |
12600
fb565b4e8c40
Update overriding-local-map-menu-flag.
Richard M. Stallman <rms@gnu.org>
parents:
12599
diff
changeset
|
642 @defvar overriding-local-map-menu-flag |
fb565b4e8c40
Update overriding-local-map-menu-flag.
Richard M. Stallman <rms@gnu.org>
parents:
12599
diff
changeset
|
643 If this variable is non-@code{nil}, the value of |
fb565b4e8c40
Update overriding-local-map-menu-flag.
Richard M. Stallman <rms@gnu.org>
parents:
12599
diff
changeset
|
644 @code{overriding-local-map} or @code{overriding-terminal-local-map} can |
fb565b4e8c40
Update overriding-local-map-menu-flag.
Richard M. Stallman <rms@gnu.org>
parents:
12599
diff
changeset
|
645 affect the display of the menu bar. The default value is @code{nil}, so |
fb565b4e8c40
Update overriding-local-map-menu-flag.
Richard M. Stallman <rms@gnu.org>
parents:
12599
diff
changeset
|
646 those map variables have no effect on the menu bar. |
fb565b4e8c40
Update overriding-local-map-menu-flag.
Richard M. Stallman <rms@gnu.org>
parents:
12599
diff
changeset
|
647 |
fb565b4e8c40
Update overriding-local-map-menu-flag.
Richard M. Stallman <rms@gnu.org>
parents:
12599
diff
changeset
|
648 Note that these two map variables do affect the execution of key |
fb565b4e8c40
Update overriding-local-map-menu-flag.
Richard M. Stallman <rms@gnu.org>
parents:
12599
diff
changeset
|
649 sequences entered using the menu bar, even if they do not affect the |
fb565b4e8c40
Update overriding-local-map-menu-flag.
Richard M. Stallman <rms@gnu.org>
parents:
12599
diff
changeset
|
650 menu bar display. So if a menu bar key sequence comes in, you should |
fb565b4e8c40
Update overriding-local-map-menu-flag.
Richard M. Stallman <rms@gnu.org>
parents:
12599
diff
changeset
|
651 clear the variables before looking up and executing that key sequence. |
fb565b4e8c40
Update overriding-local-map-menu-flag.
Richard M. Stallman <rms@gnu.org>
parents:
12599
diff
changeset
|
652 Modes that use the variables would typically do this anyway; normally |
fb565b4e8c40
Update overriding-local-map-menu-flag.
Richard M. Stallman <rms@gnu.org>
parents:
12599
diff
changeset
|
653 they respond to events that they do not handle by ``unreading'' them and |
fb565b4e8c40
Update overriding-local-map-menu-flag.
Richard M. Stallman <rms@gnu.org>
parents:
12599
diff
changeset
|
654 exiting. |
fb565b4e8c40
Update overriding-local-map-menu-flag.
Richard M. Stallman <rms@gnu.org>
parents:
12599
diff
changeset
|
655 @end defvar |
fb565b4e8c40
Update overriding-local-map-menu-flag.
Richard M. Stallman <rms@gnu.org>
parents:
12599
diff
changeset
|
656 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
657 @defvar special-event-map |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
658 This variable holds a keymap for special events. If an event type has a |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
659 binding in this keymap, then it is special, and the binding for the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
660 event is run directly by @code{read-event}. @xref{Special Events}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
661 @end defvar |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
662 |
6558 | 663 @node Key Lookup |
664 @section Key Lookup | |
665 @cindex key lookup | |
666 @cindex keymap entry | |
667 | |
668 @dfn{Key lookup} is the process of finding the binding of a key | |
669 sequence from a given keymap. Actual execution of the binding is not | |
670 part of key lookup. | |
671 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
672 Key lookup uses just the event type of each event in the key sequence; |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
673 the rest of the event is ignored. In fact, a key sequence used for key |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
674 lookup may designate mouse events with just their types (symbols) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
675 instead of with entire mouse events (lists). @xref{Input Events}. Such |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
676 a ``key-sequence'' is insufficient for @code{command-execute} to run, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
677 but it is sufficient for looking up or rebinding a key. |
6558 | 678 |
679 When the key sequence consists of multiple events, key lookup | |
680 processes the events sequentially: the binding of the first event is | |
681 found, and must be a keymap; then the second event's binding is found in | |
682 that keymap, and so on until all the events in the key sequence are used | |
683 up. (The binding thus found for the last event may or may not be a | |
684 keymap.) Thus, the process of key lookup is defined in terms of a | |
685 simpler process for looking up a single event in a keymap. How that is | |
686 done depends on the type of object associated with the event in that | |
687 keymap. | |
688 | |
689 Let's use the term @dfn{keymap entry} to describe the value found by | |
690 looking up an event type in a keymap. (This doesn't include the item | |
691 string and other extra elements in menu key bindings because | |
692 @code{lookup-key} and other key lookup functions don't include them in | |
693 the returned value.) While any Lisp object may be stored in a keymap as | |
694 a keymap entry, not all make sense for key lookup. Here is a list of | |
695 the meaningful kinds of keymap entries: | |
696 | |
697 @table @asis | |
698 @item @code{nil} | |
699 @cindex @code{nil} in keymap | |
700 @code{nil} means that the events used so far in the lookup form an | |
701 undefined key. When a keymap fails to mention an event type at all, and | |
702 has no default binding, that is equivalent to a binding of @code{nil} | |
703 for that event type. | |
704 | |
705 @item @var{keymap} | |
706 @cindex keymap in keymap | |
707 The events used so far in the lookup form a prefix key. The next | |
708 event of the key sequence is looked up in @var{keymap}. | |
709 | |
710 @item @var{command} | |
711 @cindex command in keymap | |
712 The events used so far in the lookup form a complete key, | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
713 and @var{command} is its binding. @xref{What Is a Function}. |
6558 | 714 |
12098 | 715 @item @var{array} |
6558 | 716 @cindex string in keymap |
12098 | 717 The array (either a string or a vector) is a keyboard macro. The events |
718 used so far in the lookup form a complete key, and the array is its | |
719 binding. See @ref{Keyboard Macros}, for more information. | |
6558 | 720 |
721 @item @var{list} | |
722 @cindex list in keymap | |
723 The meaning of a list depends on the types of the elements of the list. | |
724 | |
725 @itemize @bullet | |
726 @item | |
727 If the @sc{car} of @var{list} is the symbol @code{keymap}, then the list | |
728 is a keymap, and is treated as a keymap (see above). | |
729 | |
730 @item | |
731 @cindex @code{lambda} in keymap | |
732 If the @sc{car} of @var{list} is @code{lambda}, then the list is a | |
733 lambda expression. This is presumed to be a command, and is treated as | |
734 such (see above). | |
735 | |
736 @item | |
737 If the @sc{car} of @var{list} is a keymap and the @sc{cdr} is an event | |
738 type, then this is an @dfn{indirect entry}: | |
739 | |
740 @example | |
741 (@var{othermap} . @var{othertype}) | |
742 @end example | |
743 | |
744 When key lookup encounters an indirect entry, it looks up instead the | |
745 binding of @var{othertype} in @var{othermap} and uses that. | |
746 | |
747 This feature permits you to define one key as an alias for another key. | |
748 For example, an entry whose @sc{car} is the keymap called @code{esc-map} | |
12098 | 749 and whose @sc{cdr} is 32 (the code for @key{SPC}) means, ``Use the global |
6558 | 750 binding of @kbd{Meta-@key{SPC}}, whatever that may be.'' |
751 @end itemize | |
752 | |
753 @item @var{symbol} | |
754 @cindex symbol in keymap | |
755 The function definition of @var{symbol} is used in place of | |
756 @var{symbol}. If that too is a symbol, then this process is repeated, | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
757 any number of times. Ultimately this should lead to an object that is |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
758 a keymap, a command, or a keyboard macro. A list is allowed if it is a |
6558 | 759 keymap or a command, but indirect entries are not understood when found |
760 via symbols. | |
761 | |
762 Note that keymaps and keyboard macros (strings and vectors) are not | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
763 valid functions, so a symbol with a keymap, string, or vector as its |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
764 function definition is invalid as a function. It is, however, valid as |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
765 a key binding. If the definition is a keyboard macro, then the symbol |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
766 is also valid as an argument to @code{command-execute} |
6558 | 767 (@pxref{Interactive Call}). |
768 | |
769 @cindex @code{undefined} in keymap | |
770 The symbol @code{undefined} is worth special mention: it means to treat | |
771 the key as undefined. Strictly speaking, the key is defined, and its | |
772 binding is the command @code{undefined}; but that command does the same | |
773 thing that is done automatically for an undefined key: it rings the bell | |
774 (by calling @code{ding}) but does not signal an error. | |
775 | |
776 @cindex preventing prefix key | |
777 @code{undefined} is used in local keymaps to override a global key | |
778 binding and make the key ``undefined'' locally. A local binding of | |
779 @code{nil} would fail to do this because it would not override the | |
780 global binding. | |
781 | |
782 @item @var{anything else} | |
783 If any other type of object is found, the events used so far in the | |
784 lookup form a complete key, and the object is its binding, but the | |
785 binding is not executable as a command. | |
786 @end table | |
787 | |
788 In short, a keymap entry may be a keymap, a command, a keyboard macro, | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
789 a symbol that leads to one of them, or an indirection or @code{nil}. |
6558 | 790 Here is an example of a sparse keymap with two characters bound to |
791 commands and one bound to another keymap. This map is the normal value | |
792 of @code{emacs-lisp-mode-map}. Note that 9 is the code for @key{TAB}, | |
793 127 for @key{DEL}, 27 for @key{ESC}, 17 for @kbd{C-q} and 24 for | |
794 @kbd{C-x}. | |
795 | |
796 @example | |
797 @group | |
798 (keymap (9 . lisp-indent-line) | |
799 (127 . backward-delete-char-untabify) | |
800 (27 keymap (17 . indent-sexp) (24 . eval-defun))) | |
801 @end group | |
802 @end example | |
803 | |
804 @node Functions for Key Lookup | |
805 @section Functions for Key Lookup | |
806 | |
807 Here are the functions and variables pertaining to key lookup. | |
808 | |
809 @defun lookup-key keymap key &optional accept-defaults | |
810 This function returns the definition of @var{key} in @var{keymap}. If | |
811 the string or vector @var{key} is not a valid key sequence according to | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
812 the prefix keys specified in @var{keymap}, it must be ``too long'' and |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
813 have extra events at the end that do not fit into a single key sequence. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
814 Then the value is a number, the number of events at the front of |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
815 @var{key} that compose a complete key. |
6558 | 816 |
817 @c Emacs 19 feature | |
818 If @var{accept-defaults} is non-@code{nil}, then @code{lookup-key} | |
819 considers default bindings as well as bindings for the specific events | |
820 in @var{key}. Otherwise, @code{lookup-key} reports only bindings for | |
821 the specific sequence @var{key}, ignoring default bindings except when | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
822 you explicitly ask about them. (To do this, supply @code{t} as an |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
823 element of @var{key}; see @ref{Format of Keymaps}.) |
6558 | 824 |
825 All the other functions described in this chapter that look up keys use | |
826 @code{lookup-key}. | |
827 | |
828 @example | |
829 @group | |
830 (lookup-key (current-global-map) "\C-x\C-f") | |
831 @result{} find-file | |
832 @end group | |
833 @group | |
834 (lookup-key (current-global-map) "\C-x\C-f12345") | |
835 @result{} 2 | |
836 @end group | |
837 @end example | |
838 | |
839 If @var{key} contains a meta character, that character is implicitly | |
840 replaced by a two-character sequence: the value of | |
841 @code{meta-prefix-char}, followed by the corresponding non-meta | |
842 character. Thus, the first example below is handled by conversion into | |
843 the second example. | |
844 | |
845 @example | |
846 @group | |
847 (lookup-key (current-global-map) "\M-f") | |
848 @result{} forward-word | |
849 @end group | |
850 @group | |
851 (lookup-key (current-global-map) "\ef") | |
852 @result{} forward-word | |
853 @end group | |
854 @end example | |
855 | |
856 Unlike @code{read-key-sequence}, this function does not modify the | |
857 specified events in ways that discard information (@pxref{Key Sequence | |
858 Input}). In particular, it does not convert letters to lower case and | |
859 it does not change drag events to clicks. | |
860 @end defun | |
861 | |
862 @deffn Command undefined | |
863 Used in keymaps to undefine keys. It calls @code{ding}, but does | |
864 not cause an error. | |
865 @end deffn | |
866 | |
867 @defun key-binding key &optional accept-defaults | |
868 This function returns the binding for @var{key} in the current | |
869 keymaps, trying all the active keymaps. The result is @code{nil} if | |
870 @var{key} is undefined in the keymaps. | |
871 | |
872 @c Emacs 19 feature | |
873 The argument @var{accept-defaults} controls checking for default | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
874 bindings, as in @code{lookup-key} (above). |
6558 | 875 |
876 An error is signaled if @var{key} is not a string or a vector. | |
877 | |
878 @example | |
879 @group | |
880 (key-binding "\C-x\C-f") | |
881 @result{} find-file | |
882 @end group | |
883 @end example | |
884 @end defun | |
885 | |
886 @defun local-key-binding key &optional accept-defaults | |
887 This function returns the binding for @var{key} in the current | |
888 local keymap, or @code{nil} if it is undefined there. | |
889 | |
890 @c Emacs 19 feature | |
891 The argument @var{accept-defaults} controls checking for default bindings, | |
892 as in @code{lookup-key} (above). | |
893 @end defun | |
894 | |
895 @defun global-key-binding key &optional accept-defaults | |
896 This function returns the binding for command @var{key} in the | |
897 current global keymap, or @code{nil} if it is undefined there. | |
898 | |
899 @c Emacs 19 feature | |
900 The argument @var{accept-defaults} controls checking for default bindings, | |
901 as in @code{lookup-key} (above). | |
902 @end defun | |
903 | |
904 @c Emacs 19 feature | |
905 @defun minor-mode-key-binding key &optional accept-defaults | |
906 This function returns a list of all the active minor mode bindings of | |
907 @var{key}. More precisely, it returns an alist of pairs | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
908 @code{(@var{modename} . @var{binding})}, where @var{modename} is the |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
909 variable that enables the minor mode, and @var{binding} is @var{key}'s |
6558 | 910 binding in that mode. If @var{key} has no minor-mode bindings, the |
911 value is @code{nil}. | |
912 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
913 If the first binding found is not a prefix definition (a keymap or a |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
914 symbol defined as a keymap), all subsequent bindings from other minor |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
915 modes are omitted, since they would be completely shadowed. Similarly, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
916 the list omits non-prefix bindings that follow prefix bindings. |
6558 | 917 |
918 The argument @var{accept-defaults} controls checking for default | |
919 bindings, as in @code{lookup-key} (above). | |
920 @end defun | |
921 | |
922 @defvar meta-prefix-char | |
923 @cindex @key{ESC} | |
924 This variable is the meta-prefix character code. It is used when | |
925 translating a meta character to a two-character sequence so it can be | |
926 looked up in a keymap. For useful results, the value should be a prefix | |
927 event (@pxref{Prefix Keys}). The default value is 27, which is the | |
928 @sc{ASCII} code for @key{ESC}. | |
929 | |
930 As long as the value of @code{meta-prefix-char} remains 27, key | |
931 lookup translates @kbd{M-b} into @kbd{@key{ESC} b}, which is normally | |
932 defined as the @code{backward-word} command. However, if you set | |
933 @code{meta-prefix-char} to 24, the code for @kbd{C-x}, then Emacs will | |
934 translate @kbd{M-b} into @kbd{C-x b}, whose standard binding is the | |
935 @code{switch-to-buffer} command. | |
936 | |
937 @smallexample | |
938 @group | |
939 meta-prefix-char ; @r{The default value.} | |
940 @result{} 27 | |
941 @end group | |
942 @group | |
943 (key-binding "\M-b") | |
944 @result{} backward-word | |
945 @end group | |
946 @group | |
947 ?\C-x ; @r{The print representation} | |
948 @result{} 24 ; @r{of a character.} | |
949 @end group | |
950 @group | |
951 (setq meta-prefix-char 24) | |
952 @result{} 24 | |
953 @end group | |
954 @group | |
955 (key-binding "\M-b") | |
956 @result{} switch-to-buffer ; @r{Now, typing @kbd{M-b} is} | |
957 ; @r{like typing @kbd{C-x b}.} | |
958 | |
959 (setq meta-prefix-char 27) ; @r{Avoid confusion!} | |
960 @result{} 27 ; @r{Restore the default value!} | |
961 @end group | |
962 @end smallexample | |
963 @end defvar | |
964 | |
965 @node Changing Key Bindings | |
966 @section Changing Key Bindings | |
967 @cindex changing key bindings | |
968 @cindex rebinding | |
969 | |
970 The way to rebind a key is to change its entry in a keymap. If you | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
971 change a binding in the global keymap, the change is effective in all |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
972 buffers (though it has no direct effect in buffers that shadow the |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
973 global binding with a local one). If you change the current buffer's |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
974 local map, that usually affects all buffers using the same major mode. |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
975 The @code{global-set-key} and @code{local-set-key} functions are |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
976 convenient interfaces for these operations (@pxref{Key Binding |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
977 Commands}). You can also use @code{define-key}, a more general |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
978 function; then you must specify explicitly the map to change. |
6558 | 979 |
980 @cindex meta character key constants | |
981 @cindex control character key constants | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
982 In writing the key sequence to rebind, it is good to use the special |
6558 | 983 escape sequences for control and meta characters (@pxref{String Type}). |
984 The syntax @samp{\C-} means that the following character is a control | |
985 character and @samp{\M-} means that the following character is a meta | |
986 character. Thus, the string @code{"\M-x"} is read as containing a | |
987 single @kbd{M-x}, @code{"\C-f"} is read as containing a single | |
988 @kbd{C-f}, and @code{"\M-\C-x"} and @code{"\C-\M-x"} are both read as | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
989 containing a single @kbd{C-M-x}. You can also use this escape syntax in |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
990 vectors, as well as others that aren't allowed in strings; one example |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
991 is @samp{[?\C-\H-x home]}. @xref{Character Type}. |
6558 | 992 |
12067 | 993 The key definition and lookup functions accept an alternate syntax for |
994 event types in a key sequence that is a vector: you can use a list | |
995 containing modifier names plus one base event (a character or function | |
996 key name). For example, @code{(control ?a)} is equivalent to | |
997 @code{?\C-a} and @code{(hyper control left)} is equivalent to | |
998 @code{C-H-left}. | |
999 | |
12098 | 1000 One advantage of using a list to represent the event type is that the |
1001 precise numeric codes for the modifier bits don't appear in compiled | |
1002 files. | |
1003 | |
6558 | 1004 For the functions below, an error is signaled if @var{keymap} is not a |
1005 keymap or if @var{key} is not a string or vector representing a key | |
1006 sequence. You can use event types (symbols) as shorthand for events | |
1007 that are lists. | |
1008 | |
1009 @defun define-key keymap key binding | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1010 This function sets the binding for @var{key} in @var{keymap}. (If |
6558 | 1011 @var{key} is more than one event long, the change is actually made |
1012 in another keymap reached from @var{keymap}.) The argument | |
1013 @var{binding} can be any Lisp object, but only certain types are | |
1014 meaningful. (For a list of meaningful types, see @ref{Key Lookup}.) | |
1015 The value returned by @code{define-key} is @var{binding}. | |
1016 | |
1017 @cindex invalid prefix key error | |
1018 @cindex key sequence error | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1019 Every prefix of @var{key} must be a prefix key (i.e., bound to a |
6558 | 1020 keymap) or undefined; otherwise an error is signaled. |
1021 | |
1022 If some prefix of @var{key} is undefined, then @code{define-key} defines | |
1023 it as a prefix key so that the rest of @var{key} may be defined as | |
1024 specified. | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1025 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1026 If there was previously no binding for @var{key} in @var{keymap}, the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1027 new binding is added at the beginning of @var{keymap}. The order of |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1028 bindings in a keymap makes no difference in most cases, but it does |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1029 matter for menu keymaps (@pxref{Menu Keymaps}). |
6558 | 1030 @end defun |
1031 | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1032 Here is an example that creates a sparse keymap and makes a number of |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1033 bindings in it: |
6558 | 1034 |
1035 @smallexample | |
1036 @group | |
1037 (setq map (make-sparse-keymap)) | |
1038 @result{} (keymap) | |
1039 @end group | |
1040 @group | |
1041 (define-key map "\C-f" 'forward-char) | |
1042 @result{} forward-char | |
1043 @end group | |
1044 @group | |
1045 map | |
1046 @result{} (keymap (6 . forward-char)) | |
1047 @end group | |
1048 | |
1049 @group | |
1050 ;; @r{Build sparse submap for @kbd{C-x} and bind @kbd{f} in that.} | |
1051 (define-key map "\C-xf" 'forward-word) | |
1052 @result{} forward-word | |
1053 @end group | |
1054 @group | |
1055 map | |
1056 @result{} (keymap | |
1057 (24 keymap ; @kbd{C-x} | |
1058 (102 . forward-word)) ; @kbd{f} | |
1059 (6 . forward-char)) ; @kbd{C-f} | |
1060 @end group | |
1061 | |
1062 @group | |
1063 ;; @r{Bind @kbd{C-p} to the @code{ctl-x-map}.} | |
1064 (define-key map "\C-p" ctl-x-map) | |
1065 ;; @code{ctl-x-map} | |
1066 @result{} [nil @dots{} find-file @dots{} backward-kill-sentence] | |
1067 @end group | |
1068 | |
1069 @group | |
1070 ;; @r{Bind @kbd{C-f} to @code{foo} in the @code{ctl-x-map}.} | |
1071 (define-key map "\C-p\C-f" 'foo) | |
1072 @result{} 'foo | |
1073 @end group | |
1074 @group | |
1075 map | |
1076 @result{} (keymap ; @r{Note @code{foo} in @code{ctl-x-map}.} | |
1077 (16 keymap [nil @dots{} foo @dots{} backward-kill-sentence]) | |
1078 (24 keymap | |
1079 (102 . forward-word)) | |
1080 (6 . forward-char)) | |
1081 @end group | |
1082 @end smallexample | |
1083 | |
1084 @noindent | |
1085 Note that storing a new binding for @kbd{C-p C-f} actually works by | |
1086 changing an entry in @code{ctl-x-map}, and this has the effect of | |
1087 changing the bindings of both @kbd{C-p C-f} and @kbd{C-x C-f} in the | |
1088 default global map. | |
1089 | |
1090 @defun substitute-key-definition olddef newdef keymap &optional oldmap | |
1091 @cindex replace bindings | |
1092 This function replaces @var{olddef} with @var{newdef} for any keys in | |
1093 @var{keymap} that were bound to @var{olddef}. In other words, | |
1094 @var{olddef} is replaced with @var{newdef} wherever it appears. The | |
1095 function returns @code{nil}. | |
1096 | |
1097 For example, this redefines @kbd{C-x C-f}, if you do it in an Emacs with | |
1098 standard bindings: | |
1099 | |
1100 @smallexample | |
1101 @group | |
1102 (substitute-key-definition | |
1103 'find-file 'find-file-read-only (current-global-map)) | |
1104 @end group | |
1105 @end smallexample | |
1106 | |
1107 @c Emacs 19 feature | |
1108 If @var{oldmap} is non-@code{nil}, then its bindings determine which | |
14498
7097c189c25d
Minor error in substitute-key-definition.
Richard M. Stallman <rms@gnu.org>
parents:
14199
diff
changeset
|
1109 keys to rebind. The rebindings still happen in @var{keymap}, not in |
6558 | 1110 @var{oldmap}. Thus, you can change one map under the control of the |
1111 bindings in another. For example, | |
1112 | |
1113 @smallexample | |
1114 (substitute-key-definition | |
1115 'delete-backward-char 'my-funny-delete | |
1116 my-map global-map) | |
1117 @end smallexample | |
1118 | |
1119 @noindent | |
1120 puts the special deletion command in @code{my-map} for whichever keys | |
1121 are globally bound to the standard deletion command. | |
1122 | |
1123 @ignore | |
1124 @c Emacs 18 only | |
1125 Prefix keymaps that appear within @var{keymap} are not checked | |
1126 recursively for keys bound to @var{olddef}; they are not changed at all. | |
1127 Perhaps it would be better to check nested keymaps recursively. | |
1128 @end ignore | |
1129 | |
1130 Here is an example showing a keymap before and after substitution: | |
1131 | |
1132 @smallexample | |
1133 @group | |
1134 (setq map '(keymap | |
1135 (?1 . olddef-1) | |
1136 (?2 . olddef-2) | |
1137 (?3 . olddef-1))) | |
1138 @result{} (keymap (49 . olddef-1) (50 . olddef-2) (51 . olddef-1)) | |
1139 @end group | |
1140 | |
1141 @group | |
1142 (substitute-key-definition 'olddef-1 'newdef map) | |
1143 @result{} nil | |
1144 @end group | |
1145 @group | |
1146 map | |
1147 @result{} (keymap (49 . newdef) (50 . olddef-2) (51 . newdef)) | |
1148 @end group | |
1149 @end smallexample | |
1150 @end defun | |
1151 | |
1152 @defun suppress-keymap keymap &optional nodigits | |
1153 @cindex @code{self-insert-command} override | |
1154 This function changes the contents of the full keymap @var{keymap} by | |
1155 making all the printing characters undefined. More precisely, it binds | |
1156 them to the command @code{undefined}. This makes ordinary insertion of | |
1157 text impossible. @code{suppress-keymap} returns @code{nil}. | |
1158 | |
1159 If @var{nodigits} is @code{nil}, then @code{suppress-keymap} defines | |
1160 digits to run @code{digit-argument}, and @kbd{-} to run | |
1161 @code{negative-argument}. Otherwise it makes them undefined like the | |
1162 rest of the printing characters. | |
1163 | |
1164 @cindex yank suppression | |
1165 @cindex @code{quoted-insert} suppression | |
1166 The @code{suppress-keymap} function does not make it impossible to | |
1167 modify a buffer, as it does not suppress commands such as @code{yank} | |
1168 and @code{quoted-insert}. To prevent any modification of a buffer, make | |
1169 it read-only (@pxref{Read Only Buffers}). | |
1170 | |
1171 Since this function modifies @var{keymap}, you would normally use it | |
1172 on a newly created keymap. Operating on an existing keymap | |
1173 that is used for some other purpose is likely to cause trouble; for | |
1174 example, suppressing @code{global-map} would make it impossible to use | |
1175 most of Emacs. | |
1176 | |
1177 Most often, @code{suppress-keymap} is used to initialize local | |
1178 keymaps of modes such as Rmail and Dired where insertion of text is not | |
1179 desirable and the buffer is read-only. Here is an example taken from | |
1180 the file @file{emacs/lisp/dired.el}, showing how the local keymap for | |
1181 Dired mode is set up: | |
1182 | |
1183 @smallexample | |
1184 @group | |
1185 @dots{} | |
1186 (setq dired-mode-map (make-keymap)) | |
1187 (suppress-keymap dired-mode-map) | |
1188 (define-key dired-mode-map "r" 'dired-rename-file) | |
1189 (define-key dired-mode-map "\C-d" 'dired-flag-file-deleted) | |
1190 (define-key dired-mode-map "d" 'dired-flag-file-deleted) | |
1191 (define-key dired-mode-map "v" 'dired-view-file) | |
1192 (define-key dired-mode-map "e" 'dired-find-file) | |
1193 (define-key dired-mode-map "f" 'dired-find-file) | |
1194 @dots{} | |
1195 @end group | |
1196 @end smallexample | |
1197 @end defun | |
1198 | |
1199 @node Key Binding Commands | |
1200 @section Commands for Binding Keys | |
1201 | |
1202 This section describes some convenient interactive interfaces for | |
1203 changing key bindings. They work by calling @code{define-key}. | |
1204 | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1205 People often use @code{global-set-key} in their @file{.emacs} file for |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1206 simple customization. For example, |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1207 |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1208 @smallexample |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1209 (global-set-key "\C-x\C-\\" 'next-line) |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1210 @end smallexample |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1211 |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1212 @noindent |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1213 or |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1214 |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1215 @smallexample |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1216 (global-set-key [?\C-x ?\C-\\] 'next-line) |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1217 @end smallexample |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1218 |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1219 @noindent |
12098 | 1220 or |
1221 | |
1222 @smallexample | |
1223 (global-set-key [(control ?x) (control ?\\)] 'next-line) | |
1224 @end smallexample | |
1225 | |
1226 @noindent | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1227 redefines @kbd{C-x C-\} to move down a line. |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1228 |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1229 @smallexample |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1230 (global-set-key [M-mouse-1] 'mouse-set-point) |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1231 @end smallexample |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1232 |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1233 @noindent |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1234 redefines the first (leftmost) mouse button, typed with the Meta key, to |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1235 set point where you click. |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1236 |
6558 | 1237 @deffn Command global-set-key key definition |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1238 This function sets the binding of @var{key} in the current global map |
6558 | 1239 to @var{definition}. |
1240 | |
1241 @smallexample | |
1242 @group | |
1243 (global-set-key @var{key} @var{definition}) | |
1244 @equiv{} | |
1245 (define-key (current-global-map) @var{key} @var{definition}) | |
1246 @end group | |
1247 @end smallexample | |
1248 @end deffn | |
1249 | |
1250 @deffn Command global-unset-key key | |
1251 @cindex unbinding keys | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1252 This function removes the binding of @var{key} from the current |
6558 | 1253 global map. |
1254 | |
1255 One use of this function is in preparation for defining a longer key | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1256 that uses @var{key} as a prefix---which would not be allowed if |
6558 | 1257 @var{key} has a non-prefix binding. For example: |
1258 | |
1259 @smallexample | |
1260 @group | |
1261 (global-unset-key "\C-l") | |
1262 @result{} nil | |
1263 @end group | |
1264 @group | |
1265 (global-set-key "\C-l\C-l" 'redraw-display) | |
1266 @result{} nil | |
1267 @end group | |
1268 @end smallexample | |
1269 | |
1270 This function is implemented simply using @code{define-key}: | |
1271 | |
1272 @smallexample | |
1273 @group | |
1274 (global-unset-key @var{key}) | |
1275 @equiv{} | |
1276 (define-key (current-global-map) @var{key} nil) | |
1277 @end group | |
1278 @end smallexample | |
1279 @end deffn | |
1280 | |
1281 @deffn Command local-set-key key definition | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1282 This function sets the binding of @var{key} in the current local |
6558 | 1283 keymap to @var{definition}. |
1284 | |
1285 @smallexample | |
1286 @group | |
1287 (local-set-key @var{key} @var{definition}) | |
1288 @equiv{} | |
1289 (define-key (current-local-map) @var{key} @var{definition}) | |
1290 @end group | |
1291 @end smallexample | |
1292 @end deffn | |
1293 | |
1294 @deffn Command local-unset-key key | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1295 This function removes the binding of @var{key} from the current |
6558 | 1296 local map. |
1297 | |
1298 @smallexample | |
1299 @group | |
1300 (local-unset-key @var{key}) | |
1301 @equiv{} | |
1302 (define-key (current-local-map) @var{key} nil) | |
1303 @end group | |
1304 @end smallexample | |
1305 @end deffn | |
1306 | |
1307 @node Scanning Keymaps | |
1308 @section Scanning Keymaps | |
1309 | |
1310 This section describes functions used to scan all the current keymaps | |
1311 for the sake of printing help information. | |
1312 | |
1313 @defun accessible-keymaps keymap &optional prefix | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1314 This function returns a list of all the keymaps that can be reached (via |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1315 zero or more prefix keys) from @var{keymap}. The value is an |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1316 association list with elements of the form @code{(@var{key} .@: |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1317 @var{map})}, where @var{key} is a prefix key whose definition in |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1318 @var{keymap} is @var{map}. |
6558 | 1319 |
1320 The elements of the alist are ordered so that the @var{key} increases | |
1321 in length. The first element is always @code{("" .@: @var{keymap})}, | |
1322 because the specified keymap is accessible from itself with a prefix of | |
1323 no events. | |
1324 | |
1325 If @var{prefix} is given, it should be a prefix key sequence; then | |
1326 @code{accessible-keymaps} includes only the submaps whose prefixes start | |
1327 with @var{prefix}. These elements look just as they do in the value of | |
1328 @code{(accessible-keymaps)}; the only difference is that some elements | |
1329 are omitted. | |
1330 | |
1331 In the example below, the returned alist indicates that the key | |
1332 @key{ESC}, which is displayed as @samp{^[}, is a prefix key whose | |
1333 definition is the sparse keymap @code{(keymap (83 .@: center-paragraph) | |
1334 (115 .@: foo))}. | |
1335 | |
1336 @smallexample | |
1337 @group | |
1338 (accessible-keymaps (current-local-map)) | |
1339 @result{}(("" keymap | |
1340 (27 keymap ; @r{Note this keymap for @key{ESC} is repeated below.} | |
1341 (83 . center-paragraph) | |
1342 (115 . center-line)) | |
1343 (9 . tab-to-tab-stop)) | |
1344 @end group | |
1345 | |
1346 @group | |
1347 ("^[" keymap | |
1348 (83 . center-paragraph) | |
1349 (115 . foo))) | |
1350 @end group | |
1351 @end smallexample | |
1352 | |
1353 In the following example, @kbd{C-h} is a prefix key that uses a sparse | |
1354 keymap starting with @code{(keymap (118 . describe-variable)@dots{})}. | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1355 Another prefix, @kbd{C-x 4}, uses a keymap which is also the value of |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1356 the variable @code{ctl-x-4-map}. The event @code{mode-line} is one of |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1357 several dummy events used as prefixes for mouse actions in special parts |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1358 of a window. |
6558 | 1359 |
1360 @smallexample | |
1361 @group | |
1362 (accessible-keymaps (current-global-map)) | |
1363 @result{} (("" keymap [set-mark-command beginning-of-line @dots{} | |
1364 delete-backward-char]) | |
1365 @end group | |
1366 @group | |
1367 ("^H" keymap (118 . describe-variable) @dots{} | |
1368 (8 . help-for-help)) | |
1369 @end group | |
1370 @group | |
1371 ("^X" keymap [x-flush-mouse-queue @dots{} | |
1372 backward-kill-sentence]) | |
1373 @end group | |
1374 @group | |
1375 ("^[" keymap [mark-sexp backward-sexp @dots{} | |
1376 backward-kill-word]) | |
1377 @end group | |
1378 ("^X4" keymap (15 . display-buffer) @dots{}) | |
1379 @group | |
1380 ([mode-line] keymap | |
1381 (S-mouse-2 . mouse-split-window-horizontally) @dots{})) | |
1382 @end group | |
1383 @end smallexample | |
1384 | |
1385 @noindent | |
1386 These are not all the keymaps you would see in an actual case. | |
1387 @end defun | |
1388 | |
1389 @defun where-is-internal command &optional keymap firstonly noindirect | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1390 This function is a subroutine used by the @code{where-is} command |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1391 (@pxref{Help, , Help, emacs,The GNU Emacs Manual}). It returns a list |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1392 of key sequences (of any length) that are bound to @var{command} in a |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1393 set of keymaps. |
6558 | 1394 |
1395 The argument @var{command} can be any object; it is compared with all | |
1396 keymap entries using @code{eq}. | |
1397 | |
1398 If @var{keymap} is @code{nil}, then the maps used are the current active | |
1399 keymaps, disregarding @code{overriding-local-map} (that is, pretending | |
1400 its value is @code{nil}). If @var{keymap} is non-@code{nil}, then the | |
1401 maps searched are @var{keymap} and the global keymap. | |
1402 | |
1403 Usually it's best to use @code{overriding-local-map} as the expression | |
1404 for @var{keymap}. Then @code{where-is-internal} searches precisely the | |
1405 keymaps that are active. To search only the global map, pass | |
1406 @code{(keymap)} (an empty keymap) as @var{keymap}. | |
1407 | |
1408 If @var{firstonly} is @code{non-ascii}, then the value is a single | |
1409 string representing the first key sequence found, rather than a list of | |
1410 all possible key sequences. If @var{firstonly} is @code{t}, then the | |
1411 value is the first key sequence, except that key sequences consisting | |
1412 entirely of @sc{ASCII} characters (or meta variants of @sc{ASCII} | |
1413 characters) are preferred to all other key sequences. | |
1414 | |
1415 If @var{noindirect} is non-@code{nil}, @code{where-is-internal} doesn't | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1416 follow indirect keymap bindings. This makes it possible to search for |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1417 an indirect definition itself. |
6558 | 1418 |
1419 @smallexample | |
1420 @group | |
1421 (where-is-internal 'describe-function) | |
1422 @result{} ("\^hf" "\^hd") | |
1423 @end group | |
1424 @end smallexample | |
1425 @end defun | |
1426 | |
1427 @deffn Command describe-bindings prefix | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1428 This function creates a listing of all defined keys and their |
6558 | 1429 definitions. It writes the listing in a buffer named @samp{*Help*} and |
1430 displays it in a window. | |
1431 | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1432 If @var{prefix} is non-@code{nil}, it should be a prefix key; then the |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1433 listing includes only keys that start with @var{prefix}. |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1434 |
6558 | 1435 The listing describes meta characters as @key{ESC} followed by the |
1436 corresponding non-meta character. | |
1437 | |
1438 When several characters with consecutive @sc{ASCII} codes have the | |
1439 same definition, they are shown together, as | |
1440 @samp{@var{firstchar}..@var{lastchar}}. In this instance, you need to | |
1441 know the @sc{ASCII} codes to understand which characters this means. | |
1442 For example, in the default global map, the characters @samp{@key{SPC} | |
1443 ..@: ~} are described by a single line. @key{SPC} is @sc{ASCII} 32, | |
1444 @kbd{~} is @sc{ASCII} 126, and the characters between them include all | |
1445 the normal printing characters, (e.g., letters, digits, punctuation, | |
1446 etc.@:); all these characters are bound to @code{self-insert-command}. | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1447 @end deffn |
6558 | 1448 |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1449 @node Menu Keymaps |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1450 @section Menu Keymaps |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1451 @cindex menu keymaps |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1452 |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1453 @c Emacs 19 feature |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1454 A keymap can define a menu as well as bindings for keyboard keys and |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1455 mouse button. Menus are usually actuated with the mouse, but they can |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1456 work with the keyboard also. |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1457 |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1458 @menu |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1459 * Defining Menus:: How to make a keymap that defines a menu. |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1460 * Mouse Menus:: How users actuate the menu with the mouse. |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1461 * Keyboard Menus:: How they actuate it with the keyboard. |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1462 * Menu Example:: Making a simple menu. |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1463 * Menu Bar:: How to customize the menu bar. |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1464 * Modifying Menus:: How to add new items to a menu. |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1465 @end menu |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1466 |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1467 @node Defining Menus |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1468 @subsection Defining Menus |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1469 @cindex defining menus |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1470 @cindex menu prompt string |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1471 @cindex prompt string (of menu) |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1472 |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1473 A keymap is suitable for menu use if it has an @dfn{overall prompt |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1474 string}, which is a string that appears as an element of the keymap. |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1475 (@xref{Format of Keymaps}.) The string should describe the purpose of |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1476 the menu. The easiest way to construct a keymap with a prompt string is |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1477 to specify the string as an argument when you call @code{make-keymap} or |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1478 @code{make-sparse-keymap} (@pxref{Creating Keymaps}). |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1479 |
10522
dd97fd55e095
Document alias commands and menu items.
Richard M. Stallman <rms@gnu.org>
parents:
7681
diff
changeset
|
1480 The order of items in the menu is the same as the order of bindings in |
dd97fd55e095
Document alias commands and menu items.
Richard M. Stallman <rms@gnu.org>
parents:
7681
diff
changeset
|
1481 the keymap. Since @code{define-key} puts new bindings at the front, you |
dd97fd55e095
Document alias commands and menu items.
Richard M. Stallman <rms@gnu.org>
parents:
7681
diff
changeset
|
1482 should define the menu items starting at the bottom of the menu and |
dd97fd55e095
Document alias commands and menu items.
Richard M. Stallman <rms@gnu.org>
parents:
7681
diff
changeset
|
1483 moving to the top, if you care about the order. When you add an item to |
dd97fd55e095
Document alias commands and menu items.
Richard M. Stallman <rms@gnu.org>
parents:
7681
diff
changeset
|
1484 an existing menu, you can specify its position in the menu using |
dd97fd55e095
Document alias commands and menu items.
Richard M. Stallman <rms@gnu.org>
parents:
7681
diff
changeset
|
1485 @code{define-key-after} (@pxref{Modifying Menus}). |
dd97fd55e095
Document alias commands and menu items.
Richard M. Stallman <rms@gnu.org>
parents:
7681
diff
changeset
|
1486 |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1487 The individual bindings in the menu keymap should have item |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1488 strings; these strings become the items displayed in the menu. A |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1489 binding with an item string looks like this: |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1490 |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1491 @example |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1492 (@var{string} . @var{real-binding}) |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1493 @end example |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1494 |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1495 The item string for a binding should be short---one or two words. It |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1496 should describe the action of the command it corresponds to. |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1497 |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1498 You can also supply a second string, called the help string, as follows: |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1499 |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1500 @example |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1501 (@var{string} @var{help-string} . @var{real-binding}) |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1502 @end example |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1503 |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1504 Currently Emacs does not actually use @var{help-string}; it knows only |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1505 how to ignore @var{help-string} in order to extract @var{real-binding}. |
12098 | 1506 In the future we may use @var{help-string} as extended documentation for |
1507 the menu item, available on request. | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1508 |
15766
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
1509 As far as @code{define-key} is concerned, @var{string} and |
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
1510 @var{help-string} are part of the event's binding. However, |
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
1511 @code{lookup-key} returns just @var{real-binding}, and only |
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
1512 @var{real-binding} is used for executing the key. |
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
1513 |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1514 If @var{real-binding} is @code{nil}, then @var{string} appears in the |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1515 menu but cannot be selected. |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1516 |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1517 If @var{real-binding} is a symbol and has a non-@code{nil} |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1518 @code{menu-enable} property, that property is an expression that |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1519 controls whether the menu item is enabled. Every time the keymap is |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1520 used to display a menu, Emacs evaluates the expression, and it enables |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1521 the menu item only if the expression's value is non-@code{nil}. When a |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1522 menu item is disabled, it is displayed in a ``fuzzy'' fashion, and |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1523 cannot be selected with the mouse. |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1524 |
12098 | 1525 The menu bar does not recalculate which items are enabled every time you |
1526 look at a menu. This is because the X toolkit requires the whole tree | |
1527 of menus in advance. To force recalculation of the menu bar, call | |
1528 @code{force-mode-line-update} (@pxref{Mode Line Format}). | |
1529 | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1530 You've probably noticed that menu items show the equivalent keyboard key |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1531 sequence (if any) to invoke the same command. To save time on |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1532 recalculation, menu display caches this information in a sublist in the |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1533 binding, like this: |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1534 |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1535 @c This line is not too long--rms. |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1536 @example |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1537 (@var{string} @r{[}@var{help-string}@r{]} (@var{key-binding-data}) . @var{real-binding}) |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1538 @end example |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1539 |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1540 Don't put these sublists in the menu item yourself; menu display |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1541 calculates them automatically. Don't add keyboard equivalents to the |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1542 item strings in a mouse menu, since that is redundant. |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1543 |
15766
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
1544 Sometimes it is useful to make menu items that use the ``same'' command |
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
1545 but with different enable conditions. You can do this by defining alias |
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
1546 commands. Here's an example that makes two aliases for |
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
1547 @code{toggle-read-only} and gives them different enable conditions: |
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
1548 |
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
1549 @example |
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
1550 (defalias 'make-read-only 'toggle-read-only) |
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
1551 (put 'make-read-only 'menu-enable '(not buffer-read-only)) |
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
1552 (defalias 'make-writable 'toggle-read-only) |
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
1553 (put 'make-writable 'menu-enable 'buffer-read-only) |
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
1554 @end example |
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
1555 |
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
1556 When using aliases in menus, often it is useful to display the |
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
1557 equivalent key bindings for the ``real'' command name, not the aliases |
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
1558 (which typically don't have any key bindings except for the menu |
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
1559 itself). To request this, give the alias symbol a non-@code{nil} |
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
1560 @code{menu-alias} property. Thus, |
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
1561 |
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
1562 @example |
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
1563 (put 'make-read-only 'menu-alias t) |
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
1564 (put 'make-writable 'menu-alias t) |
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
1565 @end example |
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
1566 |
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
1567 @noindent |
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
1568 causes menu items for @code{make-read-only} and @code{make-writable} to |
0146c9f9f720
Explain new keymap-parent functions.
Richard M. Stallman <rms@gnu.org>
parents:
14498
diff
changeset
|
1569 show the keyboard bindings for @code{toggle-read-only}. |
10522
dd97fd55e095
Document alias commands and menu items.
Richard M. Stallman <rms@gnu.org>
parents:
7681
diff
changeset
|
1570 |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1571 @node Mouse Menus |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1572 @subsection Menus and the Mouse |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1573 |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1574 The way to make a menu keymap produce a menu is to make it the |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1575 definition of a prefix key. |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1576 |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1577 If the prefix key ends with a mouse event, Emacs handles the menu keymap |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1578 by popping up a visible menu, so that the user can select a choice with |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1579 the mouse. When the user clicks on a menu item, the event generated is |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1580 whatever character or symbol has the binding that brought about that |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1581 menu item. (A menu item may generate a series of events if the menu has |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1582 multiple levels or comes from the menu bar.) |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1583 |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1584 It's often best to use a button-down event to trigger the menu. Then |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1585 the user can select a menu item by releasing the button. |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1586 |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1587 A single keymap can appear as multiple menu panes, if you explicitly |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1588 arrange for this. The way to do this is to make a keymap for each pane, |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1589 then create a binding for each of those maps in the main keymap of the |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1590 menu. Give each of these bindings an item string that starts with |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1591 @samp{@@}. The rest of the item string becomes the name of the pane. |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1592 See the file @file{lisp/mouse.el} for an example of this. Any ordinary |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1593 bindings with @samp{@@}-less item strings are grouped into one pane, |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1594 which appears along with the other panes explicitly created for the |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1595 submaps. |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1596 |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1597 X toolkit menus don't have panes; instead, they can have submenus. |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1598 Every nested keymap becomes a submenu, whether the item string starts |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1599 with @samp{@@} or not. In a toolkit version of Emacs, the only thing |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1600 special about @samp{@@} at the beginning of an item string is that the |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1601 @samp{@@} doesn't appear in the menu item. |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1602 |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1603 You can also get multiple panes from separate keymaps. The full |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1604 definition of a prefix key always comes from merging the definitions |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1605 supplied by the various active keymaps (minor mode, local, and |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1606 global). When more than one of these keymaps is a menu, each of them |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1607 makes a separate pane or panes. @xref{Active Keymaps}. |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1608 |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1609 In toolkit versions of Emacs, menus don't have panes, so submenus are |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1610 used to represent the separate keymaps. Each keymap's contribution |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1611 becomes one submenu. |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1612 |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1613 A Lisp program can explicitly pop up a menu and receive the user's |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1614 choice. You can use keymaps for this also. @xref{Pop-Up Menus}. |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1615 |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1616 @node Keyboard Menus |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1617 @subsection Menus and the Keyboard |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1618 |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1619 When a prefix key ending with a keyboard event (a character or function |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1620 key) has a definition that is a menu keymap, the user can use the |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1621 keyboard to choose a menu item. |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1622 |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1623 Emacs displays the menu alternatives (the item strings of the bindings) |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1624 in the echo area. If they don't all fit at once, the user can type |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1625 @key{SPC} to see the next line of alternatives. Successive uses of |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1626 @key{SPC} eventually get to the end of the menu and then cycle around to |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1627 the beginning. (The variable @code{menu-prompt-more-char} specifies |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1628 which character is used for this; @key{SPC} is the default.) |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1629 |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1630 When the user has found the desired alternative from the menu, he or she |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1631 should type the corresponding character---the one whose binding is that |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1632 alternative. |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1633 |
12098 | 1634 @ignore |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1635 In a menu intended for keyboard use, each menu item must clearly |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1636 indicate what character to type. The best convention to use is to make |
12098 | 1637 the character the first letter of the item string---that is something |
1638 users will understand without being told. We plan to change this; by | |
1639 the time you read this manual, keyboard menus may explicitly name the | |
1640 key for each alternative. | |
1641 @end ignore | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1642 |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1643 This way of using menus in an Emacs-like editor was inspired by the |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1644 Hierarkey system. |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1645 |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1646 @defvar menu-prompt-more-char |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1647 This variable specifies the character to use to ask to see |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1648 the next line of a menu. Its initial value is 32, the code |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1649 for @key{SPC}. |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1650 @end defvar |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1651 |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1652 @node Menu Example |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1653 @subsection Menu Example |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1654 @cindex menu definition example |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1655 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1656 Here is a complete example of defining a menu keymap. It is the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1657 definition of the @samp{Print} submenu in the @samp{Tools} menu in the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1658 menu bar. First we create the keymap, and give it a name: |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1659 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1660 @example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1661 (defvar menu-bar-print-menu (make-sparse-keymap "Print")) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1662 @end example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1663 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1664 Next we define the menu items: |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1665 |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1666 @example |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1667 (define-key menu-bar-print-menu [ps-print-region] |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1668 '("Postscript Print Region" . ps-print-region-with-faces)) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1669 (define-key menu-bar-print-menu [ps-print-buffer] |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1670 '("Postscript Print Buffer" . ps-print-buffer-with-faces)) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1671 (define-key menu-bar-print-menu [separator-ps-print] |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1672 '("--")) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1673 (define-key menu-bar-print-menu [print-region] |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1674 '("Print Region" . print-region)) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1675 (define-key menu-bar-print-menu [print-buffer] |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1676 '("Print Buffer" . print-buffer)) |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1677 @end example |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1678 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1679 @noindent |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1680 Note the symbols which the bindings are ``made for''; these appear |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1681 inside square brackets, in the key sequence being defined. In some |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1682 cases, this symbol is the same as the command name; sometimes it is |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1683 different. These symbols are treated as ``function keys'', but they are |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1684 not real function keys on the keyboard. They do not affect the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1685 functioning of the menu itself, but they are ``echoed'' in the echo area |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1686 when the user selects from the menu, and they appear in the output of |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1687 @code{where-is} and @code{apropos}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1688 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1689 The binding whose definition is @code{("--")} is a separator line. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1690 Like a real menu item, the separator has a key symbol, in this case |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1691 @code{separator-ps-print}. If one menu has two separators, they must |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1692 have two different key symbols. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1693 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1694 Here is code to define enable conditions for two of the commands in |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1695 the menu: |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1696 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1697 @example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1698 (put 'print-region 'menu-enable 'mark-active) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1699 (put 'ps-print-region-with-faces 'menu-enable 'mark-active) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1700 @end example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1701 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1702 Here is how we make this menu appear as an item in the parent menu: |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1703 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1704 @example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1705 (define-key menu-bar-tools-menu [print] |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1706 (cons "Print" menu-bar-print-menu)) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1707 @end example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1708 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1709 @noindent |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1710 Note that this incorporates the submenu keymap, which is the value of |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1711 the variable @code{menu-bar-print-menu}, rather than the symbol |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1712 @code{menu-bar-print-menu} itself. Using that symbol in the parent menu |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1713 item would be meaningless because @code{menu-bar-print-menu} is not a |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1714 command. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1715 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1716 If you wanted to attach the same print menu to a mouse click, you |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1717 might do it this way: |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1718 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1719 @example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1720 (define-key global-map [C-S-down-mouse-1] menu-bar-print-menu) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1721 @end example |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1722 |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1723 @node Menu Bar |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1724 @subsection The Menu Bar |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1725 @cindex menu bar |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1726 |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1727 Most window systems allow each frame to have a @dfn{menu bar}---a |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1728 permanently displayed menu stretching horizontally across the top of the |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1729 frame. The items of the menu bar are the subcommands of the fake |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1730 ``function key'' @code{menu-bar}, as defined by all the active keymaps. |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1731 |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1732 To add an item to the menu bar, invent a fake ``function key'' of your |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1733 own (let's call it @var{key}), and make a binding for the key sequence |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1734 @code{[menu-bar @var{key}]}. Most often, the binding is a menu keymap, |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1735 so that pressing a button on the menu bar item leads to another menu. |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1736 |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1737 When more than one active keymap defines the same fake function key |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1738 for the menu bar, the item appears just once. If the user clicks on |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1739 that menu bar item, it brings up a single, combined submenu containing |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1740 all the subcommands of that item---the global subcommands, the local |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1741 subcommands, and the minor mode subcommands, all together. |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1742 |
12067 | 1743 The variable @code{overriding-local-map} is normally ignored when |
1744 determining the menu bar contents. That is, the menu bar is computed | |
1745 from the keymaps that would be active if @code{overriding-local-map} | |
1746 were @code{nil}. @xref{Active Keymaps}. | |
1747 | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1748 In order for a frame to display a menu bar, its @code{menu-bar-lines} |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1749 parameter must be greater than zero. Emacs uses just one line for the |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1750 menu bar itself; if you specify more than one line, the other lines |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1751 serve to separate the menu bar from the windows in the frame. We |
12098 | 1752 recommend 1 or 2 as the value of @code{menu-bar-lines}. @xref{X Frame |
1753 Parameters}. | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1754 |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1755 Here's an example of setting up a menu bar item: |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1756 |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1757 @example |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1758 @group |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1759 (modify-frame-parameters (selected-frame) |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1760 '((menu-bar-lines . 2))) |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1761 @end group |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1762 |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1763 @group |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1764 ;; @r{Make a menu keymap (with a prompt string)} |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1765 ;; @r{and make it the menu bar item's definition.} |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1766 (define-key global-map [menu-bar words] |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1767 (cons "Words" (make-sparse-keymap "Words"))) |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1768 @end group |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1769 |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1770 @group |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1771 ;; @r{Define specific subcommands in the item's menu.} |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1772 (define-key global-map |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1773 [menu-bar words forward] |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1774 '("Forward word" . forward-word)) |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1775 @end group |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1776 @group |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1777 (define-key global-map |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1778 [menu-bar words backward] |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1779 '("Backward word" . backward-word)) |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1780 @end group |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1781 @end example |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1782 |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1783 A local keymap can cancel a menu bar item made by the global keymap by |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1784 rebinding the same fake function key with @code{undefined} as the |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1785 binding. For example, this is how Dired suppresses the @samp{Edit} menu |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1786 bar item: |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1787 |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1788 @example |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1789 (define-key dired-mode-map [menu-bar edit] 'undefined) |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1790 @end example |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1791 |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1792 @noindent |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1793 @code{edit} is the fake function key used by the global map for the |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1794 @samp{Edit} menu bar item. The main reason to suppress a global |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1795 menu bar item is to regain space for mode-specific items. |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1796 |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1797 @defvar menu-bar-final-items |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1798 Normally the menu bar shows global items followed by items defined by the |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1799 local maps. |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1800 |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1801 This variable holds a list of fake function keys for items to display at |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1802 the end of the menu bar rather than in normal sequence. The default |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1803 value is @code{(help)}; thus, the @samp{Help} menu item normally appears |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1804 at the end of the menu bar, following local menu items. |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1805 @end defvar |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1806 |
14199
ac3f51460e07
Doc menu-bar-update-hook.
Richard M. Stallman <rms@gnu.org>
parents:
12600
diff
changeset
|
1807 @defvar menu-bar-update-hook |
ac3f51460e07
Doc menu-bar-update-hook.
Richard M. Stallman <rms@gnu.org>
parents:
12600
diff
changeset
|
1808 This normal hook is run whenever the user clicks on the menu bar, before |
ac3f51460e07
Doc menu-bar-update-hook.
Richard M. Stallman <rms@gnu.org>
parents:
12600
diff
changeset
|
1809 displaying a submenu. You can use it to update submenus whose contents |
ac3f51460e07
Doc menu-bar-update-hook.
Richard M. Stallman <rms@gnu.org>
parents:
12600
diff
changeset
|
1810 should vary. |
ac3f51460e07
Doc menu-bar-update-hook.
Richard M. Stallman <rms@gnu.org>
parents:
12600
diff
changeset
|
1811 @end defvar |
ac3f51460e07
Doc menu-bar-update-hook.
Richard M. Stallman <rms@gnu.org>
parents:
12600
diff
changeset
|
1812 |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1813 @node Modifying Menus |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1814 @subsection Modifying Menus |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1815 |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1816 When you insert a new item in an existing menu, you probably want to |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1817 put it in a particular place among the menu's existing items. If you |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1818 use @code{define-key} to add the item, it normally goes at the front of |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1819 the menu. To put it elsewhere in the menu, use @code{define-key-after}: |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1820 |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1821 @defun define-key-after map key binding after |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1822 Define a binding in @var{map} for @var{key}, with value @var{binding}, |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1823 just like @code{define-key}, but position the binding in @var{map} after |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1824 the binding for the event @var{after}. The argument @var{key} should be |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1825 of length one---a vector or string with just one element. But |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1826 @var{after} should be an event type---a symbol or a character. |
7681 | 1827 |
1828 For example, | |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1829 |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1830 @example |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1831 (define-key-after my-menu [drink] |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1832 '("Drink" . drink-command) 'eat) |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1833 @end example |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1834 |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1835 @noindent |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1836 makes a binding for the fake function key @key{drink} and puts it |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1837 right after the binding for @key{eat}. |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1838 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1839 If @var{after} is @code{t}, then the new binding goes last---at the end |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1840 of the keymap. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15766
diff
changeset
|
1841 |
7252
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1842 Here is how to insert an item called @samp{Work} in the @samp{Signals} |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1843 menu of Shell mode, after the item @code{break}: |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1844 |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1845 @example |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1846 (define-key-after |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1847 (lookup-key shell-mode-map [menu-bar signals]) |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1848 [work] '("Work" . work-command) 'break) |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1849 @end example |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1850 |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1851 Note that @var{key} is a sequence containing just one event type, but |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1852 @var{after} is just an event type (not a sequence). |
2ddb8063f154
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
1853 @end defun |