GtkTextView              package:RGtk2              R Documentation

_G_t_k_T_e_x_t_V_i_e_w

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

     Widget that displays a GtkTextBuffer

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

     'gtkTextViewNew(show = TRUE)'
      'gtkTextViewNewWithBuffer(buffer = NULL, show = TRUE)'
      'gtkTextViewSetBuffer(object, buffer)'
      'gtkTextViewGetBuffer(object)'
      'gtkTextViewScrollToMark(object, mark, within.margin, use.align =
     FALSE, xalign = 0.5, yalign = 0.5)'
      'gtkTextViewScrollToIter(object, iter, within.margin, use.align =
     FALSE, xalign = 0.5, yalign = 0.5)'
      'gtkTextViewScrollMarkOnscreen(object, mark)'
      'gtkTextViewMoveMarkOnscreen(object, mark)'
      'gtkTextViewPlaceCursorOnscreen(object)'
      'gtkTextViewGetVisibleRect(object)'
      'gtkTextViewGetIterLocation(object, iter)'
      'gtkTextViewGetLineAtY(object, y)'
      'gtkTextViewGetLineYrange(object, iter)'
      'gtkTextViewGetIterAtLocation(object, x, y)'
      'gtkTextViewGetIterAtPosition(object, x, y)'
      'gtkTextViewBufferToWindowCoords(object, win, buffer.x,
     buffer.y)'
      'gtkTextViewWindowToBufferCoords(object, win, window.x,
     window.y)'
      'gtkTextViewGetWindow(object, win)'
      'gtkTextViewGetWindowType(object, window)'
      'gtkTextViewSetBorderWindowSize(object, type, size)'
      'gtkTextViewGetBorderWindowSize(object, type)'
      'gtkTextViewForwardDisplayLine(object, iter)'
      'gtkTextViewBackwardDisplayLine(object, iter)'
      'gtkTextViewForwardDisplayLineEnd(object, iter)'
      'gtkTextViewBackwardDisplayLineStart(object, iter)'
      'gtkTextViewStartsDisplayLine(object, iter)'
      'gtkTextViewMoveVisually(object, iter, count)'
      'gtkTextViewAddChildAtAnchor(object, child, anchor)'
      'gtkTextChildAnchorNew()'
      'gtkTextChildAnchorGetWidgets(object)'
      'gtkTextChildAnchorGetDeleted(object)'
      'gtkTextViewAddChildInWindow(object, child, which.window, xpos,
     ypos)'
      'gtkTextViewMoveChild(object, child, xpos, ypos)'
      'gtkTextViewSetWrapMode(object, wrap.mode)'
      'gtkTextViewGetWrapMode(object)'
      'gtkTextViewSetEditable(object, setting)'
      'gtkTextViewGetEditable(object)'
      'gtkTextViewSetCursorVisible(object, setting)'
      'gtkTextViewGetCursorVisible(object)'
      'gtkTextViewSetOverwrite(object, overwrite)'
      'gtkTextViewGetOverwrite(object)'
      'gtkTextViewSetPixelsAboveLines(object, pixels.above.lines)'
      'gtkTextViewGetPixelsAboveLines(object)'
      'gtkTextViewSetPixelsBelowLines(object, pixels.below.lines)'
      'gtkTextViewGetPixelsBelowLines(object)'
      'gtkTextViewSetPixelsInsideWrap(object, pixels.inside.wrap)'
      'gtkTextViewGetPixelsInsideWrap(object)'
      'gtkTextViewSetJustification(object, justification)'
      'gtkTextViewGetJustification(object)'
      'gtkTextViewSetLeftMargin(object, left.margin)'
      'gtkTextViewGetLeftMargin(object)'
      'gtkTextViewSetRightMargin(object, right.margin)'
      'gtkTextViewGetRightMargin(object)'
      'gtkTextViewSetIndent(object, indent)'
      'gtkTextViewGetIndent(object)'
      'gtkTextViewSetTabs(object, tabs)'
      'gtkTextViewGetTabs(object)'
      'gtkTextViewSetAcceptsTab(object, accepts.tab)'
      'gtkTextViewGetAcceptsTab(object)'
      'gtkTextViewGetDefaultAttributes(object)'
      'gtkTextView(buffer = NULL, show = TRUE)'
     'gtkTextChildAnchor()'

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


     GObject
        +----GInitiallyUnowned
              +----GtkObject
                    +----GtkWidget
                          +----GtkContainer
                                +----GtkTextView
     GObject
        +----GtkTextChildAnchor


_I_n_t_e_r_f_a_c_e_s:

     GtkTextView implements AtkImplementorIface and  'GtkBuildable'.

_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_V_i_e_w' _undocumented _


     '_G_t_k_T_e_x_t_C_h_i_l_d_A_n_c_h_o_r' A 'GtkTextChildAnchor' is a spot in the
          buffer  where child widgets can be "anchored" (inserted
          inline, as if they were  characters). The anchor can have
          multiple widgets anchored, to allow for  multiple views.


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

     'gtkTextView' is the result of collapsing the constructors of
     'GtkTextView' ('gtkTextViewNew', 'gtkTextViewNewWithBuffer') and
     accepts a subset of its arguments matching the required arguments
     of one of its delegate constructors. 'gtkTextChildAnchor' is the
     equivalent of 'gtkTextChildAnchorNew'.

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


     '_G_t_k_T_e_x_t_W_i_n_d_o_w_T_y_p_e' _undocumented _

          '_p_r_i_v_a_t_e' _undocumented _

          '_w_i_d_g_e_t' _undocumented _

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

          '_l_e_f_t' _undocumented _

          '_r_i_g_h_t' _undocumented _

          '_t_o_p' _undocumented _

          '_b_o_t_t_o_m' _undocumented _


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


     '_b_a_c_k_s_p_a_c_e(_t_e_x_t._v_i_e_w, _u_s_e_r._d_a_t_a)' The ::backspace signal is a 
          keybinding signal  which gets emitted when the user asks for
          it.

          The default bindings for this signal are Backspace and
          Shift-Backspace.  

          '_t_e_x_t._v_i_e_w' ['GtkTextView']  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_o_p_y-_c_l_i_p_b_o_a_r_d(_t_e_x_t._v_i_e_w, _u_s_e_r._d_a_t_a)' The ::copy-clipboard signal
          is a  keybinding signal  which gets emitted to copy the
          selection to the clipboard.

          The default bindings for this signal are Ctrl-c and
          Ctrl-Insert.  

          '_t_e_x_t._v_i_e_w' ['GtkTextView']  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_u_t-_c_l_i_p_b_o_a_r_d(_t_e_x_t._v_i_e_w, _u_s_e_r._d_a_t_a)' The ::cut-clipboard signal
          is a  keybinding signal  which gets emitted to cut the
          selection to the clipboard.

          The default bindings for this signal are Ctrl-x and
          Shift-Delete.  

          '_t_e_x_t._v_i_e_w' ['GtkTextView']  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-_f_r_o_m-_c_u_r_s_o_r(_t_e_x_t._v_i_e_w, _t_y_p_e, _c_o_u_n_t, _u_s_e_r._d_a_t_a)' The
          ::delete-from-cursor signal is a  keybinding signal  which
          gets emitted when the user initiates a text deletion.

          If the 'type' is 'GTK_DELETE_CHARS', GTK+ deletes the
          selection if there is one, otherwise it deletes the requested
          number of characters.

          The default bindings for this signal are Delete for deleting
          a character, Ctrl-Delete for  deleting a word and
          Ctrl-Backspace for deleting a word  backwords.  

          '_t_e_x_t._v_i_e_w' ['GtkTextView']  the object which received the
               signal

          '_t_y_p_e' ['GtkDeleteType']  the granularity of the deletion, as
               a 'GtkDeleteType'

          '_c_o_u_n_t' [integer]  the number of 'type' units to delete

          '_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-_a_t-_c_u_r_s_o_r(_t_e_x_t_v_i_e_w, _a_r_g_1, _u_s_e_r._d_a_t_a)' _undocumented _

          '_t_e_x_t_v_i_e_w' ['GtkTextView'] the object which received the
               signal.

          '_a_r_g_1' [character] 

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


     '_m_o_v_e-_c_u_r_s_o_r(_t_e_x_t._v_i_e_w, _s_t_e_p, _c_o_u_n_t, _e_x_t_e_n_d._s_e_l_e_c_t_i_o_n, _u_s_e_r._d_a_t_a)' 
          The ::move-cursor signal is a  keybinding signal  which gets
          emitted when the user initiates a cursor movement.  If the
          cursor is not visible in 'text.view', this signal causes the
          viewport to be moved instead.

          Applications should not connect to it, but may emit it with 
          'gSignalEmitByName()' if they need to control scrolling 
          programmatically.

          The default bindings for this signal come in two variants,
          the variant with the Shift modifier extends the selection,
          the variant without the Shift modifer does not. There are too
          many key combinations to list them all here.

             * 

             * 

             * 

             * 

             *  .in -3

             '_t_e_x_t._v_i_e_w' ['GtkTextView']  the object which received the
                  signal

             '_s_t_e_p' ['GtkMovementStep']  the granularity of the move,
                  as a 'GtkMovementStep'

             '_c_o_u_n_t' [integer]  the number of 'step' units to move

             '_e_x_t_e_n_d._s_e_l_e_c_t_i_o_n' [logical] 'TRUE' if the move should
                  extend the selection

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


        '_m_o_v_e-_v_i_e_w_p_o_r_t(_t_e_x_t._v_i_e_w, _s_t_e_p, _c_o_u_n_t, _u_s_e_r._d_a_t_a)' The
             ::move-viewport signal is a  keybinding signal  which can
             be bound to key combinations to allow the user to move the
             viewport, i.e. change what part of the text view is
             visible in a containing scrolled window.

             There are no default bindings for this signal.  

             '_t_e_x_t._v_i_e_w' ['GtkTextView']  the object which received the
                  signal

             '_s_t_e_p' ['GtkScrollStep']  the granularity of the move, as
                  a 'GtkMovementStep'

             '_c_o_u_n_t' [integer]  the number of 'step' units to move

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


        '_p_a_g_e-_h_o_r_i_z_o_n_t_a_l_l_y(_t_e_x_t._v_i_e_w, _c_o_u_n_t, _e_x_t_e_n_d._s_e_l_e_c_t_i_o_n, _u_s_e_r._d_a_t_a)' 
             The ::page-horizontally signal is a  keybinding signal 
             which can be bound to key combinations to allow the user
             to initiate horizontal cursor movement by pages.  

             This signal should not be used anymore, instead use the
             '"move-cursor"' signal with the
             'GTK_MOVEMENT_HORIZONTAL_PAGES' granularity.  

             '_t_e_x_t._v_i_e_w' ['GtkTextView']  the object which received the
                  signal

             '_c_o_u_n_t' [integer]  the number of 'step' units to move

             '_e_x_t_e_n_d._s_e_l_e_c_t_i_o_n' [logical] 'TRUE' if the move should
                  extend the selection

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


        '_p_a_s_t_e-_c_l_i_p_b_o_a_r_d(_t_e_x_t._v_i_e_w, _u_s_e_r._d_a_t_a)' The ::paste-clipboard
             signal is a  keybinding signal  which gets emitted to
             paste the contents of the clipboard  into the text view.

             The default bindings for this signal are Ctrl-v and
             Shift-Insert.  

             '_t_e_x_t._v_i_e_w' ['GtkTextView']  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.


        '_p_o_p_u_l_a_t_e-_p_o_p_u_p(_t_e_x_t_v_i_e_w, _a_r_g_1, _u_s_e_r._d_a_t_a)' _undocumented _

             '_t_e_x_t_v_i_e_w' ['GtkTextView'] the object which received the
                  signal.

             '_a_r_g_1' ['GtkMenu'] 

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


        '_s_e_l_e_c_t-_a_l_l(_t_e_x_t._v_i_e_w, _s_e_l_e_c_t, _u_s_e_r._d_a_t_a)' The ::select-all
             signal is a  keybinding signal  which gets emitted to
             select or unselect the complete contents of the text view.

             The default bindings for this signal are Ctrl-a and Ctrl-/
              for selecting and Shift-Ctrl-a and Ctrl-\ for
             unselecting.  

             '_t_e_x_t._v_i_e_w' ['GtkTextView']  the object which received the
                  signal

             '_s_e_l_e_c_t' [logical] 'TRUE' to select, 'FALSE' to unselect

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


        '_s_e_t-_a_n_c_h_o_r(_t_e_x_t_v_i_e_w, _u_s_e_r._d_a_t_a)' _undocumented _

             '_t_e_x_t_v_i_e_w' ['GtkTextView'] 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.


        '_s_e_t-_s_c_r_o_l_l-_a_d_j_u_s_t_m_e_n_t_s(_t_e_x_t_v_i_e_w, _a_r_g_1, _a_r_g_2, _u_s_e_r._d_a_t_a)' 
             _undocumented _

             '_t_e_x_t_v_i_e_w' ['GtkTextView'] the object which received the
                  signal.

             '_a_r_g_1' ['GtkAdjustment'] 

             '_a_r_g_2' ['GtkAdjustment'] 

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


        '_t_o_g_g_l_e-_c_u_r_s_o_r-_v_i_s_i_b_l_e(_t_e_x_t._v_i_e_w, _u_s_e_r._d_a_t_a)' The
             ::toggle-cursor-visible signal is a  keybinding signal 
             which gets emitted to toggle the visibility of the cursor.

             The default binding for this signal is F7.  

             '_t_e_x_t._v_i_e_w' ['GtkTextView']  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.


        '_t_o_g_g_l_e-_o_v_e_r_w_r_i_t_e(_t_e_x_t._v_i_e_w, _u_s_e_r._d_a_t_a)' The ::toggle-overwrite
             signal is a  keybinding signal  which gets emitted to
             change the editability of the text view.

             The default bindings for this signal is Insert.  

             '_t_e_x_t._v_i_e_w' ['GtkTextView']  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.


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


     '_a_c_c_e_p_t_s-_t_a_b' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Whether Tab will result in
          a tab character being entered.  Default value: TRUE


     '_b_u_f_f_e_r' ['_G_t_k_T_e_x_t_B_u_f_f_e_r' : _R_e_a_d / _W_r_i_t_e] The buffer which is
          displayed.


     '_c_u_r_s_o_r-_v_i_s_i_b_l_e' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] If the insertion cursor
          is shown.  Default value: TRUE


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


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


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


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


     '_o_v_e_r_w_r_i_t_e' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Whether entered text
          overwrites existing contents.  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-_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-_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


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


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


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


_S_t_y_l_e _P_r_o_p_e_r_t_i_e_s:


     '_e_r_r_o_r-_u_n_d_e_r_l_i_n_e-_c_o_l_o_r' ['_G_d_k_C_o_l_o_r' : _R_e_a_d] Color with which to
          draw error-indication underlines.


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

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

     'GtkTextBuffer' 'GtkTextIter'

