1 /* GTK - The GIMP Toolkit
2 * gtkrecentchooserdialog.c: Recent files selector dialog
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 #include "config.h"
20
21 #include "gtkrecentchooserdialog.h"
22 #include "gtkrecentchooserwidget.h"
23 #include "gtkrecentchooserutils.h"
24 #include "gtkrecentmanager.h"
25 #include "gtktypebuiltins.h"
26 #include "gtksettings.h"
27 #include "gtkdialogprivate.h"
28
29 #include <stdarg.h>
30
31
32 /**
33 * SECTION:gtkrecentchooserdialog
34 * @Short_description: Displays recently used files in a dialog
35 * @Title: GtkRecentChooserDialog
36 * @See_also:#GtkRecentChooser, #GtkDialog
37 *
38 * #GtkRecentChooserDialog is a dialog box suitable for displaying the recently
39 * used documents. This widgets works by putting a #GtkRecentChooserWidget inside
40 * a #GtkDialog. It exposes the #GtkRecentChooserIface interface, so you can use
41 * all the #GtkRecentChooser functions on the recent chooser dialog as well as
42 * those for #GtkDialog.
43 *
44 * Note that #GtkRecentChooserDialog does not have any methods of its own.
45 * Instead, you should use the functions that work on a #GtkRecentChooser.
46 *
47 * ## Typical usage ## {#gtkrecentchooser-typical-usage}
48 *
49 * In the simplest of cases, you can use the following code to use
50 * a #GtkRecentChooserDialog to select a recently used file:
51 *
52 * |[<!-- language="C" -->
53 * GtkWidget *dialog;
54 * gint res;
55 *
56 * dialog = gtk_recent_chooser_dialog_new ("Recent Documents",
57 * parent_window,
58 * _("_Cancel"),
59 * GTK_RESPONSE_CANCEL,
60 * _("_Open"),
61 * GTK_RESPONSE_ACCEPT,
62 * NULL);
63 *
64 * res = gtk_dialog_run (GTK_DIALOG (dialog));
65 * if (res == GTK_RESPONSE_ACCEPT)
66 * {
67 * GtkRecentInfo *info;
68 * GtkRecentChooser *chooser = GTK_RECENT_CHOOSER (dialog);
69 *
70 * info = gtk_recent_chooser_get_current_item (chooser);
71 * open_file (gtk_recent_info_get_uri (info));
72 * gtk_recent_info_unref (info);
73 * }
74 *
75 * gtk_widget_destroy (dialog);
76 * ]|
77 *
78 * Recently used files are supported since GTK+ 2.10.
79 */
80
81
82 struct _GtkRecentChooserDialogPrivate
83 {
84 GtkRecentManager *manager;
85
86 GtkWidget *chooser;
87 };
88
89 #define GTK_RECENT_CHOOSER_DIALOG_GET_PRIVATE(obj) (GTK_RECENT_CHOOSER_DIALOG (obj)->priv)
90
91 static void gtk_recent_chooser_dialog_class_init (GtkRecentChooserDialogClass *klass);
92 static void gtk_recent_chooser_dialog_init (GtkRecentChooserDialog *dialog);
93 static void gtk_recent_chooser_dialog_finalize (GObject *object);
94
95 static void gtk_recent_chooser_dialog_constructed (GObject *object);
96
97 static void gtk_recent_chooser_dialog_set_property (GObject *object,
98 guint prop_id,
99 const GValue *value,
100 GParamSpec *pspec);
101 static void gtk_recent_chooser_dialog_get_property (GObject *object,
102 guint prop_id,
103 GValue *value,
104 GParamSpec *pspec);
105
G_DEFINE_TYPE_WITH_CODE(GtkRecentChooserDialog,gtk_recent_chooser_dialog,GTK_TYPE_DIALOG,G_ADD_PRIVATE (GtkRecentChooserDialog)G_IMPLEMENT_INTERFACE (GTK_TYPE_RECENT_CHOOSER,_gtk_recent_chooser_delegate_iface_init))106 G_DEFINE_TYPE_WITH_CODE (GtkRecentChooserDialog,
107 gtk_recent_chooser_dialog,
108 GTK_TYPE_DIALOG,
109 G_ADD_PRIVATE (GtkRecentChooserDialog)
110 G_IMPLEMENT_INTERFACE (GTK_TYPE_RECENT_CHOOSER,
111 _gtk_recent_chooser_delegate_iface_init))
112
113 static void
114 gtk_recent_chooser_dialog_class_init (GtkRecentChooserDialogClass *klass)
115 {
116 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
117
118 gobject_class->set_property = gtk_recent_chooser_dialog_set_property;
119 gobject_class->get_property = gtk_recent_chooser_dialog_get_property;
120 gobject_class->constructed = gtk_recent_chooser_dialog_constructed;
121 gobject_class->finalize = gtk_recent_chooser_dialog_finalize;
122
123 _gtk_recent_chooser_install_properties (gobject_class);
124 }
125
126 static void
gtk_recent_chooser_dialog_init(GtkRecentChooserDialog * dialog)127 gtk_recent_chooser_dialog_init (GtkRecentChooserDialog *dialog)
128 {
129 GtkRecentChooserDialogPrivate *priv;
130 GtkWidget *content_area, *action_area;
131 GtkDialog *rc_dialog = GTK_DIALOG (dialog);
132
133 priv = gtk_recent_chooser_dialog_get_instance_private (dialog);
134 dialog->priv = priv;
135 gtk_dialog_set_use_header_bar_from_setting (GTK_DIALOG (dialog));
136
137 content_area = gtk_dialog_get_content_area (rc_dialog);
138 G_GNUC_BEGIN_IGNORE_DEPRECATIONS
139 action_area = gtk_dialog_get_action_area (rc_dialog);
140 G_GNUC_END_IGNORE_DEPRECATIONS
141
142 gtk_container_set_border_width (GTK_CONTAINER (rc_dialog), 5);
143 gtk_box_set_spacing (GTK_BOX (content_area), 2); /* 2 * 5 + 2 = 12 */
144 gtk_container_set_border_width (GTK_CONTAINER (action_area), 5);
145 }
146
147 /* we intercept the GtkRecentChooser::item_activated signal and try to
148 * make the dialog emit a valid response signal
149 */
150 static void
gtk_recent_chooser_item_activated_cb(GtkRecentChooser * chooser,gpointer user_data)151 gtk_recent_chooser_item_activated_cb (GtkRecentChooser *chooser,
152 gpointer user_data)
153 {
154 GtkDialog *rc_dialog;
155 GtkRecentChooserDialog *dialog;
156 GtkWidget *action_area;
157 GList *children, *l;
158
159 dialog = GTK_RECENT_CHOOSER_DIALOG (user_data);
160 rc_dialog = GTK_DIALOG (dialog);
161
162 if (gtk_window_activate_default (GTK_WINDOW (dialog)))
163 return;
164
165 G_GNUC_BEGIN_IGNORE_DEPRECATIONS
166 action_area = gtk_dialog_get_action_area (rc_dialog);
167 G_GNUC_END_IGNORE_DEPRECATIONS
168 children = gtk_container_get_children (GTK_CONTAINER (action_area));
169
170 for (l = children; l; l = l->next)
171 {
172 GtkWidget *widget;
173 gint response_id;
174
175 widget = GTK_WIDGET (l->data);
176 response_id = gtk_dialog_get_response_for_widget (rc_dialog, widget);
177
178 if (response_id == GTK_RESPONSE_ACCEPT ||
179 response_id == GTK_RESPONSE_OK ||
180 response_id == GTK_RESPONSE_YES ||
181 response_id == GTK_RESPONSE_APPLY)
182 {
183 g_list_free (children);
184
185 gtk_dialog_response (GTK_DIALOG (dialog), response_id);
186
187 return;
188 }
189 }
190
191 g_list_free (children);
192 }
193
194 static void
gtk_recent_chooser_dialog_constructed(GObject * object)195 gtk_recent_chooser_dialog_constructed (GObject *object)
196 {
197 GtkRecentChooserDialogPrivate *priv;
198 GtkWidget *content_area;
199
200 G_OBJECT_CLASS (gtk_recent_chooser_dialog_parent_class)->constructed (object);
201 priv = GTK_RECENT_CHOOSER_DIALOG_GET_PRIVATE (object);
202
203 if (priv->manager)
204 priv->chooser = g_object_new (GTK_TYPE_RECENT_CHOOSER_WIDGET,
205 "recent-manager", priv->manager,
206 NULL);
207 else
208 priv->chooser = g_object_new (GTK_TYPE_RECENT_CHOOSER_WIDGET, NULL);
209
210 g_signal_connect (priv->chooser, "item-activated",
211 G_CALLBACK (gtk_recent_chooser_item_activated_cb),
212 object);
213
214 content_area = gtk_dialog_get_content_area (GTK_DIALOG (object));
215
216 gtk_container_set_border_width (GTK_CONTAINER (priv->chooser), 5);
217 gtk_box_pack_start (GTK_BOX (content_area),
218 priv->chooser, TRUE, TRUE, 0);
219 gtk_widget_show (priv->chooser);
220
221 _gtk_recent_chooser_set_delegate (GTK_RECENT_CHOOSER (object),
222 GTK_RECENT_CHOOSER (priv->chooser));
223 }
224
225 static void
gtk_recent_chooser_dialog_set_property(GObject * object,guint prop_id,const GValue * value,GParamSpec * pspec)226 gtk_recent_chooser_dialog_set_property (GObject *object,
227 guint prop_id,
228 const GValue *value,
229 GParamSpec *pspec)
230 {
231 GtkRecentChooserDialogPrivate *priv;
232
233 priv = GTK_RECENT_CHOOSER_DIALOG_GET_PRIVATE (object);
234
235 switch (prop_id)
236 {
237 case GTK_RECENT_CHOOSER_PROP_RECENT_MANAGER:
238 priv->manager = g_value_get_object (value);
239 break;
240 default:
241 g_object_set_property (G_OBJECT (priv->chooser), pspec->name, value);
242 break;
243 }
244 }
245
246 static void
gtk_recent_chooser_dialog_get_property(GObject * object,guint prop_id,GValue * value,GParamSpec * pspec)247 gtk_recent_chooser_dialog_get_property (GObject *object,
248 guint prop_id,
249 GValue *value,
250 GParamSpec *pspec)
251 {
252 GtkRecentChooserDialogPrivate *priv;
253
254 priv = GTK_RECENT_CHOOSER_DIALOG_GET_PRIVATE (object);
255
256 g_object_get_property (G_OBJECT (priv->chooser), pspec->name, value);
257 }
258
259 static void
gtk_recent_chooser_dialog_finalize(GObject * object)260 gtk_recent_chooser_dialog_finalize (GObject *object)
261 {
262 GtkRecentChooserDialog *dialog = GTK_RECENT_CHOOSER_DIALOG (object);
263
264 dialog->priv->manager = NULL;
265
266 G_OBJECT_CLASS (gtk_recent_chooser_dialog_parent_class)->finalize (object);
267 }
268
269 static GtkWidget *
gtk_recent_chooser_dialog_new_valist(const gchar * title,GtkWindow * parent,GtkRecentManager * manager,const gchar * first_button_text,va_list varargs)270 gtk_recent_chooser_dialog_new_valist (const gchar *title,
271 GtkWindow *parent,
272 GtkRecentManager *manager,
273 const gchar *first_button_text,
274 va_list varargs)
275 {
276 GtkWidget *result;
277 const char *button_text = first_button_text;
278 gint response_id;
279
280 result = g_object_new (GTK_TYPE_RECENT_CHOOSER_DIALOG,
281 "title", title,
282 "recent-manager", manager,
283 NULL);
284
285 if (parent)
286 gtk_window_set_transient_for (GTK_WINDOW (result), parent);
287
288 while (button_text)
289 {
290 response_id = va_arg (varargs, gint);
291 gtk_dialog_add_button (GTK_DIALOG (result), button_text, response_id);
292 button_text = va_arg (varargs, const gchar *);
293 }
294
295 return result;
296 }
297
298 /**
299 * gtk_recent_chooser_dialog_new:
300 * @title: (allow-none): Title of the dialog, or %NULL
301 * @parent: (allow-none): Transient parent of the dialog, or %NULL,
302 * @first_button_text: (allow-none): stock ID or text to go in the first button, or %NULL
303 * @...: response ID for the first button, then additional (button, id)
304 * pairs, ending with %NULL
305 *
306 * Creates a new #GtkRecentChooserDialog. This function is analogous to
307 * gtk_dialog_new_with_buttons().
308 *
309 * Returns: a new #GtkRecentChooserDialog
310 *
311 * Since: 2.10
312 */
313 GtkWidget *
gtk_recent_chooser_dialog_new(const gchar * title,GtkWindow * parent,const gchar * first_button_text,...)314 gtk_recent_chooser_dialog_new (const gchar *title,
315 GtkWindow *parent,
316 const gchar *first_button_text,
317 ...)
318 {
319 GtkWidget *result;
320 va_list varargs;
321
322 va_start (varargs, first_button_text);
323 result = gtk_recent_chooser_dialog_new_valist (title,
324 parent,
325 NULL,
326 first_button_text,
327 varargs);
328 va_end (varargs);
329
330 return result;
331 }
332
333 /**
334 * gtk_recent_chooser_dialog_new_for_manager:
335 * @title: (allow-none): Title of the dialog, or %NULL
336 * @parent: (allow-none): Transient parent of the dialog, or %NULL,
337 * @manager: a #GtkRecentManager
338 * @first_button_text: (allow-none): stock ID or text to go in the first button, or %NULL
339 * @...: response ID for the first button, then additional (button, id)
340 * pairs, ending with %NULL
341 *
342 * Creates a new #GtkRecentChooserDialog with a specified recent manager.
343 *
344 * This is useful if you have implemented your own recent manager, or if you
345 * have a customized instance of a #GtkRecentManager object.
346 *
347 * Returns: a new #GtkRecentChooserDialog
348 *
349 * Since: 2.10
350 */
351 GtkWidget *
gtk_recent_chooser_dialog_new_for_manager(const gchar * title,GtkWindow * parent,GtkRecentManager * manager,const gchar * first_button_text,...)352 gtk_recent_chooser_dialog_new_for_manager (const gchar *title,
353 GtkWindow *parent,
354 GtkRecentManager *manager,
355 const gchar *first_button_text,
356 ...)
357 {
358 GtkWidget *result;
359 va_list varargs;
360
361 va_start (varargs, first_button_text);
362 result = gtk_recent_chooser_dialog_new_valist (title,
363 parent,
364 manager,
365 first_button_text,
366 varargs);
367 va_end (varargs);
368
369 return result;
370 }
371