aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRichard M. Stallman2006-10-16 18:57:04 +0000
committerRichard M. Stallman2006-10-16 18:57:04 +0000
commitb98cf8d67b54170c4d25220c2b197d9881202509 (patch)
tree5a35c46956b933b70e237a6e8a89e148e314dabf
parentca7683085998b2e5957b025b90e421a68f83dde6 (diff)
downloademacs-b98cf8d67b54170c4d25220c2b197d9881202509.tar.gz
emacs-b98cf8d67b54170c4d25220c2b197d9881202509.zip
(Format of Keymaps): Show all the keymap element
patterns that result from menu items. (Key Lookup): Minor cleanups.
-rw-r--r--lispref/keymaps.texi32
1 files changed, 19 insertions, 13 deletions
diff --git a/lispref/keymaps.texi b/lispref/keymaps.texi
index 6f4c2d9aceb..1f017b1f43e 100644
--- a/lispref/keymaps.texi
+++ b/lispref/keymaps.texi
@@ -174,13 +174,18 @@ ordinary binding applies to events of a particular @dfn{event type},
174which is always a character or a symbol. @xref{Classifying Events}. 174which is always a character or a symbol. @xref{Classifying Events}.
175In this kind of binding, @var{binding} is a command. 175In this kind of binding, @var{binding} is a command.
176 176
177@item (@var{type} @var{item-name} .@: @var{binding}) 177@item (@var{type} @var{item-name} @r{[}@var{cache}@r{]} .@: @var{binding})
178This specifies a binding which is also a menu item 178This specifies a binding which is also a simple menu item that
179named @var{item-name}. @xref{Simple Menu Items}. 179displays as @var{item-name} in the menu. @var{cache}, if present,
180caches certain information for display in the menu. @xref{Simple Menu
181Items}.
182
183@item (@var{type} @var{item-name} @var{help-string} @r{[}@var{cache}@r{]} .@: @var{binding})
184This is a simple menu item with help string @var{help-string}.
180 185
181@item (@var{type} menu-item .@: @var{details}) 186@item (@var{type} menu-item .@: @var{details})
182This specifies a binding which is also a menu item and allows use of 187This specifies a binding which is also an extended menu item. This
183other features. @xref{Extended Menu Items}. 188allows use of other features. @xref{Extended Menu Items}.
184 189
185@item (t .@: @var{binding}) 190@item (t .@: @var{binding})
186@cindex default key binding 191@cindex default key binding
@@ -203,9 +208,10 @@ keymap}. Other keymaps are called @dfn{sparse keymaps}.
203@cindex keymap prompt string 208@cindex keymap prompt string
204@cindex overall prompt string 209@cindex overall prompt string
205@cindex prompt string of keymap 210@cindex prompt string of keymap
206Aside from bindings, a keymap can also have a string as an element. 211Aside from elements that specify bindings for keys, a keymap can also
207This is called the @dfn{overall prompt string} and makes it possible to 212have a string as an element. This is called the @dfn{overall prompt
208use the keymap as a menu. @xref{Defining Menus}. 213string} and makes it possible to use the keymap as a menu.
214@xref{Defining Menus}.
209@end table 215@end table
210 216
211When the binding is @code{nil}, it doesn't constitute a definition 217When the binding is @code{nil}, it doesn't constitute a definition
@@ -932,11 +938,11 @@ keymap.
932 938
933 Let's use the term @dfn{keymap entry} to describe the value found by 939 Let's use the term @dfn{keymap entry} to describe the value found by
934looking up an event type in a keymap. (This doesn't include the item 940looking up an event type in a keymap. (This doesn't include the item
935string and other extra elements in menu key bindings, because 941string and other extra elements in a keymap element for a menu item, because
936@code{lookup-key} and other key lookup functions don't include them in 942@code{lookup-key} and other key lookup functions don't include them in
937the returned value.) While any Lisp object may be stored in a keymap as 943the returned value.) While any Lisp object may be stored in a keymap
938a keymap entry, not all make sense for key lookup. Here is a table of 944as a keymap entry, not all make sense for key lookup. Here is a table
939the meaningful kinds of keymap entries: 945of the meaningful types of keymap entries:
940 946
941@table @asis 947@table @asis
942@item @code{nil} 948@item @code{nil}
@@ -964,7 +970,7 @@ event of the key sequence is looked up in @var{keymap}.
964 970
965@item @var{list} 971@item @var{list}
966@cindex list in keymap 972@cindex list in keymap
967The meaning of a list depends on the types of the elements of the list. 973The meaning of a list depends on what it contains:
968 974
969@itemize @bullet 975@itemize @bullet
970@item 976@item