NAME
XmbTextExtents, XwcTextExtents, Xutf8TextExtents - compute text extents SYNTAX int XmbTextExtents(XFontSet fontset, char *string, int numbytes, XRectangle *overallinkreturn, XRectangle *overalllogi‐ calreturn); int XwcTextExtents(XFontSet fontset, wchart *string, int numwchars, XRectangle *overallinkreturn, XRectangle *overalllogi‐ calreturn); int Xutf8TextExtents(XFontSet fontset, char *string, int numbytes, XRectangle *overallinkreturn, XRectangle *overalllogi‐ calreturn); ARGUMENTS fontset Specifies the font set. numbytes Specifies the number of bytes in the string argument. numwchars Specifies the number of characters in the string argument. overallinkreturn Returns the overall ink dimensions. overalllogicalreturn Returns the overall logical dimensions. string Specifies the character string. DESCRIPTION The XmbTextExtents, XwcTextExtents and Xutf8TextExtents functions set the components of the specified overallinkreturn and overalllogi‐ calreturn arguments to the overall bounding box of the string's image and a logical bounding box for spacing purposes, respectively. They return the value returned by XmbTextEscapement, XwcTextEscapement or Xutf8TextEscapement. These metrics are relative to the drawing origin of the string, using the fonts loaded for the specified font set.
If the overallinkreturn argument is non-NULL, it is set to the bound‐ ing box of the string's character ink. The overallinkreturn for a nondescending, horizontally drawn Latin character is conventionally entirely above the baseline; that is, overallinkreturn.height <=
-overallinkreturn.y. The overallinkreturn for a nonkerned charac‐ ter is entirely at, and to the right of, the origin; that is, over‐ allinkreturn.x >= 0. A character consisting of a single pixel at the origin would set overallinkreturn fields y = 0, x = 0, width = 1, and height = 1.
If the overalllogicalreturn argument is non-NULL, it is set to the bounding box that provides minimum spacing to other graphical features for the string. Other graphical features, for example, a border sur‐ rounding the text, should not intersect this rectangle. When the XFontSet has missing charsets, metrics for each unavailable character are taken from the default string returned by XCreateFontSet so that the metrics represent the text as it will actually be drawn. The behavior for an invalid codepoint is undefined. The function Xutf8TextExtents is an extension introduced by The XFree86 Project, Inc. in their 4.0.2 release. Its presence is indicated by the macro XHAVEUTF8STRING. SEE ALSO
XmbTextEscapement(3), XmbTextPerCharExtents(3) Xlib - C Language X Interface X Version 11 libX11 1.6.5 XmbTextExtents(3)