hpux man page for xmbtextpercharextents

XmbTextPerCharExtents() 												   XmbTextPerCharExtents()

Name
  XmbTextPerCharExtents - obtain per-character measurements of an internationalized multi-byte text string.

Synopsis
  Status  XmbTextPerCharExtents(font_set,  string,  num_bytes,	ink_array_return,  logical_array_return,  array_size, num_chars_return, over-
  all_ink_return, overall_logical_return)
	XFontSet font_set;
	char *string;
	int num_bytes;
	XRectangle *ink_array_return;
	XRectangle *logical_array_return;
	int array_size;
	int *num_chars_return;
	XRectangle *overall_ink_return;
	XRectangle *overall_logical_return;

Arguments
  font_set  Specifies the font set.

  string    Specifies the character string.

  num_bytes Specifies the number of bytes in the string argument.

  ink_array_return
	    Returns the ink dimensions for each character.

  logical_array_return
	    Returns the logical dimensions for each character.

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

  num_chars_return
	    Returns the number characters in the string argument.

  overall_ink_return
	    Returns the overall ink extents of the entire string.

  overall_logical_return
	    Returns the overall logical extents of the entire string.

Returns
  Zero on failure, non-zero on success.

Availability
  Release 5 and later.

Description
  XmbTextPerCharExtents() returns the text dimensions of each character of the specified text, using the fonts loaded for the specified  font
  set.	 Each  element	of  ink_array_return  and logical_array_return is set to the corresponding character's drawn metrics, relative to the
  drawing origin of the string.  The number of elements of ink_array_return and logical_array_return  that  have  been	set  is  returned  in
  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 XCreate-
  FontSet(), 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 function returns zero and num_chars_return is set  to
  the number of rectangles required.  Otherwise, it returns a non-zero value.

  If  the  overall_ink_return  or  overall_logical_return  argument  is  non-NULL,  XmbTextPerCharExtents() returns the maximum extent of the
  string's metrics to overall_ink_return or overall_logical_return, as is done by XmbTextExtents().

Structures
     typedef struct {
	 short x, y;
	 unsigned short width, height;
     } XRectangle;

See Also
  XmbTextEscapement(), XmbTextExtents(), XwcTextPerCharExtents().

Xlib - Internationalized Text												   XmbTextPerCharExtents()