# HG changeset patch # User Miles Bader # Date 970969264 0 # Node ID c354d0540694f8d7b22734994e30153370136f6f # Parent b3df18daadfbe2372b9a9693cbf1afe6992156c2 Document `display-message-or-buffer'. diff -r b3df18daadfb -r c354d0540694 lispref/display.texi --- a/lispref/display.texi Sun Oct 08 01:37:42 2000 +0000 +++ b/lispref/display.texi Sun Oct 08 01:41:04 2000 +0000 @@ -212,6 +212,9 @@ ---------- Echo Area ---------- @end group @end example + +To automatically display a message in the echo area or in a pop-buffer, +depending on its size, use @code{display-message-or-buffer}. @end defun @tindex with-temp-message @@ -244,6 +247,26 @@ @code{message}. @end defun +@defun display-message-or-buffer message &optional buffer-name not-this-window frame +This function displays the message @var{message}, which may be either a +string or a buffer. If it is shorter than the maximum height of the +echo area, as defined by @code{max-mini-window-height}, it is displayed +in the echo area, using @code{message}. Otherwise, +@code{display-buffer} is used to show it in a pop-up buffer. + +Returns either the string shown in the echo area, or when a pop-up +buffer is used, the window used to display it. + +If @var{message} is a string, then the optional argument +@var{buffer-name} is the name of the buffer used to display it when a +pop-up buffer is used, defaulting to @samp{*Message*}. In the case +where @var{message} is a string and displayed in the echo area, it is +not specified whether the contents are inserted into the buffer anyway. + +The optional arguments @var{not-this-window} and @var{frame} are as for +@code{display-buffer}, and only used if a buffer is displayed. +@end defun + @defun current-message This function returns the message currently being displayed in the echo area, or @code{nil} if there is none.