Function: set-temporary-overlay-map

set-temporary-overlay-map is a function alias for set-transient-map, defined in subr.el.gz.

This function is obsolete since 24.4; use set-transient-map instead.

Signature

(set-temporary-overlay-map MAP &optional KEEP-PRED ON-EXIT MESSAGE TIMEOUT)

Documentation

Set MAP as a temporary keymap taking precedence over other keymaps.

Normally, MAP is used only once, to look up the very next key. However, if the optional argument KEEP-PRED is t, MAP stays active if a key from MAP is used. KEEP-PRED can also be a function of no arguments: it is called from pre-command-hook and if it returns non-nil, then MAP stays active.

Optional arg ON-EXIT, if non-nil, specifies a function that is called, with no arguments, after MAP is deactivated.

Optional arg MESSAGE, if non-nil, requests display of an informative message after activating the transient map. If MESSAGE is a string, it specifies the format string for the message to display, and the %k specifier in the string is replaced with the list of keys from the transient map. Any other non-nil value of MESSAGE means to use the message format string "Repeat with %k". Upon deactivating the map, the displayed message will be cleared out.

Optional arg TIMEOUT, if non-nil, should be a number specifying the number of seconds of idle time after which the map is deactivated. The variable set-transient-map-timeout, if non-nil, overrides the value of TIMEOUT.

This function uses overriding-terminal-local-map, which takes precedence over all other keymaps. As usual, if no match for a key is found in MAP, the normal key lookup sequence then continues.

This returns an "exit function", which can be called with no argument to deactivate this transient map, regardless of KEEP-PRED.

Probably introduced at or before Emacs version 24.3.

Aliases

set-temporary-overlay-map (obsolete since 24.4)