GtkTreeModelFilter           package:RGtk2           R Documentation

_G_t_k_T_r_e_e_M_o_d_e_l_F_i_l_t_e_r

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

     A GtkTreeModel which hides parts of an underlying tree model

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

     'gtkTreeModelFilterNew(child.model, root = NULL)'
      'gtkTreeModelFilterSetVisibleFunc(object, func, data = NULL)'
      'gtkTreeModelFilterSetModifyFunc(object, types, func, data =
     NULL)'
      'gtkTreeModelFilterSetVisibleColumn(object, column)'
      'gtkTreeModelFilterGetModel(object)'
      'gtkTreeModelFilterConvertChildIterToIter(object, child.iter)'
      'gtkTreeModelFilterConvertIterToChildIter(object, filter.iter)'
      'gtkTreeModelFilterConvertChildPathToPath(object, child.path)'
      'gtkTreeModelFilterConvertPathToChildPath(object, filter.path)'
      'gtkTreeModelFilterRefilter(object)'
      'gtkTreeModelFilterClearCache(object)'
      'gtkTreeModelFilter(child.model, root = NULL)'

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

     GObject
        +----GtkTreeModelFilter 

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

     GtkTreeModelFilter implements 'GtkTreeModel' and 
     'GtkTreeDragSource'.

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

     A 'GtkTreeModelFilter' is a tree model which wraps another tree
     model, and can do the following things:

        *  Filter specific rows, based on data from a "visible column",
           a column storing booleans indicating whether the row should
           be filtered or not, or based on the return value of a
           "visible function", which gets a model, iter and user_data
           and returns a boolean indicating whether the row should be
           filtered or not.

        *  Modify the "appearance" of the model, using a modify
           function.  This is extremely powerful and allows for just
           changing some values and also for creating a completely
           different model based on the given child model. 

        *  Set a different root node, also known as a "virtual root".
           You can pass in  a 'GtkTreePath' indicating the root node
           for the filter at construction time.

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


     '_G_t_k_T_r_e_e_M_o_d_e_l_F_i_l_t_e_r' The GtkTreeModelFilter struct contains only
          private fields.


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

     'gtkTreeModelFilter' is the equivalent of 'gtkTreeModelFilterNew'.

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


     '_G_t_k_T_r_e_e_M_o_d_e_l_F_i_l_t_e_r_V_i_s_i_b_l_e_F_u_n_c(_m_o_d_e_l, _i_t_e_r, _d_a_t_a)' A function
          which decides whether the row indicated by 'iter' is visible.

          '_m_o_d_e_l' ['GtkTreeModel'] the child model of the
               'GtkTreeModelFilter'

          '_i_t_e_r' ['GtkTreeIter'] a 'GtkTreeIter' pointing to the row in
               'model' whose visibility  is determined

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

          _Returns:_ [logical] Whether the row indicated by 'iter' is
          visible.


     '_G_t_k_T_r_e_e_M_o_d_e_l_F_i_l_t_e_r_M_o_d_i_f_y_F_u_n_c(_m_o_d_e_l, _i_t_e_r, _v_a_l_u_e, _c_o_l_u_m_n, _d_a_t_a)' A
          function which calculates display values from raw values in
          the model. It must fill 'value' with the display value for
          the column 'column' in the  row indicated by 'iter'. 

          Since this function is called for each data access, it's not
          a particularly efficient operation.

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

          '_i_t_e_r' ['GtkTreeIter'] a 'GtkTreeIter' pointing to the row
               whose display values are determined

          '_v_a_l_u_e' [R object] A 'R object' which is already initialized
               for with the correct type for  the column 'column'.

          '_c_o_l_u_m_n' [integer] the column whose display value is
               determined

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


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


     '_c_h_i_l_d-_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 / _C_o_n_s_t_r_u_c_t _O_n_l_y] The
          model for the filtermodel to filter.


     '_v_i_r_t_u_a_l-_r_o_o_t' ['_G_t_k_T_r_e_e_P_a_t_h' : _R_e_a_d / _W_r_i_t_e / _C_o_n_s_t_r_u_c_t _O_n_l_y] The
          virtual root (relative to the child model) for this
          filtermodel.


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

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

     'GtkTreeModelSort'

