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