NAME

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

SYNTAX

Status XmbTextPerCharExtents(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 *_i_n_k___a_r_r_a_y___r_e_t_u_r_n, XRectangle *_l_o_g_i_c_a_l___a_r_r_a_y___r_e_t_u_r_n, int _a_r_r_a_y___s_i_z_e, int *_n_u_m___c_h_a_r_s___r_e_t_u_r_n, 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); Status XwcTextPerCharExtents(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 *_i_n_k___a_r_r_a_y___r_e_t_u_r_n, XRectangle *_l_o_g_i_c_a_l___a_r_r_a_y___r_e_t_u_r_n, int _a_r_r_a_y___s_i_z_e, int *_n_u_m___c_h_a_r_s___r_e_t_u_r_n, 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); Status Xutf8TextPerCharExtents(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 *_i_n_k___a_r_r_a_y___r_e_t_u_r_n, XRectangle *_l_o_g_i_c_a_l___a_r_r_a_y___r_e_t_u_r_n, int _a_r_r_a_y___s_i_z_e, int *_n_u_m___c_h_a_r_s___r_e_t_u_r_n, 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

_a_r_r_a_y___s_i_z_e Specifies the size of ink_array_return and logical_array_return.
The caller must pass in arrays of this size.
_f_o_n_t___s_e_t Specifies the font set.
_i_n_k___a_r_r_a_y___r_e_t_u_r_n Returns the ink dimensions for each character.
_l_o_g_i_c_a_l___a_r_r_a_y___r_e_t_u_r_n Returns the logical dimensions for each character.
_n_u_m___b_y_t_e_s Specifies the number of bytes in the string argument.
_n_u_m___c_h_a_r_s___r_e_t_u_r_n Returns the number of characters 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 extents of the entire string.
_o_v_e_r_a_l_l___l_o_g_i_c_a_l___r_e_t_u_r_n Returns the overall logical extents of the entire string.
_s_t_r_i_n_g Specifies the character string.

DESCRIPTION

The _X_m_b_T_e_x_t_P_e_r_C_h_a_r_E_x_t_e_n_t_s, _X_w_c_T_e_x_t_P_e_r_C_h_a_r_E_x_t_e_n_t_s and _X_u_t_f_8_T_e_x_t_P_e_r_C_h_a_r_E_x_t_e_n_t_s functions 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 and one rectangle 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 that 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 _X_R_e_c_t_a_n_g_l_e 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 _X_R_e_c_t_a_n_g_l_e_s of those characters are the same.

When the _X_F_o_n_t_S_e_t has missing charsets, metrics for each unavailable character 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.

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 functions return a nonzero value.

If the overall_ink_return or overall_logical_return argument is non-NULL, _X_m_b_T_e_x_t_P_e_r_C_h_a_r_E_x_t_e_n_t_s, _X_w_c_T_e_x_t_P_e_r_C_h_a_r_E_x_t_e_n_t_s and _X_u_t_f_8_T_e_x_t_P_e_r_C_h_a_r_E_x_t_e_n_t_s return the maximum extent of the string's metrics to overall_ink_return or overall_logical_return, as returned by _X_m_b_T_e_x_t_E_x_t_e_n_t_s, _X_w_c_T_e_x_t_E_x_t_e_n_t_s or _X_u_t_f_8_T_e_x_t_E_x_t_e_n_t_s.

The function _X_u_t_f_8_T_e_x_t_P_e_r_C_h_a_r_E_x_t_e_n_t_s is an extension introduced by The XFree86 Project, Inc. in their 4.0.2 release. Its presence is indicated by the macro _X___H_A_V_E___U_T_F_8___S_T_R_I_N_G.

SEE ALSO

XmbTextEscapement(3X11), XmbTextExtents(3X11) _X_l_i_b _- _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e