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