GtkTextTag               package:RGtk2               R Documentation

_G_t_k_T_e_x_t_T_a_g

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

     A tag that can be applied to text in a GtkTextBuffer

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

     'gtkTextTagNew(name = NULL)'
      'gtkTextTagGetPriority(object)'
      'gtkTextTagSetPriority(object, priority)'
      'gtkTextTagEvent(object, event.object, event, iter)'
      'gtkTextAttributesNew()'
      'gtkTextAttributesCopy(object)'
      'gtkTextAttributesCopyValues(object, dest)'
      'gtkTextTag(name = NULL)'

_H_i_e_r_a_r_c_h_y:

     GObject
        +----GtkTextTag 

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

     You may wish to begin by reading the text widget conceptual
     overview which gives an overview of all the objects and data types
     related to the text widget and how they work together.

     Tags should be in the 'GtkTextTagTable' for a given
     'GtkTextBuffer' before using them with that buffer.
     'gtkTextBufferCreateTag' is the best way to create tags. See
     'gtk-demo' for numerous examples.

     The "invisible" property was not implemented for GTK+ 2.0; it's
     planned to be implemented in future releases.

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


     '_G_t_k_T_e_x_t_T_a_g' _undocumented _


     '_G_t_k_T_e_x_t_A_t_t_r_i_b_u_t_e_s' Using 'GtkTextAttributes' directly should
          rarely be necessary. It's primarily useful with
          'gtkTextIterGetAttributes'. As with most GTK+ structs, the
          fields in this struct should only be read, never modified
          directly.

          '_a_p_p_e_a_r_a_n_c_e' ['GtkTextAppearance'] pointer to sub-struct
               containing certain attributes

          '_j_u_s_t_i_f_i_c_a_t_i_o_n' ['GtkJustification'] 

          '_d_i_r_e_c_t_i_o_n' ['GtkTextDirection'] 

          '_f_o_n_t' ['PangoFontDescription'] 

          '_f_o_n_t_S_c_a_l_e' [numeric] 

          '_l_e_f_t_M_a_r_g_i_n' [integer] 

          '_i_n_d_e_n_t' [integer] 

          '_r_i_g_h_t_M_a_r_g_i_n' [integer] 

          '_p_i_x_e_l_s_A_b_o_v_e_L_i_n_e_s' [integer] 

          '_p_i_x_e_l_s_B_e_l_o_w_L_i_n_e_s' [integer] 

          '_p_i_x_e_l_s_I_n_s_i_d_e_W_r_a_p' [integer] 

          '_t_a_b_s' ['PangoTabArray'] 

          '_w_r_a_p_M_o_d_e' ['GtkWrapMode'] 

          '_l_a_n_g_u_a_g_e' ['PangoLanguage'] 

          '_i_n_v_i_s_i_b_l_e' [numeric] 

          '_b_g_F_u_l_l_H_e_i_g_h_t' [numeric] 

          '_e_d_i_t_a_b_l_e' [numeric] 

          '_r_e_a_l_i_z_e_d' [numeric] 


     '_G_t_k_T_e_x_t_A_p_p_e_a_r_a_n_c_e' _undocumented _

          '_b_g_C_o_l_o_r' ['GdkColor'] 

          '_f_g_C_o_l_o_r' ['GdkColor'] 

          '_b_g_S_t_i_p_p_l_e' ['GdkBitmap'] 

          '_f_g_S_t_i_p_p_l_e' ['GdkBitmap'] 

          '_r_i_s_e' [integer] 

          '_u_n_d_e_r_l_i_n_e' [numeric] 

          '_s_t_r_i_k_e_t_h_r_o_u_g_h' [numeric] 

          '_d_r_a_w_B_g' [numeric] 


_C_o_n_v_e_n_i_e_n_t _C_o_n_s_t_r_u_c_t_i_o_n:

     'gtkTextTag' is the equivalent of 'gtkTextTagNew'.

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


     '_G_t_k_W_r_a_p_M_o_d_e' Describes a type of line wrapping.

          '_n_o_n_e' do not wrap lines; just make the text area wider

          '_c_h_a_r' wrap text, breaking lines anywhere the cursor can
               appear (between characters, usually - if you want to be
               technical, between graphemes, see 'pangoGetLogAttrs')

          '_w_o_r_d' wrap text, breaking lines in between words

          '_w_o_r_d__c_h_a_r' wrap text, breaking lines in between words, or if
                that is not enough, also between graphemes.


_S_i_g_n_a_l_s:


     '_e_v_e_n_t(_t_a_g, _o_b_j_e_c_t, _e_v_e_n_t, _i_t_e_r, _u_s_e_r._d_a_t_a)' The ::event signal is
          emitted when an event occurs on a region of the buffer marked
          with this tag.  

          '_t_a_g' ['GtkTextTag']  the 'GtkTextTag' on which the signal is
               emitted

          '_o_b_j_e_c_t' ['GObject']  the object the event was fired from
               (typically a 'GtkTextView')

          '_e_v_e_n_t' ['GdkEvent']  the event which triggered the signal

          '_i_t_e_r' ['GtkTextIter']  a 'GtkTextIter' pointing at the
               location the event occured

          '_u_s_e_r._d_a_t_a' [R object] user data set when the signal handler
               was connected.

          _Returns:_ [logical] 'TRUE' to stop other handlers from being
          invoked for the event. 'FALSE' to propagate the event
          further.


_P_r_o_p_e_r_t_i_e_s:


     '_a_c_c_u_m_u_l_a_t_i_v_e-_m_a_r_g_i_n' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Whether the margins
          accumulate or override each other.

          When set to 'TRUE' the margins of this tag are added to the
          margins  of any other non-accumulative margins present. When
          set to 'FALSE'  the margins override one another (the
          default).  

          Default value: FALSE  Since  2.12


     '_b_a_c_k_g_r_o_u_n_d' [_c_h_a_r_a_c_t_e_r : _W_r_i_t_e] Background color as a string. 
          Default value: NULL


     '_b_a_c_k_g_r_o_u_n_d-_f_u_l_l-_h_e_i_g_h_t' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Whether the
          background color fills the entire line height or only the
          height of the tagged characters.  Default value: FALSE


     '_b_a_c_k_g_r_o_u_n_d-_f_u_l_l-_h_e_i_g_h_t-_s_e_t' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Whether this
          tag affects background height.  Default value: FALSE


     '_b_a_c_k_g_r_o_u_n_d-_g_d_k' ['_G_d_k_C_o_l_o_r' : _R_e_a_d / _W_r_i_t_e] Background color as a
          (possibly unallocated) GdkColor.


     '_b_a_c_k_g_r_o_u_n_d-_s_e_t' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Whether this tag affects
          the background color.  Default value: FALSE


     '_b_a_c_k_g_r_o_u_n_d-_s_t_i_p_p_l_e' ['_G_d_k_P_i_x_m_a_p' : _R_e_a_d / _W_r_i_t_e] Bitmap to use as
          a mask when drawing the text background.


     '_b_a_c_k_g_r_o_u_n_d-_s_t_i_p_p_l_e-_s_e_t' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Whether this tag
          affects the background stipple.  Default value: FALSE


     '_d_i_r_e_c_t_i_o_n' ['_G_t_k_T_e_x_t_D_i_r_e_c_t_i_o_n' : _R_e_a_d / _W_r_i_t_e] Text direction,
          e.g. right-to-left or left-to-right.  Default value:
          GTK_TEXT_DIR_NONE


     '_e_d_i_t_a_b_l_e' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Whether the text can be
          modified by the user.  Default value: TRUE


     '_e_d_i_t_a_b_l_e-_s_e_t' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Whether this tag affects
          text editability.  Default value: FALSE


     '_f_a_m_i_l_y' [_c_h_a_r_a_c_t_e_r : _R_e_a_d / _W_r_i_t_e] Name of the font family, e.g.
          Sans, Helvetica, Times, Monospace.  Default value: NULL


     '_f_a_m_i_l_y-_s_e_t' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Whether this tag affects the
          font family.  Default value: FALSE


     '_f_o_n_t' [_c_h_a_r_a_c_t_e_r : _R_e_a_d / _W_r_i_t_e] Font description as string, e.g.
          \"Sans Italic 12\". 

          Note that the initial value of this property depends on the
          internals of 'PangoFontDescription'.  

          Default value: NULL


     '_f_o_n_t-_d_e_s_c' ['_P_a_n_g_o_F_o_n_t_D_e_s_c_r_i_p_t_i_o_n' : _R_e_a_d / _W_r_i_t_e] Font
          description as a PangoFontDescription struct.


     '_f_o_r_e_g_r_o_u_n_d' [_c_h_a_r_a_c_t_e_r : _W_r_i_t_e] Foreground color as a string. 
          Default value: NULL


     '_f_o_r_e_g_r_o_u_n_d-_g_d_k' ['_G_d_k_C_o_l_o_r' : _R_e_a_d / _W_r_i_t_e] Foreground color as a
          (possibly unallocated) GdkColor.


     '_f_o_r_e_g_r_o_u_n_d-_s_e_t' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Whether this tag affects
          the foreground color.  Default value: FALSE


     '_f_o_r_e_g_r_o_u_n_d-_s_t_i_p_p_l_e' ['_G_d_k_P_i_x_m_a_p' : _R_e_a_d / _W_r_i_t_e] Bitmap to use as
          a mask when drawing the text foreground.


     '_f_o_r_e_g_r_o_u_n_d-_s_t_i_p_p_l_e-_s_e_t' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Whether this tag
          affects the foreground stipple.  Default value: FALSE


     '_i_n_d_e_n_t' [_i_n_t_e_g_e_r : _R_e_a_d / _W_r_i_t_e] Amount to indent the paragraph,
          in pixels.  Default value: 0


     '_i_n_d_e_n_t-_s_e_t' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Whether this tag affects
          indentation.  Default value: FALSE


     '_i_n_v_i_s_i_b_l_e' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Whether this text is hidden.

          Note that there may still be problems with the support for
          invisible  text, in particular when navigating
          programmatically inside a buffer containing invisible
          segments.  

          Default value: FALSE  Since  2.8


     '_i_n_v_i_s_i_b_l_e-_s_e_t' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Whether this tag affects
          text visibility.  Default value: FALSE


     '_j_u_s_t_i_f_i_c_a_t_i_o_n' ['_G_t_k_J_u_s_t_i_f_i_c_a_t_i_o_n' : _R_e_a_d / _W_r_i_t_e] Left, right,
          or center justification.  Default value: GTK_JUSTIFY_LEFT


     '_j_u_s_t_i_f_i_c_a_t_i_o_n-_s_e_t' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Whether this tag
          affects paragraph justification.  Default value: FALSE


     '_l_a_n_g_u_a_g_e' [_c_h_a_r_a_c_t_e_r : _R_e_a_d / _W_r_i_t_e] The language this text is
          in, as an ISO code. Pango can use this as a  hint when
          rendering the text. If not set, an appropriate default will
          be  used.

          Note that the initial value of this property depends on the
          current locale, see also 'gtkGetDefaultLanguage'.  

          Default value: NULL


     '_l_a_n_g_u_a_g_e-_s_e_t' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Whether this tag affects
          the language the text is rendered as.  Default value: FALSE


     '_l_e_f_t-_m_a_r_g_i_n' [_i_n_t_e_g_e_r : _R_e_a_d / _W_r_i_t_e] Width of the left margin in
          pixels.  Allowed values: >= 0  Default value: 0


     '_l_e_f_t-_m_a_r_g_i_n-_s_e_t' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Whether this tag
          affects the left margin.  Default value: FALSE


     '_n_a_m_e' [_c_h_a_r_a_c_t_e_r : _R_e_a_d / _W_r_i_t_e / _C_o_n_s_t_r_u_c_t _O_n_l_y] Name used to
          refer to the text tag. NULL for anonymous tags.  Default
          value: NULL


     '_p_a_r_a_g_r_a_p_h-_b_a_c_k_g_r_o_u_n_d' [_c_h_a_r_a_c_t_e_r : _W_r_i_t_e] The paragraph
          background color as a string.  

          Default value: NULL  Since  2.8


     '_p_a_r_a_g_r_a_p_h-_b_a_c_k_g_r_o_u_n_d-_g_d_k' ['_G_d_k_C_o_l_o_r' : _R_e_a_d / _W_r_i_t_e] The
          paragraph background color as a as a (possibly unallocated) 
          'GdkColor'.  

          Since  2.8


     '_p_a_r_a_g_r_a_p_h-_b_a_c_k_g_r_o_u_n_d-_s_e_t' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Whether this
          tag affects the paragraph background color.  Default value:
          FALSE


     '_p_i_x_e_l_s-_a_b_o_v_e-_l_i_n_e_s' [_i_n_t_e_g_e_r : _R_e_a_d / _W_r_i_t_e] Pixels of blank
          space above paragraphs.  Allowed values: >= 0  Default value:
          0


     '_p_i_x_e_l_s-_a_b_o_v_e-_l_i_n_e_s-_s_e_t' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Whether this tag
          affects the number of pixels above lines.  Default value:
          FALSE


     '_p_i_x_e_l_s-_b_e_l_o_w-_l_i_n_e_s' [_i_n_t_e_g_e_r : _R_e_a_d / _W_r_i_t_e] Pixels of blank
          space below paragraphs.  Allowed values: >= 0  Default value:
          0


     '_p_i_x_e_l_s-_b_e_l_o_w-_l_i_n_e_s-_s_e_t' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Whether this tag
          affects the number of pixels above lines.  Default value:
          FALSE


     '_p_i_x_e_l_s-_i_n_s_i_d_e-_w_r_a_p' [_i_n_t_e_g_e_r : _R_e_a_d / _W_r_i_t_e] Pixels of blank
          space between wrapped lines in a paragraph.  Allowed values:
          >= 0  Default value: 0


     '_p_i_x_e_l_s-_i_n_s_i_d_e-_w_r_a_p-_s_e_t' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Whether this tag
          affects the number of pixels between wrapped lines.  Default
          value: FALSE


     '_r_i_g_h_t-_m_a_r_g_i_n' [_i_n_t_e_g_e_r : _R_e_a_d / _W_r_i_t_e] Width of the right margin
          in pixels.  Allowed values: >= 0  Default value: 0


     '_r_i_g_h_t-_m_a_r_g_i_n-_s_e_t' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Whether this tag
          affects the right margin.  Default value: FALSE


     '_r_i_s_e' [_i_n_t_e_g_e_r : _R_e_a_d / _W_r_i_t_e] Offset of text above the baseline
          (below the baseline if rise is negative) in Pango units. 
          Default value: 0


     '_r_i_s_e-_s_e_t' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Whether this tag affects the
          rise.  Default value: FALSE


     '_s_c_a_l_e' [_n_u_m_e_r_i_c : _R_e_a_d / _W_r_i_t_e] Font size as a scale factor
          relative to the default font size. This properly adapts to
          theme changes etc. so is recommended. Pango predefines some
          scales such as PANGO_SCALE_X_LARGE.  Allowed values: >= 0 
          Default value: 1


     '_s_c_a_l_e-_s_e_t' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Whether this tag scales the
          font size by a factor.  Default value: FALSE


     '_s_i_z_e' [_i_n_t_e_g_e_r : _R_e_a_d / _W_r_i_t_e] Font size in Pango units.  Allowed
          values: >= 0  Default value: 0


     '_s_i_z_e-_p_o_i_n_t_s' [_n_u_m_e_r_i_c : _R_e_a_d / _W_r_i_t_e] Font size in points. 
          Allowed values: >= 0  Default value: 0


     '_s_i_z_e-_s_e_t' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Whether this tag affects the
          font size.  Default value: FALSE


     '_s_t_r_e_t_c_h' ['_P_a_n_g_o_S_t_r_e_t_c_h' : _R_e_a_d / _W_r_i_t_e] Font stretch as a
          PangoStretch, e.g. PANGO_STRETCH_CONDENSED.  Default value:
          PANGO_STRETCH_NORMAL


     '_s_t_r_e_t_c_h-_s_e_t' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Whether this tag affects
          the font stretch.  Default value: FALSE


     '_s_t_r_i_k_e_t_h_r_o_u_g_h' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Whether to strike through
          the text.  Default value: FALSE


     '_s_t_r_i_k_e_t_h_r_o_u_g_h-_s_e_t' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Whether this tag
          affects strikethrough.  Default value: FALSE


     '_s_t_y_l_e' ['_P_a_n_g_o_S_t_y_l_e' : _R_e_a_d / _W_r_i_t_e] Font style as a PangoStyle,
          e.g. PANGO_STYLE_ITALIC.  Default value: PANGO_STYLE_NORMAL


     '_s_t_y_l_e-_s_e_t' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Whether this tag affects the
          font style.  Default value: FALSE


     '_t_a_b_s' ['_P_a_n_g_o_T_a_b_A_r_r_a_y' : _R_e_a_d / _W_r_i_t_e] Custom tabs for this text.


     '_t_a_b_s-_s_e_t' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Whether this tag affects tabs.
           Default value: FALSE


     '_u_n_d_e_r_l_i_n_e' ['_P_a_n_g_o_U_n_d_e_r_l_i_n_e' : _R_e_a_d / _W_r_i_t_e] Style of underline
          for this text.  Default value: PANGO_UNDERLINE_NONE


     '_u_n_d_e_r_l_i_n_e-_s_e_t' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Whether this tag affects
          underlining.  Default value: FALSE


     '_v_a_r_i_a_n_t' ['_P_a_n_g_o_V_a_r_i_a_n_t' : _R_e_a_d / _W_r_i_t_e] Font variant as a
          PangoVariant, e.g. PANGO_VARIANT_SMALL_CAPS.  Default value:
          PANGO_VARIANT_NORMAL


     '_v_a_r_i_a_n_t-_s_e_t' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Whether this tag affects
          the font variant.  Default value: FALSE


     '_w_e_i_g_h_t' [_i_n_t_e_g_e_r : _R_e_a_d / _W_r_i_t_e] Font weight as an integer, see
          predefined values in PangoWeight; for example,
          PANGO_WEIGHT_BOLD.  Allowed values: >= 0  Default value: 400


     '_w_e_i_g_h_t-_s_e_t' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Whether this tag affects the
          font weight.  Default value: FALSE


     '_w_r_a_p-_m_o_d_e' ['_G_t_k_W_r_a_p_M_o_d_e' : _R_e_a_d / _W_r_i_t_e] Whether to wrap lines
          never, at word boundaries, or at character boundaries. 
          Default value: GTK_WRAP_NONE


     '_w_r_a_p-_m_o_d_e-_s_e_t' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Whether this tag affects
          line wrap mode.  Default value: FALSE


_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/gtk/GtkTextTag.html>

