1/* GTK - The GIMP Toolkit
2 * gtkrecentfilter.h - Filter object for recently used resources
3 * Copyright (C) 2006, Emmanuele Bassi
4 *
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
9 *
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
14 *
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
17 */
18
19#ifndef __GTK_RECENT_FILTER_H__
20#define __GTK_RECENT_FILTER_H__
21
22#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
23#error "Only <gtk/gtk.h> can be included directly."
24#endif
25
26#include <glib-object.h>
27#include <gdk/gdk.h>
28
29G_BEGIN_DECLS
30
31#define GTK_TYPE_RECENT_FILTER (gtk_recent_filter_get_type ())
32#define GTK_RECENT_FILTER(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_RECENT_FILTER, GtkRecentFilter))
33#define GTK_IS_RECENT_FILTER(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_RECENT_FILTER))
34
35typedef struct _GtkRecentFilter GtkRecentFilter;
36typedef struct _GtkRecentFilterInfo GtkRecentFilterInfo;
37
38/**
39 * GtkRecentFilterFlags:
40 * @GTK_RECENT_FILTER_URI: the URI of the file being tested
41 * @GTK_RECENT_FILTER_DISPLAY_NAME: the string that will be used to
42 * display the file in the recent chooser
43 * @GTK_RECENT_FILTER_MIME_TYPE: the mime type of the file
44 * @GTK_RECENT_FILTER_APPLICATION: the list of applications that have
45 * registered the file
46 * @GTK_RECENT_FILTER_GROUP: the groups to which the file belongs to
47 * @GTK_RECENT_FILTER_AGE: the number of days elapsed since the file
48 * has been registered
49 *
50 * These flags indicate what parts of a #GtkRecentFilterInfo struct
51 * are filled or need to be filled.
52 */
53typedef enum {
54 GTK_RECENT_FILTER_URI = 1 << 0,
55 GTK_RECENT_FILTER_DISPLAY_NAME = 1 << 1,
56 GTK_RECENT_FILTER_MIME_TYPE = 1 << 2,
57 GTK_RECENT_FILTER_APPLICATION = 1 << 3,
58 GTK_RECENT_FILTER_GROUP = 1 << 4,
59 GTK_RECENT_FILTER_AGE = 1 << 5
60} GtkRecentFilterFlags;
61
62/**
63 * GtkRecentFilterFunc:
64 * @filter_info: a #GtkRecentFilterInfo that is filled according
65 * to the @needed flags passed to gtk_recent_filter_add_custom()
66 * @user_data: user data passed to gtk_recent_filter_add_custom()
67 *
68 * The type of function that is used with custom filters,
69 * see gtk_recent_filter_add_custom().
70 *
71 * Returns: %TRUE if the file should be displayed
72 */
73typedef gboolean (*GtkRecentFilterFunc) (const GtkRecentFilterInfo *filter_info,
74 gpointer user_data);
75
76
77/**
78 * GtkRecentFilterInfo:
79 * @contains: #GtkRecentFilterFlags to indicate which fields are set.
80 * @uri: (nullable): The URI of the file being tested.
81 * @display_name: (nullable): The string that will be used to display
82 * the file in the recent chooser.
83 * @mime_type: (nullable): MIME type of the file.
84 * @applications: (nullable) (array zero-terminated=1): The list of
85 * applications that have registered the file.
86 * @groups: (nullable) (array zero-terminated=1): The groups to which
87 * the file belongs to.
88 * @age: The number of days elapsed since the file has been
89 * registered.
90 *
91 * A GtkRecentFilterInfo struct is used
92 * to pass information about the tested file to gtk_recent_filter_filter().
93 */
94struct _GtkRecentFilterInfo
95{
96 GtkRecentFilterFlags contains;
97
98 const gchar *uri;
99 const gchar *display_name;
100 const gchar *mime_type;
101 const gchar **applications;
102 const gchar **groups;
103
104 gint age;
105};
106
107GDK_AVAILABLE_IN_ALL
108GType gtk_recent_filter_get_type (void) G_GNUC_CONST;
109
110GDK_AVAILABLE_IN_ALL
111GtkRecentFilter * gtk_recent_filter_new (void);
112GDK_AVAILABLE_IN_ALL
113void gtk_recent_filter_set_name (GtkRecentFilter *filter,
114 const gchar *name);
115GDK_AVAILABLE_IN_ALL
116const gchar * gtk_recent_filter_get_name (GtkRecentFilter *filter);
117
118GDK_AVAILABLE_IN_ALL
119void gtk_recent_filter_add_mime_type (GtkRecentFilter *filter,
120 const gchar *mime_type);
121GDK_AVAILABLE_IN_ALL
122void gtk_recent_filter_add_pattern (GtkRecentFilter *filter,
123 const gchar *pattern);
124GDK_AVAILABLE_IN_ALL
125void gtk_recent_filter_add_pixbuf_formats (GtkRecentFilter *filter);
126GDK_AVAILABLE_IN_ALL
127void gtk_recent_filter_add_application (GtkRecentFilter *filter,
128 const gchar *application);
129GDK_AVAILABLE_IN_ALL
130void gtk_recent_filter_add_group (GtkRecentFilter *filter,
131 const gchar *group);
132GDK_AVAILABLE_IN_ALL
133void gtk_recent_filter_add_age (GtkRecentFilter *filter,
134 gint days);
135GDK_AVAILABLE_IN_ALL
136void gtk_recent_filter_add_custom (GtkRecentFilter *filter,
137 GtkRecentFilterFlags needed,
138 GtkRecentFilterFunc func,
139 gpointer data,
140 GDestroyNotify data_destroy);
141
142GDK_AVAILABLE_IN_ALL
143GtkRecentFilterFlags gtk_recent_filter_get_needed (GtkRecentFilter *filter);
144GDK_AVAILABLE_IN_ALL
145gboolean gtk_recent_filter_filter (GtkRecentFilter *filter,
146 const GtkRecentFilterInfo *filter_info);
147
148G_END_DECLS
149
150#endif /* ! __GTK_RECENT_FILTER_H__ */
151

source code of include/gtk-3.0/gtk/gtkrecentfilter.h