annotate doc/lispref/keymaps.texi @ 101349:191a3121c949

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