XmbTextExtents(XS)       X Version 11 (Release 5)         XmbTextExtents(XS)
                                6 January 1993


 Name

    XmbTextExtents - compute text extents

 Syntax


    int XmbTextExtents(font_set, string, num_bytes, overall_return)
          XFontSet font_set;
          char *string;
          int num_bytes;
          XRectangle *overall_ink_return;
          XRectangle *overall_logical_return;

    int XwcTextExtents(font_set, string, num_wchars, overall_return)
          XFontSet font_set;
          wchar_t *string;
          int num_wchars;
          XRectangle *overall_ink_return;
          XRectangle *overall_logical_return;


 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 overallinkreturn and overalllogicalreturn 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 speci-
    fied font set.

    If the overallinkreturn argument is non-NULL, it is set to the bounding
    box of the string's character ink.  Note that the overallinkreturn for
    a non-descending horizontally drawn Latin character is conventionally
    entirely above the baseline, that is,

       overallinkreturn.height <= -overallinkreturn.y.

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

    If the overalllogicalreturn 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 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.

 See also

    XmbTextEscapement(XS), XmbTextPerCharExtents(XS)
    Xlib - C Language X Interface