FunctionPackage: cgToCDocOverviewCGDocRelNotesFAQIndexPermutedIndex
Allegro CL version 10.1
Unrevised from 10.0 to 10.1.
10.0 version


Arguments: stream string &key font left-margin-in-pixels right-margin-in-pixels newline-spacing-in-lines stream-width just-return-text-height-p

Draws string on stream at the current position (see current-position), wrapping at spaces as needed to fit within the margins. Returns the total pixel height of the printed text.

stream should be a cg-stream.

font specifies the font to use to write the text. It defaults to the font of stream, the value of font applied to stream.

left-margin-in-pixels, measured from the left edge, and right-margin-in-pixels, measured from the right edge, bound the drawing of the string. Both default to 0.

If newline-spacing-in-lines is specified, it should indicate the number of lines to skip when an explicit newline appears in string. The appearance will then differentiate between newlines caused by wrapping and those caused by explicit newlines. The value can be a floating-point number. It defaults to 0.5.

If stream-width is specified, it overrides right-margin-in-pixels. The text will be this width.

If just-return-text-height-p is specified true, no drawing is done but the height needed for the drawing is calculated and returned.

Copyright (c) 1998-2017, Franz Inc. Oakland, CA., USA. All rights reserved.
This page was not revised from the 10.0 page.
Created 2017.2.15.

Allegro CL version 10.1
Unrevised from 10.0 to 10.1.
10.0 version