diff options
author | Luc Teirlinck <teirllm@auburn.edu> | 2004-08-09 18:42:04 +0000 |
---|---|---|
committer | Luc Teirlinck <teirllm@auburn.edu> | 2004-08-09 18:42:04 +0000 |
commit | 6ebdcd02020022f9cb531b6325a5b94e5c621b66 (patch) | |
tree | dfb4f2230435d6a5019aee098b2f9aa23aa36332 /src/keymap.c | |
parent | f945a729721d28c40ad389f9af51f948e13eb1b9 (diff) | |
download | emacs-6ebdcd02020022f9cb531b6325a5b94e5c621b66.tar.gz |
(Fmake_keymap, Fmap_keymap, Fwhere_is_internal): Doc fixes.
Diffstat (limited to 'src/keymap.c')
-rw-r--r-- | src/keymap.c | 20 |
1 files changed, 12 insertions, 8 deletions
diff --git a/src/keymap.c b/src/keymap.c index 3d4a782b5f8..92cb6902a1e 100644 --- a/src/keymap.c +++ b/src/keymap.c @@ -130,10 +130,11 @@ static void silly_event_symbol_error P_ ((Lisp_Object)); DEFUN ("make-keymap", Fmake_keymap, Smake_keymap, 0, 1, 0, doc: /* Construct and return a new keymap, of the form (keymap CHARTABLE . ALIST). -CHARTABLE is a char-table that holds the bindings for the ASCII -characters. ALIST is an assoc-list which holds bindings for function keys, -mouse events, and any other things that appear in the input stream. -All entries in it are initially nil, meaning "command undefined". +CHARTABLE is a char-table that holds the bindings for all characters +without modifiers. All entries in it are initially nil, meaning +"command undefined". ALIST is an assoc-list which holds bindings for +function keys, mouse events, and any other things that appear in the +input stream. Initially, ALIST is nil. The optional arg STRING supplies a menu name for the keymap in case you use it as a menu with `x-popup-menu'. */) @@ -728,7 +729,10 @@ map_keymap_call (key, val, fun, dummy) DEFUN ("map-keymap", Fmap_keymap, Smap_keymap, 2, 2, 0, doc: /* Call FUNCTION for every binding in KEYMAP. -FUNCTION is called with two arguments: the event and its binding. */) +FUNCTION is called with two arguments: the event and its binding. +If KEYMAP has a parent, the parent's bindings are included as well. +This works recursively: if the parent has itself a parent, then the +grandparent's bindings are also included and so on. */) (function, keymap) Lisp_Object function, keymap; { @@ -2572,7 +2576,7 @@ where_is_internal (definition, keymaps, firstonly, noindirect, no_remap) DEFUN ("where-is-internal", Fwhere_is_internal, Swhere_is_internal, 1, 5, 0, doc: /* Return list of keys that invoke DEFINITION. -If KEYMAP is non-nil, search only KEYMAP and the global keymap. +If KEYMAP is a keymap, search only KEYMAP and the global keymap. If KEYMAP is nil, search all the currently active keymaps. If KEYMAP is a list of keymaps, search only those keymaps. @@ -2580,8 +2584,8 @@ If optional 3rd arg FIRSTONLY is non-nil, return the first key sequence found, rather than a list of all possible key sequences. If FIRSTONLY is the symbol `non-ascii', return the first binding found, no matter what it is. -If FIRSTONLY has another non-nil value, prefer sequences of ASCII characters, -and entirely reject menu bindings. +If FIRSTONLY has another non-nil value, prefer sequences of ASCII characters +\(or their meta variants) and entirely reject menu bindings. If optional 4th arg NOINDIRECT is non-nil, don't follow indirections to other keymaps or slots. This makes it possible to search for an |