XmbTextPerCharExtents(3X11)   X11 SDE 5.4R3.00   XmbTextPerCharExtents(3X11)


NAME
       XmbTextPerCharExtents, XwcTextPerCharExtents - obtain per-character
       information for a text string

SYNTAX
       Status XmbTextPerCharExtents(fontset, string, numbytes,
       inkarrayreturn,
                  logicalarrayreturn, arraysize, numcharsreturn,
       overallreturn)
             XFontSet fontset;
             char *string;
             int numbytes;
             XRectangle *inkarrayreturn;
             XRectangle *logicalarrayreturn;
             int arraysize;
             int *numcharsreturn;
             XRectangle *overallinkreturn;
             XRectangle *overalllogicalreturn;

       Status XwcTextPerCharExtents(fontset, string, numwchars,
       inkarrayreturn,
                 logicalarrayreturn, arraysize, numcharsreturn,
       overallreturn)
             XFontSet fontset;
             wchar_t *string;
             int numwchars;
             XRectangle *inkarrayreturn;
             XRectangle *logicalarrayreturn;
             int arraysize;
             int *numcharsreturn;
             XRectangle *overallinkreturn;
             XRectangle *overalllogicalreturn;

ARGUMENTS
       arraysize
                 Specifies the size of ink_array_return and
                 logical_array_return.  Note that the caller must pass in
                 arrays of this size.

       fontset  Specifies the font set.

       inkarrayreturn
                 Returns the ink dimensions for each character.

       logicalarrayreturn
                 Returns the logical dimensions for each character.

       numbytes Specifies the number of bytes in the string argument.

       numcharsreturn
                 Returns the number characters in the string argument.

       numwchars
                 Specifies the number of characters in the string argument.



Licensed material--property of copyright holder(s)                         1

XmbTextPerCharExtents(3X11)   X11 SDE 5.4R3.00   XmbTextPerCharExtents(3X11)


       overallinkreturn
                 Returns the overall ink extents of the entire string.

       overalllogicalreturn
                 Returns the overall logical extents of the entire string.

       string    Specifies the character string.

DESCRIPTION
       The XmbTextPerCharExtents and XwcTextPerCharExtents return the text
       dimensions of each character of the specified text, using the fonts
       loaded for the specified font set.  Each successive element of
       ink_array_return and logical_array_return is set to the successive
       character's drawn metrics, relative to the drawing origin of the
       string, one XRectangle for each character in the supplied text
       string.  The number of elements of ink_array_return and
       logical_array_return that have been set is returned to
       num_chars_return.

       Each element of ink_array_return is set to the bounding box of the
       corresponding character's drawn foreground color.  Each element of
       logical_array_return is set to the bounding box which provides
       minimum spacing to other graphical features for the corresponding
       character.  Other graphical features should not intersect any of the
       logical_array_return rectangles.

       Note that an XRectangle represents the effective drawing dimensions
       of the character, regardless of the number of font glyphs that are
       used to draw the character, or the direction in which the character
       is drawn.  If multiple characters map to a single character glyph,
       the dimensions of all the XRectangles of those characters are the
       same.

       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.

       If the array_size is too small for the number of characters in the
       supplied text, the functions return zero and num_chars_return is set
       to the number of rectangles required.  Otherwise, the routines return
       a non-zero value.

       If the overall_ink_return or overall_logical_return argument is non-
       NULL, XmbTextPerCharExtents and XwcTextPerCharExtents return the
       maximum extent of the string's metrics to overall_ink_return or
       overall_logical_return, as returned by XmbTextExtents or
       XwcTextExtents.

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




Licensed material--property of copyright holder(s)                         2