aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorChong Yidong2013-12-23 11:59:10 +0800
committerChong Yidong2013-12-23 11:59:10 +0800
commit8cd22a0818f3ed6832d4caa1883b32bab3107b54 (patch)
tree1c0922d3bd2e3ebd1fa17f05ca847f85bf7e6391 /doc
parentaec3bf9f49c8c0d0356a0e57f362bd0e23206e7d (diff)
downloademacs-8cd22a0818f3ed6832d4caa1883b32bab3107b54.tar.gz
emacs-8cd22a0818f3ed6832d4caa1883b32bab3107b54.zip
Rename set-temporary-overlay-map -> set-transient-map
* lisp/subr.el (set-transient-map): Rename from set-temporary-overlay-map. Doc fix. * lisp/face-remap.el (text-scale-adjust): * lisp/indent.el (indent-rigidly): * lisp/kmacro.el (kmacro-call-macro): * lisp/minibuffer.el (minibuffer-force-complete): * lisp/repeat.el (repeat): * lisp/simple.el (universal-argument--mode): * lisp/calendar/todo-mode.el (todo-insert-item--next-param): * lisp/progmodes/f90.el (f90-abbrev-start): Callers changed. * lisp/org/org.el (orgstruct-make-binding): Call set-transient-map instead of old name set-temporary-overlay-map. * doc/lispref/keymaps.texi (Controlling Active Maps): Renamed set-temporary-overlay-map to set-transient map. Doc fixes. (Searching Keymaps): The transient keymap takes precedence.
Diffstat (limited to 'doc')
-rw-r--r--doc/lispref/ChangeLog6
-rw-r--r--doc/lispref/keymaps.texi57
2 files changed, 40 insertions, 23 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index dbe148dbcf8..aae5a1a6cc2 100644
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -1,3 +1,9 @@
12013-12-23 Chong Yidong <cyd@gnu.org>
2
3 * keymaps.texi (Controlling Active Maps): Renamed
4 set-temporary-overlay-map to set-transient map. Doc fixes.
5 (Searching Keymaps): The transient keymap takes precedence.
6
12013-12-23 Glenn Morris <rgm@gnu.org> 72013-12-23 Glenn Morris <rgm@gnu.org>
2 8
3 * loading.texi (How Programs Do Loading, Load Suffixes): 9 * loading.texi (How Programs Do Loading, Load Suffixes):
diff --git a/doc/lispref/keymaps.texi b/doc/lispref/keymaps.texi
index 855420a70c9..86e205cf14d 100644
--- a/doc/lispref/keymaps.texi
+++ b/doc/lispref/keymaps.texi
@@ -747,13 +747,13 @@ pseudo-Lisp description of the order and conditions for searching
747them: 747them:
748 748
749@lisp 749@lisp
750(or (cond 750(or (@var{find-in} @var{transient-map})
751 (cond
751 (overriding-terminal-local-map 752 (overriding-terminal-local-map
752 (@var{find-in} overriding-terminal-local-map)) 753 (@var{find-in} overriding-terminal-local-map))
753 (overriding-local-map 754 (overriding-local-map
754 (@var{find-in} overriding-local-map)) 755 (@var{find-in} overriding-local-map))
755 ((or (@var{find-in} (get-char-property (point) 'keymap)) 756 ((or (@var{find-in} (get-char-property (point) 'keymap))
756 (@var{find-in} @var{temp-map})
757 (@var{find-in-any} emulation-mode-map-alists) 757 (@var{find-in-any} emulation-mode-map-alists)
758 (@var{find-in-any} minor-mode-overriding-map-alist) 758 (@var{find-in-any} minor-mode-overriding-map-alist)
759 (@var{find-in-any} minor-mode-map-alist) 759 (@var{find-in-any} minor-mode-map-alist)
@@ -764,14 +764,17 @@ them:
764@end lisp 764@end lisp
765 765
766@noindent 766@noindent
767@var{find-in} and @var{find-in-any} are pseudo functions that search 767Here, @var{find-in} and @var{find-in-any} are pseudo functions that
768in one keymap and in an alist of keymaps, respectively. (Searching a 768search in one keymap and in an alist of keymaps, respectively.
769single keymap for a binding is called @dfn{key lookup}; see @ref{Key 769(Searching a single keymap for a binding is called @dfn{key lookup};
770Lookup}.) If the key sequence starts with a mouse event, that event's position 770see @ref{Key Lookup}.) @var{transient-map} is a pseudo variable that
771is used instead of point and the current buffer. Mouse events on an 771represents the effect of a @code{set-transient-map} call
772embedded string use non-@code{nil} text properties from that string 772(@pxref{Controlling Active Maps}).
773instead of the buffer. @var{temp-map} is a pseudo variable that 773
774represents the effect of a @code{set-temporary-overlay-map} call. 774 In the above pseudo-code, if a key sequence starts with a mouse
775event, that event's position is used instead of point and the current
776buffer. Mouse events on an embedded string use non-@code{nil} text
777properties from that string instead of the buffer.
775 778
776 When a match is found (@pxref{Key Lookup}), if the binding in the 779 When a match is found (@pxref{Key Lookup}), if the binding in the
777keymap is a function, the search is over. However if the keymap entry 780keymap is a function, the search is over. However if the keymap entry
@@ -951,19 +954,27 @@ are used before @code{minor-mode-map-alist} and
951@code{minor-mode-overriding-map-alist}. 954@code{minor-mode-overriding-map-alist}.
952@end defvar 955@end defvar
953 956
954@defun set-temporary-overlay-map keymap &optional keep 957@cindex transient keymap
955This function adds @var{keymap} as a temporary keymap that takes 958@defun set-transient-map keymap &optional keep
956precedence over most other keymaps. It does not take precedence over 959This function adds @var{keymap} as a @dfn{transient} keymap, which
957the ``overriding'' maps (see above); and unlike them, if no match for 960takes precedence over other keymaps for one (or more) subsequent keys.
958a key is found in @var{keymap}, the search continues. 961
959 962Normally, @var{keymap} is used just once, to look up the very next
960Normally, @var{keymap} is used only once. If the optional argument 963key. If the optional argument @var{pred} is @code{t}, the map stays
961@var{pred} is @code{t}, the map stays active if a key from @var{keymap} 964active as long as the user types keys defined in @var{keymap}; when
962is used. @var{pred} can also be a function of no arguments: if it returns 965the user types a key that is not in @var{keymap}, the transient keymap
963non-@code{nil} then @var{keymap} stays active. 966is deactivated and normal key lookup continues for that key.
964 967
965For a pseudo-Lisp description of exactly how and when this keymap applies, 968The @var{pred} argument can also be a function. In that case, the
966@pxref{Searching Keymaps}. 969function is called with no arguments, prior to running each command,
970while @var{keymap} is active; it should return non-@code{nil} if
971@var{keymap} should stay active.
972
973The transient keymap takes precedence over the ``overriding'' maps
974(see above); and unlike them, if no match for a key is found in
975@var{keymap}, the key lookup process continues. For a pseudo-Lisp
976description of exactly how and when this keymap applies,
977@xref{Searching Keymaps}.
967@end defun 978@end defun
968 979
969@node Key Lookup 980@node Key Lookup