


XmbTextExtents(3X11)					 XmbTextExtents(3X11)
X11R5									X11R5



NAME
  XmbTextExtents, XwcTextExtents - compute text	extents

SYNTAX
  int XmbTextExtents(_f_o_n_t__s_e_t, _s_t_r_i_n_g, _n_u_m__b_y_t_e_s, _o_v_e_r_a_l_l__r_e_t_u_r_n)
	XFontSet _f_o_n_t__s_e_t;
	char *_s_t_r_i_n_g;
	int _n_u_m__b_y_t_e_s;
	XRectangle *_o_v_e_r_a_l_l__i_n_k__r_e_t_u_r_n;
	XRectangle *_o_v_e_r_a_l_l__l_o_g_i_c_a_l__r_e_t_u_r_n;

  int XwcTextExtents(_f_o_n_t__s_e_t, _s_t_r_i_n_g, _n_u_m__w_c_h_a_r_s, _o_v_e_r_a_l_l__r_e_t_u_r_n)
	XFontSet _f_o_n_t__s_e_t;
	wchar_t	*_s_t_r_i_n_g;
	int _n_u_m__w_c_h_a_r_s;
	XRectangle *_o_v_e_r_a_l_l__i_n_k__r_e_t_u_r_n;
	XRectangle *_o_v_e_r_a_l_l__l_o_g_i_c_a_l__r_e_t_u_r_n;

ARGUMENTS

  _f_o_n_t__s_e_t  Specifies the font set.

  _n_u_m__b_y_t_e_s Specifies the number of bytes in the string	argument.

  _n_u_m__w_c_h_a_r_s
	    Specifies the number of characters in the string argument.

  _o_v_e_r_a_l_l__i_n_k__r_e_t_u_r_n
	    Returns the	overall	ink dimensions.

  _o_v_e_r_a_l_l__l_o_g_i_c_a_l__r_e_t_u_r_n
	    Returns the	overall	logical	dimensions.

  _s_t_r_i_n_g    Specifies the character string.

DESCRIPTION
  The _X_m_b_T_e_x_t_E_x_t_e_n_t_s and _X_w_c_T_e_x_t_E_x_t_e_n_t_s	functions set the components of	the
  specified overall_ink_return and overall_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 _X_m_b_T_e_x_-
  _t_E_s_c_a_p_e_m_e_n_t or _X_w_c_T_e_x_t_E_s_c_a_p_e_m_e_n_t.  These metrics are relative	to the draw-
  ing 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 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 set
  overall_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 bound-
  ing 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 _X_F_o_n_t_S_e_t has	missing	charsets, metrics for each unavailable char-
  acter	are taken from the default string returned by _X_C_r_e_a_t_e_F_o_n_t_S_e_t 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) _X_l_i_b - _C	_L_a_n_g_u_a_g_e _X
  _I_n_t_e_r_f_a_c_e


























































