|  |  |  | GTK+ 3 Reference Manual |  | 
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Implemented Interfaces | ||||
#include <gtk/gtk.h>
                    GtkRecentFilter;
struct              GtkRecentFilterInfo;
enum                GtkRecentFilterFlags;
gboolean            (*GtkRecentFilterFunc)              (const GtkRecentFilterInfo *filter_info,
                                                         gpointer user_data);
GtkRecentFilter *      gtk_recent_filter_new            (void);
const gchar *          gtk_recent_filter_get_name       (GtkRecentFilter *filter);
void                gtk_recent_filter_set_name          (GtkRecentFilter *filter,
                                                         const gchar *name);
void                gtk_recent_filter_add_mime_type     (GtkRecentFilter *filter,
                                                         const gchar *mime_type);
void                gtk_recent_filter_add_pattern       (GtkRecentFilter *filter,
                                                         const gchar *pattern);
void                gtk_recent_filter_add_pixbuf_formats
                                                        (GtkRecentFilter *filter);
void                gtk_recent_filter_add_application   (GtkRecentFilter *filter,
                                                         const gchar *application);
void                gtk_recent_filter_add_group         (GtkRecentFilter *filter,
                                                         const gchar *group);
void                gtk_recent_filter_add_age           (GtkRecentFilter *filter,
                                                         gint days);
void                gtk_recent_filter_add_custom        (GtkRecentFilter *filter,
                                                         GtkRecentFilterFlags needed,
                                                         GtkRecentFilterFunc func,
                                                         gpointer data,
                                                         GDestroyNotify data_destroy);
GtkRecentFilterFlags  gtk_recent_filter_get_needed      (GtkRecentFilter *filter);
gboolean            gtk_recent_filter_filter            (GtkRecentFilter *filter,
                                                         const GtkRecentFilterInfo *filter_info);
A GtkRecentFilter can be used to restrict the files being shown
in a GtkRecentChooser.  Files can be filtered based on their name
(with gtk_recent_filter_add_pattern()), on their mime type (with
gtk_file_filter_add_mime_type()), on the application that has
registered them (with gtk_recent_filter_add_application()), or by
a custom filter function (with gtk_recent_filter_add_custom()).
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 gtk_recent_chooser_add_filter(), but it is also possible to
manually use a filter on a file with gtk_recent_filter_filter().
Recently used files are supported since GTK+ 2.10.
The GtkRecentFilter implementation of the GtkBuildable interface
supports adding rules using the <mime-types>, <patterns> and
<applications> elements and listing the rules within. Specifying
a <mime-type>, <pattern> or <application> is the same
as calling gtk_recent_filter_add_mime_type(), gtk_recent_filter_add_pattern()
or gtk_recent_filter_add_application().
Example 108. A UI definition fragment specifying GtkRecentFilter rules
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | <object class="GtkRecentFilter"> <mime-types> <mime-type>text/plain</mime-type> <mime-type>image/png</mime-type> </mime-types> <patterns> <pattern>*.txt</pattern> <pattern>*.png</pattern> </patterns> <applications> <application>gimp</application> <application>gedit</application> <application>glade</application> </applications> </object> | 
struct GtkRecentFilterInfo {
  GtkRecentFilterFlags contains;
  const gchar *uri;
  const gchar *display_name;
  const gchar *mime_type;
  const gchar **applications;
  const gchar **groups;
  gint age;
};
A GtkRecentFilterInfo struct is used
to pass information about the tested file to gtk_recent_filter_filter().
typedef enum {
  GTK_RECENT_FILTER_URI          = 1 << 0,
  GTK_RECENT_FILTER_DISPLAY_NAME = 1 << 1,
  GTK_RECENT_FILTER_MIME_TYPE    = 1 << 2,
  GTK_RECENT_FILTER_APPLICATION  = 1 << 3,
  GTK_RECENT_FILTER_GROUP        = 1 << 4,
  GTK_RECENT_FILTER_AGE          = 1 << 5
} GtkRecentFilterFlags;
These flags indicate what parts of a GtkRecentFilterInfo struct are filled or need to be filled.
| the URI of the file being tested | |
| the string that will be used to display the file in the recent chooser | |
| the mime type of the file | |
| the list of applications that have registered the file | |
| the groups to which the file belongs to | |
| the number of days elapsed since the file has been registered | 
gboolean (*GtkRecentFilterFunc) (const GtkRecentFilterInfo *filter_info,gpointer user_data);
The type of function that is used with custom filters,
see gtk_recent_filter_add_custom().
| 
 | a GtkRecentFilterInfo that is filled according
to the neededflags passed togtk_recent_filter_add_custom() | 
| 
 | user data passed to gtk_recent_filter_add_custom() | 
| Returns : | TRUEif the file should be displayed | 
GtkRecentFilter *      gtk_recent_filter_new            (void);
Creates a new GtkRecentFilter with no rules added to it.
Such filter does not accept any recently used resources, so is not
particularly useful until you add rules with
gtk_recent_filter_add_pattern(), gtk_recent_filter_add_mime_type(),
gtk_recent_filter_add_application(), gtk_recent_filter_add_age().
To create a filter that accepts any recently used resource, use:
| 1 2 | GtkRecentFilter *filter = gtk_recent_filter_new (); gtk_recent_filter_add_pattern (filter, "*"); | 
| Returns : | a new GtkRecentFilter | 
Since 2.10
const gchar *          gtk_recent_filter_get_name       (GtkRecentFilter *filter);
Gets the human-readable name for the filter.
See gtk_recent_filter_set_name().
| 
 | a GtkRecentFilter | 
| Returns : | the name of the filter, or NULL.  The returned string
is owned by the filter object and should not be freed. | 
Since 2.10
void gtk_recent_filter_set_name (GtkRecentFilter *filter,const gchar *name);
Sets the human-readable name of the filter; this is the string that will be displayed in the recently used resources selector user interface if there is a selectable list of filters.
| 
 | a GtkRecentFilter | 
| 
 | then human readable name of filter | 
Since 2.10
void gtk_recent_filter_add_mime_type (GtkRecentFilter *filter,const gchar *mime_type);
Adds a rule that allows resources based on their registered MIME type.
| 
 | a GtkRecentFilter | 
| 
 | a MIME type | 
Since 2.10
void gtk_recent_filter_add_pattern (GtkRecentFilter *filter,const gchar *pattern);
Adds a rule that allows resources based on a pattern matching their display name.
| 
 | a GtkRecentFilter | 
| 
 | a file pattern | 
Since 2.10
void                gtk_recent_filter_add_pixbuf_formats
                                                        (GtkRecentFilter *filter);
Adds a rule allowing image files in the formats supported by GdkPixbuf.
| 
 | a GtkRecentFilter | 
Since 2.10
void gtk_recent_filter_add_application (GtkRecentFilter *filter,const gchar *application);
Adds a rule that allows resources based on the name of the application that has registered them.
| 
 | a GtkRecentFilter | 
| 
 | an application name | 
Since 2.10
void gtk_recent_filter_add_group (GtkRecentFilter *filter,const gchar *group);
Adds a rule that allows resources based on the name of the group to which they belong
| 
 | a GtkRecentFilter | 
| 
 | a group name | 
Since 2.10
void gtk_recent_filter_add_age (GtkRecentFilter *filter,gint days);
Adds a rule that allows resources based on their age - that is, the number of days elapsed since they were last modified.
| 
 | a GtkRecentFilter | 
| 
 | number of days | 
Since 2.10
void gtk_recent_filter_add_custom (GtkRecentFilter *filter,GtkRecentFilterFlags needed,GtkRecentFilterFunc func,gpointer data,GDestroyNotify data_destroy);
Adds a rule to a filter that allows resources based on a custom callback
function. The bitfield needed which is passed in provides information
about what sorts of information that the filter function needs;
this allows GTK+ to avoid retrieving expensive information when
it isn't needed by the filter.
| 
 | a GtkRecentFilter | 
| 
 | bitfield of flags indicating the information that the custom filter function needs. | 
| 
 | callback function; if the function returns TRUE, then
the file will be displayed. | 
| 
 | data to pass to func | 
| 
 | function to call to free datawhen it is no longer needed. | 
Since 2.10
GtkRecentFilterFlags  gtk_recent_filter_get_needed      (GtkRecentFilter *filter);
Gets the fields that need to be filled in for the structure
passed to gtk_recent_filter_filter()
This function will not typically be used by applications; it is intended principally for use in the implementation of GtkRecentChooser.
| 
 | a GtkRecentFilter | 
| Returns : | bitfield of flags indicating needed fields when
calling gtk_recent_filter_filter() | 
Since 2.10
gboolean gtk_recent_filter_filter (GtkRecentFilter *filter,const GtkRecentFilterInfo *filter_info);
Tests whether a file should be displayed according to filter.
The GtkRecentFilterInfo structure filter_info should include
the fields returned from gtk_recent_filter_get_needed().
This function will not typically be used by applications; it is intended principally for use in the implementation of GtkRecentChooser.
| 
 | a GtkRecentFilter | 
| 
 | a GtkRecentFilterInfo structure containing information about a recently used resource | 
| Returns : | TRUEif the file should be displayed | 
Since 2.10