XmbTextExtents(3X11)      XLIB FUNCTIONS     XmbTextExtents(3X11)


NAME
       XmbTextExtents, XwcTextExtents - compute text extents

SYNTAX
       int XmbTextExtents(fontset, string, numbytes,
       overallreturn)
             XFontSet fontset;
             char *string;
             int numbytes;
             XRectangle *overallinkreturn;
             XRectangle *overalllogicalreturn;

       int XwcTextExtents(fontset, string, numwchars,
       overallreturn)
             XFontSet fontset;
             wchar_t *string;
             int numwchars;
             XRectangle *overallinkreturn;
             XRectangle *overalllogicalreturn;

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 and XwcTextExtents functions set the
       components of the specified overall_ink_return and over-
       all_logical_return 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 or XwcTextEscapement.  These
       metrics are relative to the drawing origin of the string,
       using the fonts loaded for the specified font set.

       If the overall_ink_return argument is non-NULL, it is set
       to the bounding box of the string's character ink.  Note
       that the overall_ink_return for a non-descending horizon-
       tally drawn Latin character is conventionally entirely
       above the baseline, that is, overall_ink_return.height <=
       -overall_ink_return.y.  The overall_ink_return for a



X Version 11                Release 5                           1

XmbTextExtents(3X11)      XLIB FUNCTIONS     XmbTextExtents(3X11)


       nonkerned character is entirely at and to the right of the
       origin, that is, overall_ink_return.x >= 0.  A character
       consisting of a single pixel at the origin would set over-
       all_ink_return fields y = 0, x = 0, width = 1, height = 1.

       If the overall_logical_return argument is non-NULL, it is
       set to the bounding box which provides minimum spacing to
       other graphical features for the string.  Other graphical
       features, for example, a border surrounding 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.

SEE ALSO
       XmbTextEscapement(3X11), XmbTextPerCharExtents(3X11) Xlib
       - C Language X Interface





































X Version 11                Release 5                           2