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