mirror/emacs
1
0
Fork 0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2025-01-05 11:45:45 +00:00
Code Issues Releases Activity

Document `display-message-or-buffer'.

Browse Source
This commit is contained in:
Miles Bader 2000-10-08 01:41:04 +00:00
parent 2a3f00bf5f
commit a43709e643
1 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
lispref/display.texi
View File

@ -212,6 +212,9 @@ Minibuffer depth is 0.
---------- 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 @@ support them, then @code{message-box} uses the echo area, like
@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.