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