cairoScaledFontTextExtents       package:RGtk2       R Documentation

_c_a_i_r_o_S_c_a_l_e_d_F_o_n_t_T_e_x_t_E_x_t_e_n_t_s

_D_e_s_c_r_i_p_t_i_o_n:

     Gets the extents for a string of text. The extents describe a
     user-space rectangle that encloses the "inked" portion of the text
     drawn at the origin (0,0) (as it would be drawn by 'cairoShowText'
     if the cairo graphics state were set to the same font_face,
     font_matrix, ctm, and font_options as 'scaled.font'). 
     Additionally, the x_advance and y_advance values indicate the
     amount by which the current point would be advanced by
     'cairoShowText'.

_U_s_a_g_e:

     cairoScaledFontTextExtents(scaled.font, utf8)

_A_r_g_u_m_e_n_t_s:

'scaled.font': ['CairoScaledFont']  a 'CairoScaledFont'

  'utf8': [char]  a string of text, encoded in UTF-8

_D_e_t_a_i_l_s:

     Note that whitespace characters do not directly contribute to the
     size of the rectangle (extents.width and extents.height). They do
     contribute indirectly by changing the position of non-whitespace
     characters. In particular, trailing whitespace characters are
     likely to not affect the size of the rectangle, though they will
     affect the x_advance and y_advance values.  

     Since  1.2

_V_a_l_u_e:

     A list containing the following elements: 

'extents': ['CairoTextExtents']  a 'CairoTextExtents' which to store
          the retrieved extents.

_A_u_t_h_o_r(_s):

     Derived by RGtkGen from GTK+ documentation

