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