5.3 DUIM-Sheets Module

text-size

Generic function

Summary

Returns information about the size of the specified text on the specified medium.

Signature

text-size medium text #key text-style start end do-newlines? => largest-x largest-y cursor-x cursor-y baseline

Arguments

medium: An instance of type <medium>.
text: An instance of type type-union(<string>, <character>).
text-style: An instance of type <text-style>.
start: An instance of type <integer>. Default value: 0.
end: An instance of type <integer>. Default value: size(text).
do-newlines?: An instance of type <boolean>. Default value: #f.
do-tabs?: An instance of type <boolean>. Default value: #f.

Values

largest-x: An instance of type <integer>.
total-height: An instance of type <integer>.
last-x: An instance of type <integer>.
last-y: An instance of type <integer>.
baseline: An instance of type <integer>.

Library

duim-sheets

Module

duim-sheets

Description

Returns information about the size of text on medium.

If text-style is specified, then the information that text-size returns is based on the text style it describes.

If start and end are specified, then these values represent a portion of the string specified by text, and only the characters they represent are examined by text-size. Both start and end represent the index of each character in text, starting at 0. By default, the whole of text is examined.

The do-newlines? and do-tabs? arguments let you specify how newline or tab characters in text should be handled. If either of these arguments is true, then any newline or tab characters in text are examined, as appropriate. By default, newline characters are ignored.