1 /* GTK - The GIMP Toolkit
2 * gtkrecentfilter.h - Filter object for recently used resources
3 * Copyright (C) 2006, Emmanuele Bassi
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.
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.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 * Boston, MA 02111-1307, USA.
24 #include "gtkrecentfilter.h"
26 #include "gtkprivate.h"
30 typedef struct _GtkRecentFilterClass GtkRecentFilterClass;
31 typedef struct _FilterRule FilterRule;
35 FILTER_RULE_DISPLAY_NAME,
36 FILTER_RULE_MIME_TYPE,
37 FILTER_RULE_PIXBUF_FORMATS,
38 FILTER_RULE_APPLICATION,
44 struct _GtkRecentFilter
46 GtkObject parent_instance;
51 GtkRecentFilterFlags needed;
54 struct _GtkRecentFilterClass
56 GtkObjectClass parent_class;
62 GtkRecentFilterFlags needed;
68 GSList *pixbuf_formats;
73 GtkRecentFilterFunc func;
75 GDestroyNotify data_destroy;
80 G_DEFINE_TYPE (GtkRecentFilter, gtk_recent_filter, GTK_TYPE_OBJECT)
84 filter_rule_free (FilterRule *rule)
88 case FILTER_RULE_MIME_TYPE:
89 g_free (rule->u.mime_type);
94 case FILTER_RULE_DISPLAY_NAME:
95 g_free (rule->u.pattern);
97 case FILTER_RULE_PIXBUF_FORMATS:
98 g_slist_free (rule->u.pixbuf_formats);
100 case FILTER_RULE_AGE:
102 case FILTER_RULE_APPLICATION:
103 g_free (rule->u.application);
105 case FILTER_RULE_GROUP:
106 g_free (rule->u.group);
108 case FILTER_RULE_CUSTOM:
109 if (rule->u.custom.data_destroy)
110 rule->u.custom.data_destroy (rule->u.custom.data);
113 g_assert_not_reached ();
121 gtk_recent_filter_finalize (GObject *object)
123 GtkRecentFilter *filter = GTK_RECENT_FILTER (object);
125 g_free (filter->name);
129 g_slist_foreach (filter->rules,
130 (GFunc) filter_rule_free,
132 g_slist_free (filter->rules);
135 G_OBJECT_CLASS (gtk_recent_filter_parent_class)->finalize (object);
139 gtk_recent_filter_class_init (GtkRecentFilterClass *klass)
141 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
143 gobject_class->finalize = gtk_recent_filter_finalize;
147 gtk_recent_filter_init (GtkRecentFilter *filter)
157 * gtk_recent_filter_new:
159 * Creates a new #GtkRecentFilter with no rules added to it.
160 * Such filter does not accept any recently used resources, so is not
161 * particularly useful until you add rules with
162 * gtk_recent_filter_add_pattern(), gtk_recent_filter_add_mime_type(),
163 * gtk_recent_filter_add_application(), gtk_recent_filter_add_age().
164 * To create a filter that accepts any recently used resource, use:
166 * GtkRecentFilter *filter = gtk_recent_filter_new ();
167 * gtk_recent_filter_add_pattern (filter, "*");
170 * Return value: a new #GtkRecentFilter
175 gtk_recent_filter_new (void)
177 return g_object_new (GTK_TYPE_RECENT_FILTER, NULL);
181 * gtk_recent_filter_set_name:
182 * @filter: a #GtkRecentFilter
183 * @name: then human readable name of @filter
185 * Sets the human-readable name of the filter; this is the string
186 * that will be displayed in the recently used resources selector
187 * user interface if there is a selectable list of filters.
192 gtk_recent_filter_set_name (GtkRecentFilter *filter,
195 g_return_if_fail (GTK_IS_RECENT_FILTER (filter));
197 g_free (filter->name);
200 filter->name = g_strdup (name);
204 * gtk_recent_filter_get_name:
205 * @filter: a #GtkRecentFilter
207 * Gets the human-readable name for the filter.
208 * See gtk_recent_filter_set_name().
210 * Return value: the name of the filter, or %NULL. The returned string
211 * is owned by the filter object and should not be freed.
215 G_CONST_RETURN gchar *
216 gtk_recent_filter_get_name (GtkRecentFilter *filter)
218 g_return_val_if_fail (GTK_IS_RECENT_FILTER (filter), NULL);
224 * gtk_recent_filter_get_needed:
225 * @filter: a #GtkRecentFilter
227 * Gets the fields that need to be filled in for the structure
228 * passed to gtk_recent_filter_filter()
230 * This function will not typically be used by applications; it
231 * is intended principally for use in the implementation of
234 * Return value: bitfield of flags indicating needed fields when
235 * calling gtk_recent_filter_filter()
240 gtk_recent_filter_get_needed (GtkRecentFilter *filter)
242 return filter->needed;
246 recent_filter_add_rule (GtkRecentFilter *filter,
249 filter->needed |= rule->needed;
250 filter->rules = g_slist_append (filter->rules, rule);
254 * gtk_recent_filter_add_mime_type:
255 * @filter: a #GtkRecentFilter
256 * @mime_type: a MIME type
258 * Adds a rule that allows resources based on their registered MIME type.
263 gtk_recent_filter_add_mime_type (GtkRecentFilter *filter,
264 const gchar *mime_type)
268 g_return_if_fail (GTK_IS_RECENT_FILTER (filter));
269 g_return_if_fail (mime_type != NULL);
271 rule = g_new0 (FilterRule, 1);
272 rule->type = FILTER_RULE_MIME_TYPE;
273 rule->needed = GTK_RECENT_FILTER_MIME_TYPE;
274 rule->u.mime_type = g_strdup (mime_type);
276 recent_filter_add_rule (filter, rule);
280 * gtk_recent_filter_add_pattern:
281 * @filter: a #GtkRecentFilter
282 * @pattern: a file pattern
284 * Adds a rule that allows resources based on a pattern matching their
290 gtk_recent_filter_add_pattern (GtkRecentFilter *filter,
291 const gchar *pattern)
295 g_return_if_fail (GTK_IS_RECENT_FILTER (filter));
296 g_return_if_fail (pattern != NULL);
298 rule = g_new0 (FilterRule, 1);
299 rule->type = FILTER_RULE_DISPLAY_NAME;
300 rule->needed = GTK_RECENT_FILTER_DISPLAY_NAME;
301 rule->u.pattern = g_strdup (pattern);
303 recent_filter_add_rule (filter, rule);
307 * gtk_recent_filter_add_pixbuf_formats:
308 * @filter: a #GtkRecentFilter
310 * Adds a rule allowing image files in the formats supported
316 gtk_recent_filter_add_pixbuf_formats (GtkRecentFilter *filter)
320 g_return_if_fail (GTK_IS_RECENT_FILTER (filter));
322 rule = g_new0 (FilterRule, 1);
323 rule->type = FILTER_RULE_PIXBUF_FORMATS;
324 rule->needed = GTK_RECENT_FILTER_MIME_TYPE;
325 rule->u.pixbuf_formats = gdk_pixbuf_get_formats ();
327 recent_filter_add_rule (filter, rule);
331 * gtk_recent_filter_add_application:
332 * @filter: a #GtkRecentFilter
333 * @application: an application name
335 * Adds a rule that allows resources based on the name of the application
336 * that has registered them.
341 gtk_recent_filter_add_application (GtkRecentFilter *filter,
342 const gchar *application)
346 g_return_if_fail (GTK_IS_RECENT_FILTER (filter));
347 g_return_if_fail (application != NULL);
349 rule = g_new0 (FilterRule, 1);
350 rule->type = FILTER_RULE_APPLICATION;
351 rule->needed = GTK_RECENT_FILTER_APPLICATION;
352 rule->u.application = g_strdup (application);
354 recent_filter_add_rule (filter, rule);
358 * gtk_recent_filter_add_group:
359 * @filter: a #GtkRecentFilter
360 * @group: a group name
362 * Adds a rule that allows resources based on the name of the group
363 * to which they belong
368 gtk_recent_filter_add_group (GtkRecentFilter *filter,
373 g_return_if_fail (GTK_IS_RECENT_FILTER (filter));
374 g_return_if_fail (group != NULL);
376 rule = g_new0 (FilterRule, 1);
377 rule->type = FILTER_RULE_GROUP;
378 rule->needed = GTK_RECENT_FILTER_GROUP;
379 rule->u.group = g_strdup (group);
381 recent_filter_add_rule (filter, rule);
385 * gtk_recent_filter_add_age:
386 * @filter: a #GtkRecentFilter
387 * @days: number of days
389 * Adds a rule that allows resources based on their age - that is, the number
390 * of days elapsed since they were last modified.
395 gtk_recent_filter_add_age (GtkRecentFilter *filter,
400 g_return_if_fail (GTK_IS_RECENT_FILTER (filter));
402 rule = g_new0 (FilterRule, 1);
403 rule->type = FILTER_RULE_AGE;
404 rule->needed = GTK_RECENT_FILTER_AGE;
407 recent_filter_add_rule (filter, rule);
411 * gtk_recent_filter_add_custom:
412 * @filter: a #GtkRecentFilter
413 * @needed: bitfield of flags indicating the information that the custom
414 * filter function needs.
415 * @func: callback function; if the function returns %TRUE, then
416 * the file will be displayed.
417 * @data: data to pass to @func
418 * @data_destroy: function to call to free @data when it is no longer needed.
420 * Adds a rule to a filter that allows resources based on a custom callback
421 * function. The bitfield @needed which is passed in provides information
422 * about what sorts of information that the filter function needs;
423 * this allows GTK+ to avoid retrieving expensive information when
424 * it isn't needed by the filter.
429 gtk_recent_filter_add_custom (GtkRecentFilter *filter,
430 GtkRecentFilterFlags needed,
431 GtkRecentFilterFunc func,
433 GDestroyNotify data_destroy)
437 g_return_if_fail (GTK_IS_RECENT_FILTER (filter));
438 g_return_if_fail (func != NULL);
440 rule = g_new0 (FilterRule, 1);
441 rule->type = FILTER_RULE_CUSTOM;
442 rule->needed = needed;
443 rule->u.custom.func = func;
444 rule->u.custom.data = data;
445 rule->u.custom.data_destroy = data_destroy;
447 recent_filter_add_rule (filter, rule);
452 * gtk_recent_filter_filter:
453 * @filter: a #GtkRecentFilter
454 * @filter_info: a #GtkRecentFilterInfo structure containing information
455 * about a recently used resource
457 * Tests whether a file should be displayed according to @filter.
458 * The #GtkRecentFilterInfo structure @filter_info should include
459 * the fields returned from gtk_recent_filter_get_needed().
461 * This function will not typically be used by applications; it
462 * is intended principally for use in the implementation of
465 * Return value: %TRUE if the file should be displayed
470 gtk_recent_filter_filter (GtkRecentFilter *filter,
471 const GtkRecentFilterInfo *filter_info)
475 g_return_val_if_fail (GTK_IS_RECENT_FILTER (filter), FALSE);
476 g_return_val_if_fail (filter_info != NULL, FALSE);
478 for (l = filter->rules; l != NULL; l = l->next)
480 FilterRule *rule = (FilterRule *) l->data;
482 if ((filter_info->contains & rule->needed) != rule->needed)
487 case FILTER_RULE_MIME_TYPE:
488 if (filter_info->mime_type != NULL &&
489 g_content_type_is_a (filter_info->mime_type, rule->u.mime_type))
492 case FILTER_RULE_APPLICATION:
493 if (filter_info->applications)
497 for (i = 0; filter_info->applications[i] != NULL; i++)
499 if (strcmp (filter_info->applications[i], rule->u.application) == 0)
504 case FILTER_RULE_GROUP:
505 if (filter_info->groups)
509 for (i = 0; filter_info->groups[i] != NULL; i++)
511 if (strcmp (filter_info->groups[i], rule->u.group) == 0)
516 case FILTER_RULE_PIXBUF_FORMATS:
519 if (!filter_info->mime_type)
522 for (list = rule->u.pixbuf_formats; list; list = list->next)
527 mime_types = gdk_pixbuf_format_get_mime_types (list->data);
529 for (i = 0; mime_types[i] != NULL; i++)
531 if (strcmp (mime_types[i], filter_info->mime_type) == 0)
533 g_strfreev (mime_types);
538 g_strfreev (mime_types);
542 case FILTER_RULE_URI:
543 if ((filter_info->uri != NULL) &&
544 _gtk_fnmatch (rule->u.uri, filter_info->uri, FALSE))
547 case FILTER_RULE_DISPLAY_NAME:
548 if ((filter_info->display_name != NULL) &&
549 _gtk_fnmatch (rule->u.pattern, filter_info->display_name, FALSE))
552 case FILTER_RULE_AGE:
553 if ((filter_info->age != -1) &&
554 (filter_info->age < rule->u.age))
557 case FILTER_RULE_CUSTOM:
558 if (rule->u.custom.func (filter_info, rule->u.custom.data))
567 #define __GTK_RECENT_FILTER_C__
568 #include "gtkaliasdef.c"