pango-Text-Attributes         package:RGtk2         R Documentation

_T_e_x_t _A_t_t_r_i_b_u_t_e_s

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

     Font and other attributes for annotating text

_M_e_t_h_o_d_s _a_n_d _F_u_n_c_t_i_o_n_s:

     'pangoParseMarkup(markup.text, accel.marker, .errwarn = TRUE)'
      'pangoAttrTypeRegister(name)'
      'pangoAttributeInit(attr, klass)'
      'pangoAttributeCopy(object)'
      'pangoAttributeEqual(object, attr2)'
      'pangoAttrLanguageNew(language)'
      'pangoAttrFamilyNew(family)'
      'pangoAttrStyleNew(style)'
      'pangoAttrVariantNew(variant)'
      'pangoAttrStretchNew(stretch)'
      'pangoAttrWeightNew(weight)'
      'pangoAttrSizeNew(size)'
      'pangoAttrSizeNewAbsolute(size)'
      'pangoAttrFontDescNew(desc)'
      'pangoAttrForegroundNew(red, green, blue)'
      'pangoAttrBackgroundNew(red, green, blue)'
      'pangoAttrStrikethroughNew(strikethrough)'
      'pangoAttrStrikethroughColorNew(red, green, blue)'
      'pangoAttrUnderlineNew(underline)'
      'pangoAttrUnderlineColorNew(red, green, blue)'
      'pangoAttrShapeNew(ink.rect, logical.rect)'
      'pangoAttrShapeNewWithData(ink.rect, logical.rect, data)'
      'pangoAttrScaleNew(scale.factor)'
      'pangoAttrRiseNew(rise)'
      'pangoAttrLetterSpacingNew(letter.spacing)'
      'pangoAttrFallbackNew(fallback)'
      'pangoAttrGravityNew(gravity)'
      'pangoAttrGravityHintNew(hint)'
      'pangoColorParse(spec)'
      'pangoColorCopy(object)'
      'pangoColorFree(object)'
      'pangoColorToString(object)'
      'pangoLanguageFromString(language)'
      'pangoLanguageMatches(object, range.list)'
      'pangoAttrListNew()'
      'pangoAttrListCopy(object)'
      'pangoAttrListInsert(object, attr)'
      'pangoAttrListInsertBefore(object, attr)'
      'pangoAttrListChange(object, attr)'
      'pangoAttrListSplice(object, other, pos, len)'
      'pangoAttrListFilter(object, func, data)'
      'pangoAttrListGetIterator(object)'
      'pangoAttrIteratorCopy(object)'
      'pangoAttrIteratorNext(object)'
      'pangoAttrIteratorRange(object)'
      'pangoAttrIteratorGet(object, type)'
      'pangoAttrIteratorGetFont(object)'
      'pangoAttrIteratorGetAttrs(object)'

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

     Attributed text is used in a number of places in Pango. It is used
     as the input to the itemization process and also when creating a
     'PangoLayout'. The data types and functions in this section are
     used to represent and manipulate sets of attributes applied to a
     portion of text.

_S_t_r_u_c_t_u_r_e_s:


     '_P_a_n_g_o_A_t_t_r_C_l_a_s_s' The 'PangoAttrClass' structure stores the type
          and operations for a particular type of attribute. The
          functions in this structure should not be called directly.
          Instead, one should use the wrapper functions provided for
          'PangoAttribute'.

          '_t_y_p_e' ['PangoAttrType'] the type ID for this attribute


     '_P_a_n_g_o_A_t_t_r_i_b_u_t_e' The 'PangoAttribute' structure represents the
          common portions of all attributes. Particular types of
          attributes include this structure as their initial portion.
          The common portion of the attribute holds the range to which
          the value in the type-specific part of the attribute applies
          and should be initialized using 'pangoAttributeInit'. By
          default an attribute will have an all-inclusive range of
          [0,'G_MAXUINT'].

          '_k_l_a_s_s' ['PangoAttrClass'] the class structure holding
               information about the type of the attribute

          '_s_t_a_r_t_I_n_d_e_x' [numeric] the start index of the range (in
               bytes).

          '_e_n_d_I_n_d_e_x' [numeric] end index of the range (in bytes). The
               character at this index is not included in the range.


     '_P_a_n_g_o_A_t_t_r_S_t_r_i_n_g' The 'PangoAttrString' structure is used to
          represent attributes with a string value.

          '_v_a_l_u_e' [char] the common portion of the attribute


     '_P_a_n_g_o_A_t_t_r_L_a_n_g_u_a_g_e' The 'PangoAttrLanguage' structure is used to
          represent attributes that are languages.

          '_v_a_l_u_e' ['PangoLanguage'] the common portion of the attribute


     '_P_a_n_g_o_A_t_t_r_C_o_l_o_r' The 'PangoAttrColor' structure is used to
          represent attributes that are colors.

          '_c_o_l_o_r' ['PangoColor'] the common portion of the attribute


     '_P_a_n_g_o_A_t_t_r_I_n_t' The 'PangoAttrInt' structure is used to represent
          attributes with an integer or enumeration value.

          '_v_a_l_u_e' [integer] the common portion of the attribute


     '_P_a_n_g_o_A_t_t_r_F_l_o_a_t' The 'PangoAttrFloat' structure is used to
          represent attributes with a float or double value.

          '_v_a_l_u_e' [numeric] the common portion of the attribute


     '_P_a_n_g_o_A_t_t_r_F_o_n_t_D_e_s_c' The 'PangoAttrFontDesc' structure is used to
          store an attribute that sets all aspects of the font
          description at once.

          '_d_e_s_c' ['PangoFontDescription'] the common portion of the
               attribute


     '_P_a_n_g_o_A_t_t_r_S_h_a_p_e' The 'PangoAttrShape' structure is used to
          represent attributes which  impose shape restrictions.

          '_i_n_k_R_e_c_t' ['PangoRectangle'] the common portion of the
               attribute

          '_l_o_g_i_c_a_l_R_e_c_t' ['PangoRectangle'] the ink rectangle to
               restrict to


     '_P_a_n_g_o_A_t_t_r_S_i_z_e' The 'PangoAttrShape' structure is used to
          represent attributes which set font size.

          '_s_i_z_e' [integer] the common portion of the attribute

          '_a_b_s_o_l_u_t_e' [numeric] size of font, in units of
               1/'PANGO_SCALE' of a point (for 'PANGO_ATTR_SIZE') or of
               a device uni (for 'PANGO_ATTR_ABSOLUTE_SIZE')


     '_P_a_n_g_o_C_o_l_o_r' The 'PangoColor' structure is used to represent a
          color in an uncalibrated RGB color-space.

          '_r_e_d' [integer] The red component of the color. This is a
               value between 0 and 65535,  with 65535 indicating full
               intensity.

          '_g_r_e_e_n' [integer] The green component of the color. This is a
               value between 0 and 65535,  with 65535 indicating full
               intensity.

          '_b_l_u_e' [integer] The blue component of the color. This is a
               value between 0 and 65535,  with 65535 indicating full
               intensity.


     '_P_a_n_g_o_L_a_n_g_u_a_g_e' The 'PangoLanguage' structure is used to represent
          a language. 'PangoLanguage' pointers can be efficiently 
          copied and compared with each other.


     '_P_a_n_g_o_A_t_t_r_L_i_s_t' The 'PangoAttrList' structure represents a list of
          attributes that apply to a section of text. The attributes
          are, in general, allowed to overlap in an arbitrary fashion,
          however, if the attributes are manipulated only through
          'pangoAttrListChange', the overlap between properties will
          meet stricter criteria.

          Since the 'PangoAttrList' structure is stored as a linear
          list, it is not suitable for storing attributes for large
          amounts of text. In general, you should not use a single
          'PangoAttrList' for more than one paragraph of text.


     '_P_a_n_g_o_A_t_t_r_I_t_e_r_a_t_o_r' The 'PangoAttrIterator' structure is used to
          represent an iterator through a 'PangoAttrList'. A new
          iterator is created with 'pangoAttrListGetIterator'. Once the
          iterator is created, it can be advanced through the style
          changes in the text using 'pangoAttrIteratorNext'. At each
          style change, the range of the current style segment and the
          attributes currently in effect can be queried.


_E_n_u_m_s _a_n_d _F_l_a_g_s:


     '_P_a_n_g_o_A_t_t_r_T_y_p_e' The 'PangoAttrType' distinguishes between
          different types of attributes. Along with the predefined
          values, it is possible to allocate additional values for
          custom attributes using 'pangoAttrTypeRegister'. The
          predefined values are given below. The type of structure used
          to store the attribute is listed in parentheses after the
          description.

          '_i_n_v_a_l_i_d' does not happen

          '_l_a_n_g_u_a_g_e' language ('PangoAttrLanguage')

          '_f_a_m_i_l_y' font family name list ('PangoAttrString')

          '_s_t_y_l_e' font slant style ('PangoAttrInt')

          '_w_e_i_g_h_t' font weight ('PangoAttrInt')

          '_v_a_r_i_a_n_t' font variant (normal or small caps)
               ('PangoAttrInt')

          '_s_t_r_e_t_c_h' font stretch ('PangoAttrInt')

          '_s_i_z_e' font size in points scaled by 'PANGO_SCALE'
               ('PangoAttrInt')

          '_f_o_n_t-_d_e_s_c' font description ('PangoAttrFontDesc')

          '_f_o_r_e_g_r_o_u_n_d' foreground color ('PangoAttrColor')

          '_b_a_c_k_g_r_o_u_n_d' background color ('PangoAttrColor')

          '_u_n_d_e_r_l_i_n_e' whether the text has an underline
               ('PangoAttrInt')

          '_s_t_r_i_k_e_t_h_r_o_u_g_h' whether the text is struck-through
               ('PangoAttrInt')

          '_r_i_s_e' baseline displacement ('PangoAttrInt')

          '_s_h_a_p_e' shape ('PangoAttrShape')

          '_s_c_a_l_e' font size scale factor ('PangoAttrFloat')

          '_f_a_l_l_b_a_c_k' whether fallback is enabled ('PangoAttrInt')

          '_l_e_t_t_e_r-_s_p_a_c_i_n_g' letter spacing ('PangoAttrInt')

          '_u_n_d_e_r_l_i_n_e-_c_o_l_o_r' underline color ('PangoAttrColor')

          '_s_t_r_i_k_e_t_h_r_o_u_g_h-_c_o_l_o_r' strikethrough color ('PangoAttrColor')

          '_a_b_s_o_l_u_t_e-_s_i_z_e' font size in pixels scaled by 'PANGO_SCALE'
               ('PangoAttrInt')

          '_g_r_a_v_i_t_y' base text gravity ('PangoAttrInt')

          '_g_r_a_v_i_t_y-_h_i_n_t' gravity hint ('PangoAttrInt')


     '_P_a_n_g_o_U_n_d_e_r_l_i_n_e' the 'PangoUnderline' enumeration is used to
          specify whether text should be underlined, and if so, the
          type of underlining.

          '_n_o_n_e' no underline should be drawn

          '_s_i_n_g_l_e' a single underline should be drawn

          '_d_o_u_b_l_e' a double underline should be drawn

          '_l_o_w' a single underline should be drawn at a position
               beneath the ink extents of the text being underlined.
               This should be used only for underlining single
               characters, such as for keyboard accelerators.
               'PANGO_UNDERLINE_SINGLE' should be used for extended
               portions of text.


_U_s_e_r _F_u_n_c_t_i_o_n_s:


     '_P_a_n_g_o_A_t_t_r_D_a_t_a_C_o_p_y_F_u_n_c(_d_a_t_a)' A copy function passed to attribute
          new functions that take user data.

          '_d_a_t_a' [R object] the user data

          _Returns:_ [R object] a new copy of 'data'.


     '_P_a_n_g_o_A_t_t_r_F_i_l_t_e_r_F_u_n_c(_a_t_t_r_i_b_u_t_e, _d_a_t_a)' A predicate function used
          by 'pangoAttrListFilter' to filter out a subset of attributes
          for a list.

          '_a_t_t_r_i_b_u_t_e' ['PangoAttribute'] a 'PangoAttribute'

          '_d_a_t_a' [R object] callback data passed to
               'pangoAttrListFilter'

          _Returns:_ [logical] 'TRUE' if the attribute should be
          filtered out


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

     Derived by RGtkGen from GTK+ documentation

_R_e_f_e_r_e_n_c_e_s:

     <URL:
     http://developer.gnome.org/doc/API/2.0/pango/pango-Text-Attributes.html>

