Function: ediff-read-event

ediff-read-event is a function alias for read-event, defined in lread.c.

This function is obsolete since 27.1; use read-event instead.

Signature

(ediff-read-event &optional PROMPT INHERIT-INPUT-METHOD SECONDS)

Documentation

Read an event object from the input stream.

If you want to read non-character events, consider calling read-key instead. read-key will decode events via input-decode-map that read-event will not. On a terminal this includes function keys such as <F7> and <RIGHT>, or mouse events generated by xterm-mouse-mode(var)/xterm-mouse-mode(fun).

If the optional argument PROMPT is non-nil, display that as a prompt. If PROMPT is nil or the string "", the key sequence/events that led to the current command is used as the prompt.

If the optional argument INHERIT-INPUT-METHOD is non-nil and some input method is turned on in the current buffer, that input method is used for reading a character.

If the optional argument SECONDS is non-nil, it should be a number specifying the maximum number of seconds to wait for input. If no input arrives in that time, return nil. SECONDS may be a floating-point value.

If inhibit-interaction is non-nil, this function will signal an inhibited-interaction error.

Aliases

ediff-read-event (obsolete since 27.1) pcomplete-read-event (obsolete since 27.1) semantic-read-event (obsolete since 27.1) viper-read-event-convert-to-char (obsolete since 27.1) viper-read-event (obsolete since 27.1)