diff options
Diffstat (limited to 'compat.texi')
| -rw-r--r-- | compat.texi | 45 |
1 files changed, 43 insertions, 2 deletions
diff --git a/compat.texi b/compat.texi index 04b8d25..60528cc 100644 --- a/compat.texi +++ b/compat.texi @@ -556,6 +556,49 @@ The following functions and macros are implemented in Emacs 26.1. These functions are made available by Compat on Emacs versions older than 26.1. +@c copied from lispref/minibuf.texi +@defun read-answer question answers +This function prompts the user with text in @var{question}, which +should end in the @samp{SPC} character. The function includes in the +prompt the possible responses in @var{answers} by appending them to +the end of @var{question}. The possible responses are provided in +@var{answers} as an alist whose elements are of the following form: + +@lisp +(@var{long-answer} @var{short-answer} @var{help-message}) +@end lisp + +@noindent +where @var{long-answer} is the complete text of the user response, a +string; @var{short-answer} is a short form of the same response, a +single character or a function key; and @var{help-message} is the text +that describes the meaning of the answer. If the variable +@code{read-answer-short} is non-@code{nil}, the prompt will show the +short variants of the possible answers and the user is expected to +type the single characters/keys shown in the prompt; otherwise the +prompt will show the long variants of the answers, and the user is +expected to type the full text of one of the answers and end by +pressing @key{RET}. If @code{use-dialog-box} is non-@code{nil}, and +this function was invoked by mouse events, the question and the +answers will be displayed in a GUI dialog box. + +The function returns the text of the @var{long-answer} selected by the +user, regardless of whether long or short answers were shown in the +prompt and typed by the user. + +Here is an example of using this function: + +@lisp +(let ((read-answer-short t)) + (read-answer "Foo " + '(("yes" ?y "perform the action") + ("no" ?n "skip to the next") + ("all" ?! "perform for the rest without more questions") + ("help" ?h "show help") + ("quit" ?q "exit")))) +@end lisp +@end defun + @c copied from lispref/functions.texi @defun mapcan function sequence This function applies @var{function} to each element of @var{sequence}, @@ -920,8 +963,6 @@ implemented in 26.1: @itemize @item -The function @code{read-answer}. -@item The function @code{func-arity}. @item The function @code{secure-hash-algorithms}. |