annotate lispref/keymaps.texi @ 78680:e838385a9cef

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