1 /* gtkrecentchooserutils.h - Private utility functions for implementing a
2 * GtkRecentChooser interface
4 * Copyright (C) 2006 Emmanuele Bassi
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Library General Public
10 * License as published by the Free Software Foundation; either
11 * version 2 of the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Library General Public License for more details.
18 * You should have received a copy of the GNU Library General Public
19 * License along with this library; if not, write to the
20 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 * Boston, MA 02111-1307, USA.
23 * Based on gtkfilechooserutils.c:
24 * Copyright (C) 2003 Red Hat, Inc.
29 #include "gtkrecentchooserutils.h"
33 static void delegate_set_sort_func (GtkRecentChooser *chooser,
34 GtkRecentSortFunc sort_func,
36 GDestroyNotify data_destroy);
37 static void delegate_add_filter (GtkRecentChooser *chooser,
38 GtkRecentFilter *filter);
39 static void delegate_remove_filter (GtkRecentChooser *chooser,
40 GtkRecentFilter *filter);
41 static GSList *delegate_list_filters (GtkRecentChooser *chooser);
42 static gboolean delegate_select_uri (GtkRecentChooser *chooser,
45 static void delegate_unselect_uri (GtkRecentChooser *chooser,
47 static GList *delegate_get_items (GtkRecentChooser *chooser);
48 static GtkRecentManager *delegate_get_recent_manager (GtkRecentChooser *chooser);
49 static void delegate_select_all (GtkRecentChooser *chooser);
50 static void delegate_unselect_all (GtkRecentChooser *chooser);
51 static gboolean delegate_set_current_uri (GtkRecentChooser *chooser,
54 static gchar * delegate_get_current_uri (GtkRecentChooser *chooser);
57 static void delegate_notify (GObject *object,
60 static void delegate_selection_changed (GtkRecentChooser *receiver,
62 static void delegate_item_activated (GtkRecentChooser *receiver,
66 * _gtk_recent_chooser_install_properties:
67 * @klass: the class structure for a type deriving from #GObject
69 * Installs the necessary properties for a class implementing
70 * #GtkRecentChooser. A #GtkParamSpecOverride property is installed
71 * for each property, using the values from the #GtkRecentChooserProp
72 * enumeration. The caller must make sure itself that the enumeration
73 * values don't collide with some other property values they
77 _gtk_recent_chooser_install_properties (GObjectClass *klass)
79 g_object_class_override_property (klass,
80 GTK_RECENT_CHOOSER_PROP_RECENT_MANAGER,
82 g_object_class_override_property (klass,
83 GTK_RECENT_CHOOSER_PROP_SHOW_PRIVATE,
85 g_object_class_override_property (klass,
86 GTK_RECENT_CHOOSER_PROP_SHOW_TIPS,
88 g_object_class_override_property (klass,
89 GTK_RECENT_CHOOSER_PROP_SHOW_ICONS,
91 g_object_class_override_property (klass,
92 GTK_RECENT_CHOOSER_PROP_SHOW_NOT_FOUND,
94 g_object_class_override_property (klass,
95 GTK_RECENT_CHOOSER_PROP_SELECT_MULTIPLE,
97 g_object_class_override_property (klass,
98 GTK_RECENT_CHOOSER_PROP_LIMIT,
100 g_object_class_override_property (klass,
101 GTK_RECENT_CHOOSER_PROP_LOCAL_ONLY,
103 g_object_class_override_property (klass,
104 GTK_RECENT_CHOOSER_PROP_SORT_TYPE,
106 g_object_class_override_property (klass,
107 GTK_RECENT_CHOOSER_PROP_FILTER,
112 * _gtk_recent_chooser_delegate_iface_init:
113 * @iface: a #GtkRecentChooserIface
115 * An interface-initialization function for use in cases where
116 * an object is simply delegating the methods, signals of
117 * the #GtkRecentChooser interface to another object.
118 * _gtk_recent_chooser_set_delegate() must be called on each
119 * instance of the object so that the delegate object can
123 _gtk_recent_chooser_delegate_iface_init (GtkRecentChooserIface *iface)
125 iface->set_current_uri = delegate_set_current_uri;
126 iface->get_current_uri = delegate_get_current_uri;
127 iface->select_uri = delegate_select_uri;
128 iface->unselect_uri = delegate_unselect_uri;
129 iface->select_all = delegate_select_all;
130 iface->unselect_all = delegate_unselect_all;
131 iface->get_items = delegate_get_items;
132 iface->get_recent_manager = delegate_get_recent_manager;
133 iface->set_sort_func = delegate_set_sort_func;
134 iface->add_filter = delegate_add_filter;
135 iface->remove_filter = delegate_remove_filter;
136 iface->list_filters = delegate_list_filters;
140 * _gtk_recent_chooser_set_delegate:
141 * @receiver: a #GObject implementing #GtkRecentChooser
142 * @delegate: another #GObject implementing #GtkRecentChooser
144 * Establishes that calls on @receiver for #GtkRecentChooser
145 * methods should be delegated to @delegate, and that
146 * #GtkRecentChooser signals emitted on @delegate should be
147 * forwarded to @receiver. Must be used in conjunction with
148 * _gtk_recent_chooser_delegate_iface_init().
151 _gtk_recent_chooser_set_delegate (GtkRecentChooser *receiver,
152 GtkRecentChooser *delegate)
154 g_return_if_fail (GTK_IS_RECENT_CHOOSER (receiver));
155 g_return_if_fail (GTK_IS_RECENT_CHOOSER (delegate));
157 g_object_set_data (G_OBJECT (receiver),
158 "gtk-recent-chooser-delegate", delegate);
160 g_signal_connect (delegate, "notify",
161 G_CALLBACK (delegate_notify), receiver);
162 g_signal_connect (delegate, "selection-changed",
163 G_CALLBACK (delegate_selection_changed), receiver);
164 g_signal_connect (delegate, "item_activated",
165 G_CALLBACK (delegate_item_activated), receiver);
169 _gtk_recent_chooser_delegate_get_quark (void)
171 static GQuark quark = 0;
173 if (G_UNLIKELY (quark == 0))
174 quark = g_quark_from_static_string ("gtk-recent-chooser-delegate");
179 static GtkRecentChooser *
180 get_delegate (GtkRecentChooser *receiver)
182 return g_object_get_qdata (G_OBJECT (receiver),
183 GTK_RECENT_CHOOSER_DELEGATE_QUARK);
187 delegate_set_sort_func (GtkRecentChooser *chooser,
188 GtkRecentSortFunc sort_func,
190 GDestroyNotify data_destroy)
192 gtk_recent_chooser_set_sort_func (get_delegate (chooser),
199 delegate_add_filter (GtkRecentChooser *chooser,
200 GtkRecentFilter *filter)
202 gtk_recent_chooser_add_filter (get_delegate (chooser), filter);
206 delegate_remove_filter (GtkRecentChooser *chooser,
207 GtkRecentFilter *filter)
209 gtk_recent_chooser_remove_filter (get_delegate (chooser), filter);
213 delegate_list_filters (GtkRecentChooser *chooser)
215 return gtk_recent_chooser_list_filters (get_delegate (chooser));
219 delegate_select_uri (GtkRecentChooser *chooser,
223 return gtk_recent_chooser_select_uri (get_delegate (chooser), uri, error);
227 delegate_unselect_uri (GtkRecentChooser *chooser,
230 gtk_recent_chooser_unselect_uri (get_delegate (chooser), uri);
234 delegate_get_items (GtkRecentChooser *chooser)
236 return gtk_recent_chooser_get_items (get_delegate (chooser));
239 static GtkRecentManager *
240 delegate_get_recent_manager (GtkRecentChooser *chooser)
242 return _gtk_recent_chooser_get_recent_manager (get_delegate (chooser));
246 delegate_select_all (GtkRecentChooser *chooser)
248 gtk_recent_chooser_select_all (get_delegate (chooser));
252 delegate_unselect_all (GtkRecentChooser *chooser)
254 gtk_recent_chooser_unselect_all (get_delegate (chooser));
258 delegate_set_current_uri (GtkRecentChooser *chooser,
262 return gtk_recent_chooser_set_current_uri (get_delegate (chooser), uri, error);
266 delegate_get_current_uri (GtkRecentChooser *chooser)
268 return gtk_recent_chooser_get_current_uri (get_delegate (chooser));
272 delegate_notify (GObject *object,
278 iface = g_type_interface_peek (g_type_class_peek (G_OBJECT_TYPE (object)),
279 gtk_recent_chooser_get_type ());
280 if (g_object_interface_find_property (iface, pspec->name))
281 g_object_notify (user_data, pspec->name);
285 delegate_selection_changed (GtkRecentChooser *receiver,
288 _gtk_recent_chooser_selection_changed (GTK_RECENT_CHOOSER (user_data));
292 delegate_item_activated (GtkRecentChooser *receiver,
295 _gtk_recent_chooser_item_activated (GTK_RECENT_CHOOSER (user_data));
299 sort_recent_items_mru (GtkRecentInfo *a,
303 g_assert (a != NULL && b != NULL);
305 return gtk_recent_info_get_modified (b) - gtk_recent_info_get_modified (a);
309 sort_recent_items_lru (GtkRecentInfo *a,
313 g_assert (a != NULL && b != NULL);
315 return -1 * (gtk_recent_info_get_modified (b) - gtk_recent_info_get_modified (a));
320 GtkRecentSortFunc func;
324 /* our proxy sorting function */
326 sort_recent_items_proxy (gpointer *a,
330 GtkRecentInfo *info_a = (GtkRecentInfo *) a;
331 GtkRecentInfo *info_b = (GtkRecentInfo *) b;
332 SortRecentData *sort_recent = user_data;
334 if (sort_recent->func)
335 return (* sort_recent->func) (info_a, info_b, sort_recent->data);
342 get_is_recent_filtered (GtkRecentFilter *filter,
345 GtkRecentFilterInfo filter_info;
346 GtkRecentFilterFlags needed;
349 g_assert (info != NULL);
351 needed = gtk_recent_filter_get_needed (filter);
353 filter_info.contains = GTK_RECENT_FILTER_URI | GTK_RECENT_FILTER_MIME_TYPE;
355 filter_info.uri = gtk_recent_info_get_uri (info);
356 filter_info.mime_type = gtk_recent_info_get_mime_type (info);
358 if (needed & GTK_RECENT_FILTER_DISPLAY_NAME)
360 filter_info.display_name = gtk_recent_info_get_display_name (info);
361 filter_info.contains |= GTK_RECENT_FILTER_DISPLAY_NAME;
364 filter_info.uri = NULL;
366 if (needed & GTK_RECENT_FILTER_APPLICATION)
368 filter_info.applications = (const gchar **) gtk_recent_info_get_applications (info, NULL);
369 filter_info.contains |= GTK_RECENT_FILTER_APPLICATION;
372 filter_info.applications = NULL;
374 if (needed & GTK_RECENT_FILTER_GROUP)
376 filter_info.groups = (const gchar **) gtk_recent_info_get_groups (info, NULL);
377 filter_info.contains |= GTK_RECENT_FILTER_GROUP;
380 filter_info.groups = NULL;
382 if (needed & GTK_RECENT_FILTER_AGE)
384 filter_info.age = gtk_recent_info_get_age (info);
385 filter_info.contains |= GTK_RECENT_FILTER_AGE;
388 filter_info.age = -1;
390 retval = gtk_recent_filter_filter (filter, &filter_info);
393 if (filter_info.applications)
394 g_strfreev ((gchar **) filter_info.applications);
395 if (filter_info.groups)
396 g_strfreev ((gchar **) filter_info.groups);
402 * _gtk_recent_chooser_get_items:
403 * @chooser: a #GtkRecentChooser
404 * @filter: a #GtkRecentFilter
405 * @sort_func: sorting function, or %NULL
406 * @sort_data: sorting function data, or %NULL
408 * Default implementation for getting the filtered, sorted and
409 * clamped list of recently used resources from a #GtkRecentChooser.
410 * This function should be used by implementations of the
411 * #GtkRecentChooser interface inside the GtkRecentChooser::get_items
414 * Return value: a list of #GtkRecentInfo objects
417 _gtk_recent_chooser_get_items (GtkRecentChooser *chooser,
418 GtkRecentFilter *filter,
419 GtkRecentSortFunc sort_func,
422 GtkRecentManager *manager;
424 GtkRecentSortType sort_type;
426 GCompareDataFunc compare_func;
429 g_return_val_if_fail (GTK_IS_RECENT_CHOOSER (chooser), NULL);
431 manager = _gtk_recent_chooser_get_recent_manager (chooser);
435 items = gtk_recent_manager_get_items (manager);
439 limit = gtk_recent_chooser_get_limit (chooser);
445 GList *filter_items, *l;
446 gboolean local_only = FALSE;
447 gboolean show_private = FALSE;
448 gboolean show_not_found = FALSE;
450 g_object_get (G_OBJECT (chooser),
451 "local-only", &local_only,
452 "show-private", &show_private,
453 "show-not-found", &show_not_found,
457 for (l = items; l != NULL; l = l->next)
459 GtkRecentInfo *info = l->data;
460 gboolean remove_item = FALSE;
462 if (get_is_recent_filtered (filter, info))
465 if (local_only && !gtk_recent_info_is_local (info))
468 if (!show_private && gtk_recent_info_get_private_hint (info))
471 if (!show_not_found && !gtk_recent_info_exists (info))
475 filter_items = g_list_prepend (filter_items, info);
477 gtk_recent_info_unref (info);
481 items = filter_items;
487 sort_type = gtk_recent_chooser_get_sort_type (chooser);
490 case GTK_RECENT_SORT_NONE:
493 case GTK_RECENT_SORT_MRU:
494 compare_func = (GCompareDataFunc) sort_recent_items_mru;
496 case GTK_RECENT_SORT_LRU:
497 compare_func = (GCompareDataFunc) sort_recent_items_lru;
499 case GTK_RECENT_SORT_CUSTOM:
500 compare_func = (GCompareDataFunc) sort_recent_items_proxy;
503 g_assert_not_reached ();
509 SortRecentData sort_recent;
511 sort_recent.func = sort_func;
512 sort_recent.data = sort_data;
514 items = g_list_sort_with_data (items, compare_func, &sort_recent);
517 length = g_list_length (items);
518 if ((limit != -1) && (length > limit))
522 clamp = g_list_nth (items, limit - 1);
529 g_list_foreach (l, (GFunc) gtk_recent_info_unref, NULL);