diff man/lispref/display.texi @ 1703:f561c3904bb3

[xemacs-hg @ 2003-09-20 01:46:53 by youngs] 2003-09-20 Ilya N. Golubev <gin@mo.msk.ru> * simple.el (raw-append-message): Allow user to specify alternative function for displaying message. (redisplay-echo-area-function): New. (clear-message): Allow user to specify function for finishing message display. (undisplay-echo-area-function): New. 2003-09-20 Ilya N. Golubev <gin@mo.msk.ru> * xemacs/mini.texi (Minibuffer): Add customizing message display reference. * lispref/display.texi (Customizing Message Display): New, describe `redisplay-echo-area-function', `undisplay-echo-area-function', `minibuffer-echo-wait-function'. (The Echo Area): Add menu. 2003-09-20 Ilya N. Golubev <gin@mo.msk.ru> * cmdloop.c (Fcommand_loop_1): Allow specifying elisp function for waiting user input while displaying message while in minibuffer. (Vminibuffer_echo_wait_function): New, associated variable... (vars_of_cmdloop): ... initialize it.
author youngs
date Sat, 20 Sep 2003 01:47:03 +0000
parents 1fa8838efe99
children f43f9ca6c7d9
line wrap: on
line diff
--- a/man/lispref/display.texi	Sat Sep 20 01:25:48 2003 +0000
+++ b/man/lispref/display.texi	Sat Sep 20 01:47:03 2003 +0000
@@ -170,6 +170,9 @@
 @cite{XEmacs Lisp Reference Manual} specifies the rules for resolving conflicts
 between the echo area and the minibuffer for use of that screen space
 (@pxref{Minibuffer,, The Minibuffer, xemacs, The XEmacs Lisp Reference Manual}).
+Such a conflicts may be avoided at all as described in @ref{Customizing Message
+Display}.
+
 Error messages appear in the echo area; see @ref{Errors}.
 
 You can write output in the echo area by using the Lisp printing
@@ -349,6 +352,43 @@
 for brief periods of time.
 @end defvar
 
+@menu
+* Customizing Message Display::
+@end menu
+
+@node Customizing Message Display
+@subsection Customizing Message Display
+
+Message display function specify message intended for echo area by
+putting message text into @code{" *Echo Area*"} buffer.  When event
+loop code decides to update display after displaying the message, text
+of this buffer is erased.  How exactly the text will be displayed may
+be affected by the following.
+
+@findex redisplay-echo-area
+@defvar redisplay-echo-area-function
+The function called to display echo area text.  The default variable
+value, @code{redisplay-echo-area} function, does that by displaying
+the text in the same place on the screen as the echo area.  So does
+other redisplay code.  User code can avoid this regardless of what
+redisplay code will run afterwards by erasing text of @code{" *Echo
+Area*"} buffer.
+@end defvar
+
+@defvar undisplay-echo-area-function
+The variable value, if non-@code{nil}, is called by command loop after
+erasing text of @code{" *Echo Area*"} buffer.  It must clean up data
+created by @code{redisplay-echo-area-function} value.
+@end defvar
+
+@defvar minibuffer-echo-wait-function
+The function is called by command loop only when minibuffer was active
+and message was displayed (text appeared in @code{" *Echo Area*"}
+buffer).  It must wait after displaying message so that user can read
+it.  By default, when the variable value is @code{nil}, the equivalent
+of @code{(sit-for 2)} is run.
+@end defvar
+
 @node Warnings
 @section Warnings