GtkTreeSelection            package:RGtk2            R Documentation

_G_t_k_T_r_e_e_S_e_l_e_c_t_i_o_n

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

     The selection object for GtkTreeView

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

     'gtkTreeSelectionSetMode(object, type)'
      'gtkTreeSelectionGetMode(object)'
      'gtkTreeSelectionSetSelectFunction(object, func, data = NULL)'
      'gtkTreeSelectionGetUserData(object)'
      'gtkTreeSelectionGetTreeView(object)'
      'gtkTreeSelectionGetSelected(object)'
      'gtkTreeSelectionSelectedForeach(object, func, data = NULL)'
      'gtkTreeSelectionGetSelectedRows(object)'
      'gtkTreeSelectionCountSelectedRows(object)'
      'gtkTreeSelectionSelectPath(object, path)'
      'gtkTreeSelectionUnselectPath(object, path)'
      'gtkTreeSelectionPathIsSelected(object, path)'
      'gtkTreeSelectionSelectIter(object, iter)'
      'gtkTreeSelectionUnselectIter(object, iter)'
      'gtkTreeSelectionIterIsSelected(object, iter)'
      'gtkTreeSelectionSelectAll(object)'
      'gtkTreeSelectionUnselectAll(object)'
      'gtkTreeSelectionSelectRange(object, start.path, end.path)'
      'gtkTreeSelectionUnselectRange(object, start.path, end.path)'

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

     GObject
        +----GtkTreeSelection 

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

     The 'GtkTreeSelection' object is a helper object to manage the
     selection for a 'GtkTreeView' widget.  The 'GtkTreeSelection'
     object is automatically created when a new 'GtkTreeView' widget is
     created, and cannot exist independentally of this widget.  The
     primary reason the 'GtkTreeSelection' objects exists is for
     cleanliness of code and API. That is, there is no conceptual
     reason all these functions could not be methods on the
     'GtkTreeView' widget instead of a separate function.

     The 'GtkTreeSelection' object is gotten from a 'GtkTreeView' by
     calling 'gtkTreeViewGetSelection'.  It can be manipulated to check
     the selection status of the tree, as well as select and deselect
     individual rows.  Selection is done completely view side.  As a
     result, multiple views of the same model can have completely
     different selections. Additionally, you cannot change the
     selection of a row on the model that is not currently displayed by
     the view without expanding its parents first.

     One of the important things to remember when monitoring the
     selection of a view is that the '"changed"' signal is mostly a
     hint.  That is, it may only emit one signal when a range of rows
     is selected.  Additionally, it may on occasion emit a ::changed
     signal when nothing has happened (mostly as a result of
     programmers calling select_row on an already selected row).

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


     '_G_t_k_T_r_e_e_S_e_l_e_c_t_i_o_n' _undocumented _


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


     '_G_t_k_T_r_e_e_S_e_l_e_c_t_i_o_n_F_u_n_c(_s_e_l_e_c_t_i_o_n, _m_o_d_e_l, _p_a_t_h, _p_a_t_h._c_u_r_r_e_n_t_l_y._s_e_l_e_c_t_e_d, _d_a_t_a)' 
          A function used by 'gtkTreeSelectionSetSelectFunction' to
          filter whether or not a row may be selected.  It is called
          whenever a row's state might change.  A return value of
          'TRUE' indicates to 'selection' that it is okay to change the
          selection.

          '_s_e_l_e_c_t_i_o_n' ['GtkTreeSelection'] A 'GtkTreeSelection'

          '_m_o_d_e_l' ['GtkTreeModel'] A 'GtkTreeModel' being viewed

          '_p_a_t_h' ['GtkTreePath'] The 'GtkTreePath' of the row in
               question

          '_p_a_t_h._c_u_r_r_e_n_t_l_y._s_e_l_e_c_t_e_d' [logical] 'TRUE', if the path is
               currently selected

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

          _Returns:_ [logical] 'TRUE', if the selection state of the
          row can be toggled


     '_G_t_k_T_r_e_e_S_e_l_e_c_t_i_o_n_F_o_r_e_a_c_h_F_u_n_c(_m_o_d_e_l, _p_a_t_h, _i_t_e_r, _d_a_t_a)' A function
          used by 'gtkTreeSelectionSelectedForeach' to map all selected
          rows.  It will be called on every selected row in the view.

          '_m_o_d_e_l' ['GtkTreeModel'] The 'GtkTreeModel' being viewed

          '_p_a_t_h' ['GtkTreePath'] The 'GtkTreePath' of a selected row

          '_i_t_e_r' ['GtkTreeIter'] A 'GtkTreeIter' pointing to a selected
               row

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


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


     '_c_h_a_n_g_e_d(_t_r_e_e_s_e_l_e_c_t_i_o_n, _u_s_e_r._d_a_t_a)' Emitted whenever the selection
          has (possibly) changed.  Please note that this signal is
          mostly a hint.  It may only be emitted once when a range of
          rows are selected, and it may occasionally be emitted when
          nothing has happened.

          '_t_r_e_e_s_e_l_e_c_t_i_o_n' ['GtkTreeSelection'] 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.


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

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

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

