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