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