gtk-gtkfilefilter           package:RGtk2           R Documentation

_G_t_k_F_i_l_e_F_i_l_t_e_r

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

     A filter for selecting a file subset

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

     'gtkFileFilterNew()'
      'gtkFileFilterSetName(object, name)'
      'gtkFileFilterGetName(object)'
      'gtkFileFilterAddMimeType(object, mime.type)'
      'gtkFileFilterAddPattern(object, pattern)'
      'gtkFileFilterAddPixbufFormats(object)'
      'gtkFileFilterAddCustom(object, needed, func, data = NULL)'
      'gtkFileFilterGetNeeded(object)'
      'gtkFileFilterFilter(object, filter.info)'
      'gtkFileFilter()'

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

     GObject
        +----GInitiallyUnowned
              +----GtkObject
                    +----GtkFileFilter 

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

     A GtkFileFilter can be used to restrict the files being shown in a
     'GtkFileChooser'. Files can be filtered based on their name (with
     'gtkFileFilterAddPattern'), on their mime type (with
     'gtkFileFilterAddMimeType'), or by a custom filter function (with
     'gtkFileFilterAddCustom'). 

     Filtering by mime types 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 'GtkFileFilter' 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 'GtkFileChooser',
     see 'gtkFileChooserAddFilter', but it is also possible to manually
     use a filter on a file with 'gtkFileFilterFilter'.

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


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


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

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

          '_f_i_l_e_n_a_m_e' [character] the filename of the file being tested

          '_u_r_i' [character] the URI for 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 file chooser

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


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

     'gtkFileFilter' is the equivalent of 'gtkFileFilterNew'.

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


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

          '_f_i_l_e_n_a_m_e' the filename of the file being tested

          '_u_r_i' the URI for 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 file chooser

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


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


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

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

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

          _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/gtk-gtkfilefilter.html>

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

     'GtkFileChooser'

