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