hpux man page for xmbtextextents

Query: xmbtextextents

OS: hpux

Section: 3

Format: Original Unix Latex Style Formatted with HTML and a Horizontal Scroll Bar

XmbTextExtents()														  XmbTextExtents()

Name
  XmbTextExtents - compute the extents of internationalized multi-byte text.

Synopsis
  int XmbTextExtents(font_set, string, num_bytes, overall_ink_return,
  overall_logical_return)
	XFontSet font_set;
	char *string;
	int num_bytes;
	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.

  overall_ink_return
	    Returns the overall ink dimensions.

  overall_logical_return
	    Returns the overall logical dimensions.

Returns
  Escapement in pixels.

Availability
  Release 5 and later.

Description
  XmbTextExtents()  sets  the components of the specified overall_ink_return and overall_logical_return arguments to the overall bounding box
  of the string's image, and the overall logical bounding box of the string's image plus inter-line and inter-character spacing.  It  returns
  the  value  returned by XmbTextEscapement().	The returned 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	over-
  all_ink_return  for  a  non-descending  horizontally	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 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 have overall_ink_return
  fields y = 0, x = 0, width = 1, and 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  fea-
  tures 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 XCreate-
  FontSet() so that the metrics represent the text as it will actually be drawn.  The behavior for an invalid codepoint is undefined.

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

See Also
  XmbTextEscapement(), XmbTextPerCharExtents(), XwcTextExtents().

Xlib - Internationalized Text													  XmbTextExtents()
Related Man Pages
xwctextextents(3x11) - redhat
xutf8textextents(3) - debian
xwctextextents(3) - suse
xmbtextextents(3x11) - osf1
xwctextextents(3x11) - osf1
Similar Topics in the Unix Linux Community
Unix File Permissions
Is UNIX an open source OS ?
Sequence extraction
Hpux 11iV3 administration document
Shopt -s histappend