GtkTextBuffer             package:RGtk2             R Documentation

_G_t_k_T_e_x_t_B_u_f_f_e_r

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

     Stores attributed text for display in a GtkTextView

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

     'gtkTextBufferNew(table = NULL)'
      'gtkTextBufferGetLineCount(object)'
      'gtkTextBufferGetCharCount(object)'
      'gtkTextBufferGetTagTable(object)'
      'gtkTextBufferInsert(object, iter, text, len = -1)'
      'gtkTextBufferInsertAtCursor(object, text, len = -1)'
      'gtkTextBufferInsertInteractive(object, iter, text,
     default.editable)'
      'gtkTextBufferInsertInteractiveAtCursor(object, text,
     default.editable)'
      'gtkTextBufferInsertRange(object, iter, start, end)'
      'gtkTextBufferInsertRangeInteractive(object, iter, start, end,
     default.editable)'
      'gtkTextBufferInsertWithTags(object, iter, text, ...)'
      'gtkTextBufferInsertWithTagsByName(object, iter, text, ...)'
      'gtkTextBufferDelete(object, start, end)'
      'gtkTextBufferDeleteInteractive(object, start.iter, end.iter,
     default.editable)'
      'gtkTextBufferBackspace(object, iter, interactive,
     default.editable)'
      'gtkTextBufferSetText(object, text, len = -1)'
      'gtkTextBufferGetText(object, start, end, include.hidden.chars =
     TRUE)'
      'gtkTextBufferGetSlice(object, start, end, include.hidden.chars =
     TRUE)'
      'gtkTextBufferInsertPixbuf(object, iter, pixbuf)'
      'gtkTextBufferInsertChildAnchor(object, iter, anchor)'
      'gtkTextBufferCreateChildAnchor(object, iter)'
      'gtkTextBufferCreateMark(object, mark.name = NULL, where,
     left.gravity = FALSE)'
      'gtkTextBufferMoveMark(object, mark, where)'
      'gtkTextBufferMoveMarkByName(object, name, where)'
      'gtkTextBufferAddMark(object, mark, where)'
      'gtkTextBufferDeleteMark(object, mark)'
      'gtkTextBufferDeleteMarkByName(object, name)'
      'gtkTextBufferGetMark(object, name)'
      'gtkTextBufferGetInsert(object)'
      'gtkTextBufferGetSelectionBound(object)'
      'gtkTextBufferGetHasSelection(object)'
      'gtkTextBufferPlaceCursor(object, where)'
      'gtkTextBufferSelectRange(object, ins, bound)'
      'gtkTextBufferApplyTag(object, tag, start, end)'
      'gtkTextBufferRemoveTag(object, tag, start, end)'
      'gtkTextBufferApplyTagByName(object, name, start, end)'
      'gtkTextBufferRemoveTagByName(object, name, start, end)'
      'gtkTextBufferRemoveAllTags(object, start, end)'
      'gtkTextBufferCreateTag(object, tag.name, ...)'
      'gtkTextBufferGetIterAtLineOffset(object, line.number,
     char.offset)'
      'gtkTextBufferGetIterAtOffset(object, char.offset)'
      'gtkTextBufferGetIterAtLine(object, line.number)'
      'gtkTextBufferGetIterAtLineIndex(object, line.number,
     byte.index)'
      'gtkTextBufferGetIterAtMark(object, mark)'
      'gtkTextBufferGetIterAtChildAnchor(object, anchor)'
      'gtkTextBufferGetStartIter(object)'
      'gtkTextBufferGetEndIter(object)'
      'gtkTextBufferGetBounds(object)'
      'gtkTextBufferGetModified(object)'
      'gtkTextBufferSetModified(object, setting)'
      'gtkTextBufferDeleteSelection(object, interactive,
     default.editable)'
      'gtkTextBufferPasteClipboard(object, clipboard, override.location
     = NULL, default.editable)'
      'gtkTextBufferCopyClipboard(object, clipboard)'
      'gtkTextBufferCutClipboard(object, clipboard, default.editable)'
      'gtkTextBufferGetSelectionBounds(object)'
      'gtkTextBufferBeginUserAction(object)'
      'gtkTextBufferEndUserAction(object)'
      'gtkTextBufferAddSelectionClipboard(object, clipboard)'
      'gtkTextBufferRemoveSelectionClipboard(object, clipboard)'
      'gtkTextBufferDeserialize(object, content.buffer, format, iter,
     data, .errwarn = TRUE)'
      'gtkTextBufferDeserializeGetCanCreateTags(object, format)'
      'gtkTextBufferDeserializeSetCanCreateTags(object, format,
     can.create.tags)'
      'gtkTextBufferGetCopyTargetList(object)'
      'gtkTextBufferGetDeserializeFormats(object)'
      'gtkTextBufferGetPasteTargetList(object)'
      'gtkTextBufferGetSerializeFormats(object)'
      'gtkTextBufferRegisterDeserializeFormat(object, mime.type, fun,
     user.data)'
      'gtkTextBufferRegisterDeserializeTagset(object, tagset.name =
     NULL)'
      'gtkTextBufferRegisterSerializeFormat(object, mime.type, fun,
     user.data)'
      'gtkTextBufferRegisterSerializeTagset(object, tagset.name =
     NULL)'
      'gtkTextBufferSerialize(object, content.buffer, format, start,
     end)'
      'gtkTextBufferUnregisterDeserializeFormat(object, format)'
      'gtkTextBufferUnregisterSerializeFormat(object, format)'
      'gtkTextBuffer(table = NULL)'

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

     GObject
        +----GtkTextBuffer 

_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.

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


     '_G_t_k_T_e_x_t_B_u_f_f_e_r' _undocumented _

          '_t_a_g_T_a_b_l_e' ['GtkTextTagTable'] 


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

     'gtkTextBuffer' is the equivalent of 'gtkTextBufferNew'.

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


     '_G_t_k_T_e_x_t_B_u_f_f_e_r_T_a_r_g_e_t_I_n_f_o' _undocumented _

          '_b_u_f_f_e_r-_c_o_n_t_e_n_t_s' _undocumented _

          '_r_i_c_h-_t_e_x_t' _undocumented _

          '_t_e_x_t' _undocumented _


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


     '_G_t_k_T_e_x_t_B_u_f_f_e_r_D_e_s_e_r_i_a_l_i_z_e_F_u_n_c(_r_e_g_i_s_t_e_r._b_u_f_f_e_r, _c_o_n_t_e_n_t._b_u_f_f_e_r, _i_t_e_r, _d_a_t_a, _l_e_n_g_t_h, _c_r_e_a_t_e._t_a_g_s, _u_s_e_r._d_a_t_a, _e_r_r_o_r)' 
          A function that is called to deserialize rich text that has
          been serialized with 'gtkTextBufferSerialize', and insert it
          at 'iter'.

          '_r_e_g_i_s_t_e_r._b_u_f_f_e_r' ['GtkTextBuffer'] the 'GtkTextBuffer' the
               format is registered with

          '_c_o_n_t_e_n_t._b_u_f_f_e_r' ['GtkTextBuffer'] the 'GtkTextBuffer' to
               deserialize into

          '_i_t_e_r' ['GtkTextIter'] insertion point for the deserialized
               text

          '_d_a_t_a' [raw] data to deserialize

          '_l_e_n_g_t_h' [numeric] length of 'data'

          '_c_r_e_a_t_e._t_a_g_s' [logical] 'TRUE' if deserializing may create
               tags

          '_u_s_e_r._d_a_t_a' [R object] user data that was specified when
               registering the format

          '_e_r_r_o_r' ['GError'] return location for a 'GError'

          _Returns:_ [logical] 'TRUE' on success, 'FALSE' otherwise


     '_G_t_k_T_e_x_t_B_u_f_f_e_r_S_e_r_i_a_l_i_z_e_F_u_n_c(_r_e_g_i_s_t_e_r._b_u_f_f_e_r, _c_o_n_t_e_n_t._b_u_f_f_e_r, _s_t_a_r_t, _e_n_d, _l_e_n_g_t_h, _u_s_e_r._d_a_t_a)' 
          A function that is called to serialize the content of a text
          buffer. It must return the serialized form of the content.

          '_r_e_g_i_s_t_e_r._b_u_f_f_e_r' ['GtkTextBuffer'] the 'GtkTextBuffer' for
               which the format is registered

          '_c_o_n_t_e_n_t._b_u_f_f_e_r' ['GtkTextBuffer'] the 'GtkTextsBuffer' to
               serialize

          '_s_t_a_r_t' ['GtkTextIter'] start of the block of text to
               serialize

          '_e_n_d' ['GtkTextIter'] end of the block of text to serialize

          '_l_e_n_g_t_h' [numeric] Return location for the length of the
               serialized data

          '_u_s_e_r._d_a_t_a' [R object] user data that was specified when
               registering the format

          _Returns:_ [raw] a newly-allocated list of guint8 which
          contains the serialized data, or 'NULL' if an error occurred


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


     '_a_p_p_l_y-_t_a_g(_t_e_x_t_b_u_f_f_e_r, _t_a_g, _s_t_a_r_t, _e_n_d, _u_s_e_r._d_a_t_a)' The apply_tag
          signal is emitted to apply a tag to a range of text in a
          'GtkTextBuffer'.  Applying actually occurs in the default
          handler.

          Note that if your handler runs before the default handler it
          must not  invalidate the 'start' and 'end' iters (or has to
          revalidate them). 

          See also:  'gtkTextBufferApplyTag',
          'gtkTextBufferInsertWithTags', 'gtkTextBufferInsertRange'.  

          '_t_e_x_t_b_u_f_f_e_r' ['GtkTextBuffer']  the object which received the
               signal

          '_t_a_g' ['GtkTextTag']  the applied tag

          '_s_t_a_r_t' ['GtkTextIter']  the start of the range the tag is
               applied to

          '_e_n_d' ['GtkTextIter']  the end of the range the tag is
               applied to

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


     '_b_e_g_i_n-_u_s_e_r-_a_c_t_i_o_n(_t_e_x_t_b_u_f_f_e_r, _u_s_e_r._d_a_t_a)' The begin_user_action
          signal is emitted at the beginning of a single user-visible
          operation on a 'GtkTextBuffer'.

          See also:  'gtkTextBufferBeginUserAction',
          'gtkTextBufferInsertInteractive',
          'gtkTextBufferInsertRangeInteractive',
          'gtkTextBufferDeleteInteractive', 'gtkTextBufferBackspace',
          'gtkTextBufferDeleteSelection'.  

          '_t_e_x_t_b_u_f_f_e_r' ['GtkTextBuffer']  the object which received the
               signal

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


     '_c_h_a_n_g_e_d(_t_e_x_t_b_u_f_f_e_r, _u_s_e_r._d_a_t_a)' The changed signal is emitted
          when the content of a 'GtkTextBuffer'  has changed.  

          '_t_e_x_t_b_u_f_f_e_r' ['GtkTextBuffer']  the object which received the
               signal

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


     '_d_e_l_e_t_e-_r_a_n_g_e(_t_e_x_t_b_u_f_f_e_r, _s_t_a_r_t, _e_n_d, _u_s_e_r._d_a_t_a)' The delete_range
          signal is emitted to delete a range  from a 'GtkTextBuffer'. 

          Note that if your handler runs before the default handler it
          must not  invalidate the 'start' and 'end' iters (or has to
          revalidate them).  The default signal handler revalidates the
          'start' and 'end' iters to  both point point to the location
          where text was deleted. Handlers which run after the default
          handler (see 'gSignalConnectAfter()') do not have access to
          the deleted text.

          See also: 'gtkTextBufferDelete'.  

          '_t_e_x_t_b_u_f_f_e_r' ['GtkTextBuffer']  the object which received the
               signal

          '_s_t_a_r_t' ['GtkTextIter']  the start of the range to be deleted

          '_e_n_d' ['GtkTextIter']  the end of the range to be deleted

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


     '_e_n_d-_u_s_e_r-_a_c_t_i_o_n(_t_e_x_t_b_u_f_f_e_r, _u_s_e_r._d_a_t_a)' The end_user_action
          signal is emitted at the end of a single user-visible
          operation 'GtkTextBuffer'.

          See also:  'gtkTextBufferEndUserAction',
          'gtkTextBufferInsertInteractive',
          'gtkTextBufferInsertRangeInteractive',
          'gtkTextBufferDeleteInteractive', 'gtkTextBufferBackspace',
          'gtkTextBufferDeleteSelection', 'gtkTextBufferBackspace'.  

          '_t_e_x_t_b_u_f_f_e_r' ['GtkTextBuffer']  the object which received the
               signal

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


     '_i_n_s_e_r_t-_c_h_i_l_d-_a_n_c_h_o_r(_t_e_x_t_b_u_f_f_e_r, _l_o_c_a_t_i_o_n, _a_n_c_h_o_r, _u_s_e_r._d_a_t_a)' The
          insert_child_anchor signal is emitted to insert a
          'GtkTextChildAnchor' in a 'GtkTextBuffer'. Insertion actually
          occurs in the default handler.

          Note that if your handler runs before the default handler it
          must not invalidate the 'location' iter (or has to revalidate
          it).  The default signal handler revalidates it to be placed
          after the  inserted 'anchor'.

          See also: 'gtkTextBufferInsertChildAnchor'.  

          '_t_e_x_t_b_u_f_f_e_r' ['GtkTextBuffer']  the object which received the
               signal

          '_l_o_c_a_t_i_o_n' ['GtkTextIter']  position to insert 'anchor' in
               'textbuffer'

          '_a_n_c_h_o_r' ['GtkTextChildAnchor']  the 'GtkTextChildAnchor' to
               be inserted

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


     '_i_n_s_e_r_t-_p_i_x_b_u_f(_t_e_x_t_b_u_f_f_e_r, _l_o_c_a_t_i_o_n, _p_i_x_b_u_f, _u_s_e_r._d_a_t_a)' The
          insert_pixbuf signal is emitted to insert a 'GdkPixbuf'  in a
          'GtkTextBuffer'. Insertion actually occurs in the default
          handler.

          Note that if your handler runs before the default handler it
          must not  invalidate the 'location' iter (or has to
          revalidate it).  The default signal handler revalidates it to
          be placed after the  inserted 'pixbuf'.

          See also: 'gtkTextBufferInsertPixbuf'.  

          '_t_e_x_t_b_u_f_f_e_r' ['GtkTextBuffer']  the object which received the
               signal

          '_l_o_c_a_t_i_o_n' ['GtkTextIter']  position to insert 'pixbuf' in
               'textbuffer'

          '_p_i_x_b_u_f' ['GdkPixbuf']  the 'GdkPixbuf' to be inserted

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


     '_i_n_s_e_r_t-_t_e_x_t(_t_e_x_t_b_u_f_f_e_r, _l_o_c_a_t_i_o_n, _t_e_x_t, _l_e_n, _u_s_e_r._d_a_t_a)' The
          insert_text signal is emitted to insert text in a
          'GtkTextBuffer'. Insertion actually occurs in the default
          handler.  

          Note that if your handler runs before the default handler it
          must not  invalidate the 'location' iter (or has to
          revalidate it).  The default signal handler revalidates it to
          point to the end of the  inserted text.

          See also:  'gtkTextBufferInsert', 
          'gtkTextBufferInsertRange'.  

          '_t_e_x_t_b_u_f_f_e_r' ['GtkTextBuffer']  the object which received the
               signal

          '_l_o_c_a_t_i_o_n' ['GtkTextIter']  position to insert 'text' in
               'textbuffer'

          '_t_e_x_t' [character]  the UTF-8 text to be inserted

          '_l_e_n' [integer]  length of the inserted text in bytes

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


     '_m_a_r_k-_d_e_l_e_t_e_d(_t_e_x_t_b_u_f_f_e_r, _m_a_r_k, _u_s_e_r._d_a_t_a)' The mark_deleted
          signal is emitted as notification after a 'GtkTextMark' is
          deleted. 

          See also: 'gtkTextBufferDeleteMark'.  

          '_t_e_x_t_b_u_f_f_e_r' ['GtkTextBuffer']  the object which received the
               signal

          '_m_a_r_k' ['GtkTextMark']  The mark that was deleted

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


     '_m_a_r_k-_s_e_t(_t_e_x_t_b_u_f_f_e_r, _l_o_c_a_t_i_o_n, _m_a_r_k, _u_s_e_r._d_a_t_a)' The mark_set
          signal is emitted as notification after a 'GtkTextMark' is
          set.

          See also:  'gtkTextBufferCreateMark',
          'gtkTextBufferMoveMark'.  

          '_t_e_x_t_b_u_f_f_e_r' ['GtkTextBuffer']  the object which received the
               signal

          '_l_o_c_a_t_i_o_n' ['GtkTextIter']  The location of 'mark' in
               'textbuffer'

          '_m_a_r_k' ['GtkTextMark']  The mark that is set

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


     '_m_o_d_i_f_i_e_d-_c_h_a_n_g_e_d(_t_e_x_t_b_u_f_f_e_r, _u_s_e_r._d_a_t_a)' The modified_changed
          signal is emitted when the modified bit of a  'GtkTextBuffer'
          flips.

          See also: 'gtkTextBufferSetModified'.  

          '_t_e_x_t_b_u_f_f_e_r' ['GtkTextBuffer']  the object which received the
               signal

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


     '_r_e_m_o_v_e-_t_a_g(_t_e_x_t_b_u_f_f_e_r, _t_a_g, _s_t_a_r_t, _e_n_d, _u_s_e_r._d_a_t_a)' The
          remove_tag signal is emitted to remove all occurrences of
          'tag' from a range of text in a 'GtkTextBuffer'.  Removal
          actually occurs in the default handler.

          Note that if your handler runs before the default handler it
          must not  invalidate the 'start' and 'end' iters (or has to
          revalidate them). 

          See also:  'gtkTextBufferRemoveTag'.  

          '_t_e_x_t_b_u_f_f_e_r' ['GtkTextBuffer']  the object which received the
               signal

          '_t_a_g' ['GtkTextTag']  the tag to be removed

          '_s_t_a_r_t' ['GtkTextIter']  the start of the range the tag is
               removed from

          '_e_n_d' ['GtkTextIter']  the end of the range the tag is
               removed from

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


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


     '_c_o_p_y-_t_a_r_g_e_t-_l_i_s_t' ['_G_t_k_T_a_r_g_e_t_L_i_s_t' : _R_e_a_d] The list of targets
          this buffer supports for clipboard copying and as DND source.            

          Since  2.10


     '_c_u_r_s_o_r-_p_o_s_i_t_i_o_n' [_i_n_t_e_g_e_r : _R_e_a_d] The position of the insert mark
          (as offset from the beginning  of the buffer). It is useful
          for getting notified when the  cursor moves.  

          Allowed values: >= 0  Default value: 0  Since  2.10


     '_h_a_s-_s_e_l_e_c_t_i_o_n' [_l_o_g_i_c_a_l : _R_e_a_d] Whether the buffer has some text
          currently selected.  

          Default value: FALSE  Since  2.10


     '_p_a_s_t_e-_t_a_r_g_e_t-_l_i_s_t' ['_G_t_k_T_a_r_g_e_t_L_i_s_t' : _R_e_a_d] The list of targets
          this buffer supports for clipboard pasting and as DND
          destination.  

          Since  2.10


     '_t_a_g-_t_a_b_l_e' ['_G_t_k_T_e_x_t_T_a_g_T_a_b_l_e' : _R_e_a_d / _W_r_i_t_e / _C_o_n_s_t_r_u_c_t _O_n_l_y] 
          Text Tag Table.


     '_t_e_x_t' [_c_h_a_r_a_c_t_e_r : _R_e_a_d / _W_r_i_t_e] The text content of the buffer.
          Without child widgets and images, see 'gtkTextBufferGetText'
          for more information.  

          Default value: ""  Since  2.8


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

_S_e_e _A_l_s_o:

     'GtkTextView' 'GtkTextIter' 'GtkTextMark'

