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