font-string-width

Function

Package: common-graphics

Arguments: font string &optional start end

Returns the width in font of the substring of string starting at start and ending at end (the whole string if start and end are not specified).

start must be greater than or equal to 0 and less than or equal to end, which must be greater than or equal to 0 and less than or equal to the length of string.

Example (the return values depend on the font returned by system-font; you may see different values):

(font-string-width (system-font) "foo") -> 20
(font-string-width (system-font) "foo" 0 3) -> 20
(font-string-width (system-font) "foo" 1 3) -> 16
(font-string-width (system-font) "foo" 2 2) -> 0
(font-string-width (system-font) "foo" 0 4) -> ERROR 
               (end is bigger than the length of string)

Common Graphics and IDE documentation is described in About Common Graphics and IDE documentation in cgide.htm.

The documentation is described in introduction.htm and the index is in index.htm.

Created 2000.10.5.