comparison man/lispref/display.texi @ 444:576fb035e263 r21-2-37

Import from CVS: tag r21-2-37
author cvs
date Mon, 13 Aug 2007 11:36:19 +0200
parents abe6d1db359e
children 1ccc32a20af4
comparison
equal deleted inserted replaced
443:a8296e22da4e 444:576fb035e263
1 @c -*-texinfo-*- 1 @c -*-texinfo-*-
2 @c This is part of the XEmacs Lisp Reference Manual. 2 @c This is part of the XEmacs Lisp Reference Manual.
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1998 Free Software Foundation, Inc. 3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1998 Free Software Foundation, Inc.
4 @c See the file lispref.texi for copying conditions. 4 @c See the file lispref.texi for copying conditions.
5 @setfilename ../../info/display.info 5 @setfilename ../../info/display.info
6 @node Display, Hash Tables, Annotations, Top 6 @node Display, Hash Tables, Annotations, Top
7 @chapter Emacs Display 7 @chapter Emacs Display
8 8
28 @section Refreshing the Screen 28 @section Refreshing the Screen
29 29
30 The function @code{redraw-frame} redisplays the entire contents of a 30 The function @code{redraw-frame} redisplays the entire contents of a
31 given frame. @xref{Frames}. 31 given frame. @xref{Frames}.
32 32
33 @c Emacs 19 feature 33 @defun redraw-frame &optional frame no-preempt
34 @defun redraw-frame frame
35 This function clears and redisplays frame @var{frame}. 34 This function clears and redisplays frame @var{frame}.
35
36 @var{frame} defaults to the selected frame if omitted.
37
38 Normally, redisplay is preempted as normal if input arrives. However,
39 if optional second arg @var{no-preempt} is non-@code{nil}, redisplay
40 will not stop for input and is guaranteed to proceed to completion.
36 @end defun 41 @end defun
37 42
38 Even more powerful is @code{redraw-display}: 43 Even more powerful is @code{redraw-display}:
39 44
40 @deffn Command redraw-display &optional device 45 @deffn Command redraw-display &optional device
70 maintains, so that the next time the display is updated it will be 75 maintains, so that the next time the display is updated it will be
71 redrawn from scratch. Normally this occurs the next time that 76 redrawn from scratch. Normally this occurs the next time that
72 @code{next-event} or @code{sit-for} is called; however, a display update 77 @code{next-event} or @code{sit-for} is called; however, a display update
73 will not occur if there is input pending. @xref{Command Loop}. 78 will not occur if there is input pending. @xref{Command Loop}.
74 79
75 @defun force-cursor-redisplay 80 @defun force-cursor-redisplay &optional frame
76 This function causes an immediate update of the cursor on the selected 81 This function causes an immediate update of the cursor on @var{frame},
77 frame. (This function does not exist in FSF Emacs.) 82 which defaults to the selected frame.
78 @end defun 83 @end defun
79 84
80 @node Truncation 85 @node Truncation
81 @section Truncation 86 @section Truncation
82 @cindex line wrapping 87 @cindex line wrapping
214 @item @code{error}---default label used for reporting errors; 219 @item @code{error}---default label used for reporting errors;
215 220
216 @item @code{progress}---progress indicators like 221 @item @code{progress}---progress indicators like
217 @samp{Converting... 45%} (not logged by default); 222 @samp{Converting... 45%} (not logged by default);
218 223
219 @item @code{prompt}---prompt-like messages like @samp{Isearch: foo} (not 224 @item @code{prompt}---prompt-like messages like @samp{Isearch: foo} (not
220 logged by default); 225 logged by default);
221 226
222 @item @code{command}---helper command messages like @samp{Mark set} (not 227 @item @code{command}---helper command messages like @samp{Mark set} (not
223 logged by default); 228 logged by default);
224 229
225 @item @code{no-log}---messages that should never be logged 230 @item @code{no-log}---messages that should never be logged
226 @end itemize 231 @end itemize
227 232
228 Several messages may be stacked in the echo area at once. Lisp programs 233 Several messages may be stacked in the echo area at once. Lisp programs
229 may access these messages, or remove them as appropriate, via the 234 may access these messages, or remove them as appropriate, via the
230 message stack. 235 message stack.
231 236
232 @defun display-message label message &optional frame stdout-p 237 @defun display-message label message &optional frame stdout-p
233 This function displays @var{message} (a string) labeled as @var{label}, 238 This function displays @var{message} (a string) labeled as @var{label},
271 displayed there. 276 displayed there.
272 277
273 If a message remains at the head of the message-stack and 278 If a message remains at the head of the message-stack and
274 @var{no-restore} is @code{nil}, it will be displayed. The string which 279 @var{no-restore} is @code{nil}, it will be displayed. The string which
275 remains in the echo area will be returned, or @code{nil} if the 280 remains in the echo area will be returned, or @code{nil} if the
276 message-stack is now empty. If @var{label} is nil, the entire 281 message-stack is now empty. If @var{label} is @code{nil}, the entire
277 message-stack is cleared. 282 message-stack is cleared.
278 283
279 @example 284 @example
280 ;; @r{Show a message, wait for 2 seconds, and restore old minibuffer} 285 ;; @r{Show a message, wait for 2 seconds, and restore old minibuffer}
281 ;; @r{contents.} 286 ;; @r{contents.}
552 in the file, it looks OK, with nothing invisible. The selective display 557 in the file, it looks OK, with nothing invisible. The selective display
553 effect is seen only within XEmacs. 558 effect is seen only within XEmacs.
554 559
555 @defvar selective-display 560 @defvar selective-display
556 This buffer-local variable enables selective display. This means that 561 This buffer-local variable enables selective display. This means that
557 lines, or portions of lines, may be made invisible. 562 lines, or portions of lines, may be made invisible.
558 563
559 @itemize @bullet 564 @itemize @bullet
560 @item 565 @item
561 If the value of @code{selective-display} is @code{t}, then any portion 566 If the value of @code{selective-display} is @code{t}, then any portion
562 of a line that follows a control-m is not displayed. 567 of a line that follows a control-m is not displayed.
821 This variable specifies the number of seconds for the cursor to remain 826 This variable specifies the number of seconds for the cursor to remain
822 at the matching parenthesis. A fraction of a second often gives 827 at the matching parenthesis. A fraction of a second often gives
823 good results, but the default is 1, which works on all systems. 828 good results, but the default is 1, which works on all systems.
824 @end defvar 829 @end defvar
825 830
826 @defun blink-matching-open 831 @deffn Command blink-matching-open
827 This function is the default value of @code{blink-paren-function}. It 832 This function is the default value of @code{blink-paren-function}. It
828 assumes that point follows a character with close parenthesis syntax and 833 assumes that point follows a character with close parenthesis syntax and
829 moves the cursor momentarily to the matching opening character. If that 834 moves the cursor momentarily to the matching opening character. If that
830 character is not already on the screen, it displays the character's 835 character is not already on the screen, it displays the character's
831 context in the echo area. To avoid long delays, this function does not 836 context in the echo area. To avoid long delays, this function does not
834 Here is an example of calling this function explicitly. 839 Here is an example of calling this function explicitly.
835 840
836 @smallexample 841 @smallexample
837 @group 842 @group
838 (defun interactive-blink-matching-open () 843 (defun interactive-blink-matching-open ()
839 @c Do not break this line! -- rms.
840 @c The first line of a doc string
841 @c must stand alone.
842 "Indicate momentarily the start of sexp before point." 844 "Indicate momentarily the start of sexp before point."
843 (interactive) 845 (interactive)
844 @end group 846 @end group
845 @group 847 @group
846 (let ((blink-matching-paren-distance 848 (let ((blink-matching-paren-distance
847 (buffer-size)) 849 (buffer-size))
848 (blink-matching-paren t)) 850 (blink-matching-paren t))
849 (blink-matching-open))) 851 (blink-matching-open)))
850 @end group 852 @end group
851 @end smallexample 853 @end smallexample
852 @end defun 854 @end deffn
853 855
854 @node Usual Display 856 @node Usual Display
855 @section Usual Display Conventions 857 @section Usual Display Conventions
856 858
857 The usual display conventions define how to display each character 859 The usual display conventions define how to display each character