1/* GTK - The GIMP Toolkit
2 * gtkrecentchooser.h - Abstract interface for recent file selectors GUIs
3 *
4 * Copyright (C) 2006, Emmanuele Bassi
5 *
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
10 *
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the
18 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 * Boston, MA 02111-1307, USA.
20 */
21
22#ifndef __GTK_RECENT_CHOOSER_H__
23#define __GTK_RECENT_CHOOSER_H__
24
25#if defined(GTK_DISABLE_SINGLE_INCLUDES) && !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
26#error "Only <gtk/gtk.h> can be included directly."
27#endif
28
29#include <gtk/gtkwidget.h>
30#include <gtk/gtkrecentmanager.h>
31#include <gtk/gtkrecentfilter.h>
32
33G_BEGIN_DECLS
34
35#define GTK_TYPE_RECENT_CHOOSER (gtk_recent_chooser_get_type ())
36#define GTK_RECENT_CHOOSER(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_RECENT_CHOOSER, GtkRecentChooser))
37#define GTK_IS_RECENT_CHOOSER(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_RECENT_CHOOSER))
38#define GTK_RECENT_CHOOSER_GET_IFACE(inst) (G_TYPE_INSTANCE_GET_INTERFACE ((inst), GTK_TYPE_RECENT_CHOOSER, GtkRecentChooserIface))
39
40/**
41 * GtkRecentSortType:
42 * @GTK_RECENT_SORT_NONE: Do not sort the returned list of recently used
43 * resources.
44 * @GTK_RECENT_SORT_MRU: Sort the returned list with the most recently used
45 * items first.
46 * @GTK_RECENT_SORT_LRU: Sort the returned list with the least recently used
47 * items first.
48 * @GTK_RECENT_SORT_CUSTOM: Sort the returned list using a custom sorting
49 * function passed using gtk_recent_manager_set_sort_func().
50 *
51 * Used to specify the sorting method to be applyed to the recently
52 * used resource list.
53 **/
54typedef enum
55{
56 GTK_RECENT_SORT_NONE = 0,
57 GTK_RECENT_SORT_MRU,
58 GTK_RECENT_SORT_LRU,
59 GTK_RECENT_SORT_CUSTOM
60} GtkRecentSortType;
61
62typedef gint (*GtkRecentSortFunc) (GtkRecentInfo *a,
63 GtkRecentInfo *b,
64 gpointer user_data);
65
66
67typedef struct _GtkRecentChooser GtkRecentChooser; /* dummy */
68typedef struct _GtkRecentChooserIface GtkRecentChooserIface;
69
70#define GTK_RECENT_CHOOSER_ERROR (gtk_recent_chooser_error_quark ())
71
72typedef enum
73{
74 GTK_RECENT_CHOOSER_ERROR_NOT_FOUND,
75 GTK_RECENT_CHOOSER_ERROR_INVALID_URI
76} GtkRecentChooserError;
77
78GQuark gtk_recent_chooser_error_quark (void);
79
80
81struct _GtkRecentChooserIface
82{
83 GTypeInterface base_iface;
84
85 /*
86 * Methods
87 */
88 gboolean (* set_current_uri) (GtkRecentChooser *chooser,
89 const gchar *uri,
90 GError **error);
91 gchar * (* get_current_uri) (GtkRecentChooser *chooser);
92 gboolean (* select_uri) (GtkRecentChooser *chooser,
93 const gchar *uri,
94 GError **error);
95 void (* unselect_uri) (GtkRecentChooser *chooser,
96 const gchar *uri);
97 void (* select_all) (GtkRecentChooser *chooser);
98 void (* unselect_all) (GtkRecentChooser *chooser);
99 GList * (* get_items) (GtkRecentChooser *chooser);
100 GtkRecentManager *(* get_recent_manager) (GtkRecentChooser *chooser);
101 void (* add_filter) (GtkRecentChooser *chooser,
102 GtkRecentFilter *filter);
103 void (* remove_filter) (GtkRecentChooser *chooser,
104 GtkRecentFilter *filter);
105 GSList * (* list_filters) (GtkRecentChooser *chooser);
106 void (* set_sort_func) (GtkRecentChooser *chooser,
107 GtkRecentSortFunc sort_func,
108 gpointer data,
109 GDestroyNotify destroy);
110
111 /*
112 * Signals
113 */
114 void (* item_activated) (GtkRecentChooser *chooser);
115 void (* selection_changed) (GtkRecentChooser *chooser);
116};
117
118GType gtk_recent_chooser_get_type (void) G_GNUC_CONST;
119
120/*
121 * Configuration
122 */
123void gtk_recent_chooser_set_show_private (GtkRecentChooser *chooser,
124 gboolean show_private);
125gboolean gtk_recent_chooser_get_show_private (GtkRecentChooser *chooser);
126void gtk_recent_chooser_set_show_not_found (GtkRecentChooser *chooser,
127 gboolean show_not_found);
128gboolean gtk_recent_chooser_get_show_not_found (GtkRecentChooser *chooser);
129void gtk_recent_chooser_set_select_multiple (GtkRecentChooser *chooser,
130 gboolean select_multiple);
131gboolean gtk_recent_chooser_get_select_multiple (GtkRecentChooser *chooser);
132void gtk_recent_chooser_set_limit (GtkRecentChooser *chooser,
133 gint limit);
134gint gtk_recent_chooser_get_limit (GtkRecentChooser *chooser);
135void gtk_recent_chooser_set_local_only (GtkRecentChooser *chooser,
136 gboolean local_only);
137gboolean gtk_recent_chooser_get_local_only (GtkRecentChooser *chooser);
138void gtk_recent_chooser_set_show_tips (GtkRecentChooser *chooser,
139 gboolean show_tips);
140gboolean gtk_recent_chooser_get_show_tips (GtkRecentChooser *chooser);
141#ifndef GTK_DISABLE_DEPRECATED
142void gtk_recent_chooser_set_show_numbers (GtkRecentChooser *chooser,
143 gboolean show_numbers);
144gboolean gtk_recent_chooser_get_show_numbers (GtkRecentChooser *chooser);
145#endif /* GTK_DISABLE_DEPRECATED */
146void gtk_recent_chooser_set_show_icons (GtkRecentChooser *chooser,
147 gboolean show_icons);
148gboolean gtk_recent_chooser_get_show_icons (GtkRecentChooser *chooser);
149void gtk_recent_chooser_set_sort_type (GtkRecentChooser *chooser,
150 GtkRecentSortType sort_type);
151GtkRecentSortType gtk_recent_chooser_get_sort_type (GtkRecentChooser *chooser);
152void gtk_recent_chooser_set_sort_func (GtkRecentChooser *chooser,
153 GtkRecentSortFunc sort_func,
154 gpointer sort_data,
155 GDestroyNotify data_destroy);
156
157/*
158 * Items handling
159 */
160gboolean gtk_recent_chooser_set_current_uri (GtkRecentChooser *chooser,
161 const gchar *uri,
162 GError **error);
163gchar * gtk_recent_chooser_get_current_uri (GtkRecentChooser *chooser);
164GtkRecentInfo *gtk_recent_chooser_get_current_item (GtkRecentChooser *chooser);
165gboolean gtk_recent_chooser_select_uri (GtkRecentChooser *chooser,
166 const gchar *uri,
167 GError **error);
168void gtk_recent_chooser_unselect_uri (GtkRecentChooser *chooser,
169 const gchar *uri);
170void gtk_recent_chooser_select_all (GtkRecentChooser *chooser);
171void gtk_recent_chooser_unselect_all (GtkRecentChooser *chooser);
172GList * gtk_recent_chooser_get_items (GtkRecentChooser *chooser);
173gchar ** gtk_recent_chooser_get_uris (GtkRecentChooser *chooser,
174 gsize *length);
175
176/*
177 * Filters
178 */
179void gtk_recent_chooser_add_filter (GtkRecentChooser *chooser,
180 GtkRecentFilter *filter);
181void gtk_recent_chooser_remove_filter (GtkRecentChooser *chooser,
182 GtkRecentFilter *filter);
183GSList * gtk_recent_chooser_list_filters (GtkRecentChooser *chooser);
184void gtk_recent_chooser_set_filter (GtkRecentChooser *chooser,
185 GtkRecentFilter *filter);
186GtkRecentFilter *gtk_recent_chooser_get_filter (GtkRecentChooser *chooser);
187
188
189G_END_DECLS
190
191#endif /* __GTK_RECENT_CHOOSER_H__ */
192