Next Prev Up Top Contents Index

13.4.3 Wrapping Text Lines

stream-end-of-line-action [Generic Function]

Arguments: stream

(setf stream-end-of-line-action) [Generic Function]

Arguments: action stream

Summary: The end-of-line action controls what happens if the text cursor position moves horizontally out of the viewport or if text output reaches the text margin. (By default the text margin is the width of the viewport, so these often coincide.)

stream-end-of-line-action returns the end-of-line action for the extended output stream stream . It can be changed by using setf on stream-end-of-line-action .

The end-of-line action is one of:

:wrap --when doing text output, wrap the text around (that is, break the text line and start another line). When setting the cursor position, scroll the window horizontally to keep the cursor position inside the viewport. This is the default.

:scroll --scroll the window horizontally to keep the cursor position inside the viewport, then keep doing the output.

:allow --ignore the text margin and do the output on the drawing plane beyond the visible part of the viewport.

with-end-of-line-action [Macro]	

Arguments: (stream action) &body body

Summary: Temporarily changes stream 's end-of-line action for the duration of execution of body. action must be one of the actions described in stream-end-of-line-action .

The stream argument is not evaluated, and must be a symbol that is bound to a stream. If stream is t , *standard-output* is used. body may have zero or more declarations as its first forms.

stream-end-of-page-action [Generic Function]

Arguments: stream

(setf stream-end-of-page-action) [Generic Function]

Arguments: action stream

Summary: The end-of-page action controls what happens if the text cursor position moves vertically out of the viewport.

stream-end-of-page-action returns the end-of-page action for the extended output stream stream . Change it by using setf on stream-end-of-page-action .

The end-of-page action is one of:

:wrap --when doing text output, wrap the text around (that is, go back to the top of the viewport).

:scroll --scroll the window vertically to keep the cursor position inside the viewport, then keep doing output. This is the default.

:allow --ignore the viewport and do the output on the drawing plane beyond the visible part of the viewport.

with-end-of-page-action [Macro]	

Arguments: (stream action) &body body

Summary: Temporarily changes stream 's end-of-page action for the duration of execution of body. action must be one of the actions described in stream-end-of-page-action .

The stream argument is not evaluated, and must be a symbol that is bound to a stream. If stream is t , *standard-output* is used. body may have zero or more declarations as its first forms.


CommonLisp Interface Manager 2.0 User's Guide - 8 Aug 2003

Next Prev Up Top Contents Index