Method Cairo.ScaledFont()->text_extents()

Method text_extents

TextExtents text_extents(string text)

Description

Gets the extents for a string of text. The extents describe a user-space rectangle that encloses the "inked" portion of the text drawn at the origin (0,0) (as it would be drawn by Context->show_text() if the cairo graphics state were set to the same font_face, font_matrix, ctm, and font_options as this ScaledFont). Additionally, the x_advance and y_advance values indicate the amount by which the current point would be advanced by Context->show_text().

Note that whitespace characters do not directly contribute to the size of the rectangle (TextExtents->width and TextExtents->height). They do contribute indirectly by changing the position of non-whitespace characters. In particular, trailing whitespace characters are likely to not affect the size of the rectangle, though they will affect the x_advance and y_advance values.

Parameter text

a string of text

Returns

a TextExtents object which stores the retrieved extents.