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