Mercurial > emacs
annotate doc/lispref/keymaps.texi @ 102802:4f534a4fed53
Regenerate.
author | Chong Yidong <cyd@stupidchicken.com> |
---|---|
date | Tue, 31 Mar 2009 00:19:56 +0000 |
parents | c7b4bd09cdf1 |
children | a447859a557b |
rev | line source |
---|---|
84078 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1998, 1999, 2000, 2001, | |
100974 | 4 @c 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc. |
84078 | 5 @c See the file elisp.texi for copying conditions. |
84116
0ba80d073e27
(setfilename): Go up one more level to ../../info.
Glenn Morris <rgm@gnu.org>
parents:
84078
diff
changeset
|
6 @setfilename ../../info/keymaps |
84078 | 7 @node Keymaps, Modes, Command Loop, Top |
8 @chapter Keymaps | |
9 @cindex keymap | |
10 | |
11 The command bindings of input events are recorded in data structures | |
12 called @dfn{keymaps}. Each entry in a keymap associates (or | |
13 @dfn{binds}) an individual event type, either to another keymap or to | |
14 a command. When an event type is bound to a keymap, that keymap is | |
15 used to look up the next input event; this continues until a command | |
16 is found. The whole process is called @dfn{key lookup}. | |
17 | |
18 @menu | |
19 * Key Sequences:: Key sequences as Lisp objects. | |
20 * Keymap Basics:: Basic concepts of keymaps. | |
21 * Format of Keymaps:: What a keymap looks like as a Lisp object. | |
22 * Creating Keymaps:: Functions to create and copy keymaps. | |
23 * Inheritance and Keymaps:: How one keymap can inherit the bindings | |
24 of another keymap. | |
25 * Prefix Keys:: Defining a key with a keymap as its definition. | |
26 * Active Keymaps:: How Emacs searches the active keymaps | |
27 for a key binding. | |
28 * Searching Keymaps:: A pseudo-Lisp summary of searching active maps. | |
29 * Controlling Active Maps:: Each buffer has a local keymap | |
30 to override the standard (global) bindings. | |
31 A minor mode can also override them. | |
32 * Key Lookup:: Finding a key's binding in one keymap. | |
33 * Functions for Key Lookup:: How to request key lookup. | |
34 * Changing Key Bindings:: Redefining a key in a keymap. | |
35 * Remapping Commands:: A keymap can translate one command to another. | |
36 * Translation Keymaps:: Keymaps for translating sequences of events. | |
37 * Key Binding Commands:: Interactive interfaces for redefining keys. | |
38 * Scanning Keymaps:: Looking through all keymaps, for printing help. | |
39 * Menu Keymaps:: Defining a menu as a keymap. | |
40 @end menu | |
41 | |
42 @node Key Sequences | |
43 @section Key Sequences | |
44 @cindex key | |
45 @cindex keystroke | |
46 @cindex key sequence | |
47 | |
48 A @dfn{key sequence}, or @dfn{key} for short, is a sequence of one | |
49 or more input events that form a unit. Input events include | |
50 characters, function keys, and mouse actions (@pxref{Input Events}). | |
51 The Emacs Lisp representation for a key sequence is a string or | |
52 vector. Unless otherwise stated, any Emacs Lisp function that accepts | |
53 a key sequence as an argument can handle both representations. | |
54 | |
55 In the string representation, alphanumeric characters ordinarily | |
56 stand for themselves; for example, @code{"a"} represents @kbd{a} | |
57 and @code{"2"} represents @kbd{2}. Control character events are | |
58 prefixed by the substring @code{"\C-"}, and meta characters by | |
59 @code{"\M-"}; for example, @code{"\C-x"} represents the key @kbd{C-x}. | |
60 In addition, the @key{TAB}, @key{RET}, @key{ESC}, and @key{DEL} events | |
61 are represented by @code{"\t"}, @code{"\r"}, @code{"\e"}, and | |
62 @code{"\d"} respectively. The string representation of a complete key | |
63 sequence is the concatenation of the string representations of the | |
64 constituent events; thus, @code{"\C-xl"} represents the key sequence | |
65 @kbd{C-x l}. | |
66 | |
67 Key sequences containing function keys, mouse button events, or | |
68 non-ASCII characters such as @kbd{C-=} or @kbd{H-a} cannot be | |
69 represented as strings; they have to be represented as vectors. | |
70 | |
71 In the vector representation, each element of the vector represents | |
72 an input event, in its Lisp form. @xref{Input Events}. For example, | |
73 the vector @code{[?\C-x ?l]} represents the key sequence @kbd{C-x l}. | |
74 | |
75 For examples of key sequences written in string and vector | |
76 representations, @ref{Init Rebinding,,, emacs, The GNU Emacs Manual}. | |
77 | |
78 @defmac kbd keyseq-text | |
79 This macro converts the text @var{keyseq-text} (a string constant) | |
80 into a key sequence (a string or vector constant). The contents of | |
81 @var{keyseq-text} should describe the key sequence using almost the same | |
82 syntax used in this manual. More precisely, it uses the same syntax | |
83 that Edit Macro mode uses for editing keyboard macros (@pxref{Edit | |
84 Keyboard Macro,,, emacs, The GNU Emacs Manual}); you must surround | |
85 function key names with @samp{<@dots{}>}. | |
86 | |
87 @example | |
88 (kbd "C-x") @result{} "\C-x" | |
89 (kbd "C-x C-f") @result{} "\C-x\C-f" | |
90 (kbd "C-x 4 C-f") @result{} "\C-x4\C-f" | |
91 (kbd "X") @result{} "X" | |
92 (kbd "RET") @result{} "\^M" | |
93 (kbd "C-c SPC") @result{} "\C-c@ " | |
94 (kbd "<f1> SPC") @result{} [f1 32] | |
95 (kbd "C-M-<down>") @result{} [C-M-down] | |
96 @end example | |
97 | |
98 This macro is not meant for use with arguments that vary---only | |
99 with string constants. | |
100 @end defmac | |
101 | |
102 @node Keymap Basics | |
103 @section Keymap Basics | |
104 @cindex key binding | |
105 @cindex binding of a key | |
106 @cindex complete key | |
107 @cindex undefined key | |
108 | |
109 A keymap is a Lisp data structure that specifies @dfn{key bindings} | |
110 for various key sequences. | |
111 | |
112 A single keymap directly specifies definitions for individual | |
113 events. When a key sequence consists of a single event, its binding | |
114 in a keymap is the keymap's definition for that event. The binding of | |
115 a longer key sequence is found by an iterative process: first find the | |
116 definition of the first event (which must itself be a keymap); then | |
117 find the second event's definition in that keymap, and so on until all | |
118 the events in the key sequence have been processed. | |
119 | |
120 If the binding of a key sequence is a keymap, we call the key sequence | |
121 a @dfn{prefix key}. Otherwise, we call it a @dfn{complete key} (because | |
122 no more events can be added to it). If the binding is @code{nil}, | |
123 we call the key @dfn{undefined}. Examples of prefix keys are @kbd{C-c}, | |
124 @kbd{C-x}, and @kbd{C-x 4}. Examples of defined complete keys are | |
125 @kbd{X}, @key{RET}, and @kbd{C-x 4 C-f}. Examples of undefined complete | |
126 keys are @kbd{C-x C-g}, and @kbd{C-c 3}. @xref{Prefix Keys}, for more | |
127 details. | |
128 | |
129 The rule for finding the binding of a key sequence assumes that the | |
130 intermediate bindings (found for the events before the last) are all | |
131 keymaps; if this is not so, the sequence of events does not form a | |
132 unit---it is not really one key sequence. In other words, removing one | |
133 or more events from the end of any valid key sequence must always yield | |
134 a prefix key. For example, @kbd{C-f C-n} is not a key sequence; | |
135 @kbd{C-f} is not a prefix key, so a longer sequence starting with | |
136 @kbd{C-f} cannot be a key sequence. | |
137 | |
138 The set of possible multi-event key sequences depends on the bindings | |
139 for prefix keys; therefore, it can be different for different keymaps, | |
140 and can change when bindings are changed. However, a one-event sequence | |
141 is always a key sequence, because it does not depend on any prefix keys | |
142 for its well-formedness. | |
143 | |
144 At any time, several primary keymaps are @dfn{active}---that is, in | |
145 use for finding key bindings. These are the @dfn{global map}, which is | |
146 shared by all buffers; the @dfn{local keymap}, which is usually | |
147 associated with a specific major mode; and zero or more @dfn{minor mode | |
148 keymaps}, which belong to currently enabled minor modes. (Not all minor | |
149 modes have keymaps.) The local keymap bindings shadow (i.e., take | |
150 precedence over) the corresponding global bindings. The minor mode | |
151 keymaps shadow both local and global keymaps. @xref{Active Keymaps}, | |
152 for details. | |
153 | |
154 @node Format of Keymaps | |
155 @section Format of Keymaps | |
156 @cindex format of keymaps | |
157 @cindex keymap format | |
158 @cindex full keymap | |
159 @cindex sparse keymap | |
160 | |
161 Each keymap is a list whose @sc{car} is the symbol @code{keymap}. The | |
162 remaining elements of the list define the key bindings of the keymap. | |
163 A symbol whose function definition is a keymap is also a keymap. Use | |
164 the function @code{keymapp} (see below) to test whether an object is a | |
165 keymap. | |
166 | |
167 Several kinds of elements may appear in a keymap, after the symbol | |
168 @code{keymap} that begins it: | |
169 | |
170 @table @code | |
171 @item (@var{type} .@: @var{binding}) | |
172 This specifies one binding, for events of type @var{type}. Each | |
173 ordinary binding applies to events of a particular @dfn{event type}, | |
174 which is always a character or a symbol. @xref{Classifying Events}. | |
175 In this kind of binding, @var{binding} is a command. | |
176 | |
177 @item (@var{type} @var{item-name} @r{[}@var{cache}@r{]} .@: @var{binding}) | |
178 This specifies a binding which is also a simple menu item that | |
179 displays as @var{item-name} in the menu. @var{cache}, if present, | |
180 caches certain information for display in the menu. @xref{Simple Menu | |
181 Items}. | |
182 | |
183 @item (@var{type} @var{item-name} @var{help-string} @r{[}@var{cache}@r{]} .@: @var{binding}) | |
184 This is a simple menu item with help string @var{help-string}. | |
185 | |
186 @item (@var{type} menu-item .@: @var{details}) | |
187 This specifies a binding which is also an extended menu item. This | |
188 allows use of other features. @xref{Extended Menu Items}. | |
189 | |
190 @item (t .@: @var{binding}) | |
191 @cindex default key binding | |
192 This specifies a @dfn{default key binding}; any event not bound by other | |
193 elements of the keymap is given @var{binding} as its binding. Default | |
194 bindings allow a keymap to bind all possible event types without having | |
195 to enumerate all of them. A keymap that has a default binding | |
196 completely masks any lower-precedence keymap, except for events | |
197 explicitly bound to @code{nil} (see below). | |
198 | |
199 @item @var{char-table} | |
200 If an element of a keymap is a char-table, it counts as holding | |
201 bindings for all character events with no modifier bits | |
202 (@pxref{modifier bits}): element @var{n} is the binding for the | |
203 character with code @var{n}. This is a compact way to record lots of | |
204 bindings. A keymap with such a char-table is called a @dfn{full | |
205 keymap}. Other keymaps are called @dfn{sparse keymaps}. | |
206 | |
207 @item @var{string} | |
208 @cindex keymap prompt string | |
209 @cindex overall prompt string | |
210 @cindex prompt string of keymap | |
211 Aside from elements that specify bindings for keys, a keymap can also | |
212 have a string as an element. This is called the @dfn{overall prompt | |
213 string} and makes it possible to use the keymap as a menu. | |
214 @xref{Defining Menus}. | |
215 @end table | |
216 | |
217 When the binding is @code{nil}, it doesn't constitute a definition | |
218 but it does take precedence over a default binding or a binding in the | |
219 parent keymap. On the other hand, a binding of @code{nil} does | |
220 @emph{not} override lower-precedence keymaps; thus, if the local map | |
221 gives a binding of @code{nil}, Emacs uses the binding from the | |
222 global map. | |
223 | |
224 @cindex meta characters lookup | |
225 Keymaps do not directly record bindings for the meta characters. | |
226 Instead, meta characters are regarded for purposes of key lookup as | |
227 sequences of two characters, the first of which is @key{ESC} (or | |
228 whatever is currently the value of @code{meta-prefix-char}). Thus, the | |
229 key @kbd{M-a} is internally represented as @kbd{@key{ESC} a}, and its | |
230 global binding is found at the slot for @kbd{a} in @code{esc-map} | |
231 (@pxref{Prefix Keys}). | |
232 | |
233 This conversion applies only to characters, not to function keys or | |
234 other input events; thus, @kbd{M-@key{end}} has nothing to do with | |
235 @kbd{@key{ESC} @key{end}}. | |
236 | |
237 Here as an example is the local keymap for Lisp mode, a sparse | |
238 keymap. It defines bindings for @key{DEL} and @key{TAB}, plus @kbd{C-c | |
239 C-l}, @kbd{M-C-q}, and @kbd{M-C-x}. | |
240 | |
241 @example | |
242 @group | |
243 lisp-mode-map | |
244 @result{} | |
245 @end group | |
246 @group | |
247 (keymap | |
248 (3 keymap | |
249 ;; @kbd{C-c C-z} | |
250 (26 . run-lisp)) | |
251 @end group | |
252 @group | |
253 (27 keymap | |
254 ;; @r{@kbd{M-C-x}, treated as @kbd{@key{ESC} C-x}} | |
255 (24 . lisp-send-defun) | |
256 keymap | |
257 ;; @r{@kbd{M-C-q}, treated as @kbd{@key{ESC} C-q}} | |
258 (17 . indent-sexp)) | |
259 @end group | |
260 @group | |
261 ;; @r{This part is inherited from @code{lisp-mode-shared-map}.} | |
262 keymap | |
263 ;; @key{DEL} | |
264 (127 . backward-delete-char-untabify) | |
265 @end group | |
266 @group | |
267 (27 keymap | |
268 ;; @r{@kbd{M-C-q}, treated as @kbd{@key{ESC} C-q}} | |
269 (17 . indent-sexp)) | |
270 (9 . lisp-indent-line)) | |
271 @end group | |
272 @end example | |
273 | |
274 @defun keymapp object | |
275 This function returns @code{t} if @var{object} is a keymap, @code{nil} | |
276 otherwise. More precisely, this function tests for a list whose | |
277 @sc{car} is @code{keymap}, or for a symbol whose function definition | |
278 satisfies @code{keymapp}. | |
279 | |
280 @example | |
281 @group | |
282 (keymapp '(keymap)) | |
283 @result{} t | |
284 @end group | |
285 @group | |
286 (fset 'foo '(keymap)) | |
287 (keymapp 'foo) | |
288 @result{} t | |
289 @end group | |
290 @group | |
291 (keymapp (current-global-map)) | |
292 @result{} t | |
293 @end group | |
294 @end example | |
295 @end defun | |
296 | |
297 @node Creating Keymaps | |
298 @section Creating Keymaps | |
299 @cindex creating keymaps | |
300 | |
301 Here we describe the functions for creating keymaps. | |
302 | |
303 @defun make-sparse-keymap &optional prompt | |
304 This function creates and returns a new sparse keymap with no entries. | |
305 (A sparse keymap is the kind of keymap you usually want.) The new | |
306 keymap does not contain a char-table, unlike @code{make-keymap}, and | |
307 does not bind any events. | |
308 | |
309 @example | |
310 @group | |
311 (make-sparse-keymap) | |
312 @result{} (keymap) | |
313 @end group | |
314 @end example | |
315 | |
316 If you specify @var{prompt}, that becomes the overall prompt string | |
317 for the keymap. You should specify this only for menu keymaps | |
318 (@pxref{Defining Menus}). A keymap with an overall prompt string will | |
319 always present a mouse menu or a keyboard menu if it is active for | |
320 looking up the next input event. Don't specify an overall prompt string | |
321 for the main map of a major or minor mode, because that would cause | |
322 the command loop to present a keyboard menu every time. | |
323 @end defun | |
324 | |
325 @defun make-keymap &optional prompt | |
326 This function creates and returns a new full keymap. That keymap | |
327 contains a char-table (@pxref{Char-Tables}) with slots for all | |
328 characters without modifiers. The new keymap initially binds all | |
329 these characters to @code{nil}, and does not bind any other kind of | |
330 event. The argument @var{prompt} specifies a | |
331 prompt string, as in @code{make-sparse-keymap}. | |
332 | |
333 @example | |
334 @group | |
335 (make-keymap) | |
336 @result{} (keymap #^[t nil nil nil @dots{} nil nil keymap]) | |
337 @end group | |
338 @end example | |
339 | |
340 A full keymap is more efficient than a sparse keymap when it holds | |
341 lots of bindings; for just a few, the sparse keymap is better. | |
342 @end defun | |
343 | |
344 @defun copy-keymap keymap | |
345 This function returns a copy of @var{keymap}. Any keymaps that | |
346 appear directly as bindings in @var{keymap} are also copied recursively, | |
347 and so on to any number of levels. However, recursive copying does not | |
348 take place when the definition of a character is a symbol whose function | |
349 definition is a keymap; the same symbol appears in the new copy. | |
350 @c Emacs 19 feature | |
351 | |
352 @example | |
353 @group | |
354 (setq map (copy-keymap (current-local-map))) | |
355 @result{} (keymap | |
356 @end group | |
357 @group | |
358 ;; @r{(This implements meta characters.)} | |
359 (27 keymap | |
360 (83 . center-paragraph) | |
361 (115 . center-line)) | |
362 (9 . tab-to-tab-stop)) | |
363 @end group | |
364 | |
365 @group | |
366 (eq map (current-local-map)) | |
367 @result{} nil | |
368 @end group | |
369 @group | |
370 (equal map (current-local-map)) | |
371 @result{} t | |
372 @end group | |
373 @end example | |
374 @end defun | |
375 | |
376 @node Inheritance and Keymaps | |
377 @section Inheritance and Keymaps | |
378 @cindex keymap inheritance | |
379 @cindex inheriting a keymap's bindings | |
380 | |
381 A keymap can inherit the bindings of another keymap, which we call the | |
382 @dfn{parent keymap}. Such a keymap looks like this: | |
383 | |
384 @example | |
385 (keymap @var{elements}@dots{} . @var{parent-keymap}) | |
386 @end example | |
387 | |
388 @noindent | |
389 The effect is that this keymap inherits all the bindings of | |
390 @var{parent-keymap}, whatever they may be at the time a key is looked up, | |
391 but can add to them or override them with @var{elements}. | |
392 | |
393 If you change the bindings in @var{parent-keymap} using | |
394 @code{define-key} or other key-binding functions, these changed | |
395 bindings are visible in the inheriting keymap, unless shadowed by the | |
396 bindings made by @var{elements}. The converse is not true: if you use | |
397 @code{define-key} to change bindings in the inheriting keymap, these | |
398 changes are recorded in @var{elements}, but have no effect on | |
399 @var{parent-keymap}. | |
400 | |
401 The proper way to construct a keymap with a parent is to use | |
402 @code{set-keymap-parent}; if you have code that directly constructs a | |
403 keymap with a parent, please convert the program to use | |
404 @code{set-keymap-parent} instead. | |
405 | |
406 @defun keymap-parent keymap | |
407 This returns the parent keymap of @var{keymap}. If @var{keymap} | |
408 has no parent, @code{keymap-parent} returns @code{nil}. | |
409 @end defun | |
410 | |
411 @defun set-keymap-parent keymap parent | |
412 This sets the parent keymap of @var{keymap} to @var{parent}, and returns | |
413 @var{parent}. If @var{parent} is @code{nil}, this function gives | |
414 @var{keymap} no parent at all. | |
415 | |
416 If @var{keymap} has submaps (bindings for prefix keys), they too receive | |
417 new parent keymaps that reflect what @var{parent} specifies for those | |
418 prefix keys. | |
419 @end defun | |
420 | |
421 Here is an example showing how to make a keymap that inherits | |
422 from @code{text-mode-map}: | |
423 | |
424 @example | |
425 (let ((map (make-sparse-keymap))) | |
426 (set-keymap-parent map text-mode-map) | |
427 map) | |
428 @end example | |
429 | |
430 A non-sparse keymap can have a parent too, but this is not very | |
431 useful. A non-sparse keymap always specifies something as the binding | |
432 for every numeric character code without modifier bits, even if it is | |
433 @code{nil}, so these character's bindings are never inherited from | |
434 the parent keymap. | |
435 | |
436 @node Prefix Keys | |
437 @section Prefix Keys | |
438 @cindex prefix key | |
439 | |
440 A @dfn{prefix key} is a key sequence whose binding is a keymap. The | |
441 keymap defines what to do with key sequences that extend the prefix key. | |
442 For example, @kbd{C-x} is a prefix key, and it uses a keymap that is | |
443 also stored in the variable @code{ctl-x-map}. This keymap defines | |
444 bindings for key sequences starting with @kbd{C-x}. | |
445 | |
446 Some of the standard Emacs prefix keys use keymaps that are | |
447 also found in Lisp variables: | |
448 | |
449 @itemize @bullet | |
450 @item | |
451 @vindex esc-map | |
452 @findex ESC-prefix | |
453 @code{esc-map} is the global keymap for the @key{ESC} prefix key. Thus, | |
454 the global definitions of all meta characters are actually found here. | |
455 This map is also the function definition of @code{ESC-prefix}. | |
456 | |
457 @item | |
458 @cindex @kbd{C-h} | |
459 @code{help-map} is the global keymap for the @kbd{C-h} prefix key. | |
460 | |
461 @item | |
462 @cindex @kbd{C-c} | |
463 @vindex mode-specific-map | |
464 @code{mode-specific-map} is the global keymap for the prefix key | |
465 @kbd{C-c}. This map is actually global, not mode-specific, but its name | |
466 provides useful information about @kbd{C-c} in the output of @kbd{C-h b} | |
467 (@code{display-bindings}), since the main use of this prefix key is for | |
468 mode-specific bindings. | |
469 | |
470 @item | |
471 @cindex @kbd{C-x} | |
472 @vindex ctl-x-map | |
473 @findex Control-X-prefix | |
474 @code{ctl-x-map} is the global keymap used for the @kbd{C-x} prefix key. | |
475 This map is found via the function cell of the symbol | |
476 @code{Control-X-prefix}. | |
477 | |
478 @item | |
479 @cindex @kbd{C-x @key{RET}} | |
480 @vindex mule-keymap | |
481 @code{mule-keymap} is the global keymap used for the @kbd{C-x @key{RET}} | |
482 prefix key. | |
483 | |
484 @item | |
485 @cindex @kbd{C-x 4} | |
486 @vindex ctl-x-4-map | |
487 @code{ctl-x-4-map} is the global keymap used for the @kbd{C-x 4} prefix | |
488 key. | |
489 | |
490 @item | |
491 @cindex @kbd{C-x 5} | |
492 @vindex ctl-x-5-map | |
493 @code{ctl-x-5-map} is the global keymap used for the @kbd{C-x 5} prefix | |
494 key. | |
495 | |
496 @item | |
497 @cindex @kbd{C-x 6} | |
498 @vindex 2C-mode-map | |
499 @code{2C-mode-map} is the global keymap used for the @kbd{C-x 6} prefix | |
500 key. | |
501 | |
502 @item | |
503 @cindex @kbd{C-x v} | |
504 @vindex vc-prefix-map | |
505 @code{vc-prefix-map} is the global keymap used for the @kbd{C-x v} prefix | |
506 key. | |
507 | |
508 @item | |
102755
c7b4bd09cdf1
(Prefix Keys): The M-g prefix key is now named goto-map. Add
Chong Yidong <cyd@stupidchicken.com>
parents:
101861
diff
changeset
|
509 @cindex @kbd{M-g} |
c7b4bd09cdf1
(Prefix Keys): The M-g prefix key is now named goto-map. Add
Chong Yidong <cyd@stupidchicken.com>
parents:
101861
diff
changeset
|
510 @vindex goto-map |
c7b4bd09cdf1
(Prefix Keys): The M-g prefix key is now named goto-map. Add
Chong Yidong <cyd@stupidchicken.com>
parents:
101861
diff
changeset
|
511 @code{goto-map} is the global keymap used for the @kbd{M-g} prefix |
c7b4bd09cdf1
(Prefix Keys): The M-g prefix key is now named goto-map. Add
Chong Yidong <cyd@stupidchicken.com>
parents:
101861
diff
changeset
|
512 key. |
c7b4bd09cdf1
(Prefix Keys): The M-g prefix key is now named goto-map. Add
Chong Yidong <cyd@stupidchicken.com>
parents:
101861
diff
changeset
|
513 |
c7b4bd09cdf1
(Prefix Keys): The M-g prefix key is now named goto-map. Add
Chong Yidong <cyd@stupidchicken.com>
parents:
101861
diff
changeset
|
514 @item |
c7b4bd09cdf1
(Prefix Keys): The M-g prefix key is now named goto-map. Add
Chong Yidong <cyd@stupidchicken.com>
parents:
101861
diff
changeset
|
515 @cindex @kbd{M-s} |
c7b4bd09cdf1
(Prefix Keys): The M-g prefix key is now named goto-map. Add
Chong Yidong <cyd@stupidchicken.com>
parents:
101861
diff
changeset
|
516 @vindex search-map |
c7b4bd09cdf1
(Prefix Keys): The M-g prefix key is now named goto-map. Add
Chong Yidong <cyd@stupidchicken.com>
parents:
101861
diff
changeset
|
517 @code{search-map} is the global keymap used for the @kbd{M-s} prefix |
c7b4bd09cdf1
(Prefix Keys): The M-g prefix key is now named goto-map. Add
Chong Yidong <cyd@stupidchicken.com>
parents:
101861
diff
changeset
|
518 key. |
c7b4bd09cdf1
(Prefix Keys): The M-g prefix key is now named goto-map. Add
Chong Yidong <cyd@stupidchicken.com>
parents:
101861
diff
changeset
|
519 |
c7b4bd09cdf1
(Prefix Keys): The M-g prefix key is now named goto-map. Add
Chong Yidong <cyd@stupidchicken.com>
parents:
101861
diff
changeset
|
520 @item |
84078 | 521 @cindex @kbd{M-o} |
522 @vindex facemenu-keymap | |
523 @code{facemenu-keymap} is the global keymap used for the @kbd{M-o} | |
524 prefix key. | |
525 | |
526 @item | |
102755
c7b4bd09cdf1
(Prefix Keys): The M-g prefix key is now named goto-map. Add
Chong Yidong <cyd@stupidchicken.com>
parents:
101861
diff
changeset
|
527 The other Emacs prefix keys are @kbd{C-x @@}, @kbd{C-x a i}, @kbd{C-x |
c7b4bd09cdf1
(Prefix Keys): The M-g prefix key is now named goto-map. Add
Chong Yidong <cyd@stupidchicken.com>
parents:
101861
diff
changeset
|
528 @key{ESC}} and @kbd{@key{ESC} @key{ESC}}. They use keymaps that have |
c7b4bd09cdf1
(Prefix Keys): The M-g prefix key is now named goto-map. Add
Chong Yidong <cyd@stupidchicken.com>
parents:
101861
diff
changeset
|
529 no special names. |
84078 | 530 @end itemize |
531 | |
532 The keymap binding of a prefix key is used for looking up the event | |
533 that follows the prefix key. (It may instead be a symbol whose function | |
534 definition is a keymap. The effect is the same, but the symbol serves | |
535 as a name for the prefix key.) Thus, the binding of @kbd{C-x} is the | |
536 symbol @code{Control-X-prefix}, whose function cell holds the keymap | |
537 for @kbd{C-x} commands. (The same keymap is also the value of | |
538 @code{ctl-x-map}.) | |
539 | |
540 Prefix key definitions can appear in any active keymap. The | |
541 definitions of @kbd{C-c}, @kbd{C-x}, @kbd{C-h} and @key{ESC} as prefix | |
542 keys appear in the global map, so these prefix keys are always | |
543 available. Major and minor modes can redefine a key as a prefix by | |
544 putting a prefix key definition for it in the local map or the minor | |
545 mode's map. @xref{Active Keymaps}. | |
546 | |
547 If a key is defined as a prefix in more than one active map, then its | |
548 various definitions are in effect merged: the commands defined in the | |
549 minor mode keymaps come first, followed by those in the local map's | |
550 prefix definition, and then by those from the global map. | |
551 | |
552 In the following example, we make @kbd{C-p} a prefix key in the local | |
553 keymap, in such a way that @kbd{C-p} is identical to @kbd{C-x}. Then | |
554 the binding for @kbd{C-p C-f} is the function @code{find-file}, just | |
555 like @kbd{C-x C-f}. The key sequence @kbd{C-p 6} is not found in any | |
556 active keymap. | |
557 | |
558 @example | |
559 @group | |
560 (use-local-map (make-sparse-keymap)) | |
561 @result{} nil | |
562 @end group | |
563 @group | |
564 (local-set-key "\C-p" ctl-x-map) | |
565 @result{} nil | |
566 @end group | |
567 @group | |
568 (key-binding "\C-p\C-f") | |
569 @result{} find-file | |
570 @end group | |
571 | |
572 @group | |
573 (key-binding "\C-p6") | |
574 @result{} nil | |
575 @end group | |
576 @end example | |
577 | |
578 @defun define-prefix-command symbol &optional mapvar prompt | |
579 @cindex prefix command | |
580 @anchor{Definition of define-prefix-command} | |
581 This function prepares @var{symbol} for use as a prefix key's binding: | |
582 it creates a sparse keymap and stores it as @var{symbol}'s function | |
583 definition. Subsequently binding a key sequence to @var{symbol} will | |
584 make that key sequence into a prefix key. The return value is @code{symbol}. | |
585 | |
586 This function also sets @var{symbol} as a variable, with the keymap as | |
587 its value. But if @var{mapvar} is non-@code{nil}, it sets @var{mapvar} | |
588 as a variable instead. | |
589 | |
590 If @var{prompt} is non-@code{nil}, that becomes the overall prompt | |
591 string for the keymap. The prompt string should be given for menu keymaps | |
592 (@pxref{Defining Menus}). | |
593 @end defun | |
594 | |
595 @node Active Keymaps | |
596 @section Active Keymaps | |
597 @cindex active keymap | |
598 @cindex global keymap | |
599 @cindex local keymap | |
600 | |
601 Emacs normally contains many keymaps; at any given time, just a few | |
602 of them are @dfn{active}, meaning that they participate in the | |
603 interpretation of user input. All the active keymaps are used | |
604 together to determine what command to execute when a key is entered. | |
605 | |
606 Normally the active keymaps are the @code{keymap} property keymap, | |
607 the keymaps of any enabled minor modes, the current buffer's local | |
608 keymap, and the global keymap, in that order. Emacs searches for each | |
609 input key sequence in all these keymaps. @xref{Searching Keymaps}, | |
610 for more details of this procedure. | |
611 | |
612 When the key sequence starts with a mouse event (optionally preceded | |
613 by a symbolic prefix), the active keymaps are determined based on the | |
614 position in that event. If the event happened on a string embedded | |
615 with a @code{display}, @code{before-string}, or @code{after-string} | |
616 property (@pxref{Special Properties}), the non-@code{nil} map | |
94198
5f9b227e3b2e
(Active Keymaps): Clarify role of underlying textprop and overlay
Chong Yidong <cyd@stupidchicken.com>
parents:
91624
diff
changeset
|
617 properties of the string override those of the buffer (if the |
5f9b227e3b2e
(Active Keymaps): Clarify role of underlying textprop and overlay
Chong Yidong <cyd@stupidchicken.com>
parents:
91624
diff
changeset
|
618 underlying buffer text contains map properties in its text properties |
5f9b227e3b2e
(Active Keymaps): Clarify role of underlying textprop and overlay
Chong Yidong <cyd@stupidchicken.com>
parents:
91624
diff
changeset
|
619 or overlays, they are ignored). |
84078 | 620 |
621 The @dfn{global keymap} holds the bindings of keys that are defined | |
622 regardless of the current buffer, such as @kbd{C-f}. The variable | |
623 @code{global-map} holds this keymap, which is always active. | |
624 | |
625 Each buffer may have another keymap, its @dfn{local keymap}, which | |
626 may contain new or overriding definitions for keys. The current | |
627 buffer's local keymap is always active except when | |
628 @code{overriding-local-map} overrides it. The @code{local-map} text | |
629 or overlay property can specify an alternative local keymap for certain | |
630 parts of the buffer; see @ref{Special Properties}. | |
631 | |
632 Each minor mode can have a keymap; if it does, the keymap is active | |
633 when the minor mode is enabled. Modes for emulation can specify | |
634 additional active keymaps through the variable | |
635 @code{emulation-mode-map-alists}. | |
636 | |
637 The highest precedence normal keymap comes from the @code{keymap} | |
638 text or overlay property. If that is non-@code{nil}, it is the first | |
639 keymap to be processed, in normal circumstances. | |
640 | |
641 However, there are also special ways for programs to substitute | |
642 other keymaps for some of those. The variable | |
643 @code{overriding-local-map}, if non-@code{nil}, specifies a keymap | |
644 that replaces all the usual active keymaps except the global keymap. | |
645 Another way to do this is with @code{overriding-terminal-local-map}; | |
646 it operates on a per-terminal basis. These variables are documented | |
647 below. | |
648 | |
649 @cindex major mode keymap | |
650 Since every buffer that uses the same major mode normally uses the | |
651 same local keymap, you can think of the keymap as local to the mode. A | |
652 change to the local keymap of a buffer (using @code{local-set-key}, for | |
653 example) is seen also in the other buffers that share that keymap. | |
654 | |
655 The local keymaps that are used for Lisp mode and some other major | |
656 modes exist even if they have not yet been used. These local keymaps are | |
657 the values of variables such as @code{lisp-mode-map}. For most major | |
658 modes, which are less frequently used, the local keymap is constructed | |
659 only when the mode is used for the first time in a session. | |
660 | |
661 The minibuffer has local keymaps, too; they contain various completion | |
662 and exit commands. @xref{Intro to Minibuffers}. | |
663 | |
664 Emacs has other keymaps that are used in a different way---translating | |
665 events within @code{read-key-sequence}. @xref{Translation Keymaps}. | |
666 | |
667 @xref{Standard Keymaps}, for a list of standard keymaps. | |
668 | |
669 @defun current-active-maps &optional olp position | |
670 This returns the list of active keymaps that would be used by the | |
671 command loop in the current circumstances to look up a key sequence. | |
672 Normally it ignores @code{overriding-local-map} and | |
673 @code{overriding-terminal-local-map}, but if @var{olp} is non-@code{nil} | |
674 then it pays attention to them. @var{position} can optionally be either | |
675 an event position as returned by @code{event-start} or a buffer | |
676 position, and may change the keymaps as described for | |
677 @code{key-binding}. | |
678 @end defun | |
679 | |
680 @defun key-binding key &optional accept-defaults no-remap position | |
681 This function returns the binding for @var{key} according to the | |
682 current active keymaps. The result is @code{nil} if @var{key} is | |
683 undefined in the keymaps. | |
684 | |
685 The argument @var{accept-defaults} controls checking for default | |
686 bindings, as in @code{lookup-key} (@pxref{Functions for Key Lookup}). | |
687 | |
688 When commands are remapped (@pxref{Remapping Commands}), | |
689 @code{key-binding} normally processes command remappings so as to | |
690 returns the remapped command that will actually be executed. However, | |
691 if @var{no-remap} is non-@code{nil}, @code{key-binding} ignores | |
692 remappings and returns the binding directly specified for @var{key}. | |
693 | |
694 If @var{key} starts with a mouse event (perhaps following a prefix | |
695 event), the maps to be consulted are determined based on the event's | |
696 position. Otherwise, they are determined based on the value of point. | |
697 However, you can override either of them by specifying @var{position}. | |
698 If @var{position} is non-@code{nil}, it should be either a buffer | |
699 position or an event position like the value of @code{event-start}. | |
700 Then the maps consulted are determined based on @var{position}. | |
701 | |
702 An error is signaled if @var{key} is not a string or a vector. | |
703 | |
704 @example | |
705 @group | |
706 (key-binding "\C-x\C-f") | |
707 @result{} find-file | |
708 @end group | |
709 @end example | |
710 @end defun | |
711 | |
712 @node Searching Keymaps | |
713 @section Searching the Active Keymaps | |
714 @cindex searching active keymaps for keys | |
715 | |
716 After translation of event subsequences (@pxref{Translation | |
717 Keymaps}) Emacs looks for them in the active keymaps. Here is a | |
718 pseudo-Lisp description of the order and conditions for searching | |
719 them: | |
720 | |
721 @lisp | |
722 (or (if overriding-terminal-local-map | |
723 (@var{find-in} overriding-terminal-local-map) | |
724 (if overriding-local-map | |
725 (@var{find-in} overriding-local-map) | |
726 (or (@var{find-in} (get-char-property (point) 'keymap)) | |
727 (@var{find-in-any} emulation-mode-map-alists) | |
728 (@var{find-in-any} minor-mode-overriding-map-alist) | |
729 (@var{find-in-any} minor-mode-map-alist) | |
730 (if (get-text-property (point) 'local-map) | |
731 (@var{find-in} (get-char-property (point) 'local-map)) | |
732 (@var{find-in} (current-local-map)))))) | |
733 (@var{find-in} (current-global-map))) | |
734 @end lisp | |
735 | |
736 @noindent | |
737 The @var{find-in} and @var{find-in-any} are pseudo functions that | |
738 search in one keymap and in an alist of keymaps, respectively. | |
739 (Searching a single keymap for a binding is called @dfn{key lookup}; | |
740 see @ref{Key Lookup}.) If the key sequence starts with a mouse event, | |
741 or a symbolic prefix event followed by a mouse event, that event's | |
742 position is used instead of point and the current buffer. Mouse | |
743 events on an embedded string use non-@code{nil} text properties from | |
744 that string instead of the buffer. | |
745 | |
746 @enumerate | |
747 @item | |
748 The function finally found may be remapped | |
749 (@pxref{Remapping Commands}). | |
750 | |
751 @item | |
101861
cd9537533674
(Searching Keymaps): Reinstate documentation of translation-table-for-input.
Eli Zaretskii <eliz@gnu.org>
parents:
101265
diff
changeset
|
752 Characters that are bound to @code{self-insert-command} are translated |
cd9537533674
(Searching Keymaps): Reinstate documentation of translation-table-for-input.
Eli Zaretskii <eliz@gnu.org>
parents:
101265
diff
changeset
|
753 according to @code{translation-table-for-input} before insertion. |
cd9537533674
(Searching Keymaps): Reinstate documentation of translation-table-for-input.
Eli Zaretskii <eliz@gnu.org>
parents:
101265
diff
changeset
|
754 |
cd9537533674
(Searching Keymaps): Reinstate documentation of translation-table-for-input.
Eli Zaretskii <eliz@gnu.org>
parents:
101265
diff
changeset
|
755 @item |
84078 | 756 @code{current-active-maps} returns a list of the |
757 currently active keymaps at point. | |
758 | |
759 @item | |
760 When a match is found (@pxref{Key Lookup}), if the binding in the | |
761 keymap is a function, the search is over. However if the keymap entry | |
762 is a symbol with a value or a string, Emacs replaces the input key | |
763 sequences with the variable's value or the string, and restarts the | |
764 search of the active keymaps. | |
765 @end enumerate | |
766 | |
767 @node Controlling Active Maps | |
768 @section Controlling the Active Keymaps | |
769 | |
770 @defvar global-map | |
771 This variable contains the default global keymap that maps Emacs | |
772 keyboard input to commands. The global keymap is normally this | |
773 keymap. The default global keymap is a full keymap that binds | |
774 @code{self-insert-command} to all of the printing characters. | |
775 | |
776 It is normal practice to change the bindings in the global keymap, but you | |
777 should not assign this variable any value other than the keymap it starts | |
778 out with. | |
779 @end defvar | |
780 | |
781 @defun current-global-map | |
94636
3493d476ef0f
Document the fact that (current-local-map) and (urrent-global-map)
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
94331
diff
changeset
|
782 This function returns the current global keymap. This is the same as |
3493d476ef0f
Document the fact that (current-local-map) and (urrent-global-map)
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
94331
diff
changeset
|
783 the value of @code{global-map} unless you change one or the other. |
3493d476ef0f
Document the fact that (current-local-map) and (urrent-global-map)
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
94331
diff
changeset
|
784 The return value is a reference, not a copy; if you use |
3493d476ef0f
Document the fact that (current-local-map) and (urrent-global-map)
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
94331
diff
changeset
|
785 @code{define-key} or other functions on it you will alter global |
3493d476ef0f
Document the fact that (current-local-map) and (urrent-global-map)
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
94331
diff
changeset
|
786 bindings. |
84078 | 787 |
788 @example | |
789 @group | |
790 (current-global-map) | |
791 @result{} (keymap [set-mark-command beginning-of-line @dots{} | |
792 delete-backward-char]) | |
793 @end group | |
794 @end example | |
795 @end defun | |
796 | |
797 @defun current-local-map | |
798 This function returns the current buffer's local keymap, or @code{nil} | |
799 if it has none. In the following example, the keymap for the | |
800 @samp{*scratch*} buffer (using Lisp Interaction mode) is a sparse keymap | |
801 in which the entry for @key{ESC}, @acronym{ASCII} code 27, is another sparse | |
802 keymap. | |
803 | |
804 @example | |
805 @group | |
806 (current-local-map) | |
807 @result{} (keymap | |
808 (10 . eval-print-last-sexp) | |
809 (9 . lisp-indent-line) | |
810 (127 . backward-delete-char-untabify) | |
811 @end group | |
812 @group | |
813 (27 keymap | |
814 (24 . eval-defun) | |
815 (17 . indent-sexp))) | |
816 @end group | |
817 @end example | |
818 @end defun | |
819 | |
94636
3493d476ef0f
Document the fact that (current-local-map) and (urrent-global-map)
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
94331
diff
changeset
|
820 @code{current-local-map} returns a reference to the local keymap, not |
3493d476ef0f
Document the fact that (current-local-map) and (urrent-global-map)
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
94331
diff
changeset
|
821 a copy of it; if you use @code{define-key} or other functions on it |
3493d476ef0f
Document the fact that (current-local-map) and (urrent-global-map)
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
94331
diff
changeset
|
822 you will alter local bindings. |
3493d476ef0f
Document the fact that (current-local-map) and (urrent-global-map)
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
94331
diff
changeset
|
823 |
84078 | 824 @defun current-minor-mode-maps |
825 This function returns a list of the keymaps of currently enabled minor modes. | |
826 @end defun | |
827 | |
828 @defun use-global-map keymap | |
829 This function makes @var{keymap} the new current global keymap. It | |
830 returns @code{nil}. | |
831 | |
832 It is very unusual to change the global keymap. | |
833 @end defun | |
834 | |
835 @defun use-local-map keymap | |
836 This function makes @var{keymap} the new local keymap of the current | |
837 buffer. If @var{keymap} is @code{nil}, then the buffer has no local | |
838 keymap. @code{use-local-map} returns @code{nil}. Most major mode | |
839 commands use this function. | |
840 @end defun | |
841 | |
842 @c Emacs 19 feature | |
843 @defvar minor-mode-map-alist | |
844 @anchor{Definition of minor-mode-map-alist} | |
845 This variable is an alist describing keymaps that may or may not be | |
846 active according to the values of certain variables. Its elements look | |
847 like this: | |
848 | |
849 @example | |
850 (@var{variable} . @var{keymap}) | |
851 @end example | |
852 | |
853 The keymap @var{keymap} is active whenever @var{variable} has a | |
854 non-@code{nil} value. Typically @var{variable} is the variable that | |
855 enables or disables a minor mode. @xref{Keymaps and Minor Modes}. | |
856 | |
857 Note that elements of @code{minor-mode-map-alist} do not have the same | |
858 structure as elements of @code{minor-mode-alist}. The map must be the | |
859 @sc{cdr} of the element; a list with the map as the second element will | |
860 not do. The @sc{cdr} can be either a keymap (a list) or a symbol whose | |
861 function definition is a keymap. | |
862 | |
863 When more than one minor mode keymap is active, the earlier one in | |
864 @code{minor-mode-map-alist} takes priority. But you should design | |
865 minor modes so that they don't interfere with each other. If you do | |
866 this properly, the order will not matter. | |
867 | |
868 See @ref{Keymaps and Minor Modes}, for more information about minor | |
869 modes. See also @code{minor-mode-key-binding} (@pxref{Functions for Key | |
870 Lookup}). | |
871 @end defvar | |
872 | |
873 @defvar minor-mode-overriding-map-alist | |
874 This variable allows major modes to override the key bindings for | |
875 particular minor modes. The elements of this alist look like the | |
876 elements of @code{minor-mode-map-alist}: @code{(@var{variable} | |
877 . @var{keymap})}. | |
878 | |
879 If a variable appears as an element of | |
880 @code{minor-mode-overriding-map-alist}, the map specified by that | |
881 element totally replaces any map specified for the same variable in | |
882 @code{minor-mode-map-alist}. | |
883 | |
884 @code{minor-mode-overriding-map-alist} is automatically buffer-local in | |
885 all buffers. | |
886 @end defvar | |
887 | |
888 @defvar overriding-local-map | |
889 If non-@code{nil}, this variable holds a keymap to use instead of the | |
890 buffer's local keymap, any text property or overlay keymaps, and any | |
891 minor mode keymaps. This keymap, if specified, overrides all other | |
892 maps that would have been active, except for the current global map. | |
893 @end defvar | |
894 | |
895 @defvar overriding-terminal-local-map | |
896 If non-@code{nil}, this variable holds a keymap to use instead of | |
897 @code{overriding-local-map}, the buffer's local keymap, text property | |
898 or overlay keymaps, and all the minor mode keymaps. | |
899 | |
900 This variable is always local to the current terminal and cannot be | |
901 buffer-local. @xref{Multiple Displays}. It is used to implement | |
902 incremental search mode. | |
903 @end defvar | |
904 | |
905 @defvar overriding-local-map-menu-flag | |
906 If this variable is non-@code{nil}, the value of | |
907 @code{overriding-local-map} or @code{overriding-terminal-local-map} can | |
908 affect the display of the menu bar. The default value is @code{nil}, so | |
909 those map variables have no effect on the menu bar. | |
910 | |
911 Note that these two map variables do affect the execution of key | |
912 sequences entered using the menu bar, even if they do not affect the | |
913 menu bar display. So if a menu bar key sequence comes in, you should | |
914 clear the variables before looking up and executing that key sequence. | |
915 Modes that use the variables would typically do this anyway; normally | |
916 they respond to events that they do not handle by ``unreading'' them and | |
917 exiting. | |
918 @end defvar | |
919 | |
920 @defvar special-event-map | |
921 This variable holds a keymap for special events. If an event type has a | |
922 binding in this keymap, then it is special, and the binding for the | |
923 event is run directly by @code{read-event}. @xref{Special Events}. | |
924 @end defvar | |
925 | |
926 @defvar emulation-mode-map-alists | |
927 This variable holds a list of keymap alists to use for emulations | |
928 modes. It is intended for modes or packages using multiple minor-mode | |
929 keymaps. Each element is a keymap alist which has the same format and | |
930 meaning as @code{minor-mode-map-alist}, or a symbol with a variable | |
931 binding which is such an alist. The ``active'' keymaps in each alist | |
932 are used before @code{minor-mode-map-alist} and | |
933 @code{minor-mode-overriding-map-alist}. | |
934 @end defvar | |
935 | |
936 @node Key Lookup | |
937 @section Key Lookup | |
938 @cindex key lookup | |
939 @cindex keymap entry | |
940 | |
941 @dfn{Key lookup} is the process of finding the binding of a key | |
942 sequence from a given keymap. The execution or use of the binding is | |
943 not part of key lookup. | |
944 | |
945 Key lookup uses just the event type of each event in the key sequence; | |
946 the rest of the event is ignored. In fact, a key sequence used for key | |
947 lookup may designate a mouse event with just its types (a symbol) | |
948 instead of the entire event (a list). @xref{Input Events}. Such | |
949 a ``key sequence'' is insufficient for @code{command-execute} to run, | |
950 but it is sufficient for looking up or rebinding a key. | |
951 | |
952 When the key sequence consists of multiple events, key lookup | |
953 processes the events sequentially: the binding of the first event is | |
954 found, and must be a keymap; then the second event's binding is found in | |
955 that keymap, and so on until all the events in the key sequence are used | |
956 up. (The binding thus found for the last event may or may not be a | |
957 keymap.) Thus, the process of key lookup is defined in terms of a | |
958 simpler process for looking up a single event in a keymap. How that is | |
959 done depends on the type of object associated with the event in that | |
960 keymap. | |
961 | |
962 Let's use the term @dfn{keymap entry} to describe the value found by | |
963 looking up an event type in a keymap. (This doesn't include the item | |
964 string and other extra elements in a keymap element for a menu item, because | |
965 @code{lookup-key} and other key lookup functions don't include them in | |
966 the returned value.) While any Lisp object may be stored in a keymap | |
967 as a keymap entry, not all make sense for key lookup. Here is a table | |
968 of the meaningful types of keymap entries: | |
969 | |
970 @table @asis | |
971 @item @code{nil} | |
972 @cindex @code{nil} in keymap | |
973 @code{nil} means that the events used so far in the lookup form an | |
974 undefined key. When a keymap fails to mention an event type at all, and | |
975 has no default binding, that is equivalent to a binding of @code{nil} | |
976 for that event type. | |
977 | |
978 @item @var{command} | |
979 @cindex command in keymap | |
980 The events used so far in the lookup form a complete key, | |
981 and @var{command} is its binding. @xref{What Is a Function}. | |
982 | |
983 @item @var{array} | |
984 @cindex string in keymap | |
985 The array (either a string or a vector) is a keyboard macro. The events | |
986 used so far in the lookup form a complete key, and the array is its | |
987 binding. See @ref{Keyboard Macros}, for more information. | |
988 | |
989 @item @var{keymap} | |
990 @cindex keymap in keymap | |
991 The events used so far in the lookup form a prefix key. The next | |
992 event of the key sequence is looked up in @var{keymap}. | |
993 | |
994 @item @var{list} | |
995 @cindex list in keymap | |
996 The meaning of a list depends on what it contains: | |
997 | |
998 @itemize @bullet | |
999 @item | |
1000 If the @sc{car} of @var{list} is the symbol @code{keymap}, then the list | |
1001 is a keymap, and is treated as a keymap (see above). | |
1002 | |
1003 @item | |
1004 @cindex @code{lambda} in keymap | |
1005 If the @sc{car} of @var{list} is @code{lambda}, then the list is a | |
1006 lambda expression. This is presumed to be a function, and is treated | |
1007 as such (see above). In order to execute properly as a key binding, | |
1008 this function must be a command---it must have an @code{interactive} | |
1009 specification. @xref{Defining Commands}. | |
1010 | |
1011 @item | |
1012 If the @sc{car} of @var{list} is a keymap and the @sc{cdr} is an event | |
1013 type, then this is an @dfn{indirect entry}: | |
1014 | |
1015 @example | |
1016 (@var{othermap} . @var{othertype}) | |
1017 @end example | |
1018 | |
1019 When key lookup encounters an indirect entry, it looks up instead the | |
1020 binding of @var{othertype} in @var{othermap} and uses that. | |
1021 | |
1022 This feature permits you to define one key as an alias for another key. | |
1023 For example, an entry whose @sc{car} is the keymap called @code{esc-map} | |
1024 and whose @sc{cdr} is 32 (the code for @key{SPC}) means, ``Use the global | |
1025 binding of @kbd{Meta-@key{SPC}}, whatever that may be.'' | |
1026 @end itemize | |
1027 | |
1028 @item @var{symbol} | |
1029 @cindex symbol in keymap | |
1030 The function definition of @var{symbol} is used in place of | |
1031 @var{symbol}. If that too is a symbol, then this process is repeated, | |
1032 any number of times. Ultimately this should lead to an object that is | |
1033 a keymap, a command, or a keyboard macro. A list is allowed if it is a | |
1034 keymap or a command, but indirect entries are not understood when found | |
1035 via symbols. | |
1036 | |
1037 Note that keymaps and keyboard macros (strings and vectors) are not | |
1038 valid functions, so a symbol with a keymap, string, or vector as its | |
1039 function definition is invalid as a function. It is, however, valid as | |
1040 a key binding. If the definition is a keyboard macro, then the symbol | |
1041 is also valid as an argument to @code{command-execute} | |
1042 (@pxref{Interactive Call}). | |
1043 | |
1044 @cindex @code{undefined} in keymap | |
1045 The symbol @code{undefined} is worth special mention: it means to treat | |
1046 the key as undefined. Strictly speaking, the key is defined, and its | |
1047 binding is the command @code{undefined}; but that command does the same | |
1048 thing that is done automatically for an undefined key: it rings the bell | |
1049 (by calling @code{ding}) but does not signal an error. | |
1050 | |
1051 @cindex preventing prefix key | |
1052 @code{undefined} is used in local keymaps to override a global key | |
1053 binding and make the key ``undefined'' locally. A local binding of | |
1054 @code{nil} would fail to do this because it would not override the | |
1055 global binding. | |
1056 | |
1057 @item @var{anything else} | |
1058 If any other type of object is found, the events used so far in the | |
1059 lookup form a complete key, and the object is its binding, but the | |
1060 binding is not executable as a command. | |
1061 @end table | |
1062 | |
1063 In short, a keymap entry may be a keymap, a command, a keyboard macro, | |
1064 a symbol that leads to one of them, or an indirection or @code{nil}. | |
1065 Here is an example of a sparse keymap with two characters bound to | |
1066 commands and one bound to another keymap. This map is the normal value | |
1067 of @code{emacs-lisp-mode-map}. Note that 9 is the code for @key{TAB}, | |
1068 127 for @key{DEL}, 27 for @key{ESC}, 17 for @kbd{C-q} and 24 for | |
1069 @kbd{C-x}. | |
1070 | |
1071 @example | |
1072 @group | |
1073 (keymap (9 . lisp-indent-line) | |
1074 (127 . backward-delete-char-untabify) | |
1075 (27 keymap (17 . indent-sexp) (24 . eval-defun))) | |
1076 @end group | |
1077 @end example | |
1078 | |
1079 @node Functions for Key Lookup | |
1080 @section Functions for Key Lookup | |
1081 | |
1082 Here are the functions and variables pertaining to key lookup. | |
1083 | |
1084 @defun lookup-key keymap key &optional accept-defaults | |
1085 This function returns the definition of @var{key} in @var{keymap}. All | |
1086 the other functions described in this chapter that look up keys use | |
1087 @code{lookup-key}. Here are examples: | |
1088 | |
1089 @example | |
1090 @group | |
1091 (lookup-key (current-global-map) "\C-x\C-f") | |
1092 @result{} find-file | |
1093 @end group | |
1094 @group | |
1095 (lookup-key (current-global-map) (kbd "C-x C-f")) | |
1096 @result{} find-file | |
1097 @end group | |
1098 @group | |
1099 (lookup-key (current-global-map) "\C-x\C-f12345") | |
1100 @result{} 2 | |
1101 @end group | |
1102 @end example | |
1103 | |
1104 If the string or vector @var{key} is not a valid key sequence according | |
1105 to the prefix keys specified in @var{keymap}, it must be ``too long'' | |
1106 and have extra events at the end that do not fit into a single key | |
1107 sequence. Then the value is a number, the number of events at the front | |
1108 of @var{key} that compose a complete key. | |
1109 | |
1110 @c Emacs 19 feature | |
1111 If @var{accept-defaults} is non-@code{nil}, then @code{lookup-key} | |
1112 considers default bindings as well as bindings for the specific events | |
1113 in @var{key}. Otherwise, @code{lookup-key} reports only bindings for | |
1114 the specific sequence @var{key}, ignoring default bindings except when | |
1115 you explicitly ask about them. (To do this, supply @code{t} as an | |
1116 element of @var{key}; see @ref{Format of Keymaps}.) | |
1117 | |
1118 If @var{key} contains a meta character (not a function key), that | |
1119 character is implicitly replaced by a two-character sequence: the value | |
1120 of @code{meta-prefix-char}, followed by the corresponding non-meta | |
1121 character. Thus, the first example below is handled by conversion into | |
1122 the second example. | |
1123 | |
1124 @example | |
1125 @group | |
1126 (lookup-key (current-global-map) "\M-f") | |
1127 @result{} forward-word | |
1128 @end group | |
1129 @group | |
1130 (lookup-key (current-global-map) "\ef") | |
1131 @result{} forward-word | |
1132 @end group | |
1133 @end example | |
1134 | |
1135 Unlike @code{read-key-sequence}, this function does not modify the | |
1136 specified events in ways that discard information (@pxref{Key Sequence | |
1137 Input}). In particular, it does not convert letters to lower case and | |
1138 it does not change drag events to clicks. | |
1139 @end defun | |
1140 | |
1141 @deffn Command undefined | |
1142 Used in keymaps to undefine keys. It calls @code{ding}, but does | |
1143 not cause an error. | |
1144 @end deffn | |
1145 | |
1146 @defun local-key-binding key &optional accept-defaults | |
1147 This function returns the binding for @var{key} in the current | |
1148 local keymap, or @code{nil} if it is undefined there. | |
1149 | |
1150 @c Emacs 19 feature | |
1151 The argument @var{accept-defaults} controls checking for default bindings, | |
1152 as in @code{lookup-key} (above). | |
1153 @end defun | |
1154 | |
1155 @defun global-key-binding key &optional accept-defaults | |
1156 This function returns the binding for command @var{key} in the | |
1157 current global keymap, or @code{nil} if it is undefined there. | |
1158 | |
1159 @c Emacs 19 feature | |
1160 The argument @var{accept-defaults} controls checking for default bindings, | |
1161 as in @code{lookup-key} (above). | |
1162 @end defun | |
1163 | |
1164 @c Emacs 19 feature | |
1165 @defun minor-mode-key-binding key &optional accept-defaults | |
1166 This function returns a list of all the active minor mode bindings of | |
1167 @var{key}. More precisely, it returns an alist of pairs | |
1168 @code{(@var{modename} . @var{binding})}, where @var{modename} is the | |
1169 variable that enables the minor mode, and @var{binding} is @var{key}'s | |
1170 binding in that mode. If @var{key} has no minor-mode bindings, the | |
1171 value is @code{nil}. | |
1172 | |
1173 If the first binding found is not a prefix definition (a keymap or a | |
1174 symbol defined as a keymap), all subsequent bindings from other minor | |
1175 modes are omitted, since they would be completely shadowed. Similarly, | |
1176 the list omits non-prefix bindings that follow prefix bindings. | |
1177 | |
1178 The argument @var{accept-defaults} controls checking for default | |
1179 bindings, as in @code{lookup-key} (above). | |
1180 @end defun | |
1181 | |
1182 @defvar meta-prefix-char | |
1183 @cindex @key{ESC} | |
1184 This variable is the meta-prefix character code. It is used for | |
1185 translating a meta character to a two-character sequence so it can be | |
1186 looked up in a keymap. For useful results, the value should be a | |
1187 prefix event (@pxref{Prefix Keys}). The default value is 27, which is | |
1188 the @acronym{ASCII} code for @key{ESC}. | |
1189 | |
1190 As long as the value of @code{meta-prefix-char} remains 27, key lookup | |
1191 translates @kbd{M-b} into @kbd{@key{ESC} b}, which is normally defined | |
1192 as the @code{backward-word} command. However, if you were to set | |
1193 @code{meta-prefix-char} to 24, the code for @kbd{C-x}, then Emacs will | |
1194 translate @kbd{M-b} into @kbd{C-x b}, whose standard binding is the | |
1195 @code{switch-to-buffer} command. (Don't actually do this!) Here is an | |
1196 illustration of what would happen: | |
1197 | |
1198 @smallexample | |
1199 @group | |
1200 meta-prefix-char ; @r{The default value.} | |
1201 @result{} 27 | |
1202 @end group | |
1203 @group | |
1204 (key-binding "\M-b") | |
1205 @result{} backward-word | |
1206 @end group | |
1207 @group | |
1208 ?\C-x ; @r{The print representation} | |
1209 @result{} 24 ; @r{of a character.} | |
1210 @end group | |
1211 @group | |
1212 (setq meta-prefix-char 24) | |
1213 @result{} 24 | |
1214 @end group | |
1215 @group | |
1216 (key-binding "\M-b") | |
1217 @result{} switch-to-buffer ; @r{Now, typing @kbd{M-b} is} | |
1218 ; @r{like typing @kbd{C-x b}.} | |
1219 | |
1220 (setq meta-prefix-char 27) ; @r{Avoid confusion!} | |
1221 @result{} 27 ; @r{Restore the default value!} | |
1222 @end group | |
1223 @end smallexample | |
1224 | |
1225 This translation of one event into two happens only for characters, not | |
1226 for other kinds of input events. Thus, @kbd{M-@key{F1}}, a function | |
1227 key, is not converted into @kbd{@key{ESC} @key{F1}}. | |
1228 @end defvar | |
1229 | |
1230 @node Changing Key Bindings | |
1231 @section Changing Key Bindings | |
1232 @cindex changing key bindings | |
1233 @cindex rebinding | |
1234 | |
1235 The way to rebind a key is to change its entry in a keymap. If you | |
1236 change a binding in the global keymap, the change is effective in all | |
1237 buffers (though it has no direct effect in buffers that shadow the | |
1238 global binding with a local one). If you change the current buffer's | |
1239 local map, that usually affects all buffers using the same major mode. | |
1240 The @code{global-set-key} and @code{local-set-key} functions are | |
1241 convenient interfaces for these operations (@pxref{Key Binding | |
1242 Commands}). You can also use @code{define-key}, a more general | |
1243 function; then you must specify explicitly the map to change. | |
1244 | |
1245 When choosing the key sequences for Lisp programs to rebind, please | |
1246 follow the Emacs conventions for use of various keys (@pxref{Key | |
1247 Binding Conventions}). | |
1248 | |
1249 @cindex meta character key constants | |
1250 @cindex control character key constants | |
1251 In writing the key sequence to rebind, it is good to use the special | |
1252 escape sequences for control and meta characters (@pxref{String Type}). | |
1253 The syntax @samp{\C-} means that the following character is a control | |
1254 character and @samp{\M-} means that the following character is a meta | |
1255 character. Thus, the string @code{"\M-x"} is read as containing a | |
1256 single @kbd{M-x}, @code{"\C-f"} is read as containing a single | |
1257 @kbd{C-f}, and @code{"\M-\C-x"} and @code{"\C-\M-x"} are both read as | |
1258 containing a single @kbd{C-M-x}. You can also use this escape syntax in | |
1259 vectors, as well as others that aren't allowed in strings; one example | |
1260 is @samp{[?\C-\H-x home]}. @xref{Character Type}. | |
1261 | |
1262 The key definition and lookup functions accept an alternate syntax for | |
1263 event types in a key sequence that is a vector: you can use a list | |
1264 containing modifier names plus one base event (a character or function | |
1265 key name). For example, @code{(control ?a)} is equivalent to | |
1266 @code{?\C-a} and @code{(hyper control left)} is equivalent to | |
1267 @code{C-H-left}. One advantage of such lists is that the precise | |
1268 numeric codes for the modifier bits don't appear in compiled files. | |
1269 | |
1270 The functions below signal an error if @var{keymap} is not a keymap, | |
1271 or if @var{key} is not a string or vector representing a key sequence. | |
1272 You can use event types (symbols) as shorthand for events that are | |
1273 lists. The @code{kbd} macro (@pxref{Key Sequences}) is a convenient | |
1274 way to specify the key sequence. | |
1275 | |
1276 @defun define-key keymap key binding | |
1277 This function sets the binding for @var{key} in @var{keymap}. (If | |
1278 @var{key} is more than one event long, the change is actually made | |
1279 in another keymap reached from @var{keymap}.) The argument | |
1280 @var{binding} can be any Lisp object, but only certain types are | |
1281 meaningful. (For a list of meaningful types, see @ref{Key Lookup}.) | |
1282 The value returned by @code{define-key} is @var{binding}. | |
1283 | |
1284 If @var{key} is @code{[t]}, this sets the default binding in | |
1285 @var{keymap}. When an event has no binding of its own, the Emacs | |
1286 command loop uses the keymap's default binding, if there is one. | |
1287 | |
1288 @cindex invalid prefix key error | |
1289 @cindex key sequence error | |
1290 Every prefix of @var{key} must be a prefix key (i.e., bound to a keymap) | |
1291 or undefined; otherwise an error is signaled. If some prefix of | |
1292 @var{key} is undefined, then @code{define-key} defines it as a prefix | |
1293 key so that the rest of @var{key} can be defined as specified. | |
1294 | |
1295 If there was previously no binding for @var{key} in @var{keymap}, the | |
1296 new binding is added at the beginning of @var{keymap}. The order of | |
1297 bindings in a keymap makes no difference for keyboard input, but it | |
1298 does matter for menu keymaps (@pxref{Menu Keymaps}). | |
1299 @end defun | |
1300 | |
1301 This example creates a sparse keymap and makes a number of | |
1302 bindings in it: | |
1303 | |
1304 @smallexample | |
1305 @group | |
1306 (setq map (make-sparse-keymap)) | |
1307 @result{} (keymap) | |
1308 @end group | |
1309 @group | |
1310 (define-key map "\C-f" 'forward-char) | |
1311 @result{} forward-char | |
1312 @end group | |
1313 @group | |
1314 map | |
1315 @result{} (keymap (6 . forward-char)) | |
1316 @end group | |
1317 | |
1318 @group | |
1319 ;; @r{Build sparse submap for @kbd{C-x} and bind @kbd{f} in that.} | |
1320 (define-key map (kbd "C-x f") 'forward-word) | |
1321 @result{} forward-word | |
1322 @end group | |
1323 @group | |
1324 map | |
1325 @result{} (keymap | |
1326 (24 keymap ; @kbd{C-x} | |
1327 (102 . forward-word)) ; @kbd{f} | |
1328 (6 . forward-char)) ; @kbd{C-f} | |
1329 @end group | |
1330 | |
1331 @group | |
1332 ;; @r{Bind @kbd{C-p} to the @code{ctl-x-map}.} | |
1333 (define-key map (kbd "C-p") ctl-x-map) | |
1334 ;; @code{ctl-x-map} | |
1335 @result{} [nil @dots{} find-file @dots{} backward-kill-sentence] | |
1336 @end group | |
1337 | |
1338 @group | |
1339 ;; @r{Bind @kbd{C-f} to @code{foo} in the @code{ctl-x-map}.} | |
1340 (define-key map (kbd "C-p C-f") 'foo) | |
1341 @result{} 'foo | |
1342 @end group | |
1343 @group | |
1344 map | |
1345 @result{} (keymap ; @r{Note @code{foo} in @code{ctl-x-map}.} | |
1346 (16 keymap [nil @dots{} foo @dots{} backward-kill-sentence]) | |
1347 (24 keymap | |
1348 (102 . forward-word)) | |
1349 (6 . forward-char)) | |
1350 @end group | |
1351 @end smallexample | |
1352 | |
1353 @noindent | |
1354 Note that storing a new binding for @kbd{C-p C-f} actually works by | |
1355 changing an entry in @code{ctl-x-map}, and this has the effect of | |
1356 changing the bindings of both @kbd{C-p C-f} and @kbd{C-x C-f} in the | |
1357 default global map. | |
1358 | |
1359 The function @code{substitute-key-definition} scans a keymap for | |
1360 keys that have a certain binding and rebinds them with a different | |
1361 binding. Another feature which is cleaner and can often produce the | |
1362 same results to remap one command into another (@pxref{Remapping | |
1363 Commands}). | |
1364 | |
1365 @defun substitute-key-definition olddef newdef keymap &optional oldmap | |
1366 @cindex replace bindings | |
1367 This function replaces @var{olddef} with @var{newdef} for any keys in | |
1368 @var{keymap} that were bound to @var{olddef}. In other words, | |
1369 @var{olddef} is replaced with @var{newdef} wherever it appears. The | |
1370 function returns @code{nil}. | |
1371 | |
1372 For example, this redefines @kbd{C-x C-f}, if you do it in an Emacs with | |
1373 standard bindings: | |
1374 | |
1375 @smallexample | |
1376 @group | |
1377 (substitute-key-definition | |
1378 'find-file 'find-file-read-only (current-global-map)) | |
1379 @end group | |
1380 @end smallexample | |
1381 | |
1382 @c Emacs 19 feature | |
1383 If @var{oldmap} is non-@code{nil}, that changes the behavior of | |
1384 @code{substitute-key-definition}: the bindings in @var{oldmap} determine | |
1385 which keys to rebind. The rebindings still happen in @var{keymap}, not | |
1386 in @var{oldmap}. Thus, you can change one map under the control of the | |
1387 bindings in another. For example, | |
1388 | |
1389 @smallexample | |
1390 (substitute-key-definition | |
1391 'delete-backward-char 'my-funny-delete | |
1392 my-map global-map) | |
1393 @end smallexample | |
1394 | |
1395 @noindent | |
1396 puts the special deletion command in @code{my-map} for whichever keys | |
1397 are globally bound to the standard deletion command. | |
1398 | |
1399 Here is an example showing a keymap before and after substitution: | |
1400 | |
1401 @smallexample | |
1402 @group | |
1403 (setq map '(keymap | |
1404 (?1 . olddef-1) | |
1405 (?2 . olddef-2) | |
1406 (?3 . olddef-1))) | |
1407 @result{} (keymap (49 . olddef-1) (50 . olddef-2) (51 . olddef-1)) | |
1408 @end group | |
1409 | |
1410 @group | |
1411 (substitute-key-definition 'olddef-1 'newdef map) | |
1412 @result{} nil | |
1413 @end group | |
1414 @group | |
1415 map | |
1416 @result{} (keymap (49 . newdef) (50 . olddef-2) (51 . newdef)) | |
1417 @end group | |
1418 @end smallexample | |
1419 @end defun | |
1420 | |
1421 @defun suppress-keymap keymap &optional nodigits | |
1422 @cindex @code{self-insert-command} override | |
1423 This function changes the contents of the full keymap @var{keymap} by | |
1424 remapping @code{self-insert-command} to the command @code{undefined} | |
1425 (@pxref{Remapping Commands}). This has the effect of undefining all | |
1426 printing characters, thus making ordinary insertion of text impossible. | |
1427 @code{suppress-keymap} returns @code{nil}. | |
1428 | |
1429 If @var{nodigits} is @code{nil}, then @code{suppress-keymap} defines | |
1430 digits to run @code{digit-argument}, and @kbd{-} to run | |
1431 @code{negative-argument}. Otherwise it makes them undefined like the | |
1432 rest of the printing characters. | |
1433 | |
1434 @cindex yank suppression | |
1435 @cindex @code{quoted-insert} suppression | |
1436 The @code{suppress-keymap} function does not make it impossible to | |
1437 modify a buffer, as it does not suppress commands such as @code{yank} | |
1438 and @code{quoted-insert}. To prevent any modification of a buffer, make | |
1439 it read-only (@pxref{Read Only Buffers}). | |
1440 | |
1441 Since this function modifies @var{keymap}, you would normally use it | |
1442 on a newly created keymap. Operating on an existing keymap | |
1443 that is used for some other purpose is likely to cause trouble; for | |
1444 example, suppressing @code{global-map} would make it impossible to use | |
1445 most of Emacs. | |
1446 | |
1447 Most often, @code{suppress-keymap} is used to initialize local | |
1448 keymaps of modes such as Rmail and Dired where insertion of text is not | |
1449 desirable and the buffer is read-only. Here is an example taken from | |
1450 the file @file{emacs/lisp/dired.el}, showing how the local keymap for | |
1451 Dired mode is set up: | |
1452 | |
1453 @smallexample | |
1454 @group | |
1455 (setq dired-mode-map (make-keymap)) | |
1456 (suppress-keymap dired-mode-map) | |
1457 (define-key dired-mode-map "r" 'dired-rename-file) | |
1458 (define-key dired-mode-map "\C-d" 'dired-flag-file-deleted) | |
1459 (define-key dired-mode-map "d" 'dired-flag-file-deleted) | |
1460 (define-key dired-mode-map "v" 'dired-view-file) | |
1461 (define-key dired-mode-map "e" 'dired-find-file) | |
1462 (define-key dired-mode-map "f" 'dired-find-file) | |
1463 @dots{} | |
1464 @end group | |
1465 @end smallexample | |
1466 @end defun | |
1467 | |
1468 @node Remapping Commands | |
1469 @section Remapping Commands | |
1470 @cindex remapping commands | |
1471 | |
1472 A special kind of key binding, using a special ``key sequence'' | |
1473 which includes a command name, has the effect of @dfn{remapping} that | |
1474 command into another. Here's how it works. You make a key binding | |
1475 for a key sequence that starts with the dummy event @code{remap}, | |
1476 followed by the command name you want to remap. Specify the remapped | |
1477 definition as the definition in this binding. The remapped definition | |
1478 is usually a command name, but it can be any valid definition for | |
1479 a key binding. | |
1480 | |
1481 Here's an example. Suppose that My mode uses special commands | |
1482 @code{my-kill-line} and @code{my-kill-word}, which should be invoked | |
1483 instead of @code{kill-line} and @code{kill-word}. It can establish | |
1484 this by making these two command-remapping bindings in its keymap: | |
1485 | |
1486 @smallexample | |
1487 (define-key my-mode-map [remap kill-line] 'my-kill-line) | |
1488 (define-key my-mode-map [remap kill-word] 'my-kill-word) | |
1489 @end smallexample | |
1490 | |
1491 Whenever @code{my-mode-map} is an active keymap, if the user types | |
1492 @kbd{C-k}, Emacs will find the standard global binding of | |
1493 @code{kill-line} (assuming nobody has changed it). But | |
1494 @code{my-mode-map} remaps @code{kill-line} to @code{my-kill-line}, | |
1495 so instead of running @code{kill-line}, Emacs runs | |
1496 @code{my-kill-line}. | |
1497 | |
1498 Remapping only works through a single level. In other words, | |
1499 | |
1500 @smallexample | |
1501 (define-key my-mode-map [remap kill-line] 'my-kill-line) | |
1502 (define-key my-mode-map [remap my-kill-line] 'my-other-kill-line) | |
1503 @end smallexample | |
1504 | |
1505 @noindent | |
1506 does not have the effect of remapping @code{kill-line} into | |
1507 @code{my-other-kill-line}. If an ordinary key binding specifies | |
1508 @code{kill-line}, this keymap will remap it to @code{my-kill-line}; | |
1509 if an ordinary binding specifies @code{my-kill-line}, this keymap will | |
1510 remap it to @code{my-other-kill-line}. | |
1511 | |
1512 @defun command-remapping command &optional position keymaps | |
1513 This function returns the remapping for @var{command} (a symbol), | |
1514 given the current active keymaps. If @var{command} is not remapped | |
1515 (which is the usual situation), or not a symbol, the function returns | |
1516 @code{nil}. @code{position} can optionally specify a buffer position | |
1517 or an event position to determine the keymaps to use, as in | |
1518 @code{key-binding}. | |
1519 | |
1520 If the optional argument @code{keymaps} is non-@code{nil}, it | |
1521 specifies a list of keymaps to search in. This argument is ignored if | |
1522 @code{position} is non-@code{nil}. | |
1523 @end defun | |
1524 | |
1525 @node Translation Keymaps | |
1526 @section Keymaps for Translating Sequences of Events | |
1527 @cindex keymaps for translating events | |
1528 | |
1529 This section describes keymaps that are used during reading a key | |
1530 sequence, to translate certain event sequences into others. | |
1531 @code{read-key-sequence} checks every subsequence of the key sequence | |
85106
fd282fb888de
Add new `input-decode-map' keymap and use it for temrinal
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
84116
diff
changeset
|
1532 being read, as it is read, against @code{input-decode-map}, then |
101265
e7dd76011592
(Translation Keymaps): Rename function-key-map to local-function-key-map.
Eli Zaretskii <eliz@gnu.org>
parents:
100974
diff
changeset
|
1533 @code{local-function-key-map}, and then against @code{key-translation-map}. |
85106
fd282fb888de
Add new `input-decode-map' keymap and use it for temrinal
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
84116
diff
changeset
|
1534 |
fd282fb888de
Add new `input-decode-map' keymap and use it for temrinal
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
84116
diff
changeset
|
1535 @defvar input-decode-map |
84078 | 1536 This variable holds a keymap that describes the character sequences sent |
1537 by function keys on an ordinary character terminal. This keymap has the | |
1538 same structure as other keymaps, but is used differently: it specifies | |
1539 translations to make while reading key sequences, rather than bindings | |
1540 for key sequences. | |
1541 | |
85106
fd282fb888de
Add new `input-decode-map' keymap and use it for temrinal
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
84116
diff
changeset
|
1542 If @code{input-decode-map} ``binds'' a key sequence @var{k} to a vector |
84078 | 1543 @var{v}, then when @var{k} appears as a subsequence @emph{anywhere} in a |
1544 key sequence, it is replaced with the events in @var{v}. | |
1545 | |
1546 For example, VT100 terminals send @kbd{@key{ESC} O P} when the | |
1547 keypad @key{PF1} key is pressed. Therefore, we want Emacs to translate | |
1548 that sequence of events into the single event @code{pf1}. We accomplish | |
1549 this by ``binding'' @kbd{@key{ESC} O P} to @code{[pf1]} in | |
85106
fd282fb888de
Add new `input-decode-map' keymap and use it for temrinal
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
84116
diff
changeset
|
1550 @code{input-decode-map}, when using a VT100. |
84078 | 1551 |
1552 Thus, typing @kbd{C-c @key{PF1}} sends the character sequence @kbd{C-c | |
1553 @key{ESC} O P}; later the function @code{read-key-sequence} translates | |
1554 this back into @kbd{C-c @key{PF1}}, which it returns as the vector | |
1555 @code{[?\C-c pf1]}. | |
1556 | |
85106
fd282fb888de
Add new `input-decode-map' keymap and use it for temrinal
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
84116
diff
changeset
|
1557 The value of @code{input-decode-map} is usually set up automatically |
84078 | 1558 according to the terminal's Terminfo or Termcap entry, but sometimes |
1559 those need help from terminal-specific Lisp files. Emacs comes with | |
1560 terminal-specific files for many common terminals; their main purpose is | |
85106
fd282fb888de
Add new `input-decode-map' keymap and use it for temrinal
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
84116
diff
changeset
|
1561 to make entries in @code{input-decode-map} beyond those that can be |
84078 | 1562 deduced from Termcap and Terminfo. @xref{Terminal-Specific}. |
1563 @end defvar | |
1564 | |
101265
e7dd76011592
(Translation Keymaps): Rename function-key-map to local-function-key-map.
Eli Zaretskii <eliz@gnu.org>
parents:
100974
diff
changeset
|
1565 @defvar local-function-key-map |
85106
fd282fb888de
Add new `input-decode-map' keymap and use it for temrinal
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
84116
diff
changeset
|
1566 This variable holds a keymap similar to @code{input-decode-map} except |
fd282fb888de
Add new `input-decode-map' keymap and use it for temrinal
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
84116
diff
changeset
|
1567 that it describes key sequences which should be translated to |
fd282fb888de
Add new `input-decode-map' keymap and use it for temrinal
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
84116
diff
changeset
|
1568 alternative interpretations that are usually preferred. It applies |
fd282fb888de
Add new `input-decode-map' keymap and use it for temrinal
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
84116
diff
changeset
|
1569 after @code{input-decode-map} and before @code{key-translation-map}. |
fd282fb888de
Add new `input-decode-map' keymap and use it for temrinal
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
84116
diff
changeset
|
1570 |
101265
e7dd76011592
(Translation Keymaps): Rename function-key-map to local-function-key-map.
Eli Zaretskii <eliz@gnu.org>
parents:
100974
diff
changeset
|
1571 Entries in @code{local-function-key-map} are ignored if they conflict |
e7dd76011592
(Translation Keymaps): Rename function-key-map to local-function-key-map.
Eli Zaretskii <eliz@gnu.org>
parents:
100974
diff
changeset
|
1572 with bindings made in the minor mode, local, or global keymaps. I.e. |
85106
fd282fb888de
Add new `input-decode-map' keymap and use it for temrinal
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
84116
diff
changeset
|
1573 the remapping only applies if the original key sequence would |
fd282fb888de
Add new `input-decode-map' keymap and use it for temrinal
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
84116
diff
changeset
|
1574 otherwise not have any binding. |
101265
e7dd76011592
(Translation Keymaps): Rename function-key-map to local-function-key-map.
Eli Zaretskii <eliz@gnu.org>
parents:
100974
diff
changeset
|
1575 |
e7dd76011592
(Translation Keymaps): Rename function-key-map to local-function-key-map.
Eli Zaretskii <eliz@gnu.org>
parents:
100974
diff
changeset
|
1576 @code{local-function-key-map} inherits from @code{function-key-map}, |
e7dd76011592
(Translation Keymaps): Rename function-key-map to local-function-key-map.
Eli Zaretskii <eliz@gnu.org>
parents:
100974
diff
changeset
|
1577 but the latter should not be used directly. |
85106
fd282fb888de
Add new `input-decode-map' keymap and use it for temrinal
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
84116
diff
changeset
|
1578 @end defvar |
fd282fb888de
Add new `input-decode-map' keymap and use it for temrinal
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
84116
diff
changeset
|
1579 |
84078 | 1580 @defvar key-translation-map |
85106
fd282fb888de
Add new `input-decode-map' keymap and use it for temrinal
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
84116
diff
changeset
|
1581 This variable is another keymap used just like @code{input-decode-map} |
84078 | 1582 to translate input events into other events. It differs from |
85106
fd282fb888de
Add new `input-decode-map' keymap and use it for temrinal
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
84116
diff
changeset
|
1583 @code{input-decode-map} in that it goes to work after |
101265
e7dd76011592
(Translation Keymaps): Rename function-key-map to local-function-key-map.
Eli Zaretskii <eliz@gnu.org>
parents:
100974
diff
changeset
|
1584 @code{local-function-key-map} is finished rather than before; it |
e7dd76011592
(Translation Keymaps): Rename function-key-map to local-function-key-map.
Eli Zaretskii <eliz@gnu.org>
parents:
100974
diff
changeset
|
1585 receives the results of translation by @code{local-function-key-map}. |
e7dd76011592
(Translation Keymaps): Rename function-key-map to local-function-key-map.
Eli Zaretskii <eliz@gnu.org>
parents:
100974
diff
changeset
|
1586 |
e7dd76011592
(Translation Keymaps): Rename function-key-map to local-function-key-map.
Eli Zaretskii <eliz@gnu.org>
parents:
100974
diff
changeset
|
1587 Just like @code{input-decode-map}, but unlike |
e7dd76011592
(Translation Keymaps): Rename function-key-map to local-function-key-map.
Eli Zaretskii <eliz@gnu.org>
parents:
100974
diff
changeset
|
1588 @code{local-function-key-map}, this keymap is applied regardless of |
e7dd76011592
(Translation Keymaps): Rename function-key-map to local-function-key-map.
Eli Zaretskii <eliz@gnu.org>
parents:
100974
diff
changeset
|
1589 whether the input key-sequence has a normal binding. Note however |
e7dd76011592
(Translation Keymaps): Rename function-key-map to local-function-key-map.
Eli Zaretskii <eliz@gnu.org>
parents:
100974
diff
changeset
|
1590 that actual key bindings can have an effect on |
e7dd76011592
(Translation Keymaps): Rename function-key-map to local-function-key-map.
Eli Zaretskii <eliz@gnu.org>
parents:
100974
diff
changeset
|
1591 @code{key-translation-map}, even though they are overridden by it. |
e7dd76011592
(Translation Keymaps): Rename function-key-map to local-function-key-map.
Eli Zaretskii <eliz@gnu.org>
parents:
100974
diff
changeset
|
1592 Indeed, actual key bindings override @code{local-function-key-map} and |
e7dd76011592
(Translation Keymaps): Rename function-key-map to local-function-key-map.
Eli Zaretskii <eliz@gnu.org>
parents:
100974
diff
changeset
|
1593 thus may alter the key sequence that @code{key-translation-map} |
e7dd76011592
(Translation Keymaps): Rename function-key-map to local-function-key-map.
Eli Zaretskii <eliz@gnu.org>
parents:
100974
diff
changeset
|
1594 receives. Clearly, it is better to avoid this type of situation. |
84078 | 1595 |
1596 The intent of @code{key-translation-map} is for users to map one | |
1597 character set to another, including ordinary characters normally bound | |
1598 to @code{self-insert-command}. | |
1599 @end defvar | |
1600 | |
1601 @cindex key translation function | |
101265
e7dd76011592
(Translation Keymaps): Rename function-key-map to local-function-key-map.
Eli Zaretskii <eliz@gnu.org>
parents:
100974
diff
changeset
|
1602 You can use @code{input-decode-map}, @code{local-function-key-map}, or |
e7dd76011592
(Translation Keymaps): Rename function-key-map to local-function-key-map.
Eli Zaretskii <eliz@gnu.org>
parents:
100974
diff
changeset
|
1603 @code{key-translation-map} for more than simple aliases, by using a |
e7dd76011592
(Translation Keymaps): Rename function-key-map to local-function-key-map.
Eli Zaretskii <eliz@gnu.org>
parents:
100974
diff
changeset
|
1604 function, instead of a key sequence, as the ``translation'' of a key. |
e7dd76011592
(Translation Keymaps): Rename function-key-map to local-function-key-map.
Eli Zaretskii <eliz@gnu.org>
parents:
100974
diff
changeset
|
1605 Then this function is called to compute the translation of that key. |
84078 | 1606 |
1607 The key translation function receives one argument, which is the prompt | |
1608 that was specified in @code{read-key-sequence}---or @code{nil} if the | |
1609 key sequence is being read by the editor command loop. In most cases | |
1610 you can ignore the prompt value. | |
1611 | |
1612 If the function reads input itself, it can have the effect of altering | |
1613 the event that follows. For example, here's how to define @kbd{C-c h} | |
1614 to turn the character that follows into a Hyper character: | |
1615 | |
1616 @example | |
1617 @group | |
1618 (defun hyperify (prompt) | |
1619 (let ((e (read-event))) | |
1620 (vector (if (numberp e) | |
1621 (logior (lsh 1 24) e) | |
1622 (if (memq 'hyper (event-modifiers e)) | |
1623 e | |
1624 (add-event-modifier "H-" e)))))) | |
1625 | |
1626 (defun add-event-modifier (string e) | |
1627 (let ((symbol (if (symbolp e) e (car e)))) | |
1628 (setq symbol (intern (concat string | |
1629 (symbol-name symbol)))) | |
1630 @end group | |
1631 @group | |
1632 (if (symbolp e) | |
1633 symbol | |
1634 (cons symbol (cdr e))))) | |
1635 | |
101265
e7dd76011592
(Translation Keymaps): Rename function-key-map to local-function-key-map.
Eli Zaretskii <eliz@gnu.org>
parents:
100974
diff
changeset
|
1636 (define-key local-function-key-map "\C-ch" 'hyperify) |
84078 | 1637 @end group |
1638 @end example | |
1639 | |
1640 If you have enabled keyboard character set decoding using | |
1641 @code{set-keyboard-coding-system}, decoding is done after the | |
1642 translations listed above. @xref{Terminal I/O Encoding}. However, in | |
1643 future Emacs versions, character set decoding may be done at an | |
1644 earlier stage. | |
1645 | |
1646 @node Key Binding Commands | |
1647 @section Commands for Binding Keys | |
1648 | |
1649 This section describes some convenient interactive interfaces for | |
1650 changing key bindings. They work by calling @code{define-key}. | |
1651 | |
1652 People often use @code{global-set-key} in their init files | |
1653 (@pxref{Init File}) for simple customization. For example, | |
1654 | |
1655 @smallexample | |
1656 (global-set-key (kbd "C-x C-\\") 'next-line) | |
1657 @end smallexample | |
1658 | |
1659 @noindent | |
1660 or | |
1661 | |
1662 @smallexample | |
1663 (global-set-key [?\C-x ?\C-\\] 'next-line) | |
1664 @end smallexample | |
1665 | |
1666 @noindent | |
1667 or | |
1668 | |
1669 @smallexample | |
1670 (global-set-key [(control ?x) (control ?\\)] 'next-line) | |
1671 @end smallexample | |
1672 | |
1673 @noindent | |
1674 redefines @kbd{C-x C-\} to move down a line. | |
1675 | |
1676 @smallexample | |
1677 (global-set-key [M-mouse-1] 'mouse-set-point) | |
1678 @end smallexample | |
1679 | |
1680 @noindent | |
1681 redefines the first (leftmost) mouse button, entered with the Meta key, to | |
1682 set point where you click. | |
1683 | |
1684 @cindex non-@acronym{ASCII} text in keybindings | |
1685 Be careful when using non-@acronym{ASCII} text characters in Lisp | |
1686 specifications of keys to bind. If these are read as multibyte text, as | |
1687 they usually will be in a Lisp file (@pxref{Loading Non-ASCII}), you | |
1688 must type the keys as multibyte too. For instance, if you use this: | |
1689 | |
1690 @smallexample | |
1691 (global-set-key "@"o" 'my-function) ; bind o-umlaut | |
1692 @end smallexample | |
1693 | |
1694 @noindent | |
1695 or | |
1696 | |
1697 @smallexample | |
1698 (global-set-key ?@"o 'my-function) ; bind o-umlaut | |
1699 @end smallexample | |
1700 | |
1701 @noindent | |
1702 and your language environment is multibyte Latin-1, these commands | |
1703 actually bind the multibyte character with code 2294, not the unibyte | |
1704 Latin-1 character with code 246 (@kbd{M-v}). In order to use this | |
1705 binding, you need to enter the multibyte Latin-1 character as keyboard | |
1706 input. One way to do this is by using an appropriate input method | |
1707 (@pxref{Input Methods, , Input Methods, emacs, The GNU Emacs Manual}). | |
1708 | |
1709 If you want to use a unibyte character in the key binding, you can | |
1710 construct the key sequence string using @code{multibyte-char-to-unibyte} | |
1711 or @code{string-make-unibyte} (@pxref{Converting Representations}). | |
1712 | |
1713 @deffn Command global-set-key key binding | |
1714 This function sets the binding of @var{key} in the current global map | |
1715 to @var{binding}. | |
1716 | |
1717 @smallexample | |
1718 @group | |
1719 (global-set-key @var{key} @var{binding}) | |
1720 @equiv{} | |
1721 (define-key (current-global-map) @var{key} @var{binding}) | |
1722 @end group | |
1723 @end smallexample | |
1724 @end deffn | |
1725 | |
1726 @deffn Command global-unset-key key | |
1727 @cindex unbinding keys | |
1728 This function removes the binding of @var{key} from the current | |
1729 global map. | |
1730 | |
1731 One use of this function is in preparation for defining a longer key | |
1732 that uses @var{key} as a prefix---which would not be allowed if | |
1733 @var{key} has a non-prefix binding. For example: | |
1734 | |
1735 @smallexample | |
1736 @group | |
1737 (global-unset-key "\C-l") | |
1738 @result{} nil | |
1739 @end group | |
1740 @group | |
1741 (global-set-key "\C-l\C-l" 'redraw-display) | |
1742 @result{} nil | |
1743 @end group | |
1744 @end smallexample | |
1745 | |
1746 This function is implemented simply using @code{define-key}: | |
1747 | |
1748 @smallexample | |
1749 @group | |
1750 (global-unset-key @var{key}) | |
1751 @equiv{} | |
1752 (define-key (current-global-map) @var{key} nil) | |
1753 @end group | |
1754 @end smallexample | |
1755 @end deffn | |
1756 | |
1757 @deffn Command local-set-key key binding | |
1758 This function sets the binding of @var{key} in the current local | |
1759 keymap to @var{binding}. | |
1760 | |
1761 @smallexample | |
1762 @group | |
1763 (local-set-key @var{key} @var{binding}) | |
1764 @equiv{} | |
1765 (define-key (current-local-map) @var{key} @var{binding}) | |
1766 @end group | |
1767 @end smallexample | |
1768 @end deffn | |
1769 | |
1770 @deffn Command local-unset-key key | |
1771 This function removes the binding of @var{key} from the current | |
1772 local map. | |
1773 | |
1774 @smallexample | |
1775 @group | |
1776 (local-unset-key @var{key}) | |
1777 @equiv{} | |
1778 (define-key (current-local-map) @var{key} nil) | |
1779 @end group | |
1780 @end smallexample | |
1781 @end deffn | |
1782 | |
1783 @node Scanning Keymaps | |
1784 @section Scanning Keymaps | |
1785 | |
1786 This section describes functions used to scan all the current keymaps | |
1787 for the sake of printing help information. | |
1788 | |
1789 @defun accessible-keymaps keymap &optional prefix | |
1790 This function returns a list of all the keymaps that can be reached (via | |
1791 zero or more prefix keys) from @var{keymap}. The value is an | |
1792 association list with elements of the form @code{(@var{key} .@: | |
1793 @var{map})}, where @var{key} is a prefix key whose definition in | |
1794 @var{keymap} is @var{map}. | |
1795 | |
1796 The elements of the alist are ordered so that the @var{key} increases | |
1797 in length. The first element is always @code{([] .@: @var{keymap})}, | |
1798 because the specified keymap is accessible from itself with a prefix of | |
1799 no events. | |
1800 | |
1801 If @var{prefix} is given, it should be a prefix key sequence; then | |
1802 @code{accessible-keymaps} includes only the submaps whose prefixes start | |
1803 with @var{prefix}. These elements look just as they do in the value of | |
1804 @code{(accessible-keymaps)}; the only difference is that some elements | |
1805 are omitted. | |
1806 | |
1807 In the example below, the returned alist indicates that the key | |
1808 @key{ESC}, which is displayed as @samp{^[}, is a prefix key whose | |
1809 definition is the sparse keymap @code{(keymap (83 .@: center-paragraph) | |
1810 (115 .@: foo))}. | |
1811 | |
1812 @smallexample | |
1813 @group | |
1814 (accessible-keymaps (current-local-map)) | |
1815 @result{}(([] keymap | |
1816 (27 keymap ; @r{Note this keymap for @key{ESC} is repeated below.} | |
1817 (83 . center-paragraph) | |
1818 (115 . center-line)) | |
1819 (9 . tab-to-tab-stop)) | |
1820 @end group | |
1821 | |
1822 @group | |
1823 ("^[" keymap | |
1824 (83 . center-paragraph) | |
1825 (115 . foo))) | |
1826 @end group | |
1827 @end smallexample | |
1828 | |
1829 In the following example, @kbd{C-h} is a prefix key that uses a sparse | |
1830 keymap starting with @code{(keymap (118 . describe-variable)@dots{})}. | |
1831 Another prefix, @kbd{C-x 4}, uses a keymap which is also the value of | |
1832 the variable @code{ctl-x-4-map}. The event @code{mode-line} is one of | |
1833 several dummy events used as prefixes for mouse actions in special parts | |
1834 of a window. | |
1835 | |
1836 @smallexample | |
1837 @group | |
1838 (accessible-keymaps (current-global-map)) | |
1839 @result{} (([] keymap [set-mark-command beginning-of-line @dots{} | |
1840 delete-backward-char]) | |
1841 @end group | |
1842 @group | |
1843 ("^H" keymap (118 . describe-variable) @dots{} | |
1844 (8 . help-for-help)) | |
1845 @end group | |
1846 @group | |
1847 ("^X" keymap [x-flush-mouse-queue @dots{} | |
1848 backward-kill-sentence]) | |
1849 @end group | |
1850 @group | |
1851 ("^[" keymap [mark-sexp backward-sexp @dots{} | |
1852 backward-kill-word]) | |
1853 @end group | |
1854 ("^X4" keymap (15 . display-buffer) @dots{}) | |
1855 @group | |
1856 ([mode-line] keymap | |
1857 (S-mouse-2 . mouse-split-window-horizontally) @dots{})) | |
1858 @end group | |
1859 @end smallexample | |
1860 | |
1861 @noindent | |
1862 These are not all the keymaps you would see in actuality. | |
1863 @end defun | |
1864 | |
1865 @defun map-keymap function keymap | |
1866 The function @code{map-keymap} calls @var{function} once | |
1867 for each binding in @var{keymap}. It passes two arguments, | |
1868 the event type and the value of the binding. If @var{keymap} | |
1869 has a parent, the parent's bindings are included as well. | |
1870 This works recursively: if the parent has itself a parent, then the | |
1871 grandparent's bindings are also included and so on. | |
1872 | |
1873 This function is the cleanest way to examine all the bindings | |
1874 in a keymap. | |
1875 @end defun | |
1876 | |
1877 @defun where-is-internal command &optional keymap firstonly noindirect no-remap | |
1878 This function is a subroutine used by the @code{where-is} command | |
1879 (@pxref{Help, , Help, emacs,The GNU Emacs Manual}). It returns a list | |
1880 of all key sequences (of any length) that are bound to @var{command} in a | |
1881 set of keymaps. | |
1882 | |
1883 The argument @var{command} can be any object; it is compared with all | |
1884 keymap entries using @code{eq}. | |
1885 | |
1886 If @var{keymap} is @code{nil}, then the maps used are the current active | |
1887 keymaps, disregarding @code{overriding-local-map} (that is, pretending | |
1888 its value is @code{nil}). If @var{keymap} is a keymap, then the | |
1889 maps searched are @var{keymap} and the global keymap. If @var{keymap} | |
1890 is a list of keymaps, only those keymaps are searched. | |
1891 | |
1892 Usually it's best to use @code{overriding-local-map} as the expression | |
1893 for @var{keymap}. Then @code{where-is-internal} searches precisely the | |
1894 keymaps that are active. To search only the global map, pass | |
1895 @code{(keymap)} (an empty keymap) as @var{keymap}. | |
1896 | |
1897 If @var{firstonly} is @code{non-ascii}, then the value is a single | |
1898 vector representing the first key sequence found, rather than a list of | |
1899 all possible key sequences. If @var{firstonly} is @code{t}, then the | |
1900 value is the first key sequence, except that key sequences consisting | |
1901 entirely of @acronym{ASCII} characters (or meta variants of @acronym{ASCII} | |
1902 characters) are preferred to all other key sequences and that the | |
1903 return value can never be a menu binding. | |
1904 | |
1905 If @var{noindirect} is non-@code{nil}, @code{where-is-internal} doesn't | |
1906 follow indirect keymap bindings. This makes it possible to search for | |
1907 an indirect definition itself. | |
1908 | |
1909 When command remapping is in effect (@pxref{Remapping Commands}), | |
1910 @code{where-is-internal} figures out when a command will be run due to | |
1911 remapping and reports keys accordingly. It also returns @code{nil} if | |
1912 @var{command} won't really be run because it has been remapped to some | |
1913 other command. However, if @var{no-remap} is non-@code{nil}. | |
1914 @code{where-is-internal} ignores remappings. | |
1915 | |
1916 @smallexample | |
1917 @group | |
1918 (where-is-internal 'describe-function) | |
1919 @result{} ([8 102] [f1 102] [help 102] | |
1920 [menu-bar help-menu describe describe-function]) | |
1921 @end group | |
1922 @end smallexample | |
1923 @end defun | |
1924 | |
1925 @deffn Command describe-bindings &optional prefix buffer-or-name | |
1926 This function creates a listing of all current key bindings, and | |
1927 displays it in a buffer named @samp{*Help*}. The text is grouped by | |
1928 modes---minor modes first, then the major mode, then global bindings. | |
1929 | |
1930 If @var{prefix} is non-@code{nil}, it should be a prefix key; then the | |
1931 listing includes only keys that start with @var{prefix}. | |
1932 | |
1933 The listing describes meta characters as @key{ESC} followed by the | |
1934 corresponding non-meta character. | |
1935 | |
1936 When several characters with consecutive @acronym{ASCII} codes have the | |
1937 same definition, they are shown together, as | |
1938 @samp{@var{firstchar}..@var{lastchar}}. In this instance, you need to | |
1939 know the @acronym{ASCII} codes to understand which characters this means. | |
1940 For example, in the default global map, the characters @samp{@key{SPC} | |
1941 ..@: ~} are described by a single line. @key{SPC} is @acronym{ASCII} 32, | |
1942 @kbd{~} is @acronym{ASCII} 126, and the characters between them include all | |
1943 the normal printing characters, (e.g., letters, digits, punctuation, | |
1944 etc.@:); all these characters are bound to @code{self-insert-command}. | |
1945 | |
1946 If @var{buffer-or-name} is non-@code{nil}, it should be a buffer or a | |
1947 buffer name. Then @code{describe-bindings} lists that buffer's bindings, | |
1948 instead of the current buffer's. | |
1949 @end deffn | |
1950 | |
1951 @node Menu Keymaps | |
1952 @section Menu Keymaps | |
1953 @cindex menu keymaps | |
1954 | |
1955 A keymap can operate as a menu as well as defining bindings for | |
1956 keyboard keys and mouse buttons. Menus are usually actuated with the | |
1957 mouse, but they can function with the keyboard also. If a menu keymap | |
1958 is active for the next input event, that activates the keyboard menu | |
1959 feature. | |
1960 | |
1961 @menu | |
1962 * Defining Menus:: How to make a keymap that defines a menu. | |
1963 * Mouse Menus:: How users actuate the menu with the mouse. | |
1964 * Keyboard Menus:: How users actuate the menu with the keyboard. | |
1965 * Menu Example:: Making a simple menu. | |
1966 * Menu Bar:: How to customize the menu bar. | |
1967 * Tool Bar:: A tool bar is a row of images. | |
1968 * Modifying Menus:: How to add new items to a menu. | |
1969 @end menu | |
1970 | |
1971 @node Defining Menus | |
1972 @subsection Defining Menus | |
1973 @cindex defining menus | |
1974 @cindex menu prompt string | |
1975 @cindex prompt string (of menu) | |
1976 | |
1977 A keymap acts as a menu if it has an @dfn{overall prompt string}, | |
1978 which is a string that appears as an element of the keymap. | |
1979 (@xref{Format of Keymaps}.) The string should describe the purpose of | |
1980 the menu's commands. Emacs displays the overall prompt string as the | |
1981 menu title in some cases, depending on the toolkit (if any) used for | |
1982 displaying menus.@footnote{It is required for menus which do not use a | |
1983 toolkit, e.g.@: under MS-DOS.} Keyboard menus also display the | |
1984 overall prompt string. | |
1985 | |
1986 The easiest way to construct a keymap with a prompt string is to | |
1987 specify the string as an argument when you call @code{make-keymap}, | |
1988 @code{make-sparse-keymap} (@pxref{Creating Keymaps}), or | |
1989 @code{define-prefix-command} (@pxref{Definition of | |
1990 define-prefix-command}). If you do not want the keymap to operate as | |
1991 a menu, don't specify a prompt string for it. | |
1992 | |
1993 @defun keymap-prompt keymap | |
1994 This function returns the overall prompt string of @var{keymap}, | |
1995 or @code{nil} if it has none. | |
1996 @end defun | |
1997 | |
1998 The menu's items are the bindings in the keymap. Each binding | |
1999 associates an event type to a definition, but the event types have no | |
2000 significance for the menu appearance. (Usually we use pseudo-events, | |
2001 symbols that the keyboard cannot generate, as the event types for menu | |
2002 item bindings.) The menu is generated entirely from the bindings that | |
2003 correspond in the keymap to these events. | |
2004 | |
2005 The order of items in the menu is the same as the order of bindings in | |
2006 the keymap. Since @code{define-key} puts new bindings at the front, you | |
2007 should define the menu items starting at the bottom of the menu and | |
2008 moving to the top, if you care about the order. When you add an item to | |
2009 an existing menu, you can specify its position in the menu using | |
2010 @code{define-key-after} (@pxref{Modifying Menus}). | |
2011 | |
2012 @menu | |
2013 * Simple Menu Items:: A simple kind of menu key binding, | |
2014 limited in capabilities. | |
2015 * Extended Menu Items:: More powerful menu item definitions | |
2016 let you specify keywords to enable | |
2017 various features. | |
2018 * Menu Separators:: Drawing a horizontal line through a menu. | |
2019 * Alias Menu Items:: Using command aliases in menu items. | |
2020 @end menu | |
2021 | |
2022 @node Simple Menu Items | |
2023 @subsubsection Simple Menu Items | |
2024 | |
2025 The simpler (and original) way to define a menu item is to bind some | |
2026 event type (it doesn't matter what event type) to a binding like this: | |
2027 | |
2028 @example | |
2029 (@var{item-string} . @var{real-binding}) | |
2030 @end example | |
2031 | |
2032 @noindent | |
2033 The @sc{car}, @var{item-string}, is the string to be displayed in the | |
2034 menu. It should be short---preferably one to three words. It should | |
2035 describe the action of the command it corresponds to. Note that it is | |
2036 not generally possible to display non-@acronym{ASCII} text in menus. It will | |
2037 work for keyboard menus and will work to a large extent when Emacs is | |
2038 built with the Gtk+ toolkit.@footnote{In this case, the text is first | |
2039 encoded using the @code{utf-8} coding system and then rendered by the | |
2040 toolkit as it sees fit.} | |
2041 | |
2042 You can also supply a second string, called the help string, as follows: | |
2043 | |
2044 @example | |
2045 (@var{item-string} @var{help} . @var{real-binding}) | |
2046 @end example | |
2047 | |
2048 @noindent | |
2049 @var{help} specifies a ``help-echo'' string to display while the mouse | |
2050 is on that item in the same way as @code{help-echo} text properties | |
2051 (@pxref{Help display}). | |
2052 | |
2053 As far as @code{define-key} is concerned, @var{item-string} and | |
2054 @var{help-string} are part of the event's binding. However, | |
2055 @code{lookup-key} returns just @var{real-binding}, and only | |
2056 @var{real-binding} is used for executing the key. | |
2057 | |
2058 If @var{real-binding} is @code{nil}, then @var{item-string} appears in | |
2059 the menu but cannot be selected. | |
2060 | |
2061 If @var{real-binding} is a symbol and has a non-@code{nil} | |
2062 @code{menu-enable} property, that property is an expression that | |
2063 controls whether the menu item is enabled. Every time the keymap is | |
2064 used to display a menu, Emacs evaluates the expression, and it enables | |
2065 the menu item only if the expression's value is non-@code{nil}. When a | |
2066 menu item is disabled, it is displayed in a ``fuzzy'' fashion, and | |
2067 cannot be selected. | |
2068 | |
2069 The menu bar does not recalculate which items are enabled every time you | |
2070 look at a menu. This is because the X toolkit requires the whole tree | |
2071 of menus in advance. To force recalculation of the menu bar, call | |
2072 @code{force-mode-line-update} (@pxref{Mode Line Format}). | |
2073 | |
2074 You've probably noticed that menu items show the equivalent keyboard key | |
2075 sequence (if any) to invoke the same command. To save time on | |
2076 recalculation, menu display caches this information in a sublist in the | |
2077 binding, like this: | |
2078 | |
2079 @c This line is not too long--rms. | |
2080 @example | |
2081 (@var{item-string} @r{[}@var{help}@r{]} (@var{key-binding-data}) . @var{real-binding}) | |
2082 @end example | |
2083 | |
2084 @noindent | |
2085 Don't put these sublists in the menu item yourself; menu display | |
2086 calculates them automatically. Don't mention keyboard equivalents in | |
2087 the item strings themselves, since that is redundant. | |
2088 | |
2089 @node Extended Menu Items | |
2090 @subsubsection Extended Menu Items | |
2091 @kindex menu-item | |
2092 | |
2093 An extended-format menu item is a more flexible and also cleaner | |
2094 alternative to the simple format. You define an event type with a | |
2095 binding that's a list starting with the symbol @code{menu-item}. | |
2096 For a non-selectable string, the binding looks like this: | |
2097 | |
2098 @example | |
2099 (menu-item @var{item-name}) | |
2100 @end example | |
2101 | |
2102 @noindent | |
2103 A string starting with two or more dashes specifies a separator line; | |
2104 see @ref{Menu Separators}. | |
2105 | |
2106 To define a real menu item which can be selected, the extended format | |
2107 binding looks like this: | |
2108 | |
2109 @example | |
2110 (menu-item @var{item-name} @var{real-binding} | |
2111 . @var{item-property-list}) | |
2112 @end example | |
2113 | |
2114 @noindent | |
2115 Here, @var{item-name} is an expression which evaluates to the menu item | |
2116 string. Thus, the string need not be a constant. The third element, | |
2117 @var{real-binding}, is the command to execute. The tail of the list, | |
2118 @var{item-property-list}, has the form of a property list which contains | |
2119 other information. | |
2120 | |
2121 When an equivalent keyboard key binding is cached, the extended menu | |
2122 item binding looks like this: | |
2123 | |
2124 @example | |
2125 (menu-item @var{item-name} @var{real-binding} (@var{key-binding-data}) | |
2126 . @var{item-property-list}) | |
2127 @end example | |
2128 | |
2129 Here is a table of the properties that are supported: | |
2130 | |
2131 @table @code | |
2132 @item :enable @var{form} | |
2133 The result of evaluating @var{form} determines whether the item is | |
2134 enabled (non-@code{nil} means yes). If the item is not enabled, | |
2135 you can't really click on it. | |
2136 | |
2137 @item :visible @var{form} | |
2138 The result of evaluating @var{form} determines whether the item should | |
2139 actually appear in the menu (non-@code{nil} means yes). If the item | |
2140 does not appear, then the menu is displayed as if this item were | |
2141 not defined at all. | |
2142 | |
2143 @item :help @var{help} | |
2144 The value of this property, @var{help}, specifies a ``help-echo'' string | |
2145 to display while the mouse is on that item. This is displayed in the | |
2146 same way as @code{help-echo} text properties (@pxref{Help display}). | |
2147 Note that this must be a constant string, unlike the @code{help-echo} | |
2148 property for text and overlays. | |
2149 | |
2150 @item :button (@var{type} . @var{selected}) | |
2151 This property provides a way to define radio buttons and toggle buttons. | |
2152 The @sc{car}, @var{type}, says which: it should be @code{:toggle} or | |
2153 @code{:radio}. The @sc{cdr}, @var{selected}, should be a form; the | |
2154 result of evaluating it says whether this button is currently selected. | |
2155 | |
2156 A @dfn{toggle} is a menu item which is labeled as either ``on'' or ``off'' | |
2157 according to the value of @var{selected}. The command itself should | |
2158 toggle @var{selected}, setting it to @code{t} if it is @code{nil}, | |
2159 and to @code{nil} if it is @code{t}. Here is how the menu item | |
2160 to toggle the @code{debug-on-error} flag is defined: | |
2161 | |
2162 @example | |
2163 (menu-item "Debug on Error" toggle-debug-on-error | |
2164 :button (:toggle | |
2165 . (and (boundp 'debug-on-error) | |
2166 debug-on-error))) | |
2167 @end example | |
2168 | |
2169 @noindent | |
2170 This works because @code{toggle-debug-on-error} is defined as a command | |
2171 which toggles the variable @code{debug-on-error}. | |
2172 | |
2173 @dfn{Radio buttons} are a group of menu items, in which at any time one | |
2174 and only one is ``selected.'' There should be a variable whose value | |
2175 says which one is selected at any time. The @var{selected} form for | |
2176 each radio button in the group should check whether the variable has the | |
2177 right value for selecting that button. Clicking on the button should | |
2178 set the variable so that the button you clicked on becomes selected. | |
2179 | |
2180 @item :key-sequence @var{key-sequence} | |
2181 This property specifies which key sequence is likely to be bound to the | |
2182 same command invoked by this menu item. If you specify the right key | |
2183 sequence, that makes preparing the menu for display run much faster. | |
2184 | |
2185 If you specify the wrong key sequence, it has no effect; before Emacs | |
2186 displays @var{key-sequence} in the menu, it verifies that | |
2187 @var{key-sequence} is really equivalent to this menu item. | |
2188 | |
2189 @item :key-sequence nil | |
2190 This property indicates that there is normally no key binding which is | |
2191 equivalent to this menu item. Using this property saves time in | |
2192 preparing the menu for display, because Emacs does not need to search | |
2193 the keymaps for a keyboard equivalent for this menu item. | |
2194 | |
2195 However, if the user has rebound this item's definition to a key | |
2196 sequence, Emacs ignores the @code{:keys} property and finds the keyboard | |
2197 equivalent anyway. | |
2198 | |
2199 @item :keys @var{string} | |
2200 This property specifies that @var{string} is the string to display | |
2201 as the keyboard equivalent for this menu item. You can use | |
2202 the @samp{\\[...]} documentation construct in @var{string}. | |
2203 | |
2204 @item :filter @var{filter-fn} | |
2205 This property provides a way to compute the menu item dynamically. | |
2206 The property value @var{filter-fn} should be a function of one argument; | |
2207 when it is called, its argument will be @var{real-binding}. The | |
2208 function should return the binding to use instead. | |
2209 | |
2210 Emacs can call this function at any time that it does redisplay or | |
2211 operates on menu data structures, so you should write it so it can | |
2212 safely be called at any time. | |
2213 @end table | |
2214 | |
2215 @node Menu Separators | |
2216 @subsubsection Menu Separators | |
2217 @cindex menu separators | |
2218 | |
2219 A menu separator is a kind of menu item that doesn't display any | |
2220 text---instead, it divides the menu into subparts with a horizontal line. | |
2221 A separator looks like this in the menu keymap: | |
2222 | |
2223 @example | |
2224 (menu-item @var{separator-type}) | |
2225 @end example | |
2226 | |
2227 @noindent | |
2228 where @var{separator-type} is a string starting with two or more dashes. | |
2229 | |
2230 In the simplest case, @var{separator-type} consists of only dashes. | |
2231 That specifies the default kind of separator. (For compatibility, | |
2232 @code{""} and @code{-} also count as separators.) | |
2233 | |
2234 Certain other values of @var{separator-type} specify a different | |
2235 style of separator. Here is a table of them: | |
2236 | |
2237 @table @code | |
2238 @item "--no-line" | |
2239 @itemx "--space" | |
2240 An extra vertical space, with no actual line. | |
2241 | |
2242 @item "--single-line" | |
2243 A single line in the menu's foreground color. | |
2244 | |
2245 @item "--double-line" | |
2246 A double line in the menu's foreground color. | |
2247 | |
2248 @item "--single-dashed-line" | |
2249 A single dashed line in the menu's foreground color. | |
2250 | |
2251 @item "--double-dashed-line" | |
2252 A double dashed line in the menu's foreground color. | |
2253 | |
2254 @item "--shadow-etched-in" | |
2255 A single line with a 3D sunken appearance. This is the default, | |
2256 used separators consisting of dashes only. | |
2257 | |
2258 @item "--shadow-etched-out" | |
2259 A single line with a 3D raised appearance. | |
2260 | |
2261 @item "--shadow-etched-in-dash" | |
2262 A single dashed line with a 3D sunken appearance. | |
2263 | |
2264 @item "--shadow-etched-out-dash" | |
2265 A single dashed line with a 3D raised appearance. | |
2266 | |
2267 @item "--shadow-double-etched-in" | |
2268 Two lines with a 3D sunken appearance. | |
2269 | |
2270 @item "--shadow-double-etched-out" | |
2271 Two lines with a 3D raised appearance. | |
2272 | |
2273 @item "--shadow-double-etched-in-dash" | |
2274 Two dashed lines with a 3D sunken appearance. | |
2275 | |
2276 @item "--shadow-double-etched-out-dash" | |
2277 Two dashed lines with a 3D raised appearance. | |
2278 @end table | |
2279 | |
2280 You can also give these names in another style, adding a colon after | |
2281 the double-dash and replacing each single dash with capitalization of | |
2282 the following word. Thus, @code{"--:singleLine"}, is equivalent to | |
2283 @code{"--single-line"}. | |
2284 | |
2285 Some systems and display toolkits don't really handle all of these | |
2286 separator types. If you use a type that isn't supported, the menu | |
2287 displays a similar kind of separator that is supported. | |
2288 | |
2289 @node Alias Menu Items | |
2290 @subsubsection Alias Menu Items | |
2291 | |
2292 Sometimes it is useful to make menu items that use the ``same'' | |
2293 command but with different enable conditions. The best way to do this | |
2294 in Emacs now is with extended menu items; before that feature existed, | |
2295 it could be done by defining alias commands and using them in menu | |
2296 items. Here's an example that makes two aliases for | |
2297 @code{toggle-read-only} and gives them different enable conditions: | |
2298 | |
2299 @example | |
2300 (defalias 'make-read-only 'toggle-read-only) | |
2301 (put 'make-read-only 'menu-enable '(not buffer-read-only)) | |
2302 (defalias 'make-writable 'toggle-read-only) | |
2303 (put 'make-writable 'menu-enable 'buffer-read-only) | |
2304 @end example | |
2305 | |
2306 When using aliases in menus, often it is useful to display the | |
2307 equivalent key bindings for the ``real'' command name, not the aliases | |
2308 (which typically don't have any key bindings except for the menu | |
2309 itself). To request this, give the alias symbol a non-@code{nil} | |
2310 @code{menu-alias} property. Thus, | |
2311 | |
2312 @example | |
2313 (put 'make-read-only 'menu-alias t) | |
2314 (put 'make-writable 'menu-alias t) | |
2315 @end example | |
2316 | |
2317 @noindent | |
2318 causes menu items for @code{make-read-only} and @code{make-writable} to | |
2319 show the keyboard bindings for @code{toggle-read-only}. | |
2320 | |
2321 @node Mouse Menus | |
2322 @subsection Menus and the Mouse | |
2323 | |
2324 The usual way to make a menu keymap produce a menu is to make it the | |
2325 definition of a prefix key. (A Lisp program can explicitly pop up a | |
2326 menu and receive the user's choice---see @ref{Pop-Up Menus}.) | |
2327 | |
2328 If the prefix key ends with a mouse event, Emacs handles the menu keymap | |
2329 by popping up a visible menu, so that the user can select a choice with | |
2330 the mouse. When the user clicks on a menu item, the event generated is | |
2331 whatever character or symbol has the binding that brought about that | |
2332 menu item. (A menu item may generate a series of events if the menu has | |
2333 multiple levels or comes from the menu bar.) | |
2334 | |
2335 It's often best to use a button-down event to trigger the menu. Then | |
2336 the user can select a menu item by releasing the button. | |
2337 | |
2338 A single keymap can appear as multiple menu panes, if you explicitly | |
2339 arrange for this. The way to do this is to make a keymap for each pane, | |
2340 then create a binding for each of those maps in the main keymap of the | |
2341 menu. Give each of these bindings an item string that starts with | |
2342 @samp{@@}. The rest of the item string becomes the name of the pane. | |
2343 See the file @file{lisp/mouse.el} for an example of this. Any ordinary | |
2344 bindings with @samp{@@}-less item strings are grouped into one pane, | |
2345 which appears along with the other panes explicitly created for the | |
2346 submaps. | |
2347 | |
2348 X toolkit menus don't have panes; instead, they can have submenus. | |
2349 Every nested keymap becomes a submenu, whether the item string starts | |
2350 with @samp{@@} or not. In a toolkit version of Emacs, the only thing | |
2351 special about @samp{@@} at the beginning of an item string is that the | |
2352 @samp{@@} doesn't appear in the menu item. | |
2353 | |
2354 Multiple keymaps that define the same menu prefix key produce | |
2355 separate panes or separate submenus. | |
2356 | |
2357 @node Keyboard Menus | |
2358 @subsection Menus and the Keyboard | |
2359 | |
2360 When a prefix key ending with a keyboard event (a character or | |
2361 function key) has a definition that is a menu keymap, the keymap | |
2362 operates as a keyboard menu; the user specifies the next event by | |
2363 choosing a menu item with the keyboard. | |
2364 | |
2365 Emacs displays the keyboard menu with the map's overall prompt | |
2366 string, followed by the alternatives (the item strings of the map's | |
2367 bindings), in the echo area. If the bindings don't all fit at once, | |
2368 the user can type @key{SPC} to see the next line of alternatives. | |
2369 Successive uses of @key{SPC} eventually get to the end of the menu and | |
2370 then cycle around to the beginning. (The variable | |
2371 @code{menu-prompt-more-char} specifies which character is used for | |
2372 this; @key{SPC} is the default.) | |
2373 | |
2374 When the user has found the desired alternative from the menu, he or | |
2375 she should type the corresponding character---the one whose binding is | |
2376 that alternative. | |
2377 | |
2378 @ignore | |
2379 In a menu intended for keyboard use, each menu item must clearly | |
2380 indicate what character to type. The best convention to use is to make | |
2381 the character the first letter of the item string---that is something | |
2382 users will understand without being told. We plan to change this; by | |
2383 the time you read this manual, keyboard menus may explicitly name the | |
2384 key for each alternative. | |
2385 @end ignore | |
2386 | |
2387 This way of using menus in an Emacs-like editor was inspired by the | |
2388 Hierarkey system. | |
2389 | |
2390 @defvar menu-prompt-more-char | |
2391 This variable specifies the character to use to ask to see | |
2392 the next line of a menu. Its initial value is 32, the code | |
2393 for @key{SPC}. | |
2394 @end defvar | |
2395 | |
2396 @node Menu Example | |
2397 @subsection Menu Example | |
2398 @cindex menu definition example | |
2399 | |
2400 Here is a complete example of defining a menu keymap. It is the | |
2401 definition of the @samp{Replace} submenu in the @samp{Edit} menu in | |
2402 the menu bar, and it uses the extended menu item format | |
2403 (@pxref{Extended Menu Items}). First we create the keymap, and give | |
2404 it a name: | |
2405 | |
2406 @smallexample | |
2407 (defvar menu-bar-replace-menu (make-sparse-keymap "Replace")) | |
2408 @end smallexample | |
2409 | |
2410 @noindent | |
2411 Next we define the menu items: | |
2412 | |
2413 @smallexample | |
2414 (define-key menu-bar-replace-menu [tags-repl-continue] | |
2415 '(menu-item "Continue Replace" tags-loop-continue | |
2416 :help "Continue last tags replace operation")) | |
2417 (define-key menu-bar-replace-menu [tags-repl] | |
2418 '(menu-item "Replace in tagged files" tags-query-replace | |
2419 :help "Interactively replace a regexp in all tagged files")) | |
2420 (define-key menu-bar-replace-menu [separator-replace-tags] | |
2421 '(menu-item "--")) | |
2422 ;; @r{@dots{}} | |
2423 @end smallexample | |
2424 | |
2425 @noindent | |
2426 Note the symbols which the bindings are ``made for''; these appear | |
2427 inside square brackets, in the key sequence being defined. In some | |
2428 cases, this symbol is the same as the command name; sometimes it is | |
2429 different. These symbols are treated as ``function keys,'' but they are | |
2430 not real function keys on the keyboard. They do not affect the | |
2431 functioning of the menu itself, but they are ``echoed'' in the echo area | |
2432 when the user selects from the menu, and they appear in the output of | |
2433 @code{where-is} and @code{apropos}. | |
2434 | |
2435 The menu in this example is intended for use with the mouse. If a | |
2436 menu is intended for use with the keyboard, that is, if it is bound to | |
2437 a key sequence ending with a keyboard event, then the menu items | |
2438 should be bound to characters or ``real'' function keys, that can be | |
2439 typed with the keyboard. | |
2440 | |
2441 The binding whose definition is @code{("--")} is a separator line. | |
2442 Like a real menu item, the separator has a key symbol, in this case | |
2443 @code{separator-replace-tags}. If one menu has two separators, they | |
2444 must have two different key symbols. | |
2445 | |
2446 Here is how we make this menu appear as an item in the parent menu: | |
2447 | |
2448 @example | |
2449 (define-key menu-bar-edit-menu [replace] | |
2450 (list 'menu-item "Replace" menu-bar-replace-menu)) | |
2451 @end example | |
2452 | |
2453 @noindent | |
2454 Note that this incorporates the submenu keymap, which is the value of | |
2455 the variable @code{menu-bar-replace-menu}, rather than the symbol | |
2456 @code{menu-bar-replace-menu} itself. Using that symbol in the parent | |
2457 menu item would be meaningless because @code{menu-bar-replace-menu} is | |
2458 not a command. | |
2459 | |
2460 If you wanted to attach the same replace menu to a mouse click, you | |
2461 can do it this way: | |
2462 | |
2463 @example | |
2464 (define-key global-map [C-S-down-mouse-1] | |
2465 menu-bar-replace-menu) | |
2466 @end example | |
2467 | |
2468 @node Menu Bar | |
2469 @subsection The Menu Bar | |
2470 @cindex menu bar | |
2471 | |
2472 Most window systems allow each frame to have a @dfn{menu bar}---a | |
2473 permanently displayed menu stretching horizontally across the top of the | |
2474 frame. The items of the menu bar are the subcommands of the fake | |
2475 ``function key'' @code{menu-bar}, as defined in the active keymaps. | |
2476 | |
2477 To add an item to the menu bar, invent a fake ``function key'' of your | |
2478 own (let's call it @var{key}), and make a binding for the key sequence | |
2479 @code{[menu-bar @var{key}]}. Most often, the binding is a menu keymap, | |
2480 so that pressing a button on the menu bar item leads to another menu. | |
2481 | |
2482 When more than one active keymap defines the same fake function key | |
2483 for the menu bar, the item appears just once. If the user clicks on | |
2484 that menu bar item, it brings up a single, combined menu containing | |
2485 all the subcommands of that item---the global subcommands, the local | |
2486 subcommands, and the minor mode subcommands. | |
2487 | |
2488 The variable @code{overriding-local-map} is normally ignored when | |
2489 determining the menu bar contents. That is, the menu bar is computed | |
2490 from the keymaps that would be active if @code{overriding-local-map} | |
2491 were @code{nil}. @xref{Active Keymaps}. | |
2492 | |
2493 In order for a frame to display a menu bar, its @code{menu-bar-lines} | |
2494 parameter must be greater than zero. Emacs uses just one line for the | |
2495 menu bar itself; if you specify more than one line, the other lines | |
2496 serve to separate the menu bar from the windows in the frame. We | |
2497 recommend 1 or 2 as the value of @code{menu-bar-lines}. @xref{Layout | |
2498 Parameters}. | |
2499 | |
2500 Here's an example of setting up a menu bar item: | |
2501 | |
2502 @example | |
2503 @group | |
2504 (modify-frame-parameters (selected-frame) | |
2505 '((menu-bar-lines . 2))) | |
2506 @end group | |
2507 | |
2508 @group | |
2509 ;; @r{Make a menu keymap (with a prompt string)} | |
2510 ;; @r{and make it the menu bar item's definition.} | |
2511 (define-key global-map [menu-bar words] | |
2512 (cons "Words" (make-sparse-keymap "Words"))) | |
2513 @end group | |
2514 | |
2515 @group | |
2516 ;; @r{Define specific subcommands in this menu.} | |
2517 (define-key global-map | |
2518 [menu-bar words forward] | |
2519 '("Forward word" . forward-word)) | |
2520 @end group | |
2521 @group | |
2522 (define-key global-map | |
2523 [menu-bar words backward] | |
2524 '("Backward word" . backward-word)) | |
2525 @end group | |
2526 @end example | |
2527 | |
2528 A local keymap can cancel a menu bar item made by the global keymap by | |
2529 rebinding the same fake function key with @code{undefined} as the | |
2530 binding. For example, this is how Dired suppresses the @samp{Edit} menu | |
2531 bar item: | |
2532 | |
2533 @example | |
2534 (define-key dired-mode-map [menu-bar edit] 'undefined) | |
2535 @end example | |
2536 | |
2537 @noindent | |
2538 @code{edit} is the fake function key used by the global map for the | |
2539 @samp{Edit} menu bar item. The main reason to suppress a global | |
2540 menu bar item is to regain space for mode-specific items. | |
2541 | |
2542 @defvar menu-bar-final-items | |
2543 Normally the menu bar shows global items followed by items defined by the | |
2544 local maps. | |
2545 | |
2546 This variable holds a list of fake function keys for items to display at | |
2547 the end of the menu bar rather than in normal sequence. The default | |
2548 value is @code{(help-menu)}; thus, the @samp{Help} menu item normally appears | |
2549 at the end of the menu bar, following local menu items. | |
2550 @end defvar | |
2551 | |
2552 @defvar menu-bar-update-hook | |
2553 This normal hook is run by redisplay to update the menu bar contents, | |
2554 before redisplaying the menu bar. You can use it to update submenus | |
2555 whose contents should vary. Since this hook is run frequently, we | |
2556 advise you to ensure that the functions it calls do not take much time | |
2557 in the usual case. | |
2558 @end defvar | |
2559 | |
2560 @node Tool Bar | |
2561 @subsection Tool bars | |
2562 @cindex tool bar | |
2563 | |
2564 A @dfn{tool bar} is a row of icons at the top of a frame, that execute | |
2565 commands when you click on them---in effect, a kind of graphical menu | |
2566 bar. | |
2567 | |
2568 The frame parameter @code{tool-bar-lines} (X resource @samp{toolBar}) | |
2569 controls how many lines' worth of height to reserve for the tool bar. A | |
2570 zero value suppresses the tool bar. If the value is nonzero, and | |
2571 @code{auto-resize-tool-bars} is non-@code{nil}, the tool bar expands and | |
2572 contracts automatically as needed to hold the specified contents. | |
2573 | |
2574 If the value of @code{auto-resize-tool-bars} is @code{grow-only}, | |
2575 the tool bar expands automatically, but does not contract automatically. | |
2576 To contract the tool bar, the user has to redraw the frame by entering | |
2577 @kbd{C-l}. | |
2578 | |
2579 The tool bar contents are controlled by a menu keymap attached to a | |
2580 fake ``function key'' called @code{tool-bar} (much like the way the menu | |
2581 bar is controlled). So you define a tool bar item using | |
2582 @code{define-key}, like this: | |
2583 | |
2584 @example | |
2585 (define-key global-map [tool-bar @var{key}] @var{item}) | |
2586 @end example | |
2587 | |
2588 @noindent | |
2589 where @var{key} is a fake ``function key'' to distinguish this item from | |
2590 other items, and @var{item} is a menu item key binding (@pxref{Extended | |
2591 Menu Items}), which says how to display this item and how it behaves. | |
2592 | |
2593 The usual menu keymap item properties, @code{:visible}, | |
2594 @code{:enable}, @code{:button}, and @code{:filter}, are useful in | |
2595 tool bar bindings and have their normal meanings. The @var{real-binding} | |
2596 in the item must be a command, not a keymap; in other words, it does not | |
2597 work to define a tool bar icon as a prefix key. | |
2598 | |
2599 The @code{:help} property specifies a ``help-echo'' string to display | |
2600 while the mouse is on that item. This is displayed in the same way as | |
2601 @code{help-echo} text properties (@pxref{Help display}). | |
2602 | |
2603 In addition, you should use the @code{:image} property; | |
2604 this is how you specify the image to display in the tool bar: | |
2605 | |
2606 @table @code | |
2607 @item :image @var{image} | |
2608 @var{images} is either a single image specification or a vector of four | |
2609 image specifications. If you use a vector of four, | |
2610 one of them is used, depending on circumstances: | |
2611 | |
2612 @table @asis | |
2613 @item item 0 | |
2614 Used when the item is enabled and selected. | |
2615 @item item 1 | |
2616 Used when the item is enabled and deselected. | |
2617 @item item 2 | |
2618 Used when the item is disabled and selected. | |
2619 @item item 3 | |
2620 Used when the item is disabled and deselected. | |
2621 @end table | |
2622 @end table | |
2623 | |
2624 If @var{image} is a single image specification, Emacs draws the tool bar | |
2625 button in disabled state by applying an edge-detection algorithm to the | |
2626 image. | |
2627 | |
91624
910c892cc458
(Tool Bar): Doculemt rtl property.
Jan Djärv <jan.h.d@swipnet.se>
parents:
87649
diff
changeset
|
2628 The @code{:rtl} property specifies an alternative image to use for |
910c892cc458
(Tool Bar): Doculemt rtl property.
Jan Djärv <jan.h.d@swipnet.se>
parents:
87649
diff
changeset
|
2629 right-to-left languages. Only the Gtk+ version of Emacs supports this |
910c892cc458
(Tool Bar): Doculemt rtl property.
Jan Djärv <jan.h.d@swipnet.se>
parents:
87649
diff
changeset
|
2630 at present. |
910c892cc458
(Tool Bar): Doculemt rtl property.
Jan Djärv <jan.h.d@swipnet.se>
parents:
87649
diff
changeset
|
2631 |
84078 | 2632 The default tool bar is defined so that items specific to editing do not |
2633 appear for major modes whose command symbol has a @code{mode-class} | |
2634 property of @code{special} (@pxref{Major Mode Conventions}). Major | |
2635 modes may add items to the global bar by binding @code{[tool-bar | |
2636 @var{foo}]} in their local map. It makes sense for some major modes to | |
2637 replace the default tool bar items completely, since not many can be | |
2638 accommodated conveniently, and the default bindings make this easy by | |
2639 using an indirection through @code{tool-bar-map}. | |
2640 | |
2641 @defvar tool-bar-map | |
2642 By default, the global map binds @code{[tool-bar]} as follows: | |
2643 @example | |
2644 (global-set-key [tool-bar] | |
2645 '(menu-item "tool bar" ignore | |
2646 :filter (lambda (ignore) tool-bar-map))) | |
2647 @end example | |
2648 @noindent | |
2649 Thus the tool bar map is derived dynamically from the value of variable | |
2650 @code{tool-bar-map} and you should normally adjust the default (global) | |
2651 tool bar by changing that map. Major modes may replace the global bar | |
2652 completely by making @code{tool-bar-map} buffer-local and set to a | |
2653 keymap containing only the desired items. Info mode provides an | |
2654 example. | |
2655 @end defvar | |
2656 | |
2657 There are two convenience functions for defining tool bar items, as | |
2658 follows. | |
2659 | |
2660 @defun tool-bar-add-item icon def key &rest props | |
2661 This function adds an item to the tool bar by modifying | |
2662 @code{tool-bar-map}. The image to use is defined by @var{icon}, which | |
2663 is the base name of an XPM, XBM or PBM image file to be located by | |
2664 @code{find-image}. Given a value @samp{"exit"}, say, @file{exit.xpm}, | |
2665 @file{exit.pbm} and @file{exit.xbm} would be searched for in that order | |
2666 on a color display. On a monochrome display, the search order is | |
2667 @samp{.pbm}, @samp{.xbm} and @samp{.xpm}. The binding to use is the | |
2668 command @var{def}, and @var{key} is the fake function key symbol in the | |
2669 prefix keymap. The remaining arguments @var{props} are additional | |
2670 property list elements to add to the menu item specification. | |
2671 | |
2672 To define items in some local map, bind @code{tool-bar-map} with | |
2673 @code{let} around calls of this function: | |
2674 @example | |
2675 (defvar foo-tool-bar-map | |
2676 (let ((tool-bar-map (make-sparse-keymap))) | |
2677 (tool-bar-add-item @dots{}) | |
2678 @dots{} | |
2679 tool-bar-map)) | |
2680 @end example | |
2681 @end defun | |
2682 | |
2683 @defun tool-bar-add-item-from-menu command icon &optional map &rest props | |
2684 This function is a convenience for defining tool bar items which are | |
2685 consistent with existing menu bar bindings. The binding of | |
2686 @var{command} is looked up in the menu bar in @var{map} (default | |
2687 @code{global-map}) and modified to add an image specification for | |
2688 @var{icon}, which is found in the same way as by | |
2689 @code{tool-bar-add-item}. The resulting binding is then placed in | |
2690 @code{tool-bar-map}, so use this function only for global tool bar | |
2691 items. | |
2692 | |
2693 @var{map} must contain an appropriate keymap bound to | |
2694 @code{[menu-bar]}. The remaining arguments @var{props} are additional | |
2695 property list elements to add to the menu item specification. | |
2696 @end defun | |
2697 | |
2698 @defun tool-bar-local-item-from-menu command icon in-map &optional from-map &rest props | |
2699 This function is used for making non-global tool bar items. Use it | |
2700 like @code{tool-bar-add-item-from-menu} except that @var{in-map} | |
2701 specifies the local map to make the definition in. The argument | |
2702 @var{from-map} is like the @var{map} argument of | |
2703 @code{tool-bar-add-item-from-menu}. | |
2704 @end defun | |
2705 | |
2706 @defvar auto-resize-tool-bar | |
2707 If this variable is non-@code{nil}, the tool bar automatically resizes to | |
2708 show all defined tool bar items---but not larger than a quarter of the | |
2709 frame's height. | |
2710 | |
2711 If the value is @code{grow-only}, the tool bar expands automatically, | |
2712 but does not contract automatically. To contract the tool bar, the | |
2713 user has to redraw the frame by entering @kbd{C-l}. | |
2714 @end defvar | |
2715 | |
2716 @defvar auto-raise-tool-bar-buttons | |
2717 If this variable is non-@code{nil}, tool bar items display | |
2718 in raised form when the mouse moves over them. | |
2719 @end defvar | |
2720 | |
2721 @defvar tool-bar-button-margin | |
2722 This variable specifies an extra margin to add around tool bar items. | |
2723 The value is an integer, a number of pixels. The default is 4. | |
2724 @end defvar | |
2725 | |
2726 @defvar tool-bar-button-relief | |
2727 This variable specifies the shadow width for tool bar items. | |
2728 The value is an integer, a number of pixels. The default is 1. | |
2729 @end defvar | |
2730 | |
2731 @defvar tool-bar-border | |
2732 This variable specifies the height of the border drawn below the tool | |
2733 bar area. An integer value specifies height as a number of pixels. | |
2734 If the value is one of @code{internal-border-width} (the default) or | |
2735 @code{border-width}, the tool bar border height corresponds to the | |
2736 corresponding frame parameter. | |
2737 @end defvar | |
2738 | |
2739 You can define a special meaning for clicking on a tool bar item with | |
2740 the shift, control, meta, etc., modifiers. You do this by setting up | |
2741 additional items that relate to the original item through the fake | |
2742 function keys. Specifically, the additional items should use the | |
2743 modified versions of the same fake function key used to name the | |
2744 original item. | |
2745 | |
2746 Thus, if the original item was defined this way, | |
2747 | |
2748 @example | |
2749 (define-key global-map [tool-bar shell] | |
2750 '(menu-item "Shell" shell | |
2751 :image (image :type xpm :file "shell.xpm"))) | |
2752 @end example | |
2753 | |
2754 @noindent | |
2755 then here is how you can define clicking on the same tool bar image with | |
2756 the shift modifier: | |
2757 | |
2758 @example | |
2759 (define-key global-map [tool-bar S-shell] 'some-command) | |
2760 @end example | |
2761 | |
2762 @xref{Function Keys}, for more information about how to add modifiers to | |
2763 function keys. | |
2764 | |
2765 @node Modifying Menus | |
2766 @subsection Modifying Menus | |
2767 | |
2768 When you insert a new item in an existing menu, you probably want to | |
2769 put it in a particular place among the menu's existing items. If you | |
2770 use @code{define-key} to add the item, it normally goes at the front of | |
2771 the menu. To put it elsewhere in the menu, use @code{define-key-after}: | |
2772 | |
2773 @defun define-key-after map key binding &optional after | |
2774 Define a binding in @var{map} for @var{key}, with value @var{binding}, | |
2775 just like @code{define-key}, but position the binding in @var{map} after | |
2776 the binding for the event @var{after}. The argument @var{key} should be | |
2777 of length one---a vector or string with just one element. But | |
2778 @var{after} should be a single event type---a symbol or a character, not | |
2779 a sequence. The new binding goes after the binding for @var{after}. If | |
2780 @var{after} is @code{t} or is omitted, then the new binding goes last, at | |
2781 the end of the keymap. However, new bindings are added before any | |
2782 inherited keymap. | |
2783 | |
2784 Here is an example: | |
2785 | |
2786 @example | |
2787 (define-key-after my-menu [drink] | |
2788 '("Drink" . drink-command) 'eat) | |
2789 @end example | |
2790 | |
2791 @noindent | |
2792 makes a binding for the fake function key @key{DRINK} and puts it | |
2793 right after the binding for @key{EAT}. | |
2794 | |
2795 Here is how to insert an item called @samp{Work} in the @samp{Signals} | |
2796 menu of Shell mode, after the item @code{break}: | |
2797 | |
2798 @example | |
2799 (define-key-after | |
2800 (lookup-key shell-mode-map [menu-bar signals]) | |
2801 [work] '("Work" . work-command) 'break) | |
2802 @end example | |
2803 @end defun | |
2804 | |
2805 @ignore | |
2806 arch-tag: cfb87287-9364-4e46-9e93-6c2f7f6ae794 | |
2807 @end ignore |