GtkRecentFilter            package:RGtk2            R Documentation

_G_t_k_R_e_c_e_n_t_F_i_l_t_e_r

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

     A filter for selecting a subset of recently used files

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

     'gtkRecentFilterNew()'
      'gtkRecentFilterGetName(object)'
      'gtkRecentFilterSetName(object, name)'
      'gtkRecentFilterAddMimeType(object, mime.type)'
      'gtkRecentFilterAddPattern(object, pattern)'
      'gtkRecentFilterAddPixbufFormats(object)'
      'gtkRecentFilterAddApplication(object, application)'
      'gtkRecentFilterAddGroup(object, group)'
      'gtkRecentFilterAddAge(object, days)'
      'gtkRecentFilterAddCustom(object, needed, func, data)'
      'gtkRecentFilterGetNeeded(object)'
      'gtkRecentFilterFilter(object, filter.info)'
      'gtkRecentFilter()'

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

     GObject
        +----GInitiallyUnowned
              +----GtkObject
                    +----GtkRecentFilter 

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

     A 'GtkRecentFilter' can be used to restrict the files being shown
     in a 'GtkRecentChooser'.  Files can be filtered based on their
     name (with 'gtkRecentFilterAddPattern'), on their mime type (with
     'gtkFileFilterAddMimeType'), on the application that has
     registered them (with 'gtkRecentFilterAddApplication'), or by a
     custom filter function (with 'gtkRecentFilterAddCustom').

     Filtering by mime type handles aliasing and subclassing of mime
     types; e.g. a filter for text/plain also matches a file with mime
     type application/rtf, since application/rtf is a subclass of
     text/plain. Note that 'GtkRecentFilter' allows wildcards for the
     subtype of a mime type, so you can e.g. filter for image/*.

     Normally, filters are used by adding them to a 'GtkRecentChooser',
     see 'gtkRecentChooserAddFilter', but it is also possible to
     manually use a filter on a file with 'gtkRecentFilterFilter'.

     Recently used files are supported since GTK+ 2.10.

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


     '_G_t_k_R_e_c_e_n_t_F_i_l_t_e_r' The 'GtkRecentFilter' struct contains only
          private fields and should not be directly accessed.


     '_G_t_k_R_e_c_e_n_t_F_i_l_t_e_r_I_n_f_o' A 'GtkRecentFilterInfo' struct is used to
          pass information about the tested file to
          'gtkRecentFilterFilter'. *'GtkRecentFilterInfo' is a
          transparent-type.*

          '_c_o_n_t_a_i_n_s' ['GtkRecentFilterFlags'] Flags indicating which of
               the following fields need are filled

          '_u_r_i' [character] the URI of the file being tested

          '_d_i_s_p_l_a_y_N_a_m_e' [character] the string that will be used to
               display the file in the recent chooser

          '_m_i_m_e_T_y_p_e' [character] the mime type of the file

          '_a_p_p_l_i_c_a_t_i_o_n_s' [character] the list of applications that have
               registered the file

          '_g_r_o_u_p_s' [character] the groups to which the file belongs to

          '_a_g_e' [integer] the number of days elapsed since the file has
               been registered


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

     'gtkRecentFilter' is the equivalent of 'gtkRecentFilterNew'.

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


     '_G_t_k_R_e_c_e_n_t_F_i_l_t_e_r_F_l_a_g_s' These flags indicate what parts of a
          'GtkRecentFilterInfo' struct are filled or need to be filled.

          '_u_r_i' the URI of the file being tested

          '_d_i_s_p_l_a_y-_n_a_m_e' the string that will be used to display the
               file in the recent chooser

          '_m_i_m_e-_t_y_p_e' the mime type of the file

          '_a_p_p_l_i_c_a_t_i_o_n' the list of applications that have registered
               the file

          '_g_r_o_u_p' the groups to which the file belongs to

          '_a_g_e' the number of days elapsed since the file has been
               registered


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


     '_G_t_k_R_e_c_e_n_t_F_i_l_t_e_r_F_u_n_c(_f_i_l_t_e_r._i_n_f_o, _u_s_e_r._d_a_t_a)' The type of function
          that is used with custom filters, see
          'gtkRecentFilterAddCustom'.

          '_f_i_l_t_e_r._i_n_f_o' ['GtkRecentFilterInfo'] a 'GtkRecentFilterInfo'
               that is filled according to the 'needed' flags passed to
               'gtkRecentFilterAddCustom'

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

          _Returns:_ [logical] 'TRUE' if the file should be displayed


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

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

     'GtkRecentChooser'

