pangoParseMarkup            package:RGtk2            R Documentation

_p_a_n_g_o_P_a_r_s_e_M_a_r_k_u_p

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

     Parses marked-up text (see markup format) to create a plain-text
     string and an attribute list.

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

     pangoParseMarkup(markup.text, accel.marker, .errwarn = TRUE)

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

'markup.text': [char]  markup to parse (see markup format)

'accel.marker': [numeric]  character that precedes an accelerator, or 0
          for none

.errwarn: Whether to issue a warning on error or fail silently

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

     If 'accel.marker' is nonzero, the given character will mark the
     character following it as an accelerator. For example,
     'accel.marker' might be an ampersand or underscore. All characters
     marked as an accelerator will receive a 'PANGO_UNDERLINE_LOW'
     attribute, and the first character so marked will be returned in
     'accel.char'. Two 'accel.marker' characters following each other
     produce a single literal 'accel.marker' character.

     If any error happens, none of the output arguments are touched
     except for 'error'.

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

     A list containing the following elements: 

  retval: [logical] 'FALSE' if 'error' is set, otherwise 'TRUE'

'attr.list': ['PangoAttrList']  return location for a 'PangoAttrList',
          or 'NULL'

  'text': [char]  return location for text with tags stripped, or
          'NULL'

'accel.char': [numeric]  return location for accelerator char, or
          'NULL'

 'error': ['GError']  return location for errors, or 'NULL'

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

     Derived by RGtkGen from GTK+ documentation

