GtkTreeView              package:RGtk2              R Documentation

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

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

     A widget for displaying both trees and lists

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

     'gtkTreeViewNew(show = TRUE)'
      'gtkTreeViewNewWithModel(model = NULL, show = TRUE)'
      'gtkTreeViewGetModel(object)'
      'gtkTreeViewSetModel(object, model = NULL)'
      'gtkTreeViewGetSelection(object)'
      'gtkTreeViewGetHadjustment(object)'
      'gtkTreeViewSetHadjustment(object, adjustment)'
      'gtkTreeViewGetVadjustment(object)'
      'gtkTreeViewSetVadjustment(object, adjustment)'
      'gtkTreeViewGetHeadersVisible(object)'
      'gtkTreeViewSetHeadersVisible(object, headers.visible)'
      'gtkTreeViewColumnsAutosize(object)'
      'gtkTreeViewSetHeadersClickable(object, active)'
      'gtkTreeViewSetRulesHint(object, setting)'
      'gtkTreeViewGetRulesHint(object)'
      'gtkTreeViewAppendColumn(object, column)'
      'gtkTreeViewRemoveColumn(object, column)'
      'gtkTreeViewInsertColumn(object, column, position)'
      'gtkTreeViewInsertColumnWithAttributes(object, position, title,
     cell, ...)'
      'gtkTreeViewInsertColumnWithDataFunc(object, position, title,
     cell, func, data = NULL)'
      'gtkTreeViewGetColumn(object, n)'
      'gtkTreeViewGetColumns(object)'
      'gtkTreeViewMoveColumnAfter(object, column, base.column = NULL)'
      'gtkTreeViewSetExpanderColumn(object, column)'
      'gtkTreeViewGetExpanderColumn(object)'
      'gtkTreeViewSetColumnDragFunction(object, func, user.data =
     NULL)'
      'gtkTreeViewScrollToPoint(object, tree.x, tree.y)'
      'gtkTreeViewScrollToCell(object, path, column = NULL, use.align =
     FALSE, row.align = 0, col.align = 0)'
      'gtkTreeViewSetCursor(object, path, focus.column = NULL,
     start.editing = FALSE)'
      'gtkTreeViewSetCursorOnCell(object, path, focus.column = NULL,
     focus.cell = NULL, start.editing = FALSE)'
      'gtkTreeViewGetCursor(object)'
      'gtkTreeViewRowActivated(object, path, column)'
      'gtkTreeViewExpandAll(object)'
      'gtkTreeViewCollapseAll(object)'
      'gtkTreeViewExpandToPath(object, path)'
      'gtkTreeViewExpandRow(object, path, open.all)'
      'gtkTreeViewCollapseRow(object, path)'
      'gtkTreeViewMapExpandedRows(object, func, data = NULL)'
      'gtkTreeViewRowExpanded(object, path)'
      'gtkTreeViewSetReorderable(object, reorderable)'
      'gtkTreeViewGetReorderable(object)'
      'gtkTreeViewGetPathAtPos(object, x, y)'
      'gtkTreeViewGetCellArea(object, path, column)'
      'gtkTreeViewGetBackgroundArea(object, path, column)'
      'gtkTreeViewGetVisibleRect(object)'
      'gtkTreeViewGetVisibleRange(object)'
      'gtkTreeViewGetBinWindow(object)'
      'gtkTreeViewWidgetToTreeCoords(object, wx, wy)'
      'gtkTreeViewTreeToWidgetCoords(object, tx, ty)'
      'gtkTreeViewEnableModelDragDest(object, targets, actions)'
      'gtkTreeViewEnableModelDragSource(object, start.button.mask,
     targets, actions)'
      'gtkTreeViewUnsetRowsDragSource(object)'
      'gtkTreeViewUnsetRowsDragDest(object)'
      'gtkTreeViewSetDragDestRow(object, path, pos)'
      'gtkTreeViewGetDragDestRow(object, path, pos)'
      'gtkTreeViewGetDestRowAtPos(object, drag.x, drag.y)'
      'gtkTreeViewCreateRowDragIcon(object, path)'
      'gtkTreeViewSetEnableSearch(object, enable.search)'
      'gtkTreeViewGetEnableSearch(object)'
      'gtkTreeViewGetSearchColumn(object)'
      'gtkTreeViewSetSearchColumn(object, column)'
      'gtkTreeViewGetSearchEqualFunc(object)'
      'gtkTreeViewSetSearchEqualFunc(object, search.equal.func,
     search.user.data = NULL)'
      'gtkTreeViewGetFixedHeightMode(object)'
      'gtkTreeViewSetFixedHeightMode(object, enable)'
      'gtkTreeViewGetHoverSelection(object)'
      'gtkTreeViewSetHoverSelection(object, hover)'
      'gtkTreeViewGetHoverExpand(object)'
      'gtkTreeViewSetHoverExpand(object, expand)'
      'gtkTreeViewSetDestroyCountFunc(object, func, data = NULL)'
      'gtkTreeViewGetRowSeparatorFunc(object)'
      'gtkTreeViewSetRowSeparatorFunc(object, func, data = NULL)'
      'gtkTreeView(model = NULL, show = TRUE)'

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

     GObject
        +----GtkObject
              +----GtkWidget
                    +----GtkContainer
                          +----GtkTreeView 

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

     GtkTreeView implements AtkImplementorIface.

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

     Widget that displays any object that implements the 'GtkTreeModel'
     interface.

     Please refer to the tree widget conceptual overview  for an
     overview of all the objects and data types related to the tree
     widget and how  they work together.

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

     '_G_t_k_T_r_e_e_V_i_e_w' _undocumented _ .in -5 

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

     'gtkTreeView' is the result of collapsing the constructors of
     'GtkTreeView' ('gtkTreeViewNew', 'gtkTreeViewNewWithModel') and
     accepts a subset of its arguments matching the required arguments
     of one of its delegate constructors.

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

     '_G_t_k_T_r_e_e_V_i_e_w_D_r_o_p_P_o_s_i_t_i_o_n' An enum for determining where a dropped
          row goes.

          '_b_e_f_o_r_e' _undocumented _

          '_a_f_t_e_r' _undocumented _

          '_i_n_t_o-_o_r-_b_e_f_o_r_e' _undocumented _

          '_i_n_t_o-_o_r-_a_f_t_e_r' _undocumented _

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

     '_G_t_k_T_r_e_e_V_i_e_w_C_o_l_u_m_n_D_r_o_p_F_u_n_c(_t_r_e_e._v_i_e_w, _c_o_l_u_m_n, _p_r_e_v._c_o_l_u_m_n, _n_e_x_t._c_o_l_u_m_n, _d_a_t_a)' Funct
          ion type for determining whether 'column' can be dropped in a
          particular spot (as determined by 'prev.column' and
          'next.column').  In left to right locales, 'prev.column' is
          on the left of the potential drop spot, and 'next.column' is
          on the right.  In right to left mode, this is reversed.  This
          function should return 'TRUE' if the spot is a valid drop
          spot.  Please note that returning 'TRUE' does not actually
          indicate that the column drop was made, but is meant only to
          indicate a possible drop spot to the user.

          '_t_r_e_e._v_i_e_w' ['GtkTreeView'] A 'GtkTreeView'

          '_c_o_l_u_m_n' ['GtkTreeViewColumn'] The 'GtkTreeViewColumn' being
               dragged

          '_p_r_e_v._c_o_l_u_m_n' ['GtkTreeViewColumn'] A 'GtkTreeViewColumn' on
               one side of 'column'

          '_n_e_x_t._c_o_l_u_m_n' ['GtkTreeViewColumn'] A 'GtkTreeViewColumn' on
               the other side of 'column'

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


     '_G_t_k_T_r_e_e_V_i_e_w_M_a_p_p_i_n_g_F_u_n_c(_t_r_e_e._v_i_e_w, _p_a_t_h, _u_s_e_r._d_a_t_a)' Function used
          for 'gtkTreeViewMapExpandedRows'.

          '_t_r_e_e._v_i_e_w' ['GtkTreeView'] A 'GtkTreeView'

          '_p_a_t_h' ['GtkTreePath'] The path that's expanded

          '_u_s_e_r._d_a_t_a' [R object] user data


     '_G_t_k_T_r_e_e_V_i_e_w_S_e_a_r_c_h_E_q_u_a_l_F_u_n_c(_m_o_d_e_l, _c_o_l_u_m_n, _k_e_y, _i_t_e_r, _s_e_a_r_c_h._d_a_t_a)' A
          function used for checking whether a row in 'model' matches a
          search key string entered by the user. Note the return value
          is reversed from what you would normally expect, though it
          has some similarity to 'strcmp()' returning 0 for equal
          strings.

          '_m_o_d_e_l' ['GtkTreeModel'] the 'GtkTreeModel' being searched

          '_c_o_l_u_m_n' [integer] the search column set by
               'gtkTreeViewSetSearchColumn'

          '_k_e_y' [character] the key string to compare with

          '_i_t_e_r' ['GtkTreeIter'] a 'GtkTreeIter' pointing the row of
               'model' that should be compared with 'key'.

          '_s_e_a_r_c_h._d_a_t_a' [R object] user data from
               'gtkTreeViewSetSearchEqualFunc'


          '_t_r_e_e._v_i_e_w' ['GtkTreeView'] 

          '_p_a_t_h' ['GtkTreePath'] 

          '_c_h_i_l_d_r_e_n' [integer] 

          '_u_s_e_r._d_a_t_a' [R object] 


     '_G_t_k_T_r_e_e_V_i_e_w_R_o_w_S_e_p_a_r_a_t_o_r_F_u_n_c(_m_o_d_e_l, _i_t_e_r, _d_a_t_a)' Function type for
          determining whether the row pointed to by 'iter' should be
          rendered as a separator. A common way to implement this is to
          have a boolean column in the model, whose values the
          'GtkTreeViewRowSeparatorFunc' returns.

          '_m_o_d_e_l' ['GtkTreeModel'] the 'GtkTreeModel'

          '_i_t_e_r' ['GtkTreeIter'] a 'GtkTreeIter' pointing at a row in
               'model'

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


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

          '_t_r_e_e_v_i_e_w' ['GtkTreeView'] 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_r_e_e_v_i_e_w' ['GtkTreeView'] 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_r_e_e_v_i_e_w' ['GtkTreeView'] the object which received the
               signal.

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

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

          '_a_r_g_3' [logical] 

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


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

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

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

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


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

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

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

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


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

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

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

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


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

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

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

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


          '_t_r_e_e_v_i_e_w' ['GtkTreeView'] 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_r_e_e_v_i_e_w' ['GtkTreeView'] 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_r_e_e_v_i_e_w' ['GtkTreeView'] the object which received the
               signal.

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

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


          '_t_r_e_e_v_i_e_w' ['GtkTreeView'] 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_r_e_e_v_i_e_w' ['GtkTreeView'] 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_r_e_e_v_i_e_w' ['GtkTreeView'] the object which received the
               signal.

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

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

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


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

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

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

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


          '_t_r_e_e_v_i_e_w' ['GtkTreeView'] 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_r_e_e_v_i_e_w' ['GtkTreeView'] 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:

     '_e_n_a_b_l_e-_s_e_a_r_c_h' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] View allows user to
          search through columns interactively.  Default value: TRUE


     '_e_x_p_a_n_d_e_r-_c_o_l_u_m_n' ['_G_t_k_T_r_e_e_V_i_e_w_C_o_l_u_m_n' : _R_e_a_d / _W_r_i_t_e] Set the
          column for the expander column.


     '_f_i_x_e_d-_h_e_i_g_h_t-_m_o_d_e' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Setting the
          ::fixed-height-mode property to 'TRUE' speeds up 
          'GtkTreeView' by assuming that all rows have the same height.
           Only enable this option if all rows are the same height.  
          Please see 'gtkTreeViewSetFixedHeightMode' for more 
          information on this option.  

          Default value: FALSE  Since  2.4


     '_h_a_d_j_u_s_t_m_e_n_t' ['_G_t_k_A_d_j_u_s_t_m_e_n_t' : _R_e_a_d / _W_r_i_t_e] Horizontal
          Adjustment for the widget.


     '_h_e_a_d_e_r_s-_c_l_i_c_k_a_b_l_e' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Column headers
          respond to click events.  Default value: FALSE


     '_h_e_a_d_e_r_s-_v_i_s_i_b_l_e' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Show the column header
          buttons.  Default value: TRUE


     '_h_o_v_e_r-_e_x_p_a_n_d' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Enables of disables the
          hover expansion mode of 'tree.view'. Hover expansion makes
          rows expand or collaps if the pointer moves  over them.

          This mode is primarily indended for treeviews in popups, e.g.
          in 'GtkComboBox' or 'GtkEntryCompletion'.  

          Default value: FALSE  Since  2.6


     '_h_o_v_e_r-_s_e_l_e_c_t_i_o_n' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Enables of disables the
          hover selection mode of 'tree.view'. Hover selection makes
          the selected row follow the pointer. Currently, this works
          only for the selection modes  'GTK_SELECTION_SINGLE' and
          'GTK_SELECTION_BROWSE'.

          This mode is primarily indended for treeviews in popups, e.g.
          in 'GtkComboBox' or 'GtkEntryCompletion'.  

          Default value: FALSE  Since  2.6


     '_m_o_d_e_l' ['_G_t_k_T_r_e_e_M_o_d_e_l' : _R_e_a_d / _W_r_i_t_e] The model for the tree
          view.


     '_r_e_o_r_d_e_r_a_b_l_e' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] View is reorderable. 
          Default value: FALSE


     '_r_u_l_e_s-_h_i_n_t' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Set a hint to the theme
          engine to draw rows in alternating colors.  Default value:
          FALSE


     '_s_e_a_r_c_h-_c_o_l_u_m_n' [_i_n_t_e_g_e_r : _R_e_a_d / _W_r_i_t_e] Model column to search
          through when searching through code.  Allowed values: >= -1 
          Default value: -1


     '_v_a_d_j_u_s_t_m_e_n_t' ['_G_t_k_A_d_j_u_s_t_m_e_n_t' : _R_e_a_d / _W_r_i_t_e] Vertical Adjustment
          for the widget.


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

     '_a_l_l_o_w-_r_u_l_e_s' [_l_o_g_i_c_a_l : _R_e_a_d] Allow drawing of alternating color
          rows.  Default value: TRUE


     '_e_v_e_n-_r_o_w-_c_o_l_o_r' ['_G_d_k_C_o_l_o_r' : _R_e_a_d] Color to use for even rows.


     '_e_x_p_a_n_d_e_r-_s_i_z_e' [_i_n_t_e_g_e_r : _R_e_a_d] Size of the expander arrow. 
          Allowed values: >= 0  Default value: 12


     '_h_o_r_i_z_o_n_t_a_l-_s_e_p_a_r_a_t_o_r' [_i_n_t_e_g_e_r : _R_e_a_d] Horizontal space between
          cells.  Must be an even number.  Allowed values: >= 0 
          Default value: 2


     '_i_n_d_e_n_t-_e_x_p_a_n_d_e_r_s' [_l_o_g_i_c_a_l : _R_e_a_d] Make the expanders indented. 
          Default value: TRUE


     '_o_d_d-_r_o_w-_c_o_l_o_r' ['_G_d_k_C_o_l_o_r' : _R_e_a_d] Color to use for odd rows.


     '_v_e_r_t_i_c_a_l-_s_e_p_a_r_a_t_o_r' [_i_n_t_e_g_e_r : _R_e_a_d] Vertical space between
          cells.  Must be an even number.  Allowed values: >= 0 
          Default value: 2


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

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

     'GtkTreeViewColumn' 'GtkTreeSelection' 'GtkTreeSortable'
     'GtkTreeModelSort' 'GtkListStore' 'GtkTreeStore' 'GtkCellRenderer'
     'GtkCellEditable' 'GtkCellRendererPixbuf' 'GtkCellRendererText'
     'GtkCellRendererToggle'

