annotate lispref/keymaps.texi @ 64610:06bf5258607d

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