nstream-string-corners

Arguments: stream string start end top-left bottom-left top-right bottom-right

Use of the function is deprecated. Use stream-string-width and line-height instead.

Modifies and returns as multiple values the last four arguments (top-left, bottom-left, top-right, bottom-right), which should all be position objects as created with make-position.

The returned values provide information about the size of string on stream. stream should be a cg-stream.

The new values are:

1. top-left: (make-position 0 (line-height stream))
2. bottom-left: (make-position 0 0)
3. top-right:
   (make-position (stream-string-width stream string start end) (line-height stream))
4. bottom-right:
   (make-position (stream-string-width stream string start end) 0)

See line-height and stream-string-width. The returned values are not meaningful if string (or the substring specified by start and end) contains newline characters.

The results describe the area taken up by string (or the substring specified by start and end) if it were printed to stream using the font of stream as returned by font.

Because this function returns the same information as line-height and stream-string-width (though in a somewhat different format), its use is deprecated. We recommend you use line-height and stream-string-width instead.

The function stream-string-corners is the non-destructive version of this function.

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