1 /* -*- Mode: C; c-file-style: "gnu"; tab-width: 8 -*- */
2 /* GTK - The GIMP Toolkit
3 * gtkfilechooserdialog.c: File selector dialog
4 * Copyright (C) 2003, Red Hat, Inc.
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.
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.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
22 #include "gtkfilechooserdialog.h"
24 #include "gtkfilechooserprivate.h"
25 #include "gtkfilechooserwidget.h"
26 #include "gtkfilechooserutils.h"
27 #include "gtkfilechooserembed.h"
28 #include "gtkfilesystem.h"
29 #include "gtksizerequest.h"
30 #include "gtktypebuiltins.h"
37 * SECTION:gtkfilechooserdialog
38 * @Short_description: A file chooser dialog, suitable for "File/Open" or "File/Save" commands
39 * @Title: GtkFileChooserDialog
40 * @See_also: #GtkFileChooser, #GtkDialog
42 * #GtkFileChooserDialog is a dialog box suitable for use with
43 * "File/Open" or "File/Save as" commands. This widget works by
44 * putting a #GtkFileChooserWidget inside a #GtkDialog. It exposes
45 * the #GtkFileChooser interface, so you can use all of the
46 * #GtkFileChooser functions on the file chooser dialog as well as
47 * those for #GtkDialog.
49 * Note that #GtkFileChooserDialog does not have any methods of its
50 * own. Instead, you should use the functions that work on a
53 * <example id="gtkfilechooser-typical-usage">
54 * <title>Typical usage</title>
55 * In the simplest of cases, you can the following code to use
56 * #GtkFileChooserDialog to select a file for opening:
58 * <informalexample><programlisting>
61 * dialog = gtk_file_chooser_dialog_new ("Open File",
63 * GTK_FILE_CHOOSER_ACTION_OPEN,
64 * GTK_STOCK_CANCEL, GTK_RESPONSE_CANCEL,
65 * GTK_STOCK_OPEN, GTK_RESPONSE_ACCEPT,
68 * if (gtk_dialog_run (GTK_DIALOG (dialog)) == GTK_RESPONSE_ACCEPT)
72 * filename = gtk_file_chooser_get_filename (GTK_FILE_CHOOSER (dialog));
73 * open_file (filename);
77 * gtk_widget_destroy (dialog);
78 * </programlisting></informalexample>
80 * To use a dialog for saving, you can use this:
82 * <informalexample><programlisting>
85 * dialog = gtk_file_chooser_dialog_new ("Save File",
87 * GTK_FILE_CHOOSER_ACTION_SAVE,
88 * GTK_STOCK_CANCEL, GTK_RESPONSE_CANCEL,
89 * GTK_STOCK_SAVE, GTK_RESPONSE_ACCEPT,
91 * gtk_file_chooser_set_do_overwrite_confirmation (GTK_FILE_CHOOSER (dialog), TRUE);
93 * if (user_edited_a_new_document)
94 * gtk_file_chooser_set_current_name (GTK_FILE_CHOOSER (dialog), "Untitled document");
96 * gtk_file_chooser_set_filename (GTK_FILE_CHOOSER (dialog), filename_for_existing_document);
98 * if (gtk_dialog_run (GTK_DIALOG (dialog)) == GTK_RESPONSE_ACCEPT)
102 * filename = gtk_file_chooser_get_filename (GTK_FILE_CHOOSER (dialog));
103 * save_to_file (filename);
107 * gtk_widget_destroy (dialog);
108 * </programlisting></informalexample>
111 * <section id="gtkfilechooserdialog-setting-up">
112 * <title>Setting up a file chooser dialog</title>
113 * There are various cases in which you may need to use a #GtkFileChooserDialog:
114 * <itemizedlist><listitem>To select a file for opening, as for a
115 * <guimenuitem>File/Open</guimenuitem> command. Use
116 * #GTK_FILE_CHOOSER_ACTION_OPEN.
118 * <listitem>To save a file for the first time, as for a
119 * <guimenuitem>File/Save</guimenuitem> command. Use
120 * #GTK_FILE_CHOOSER_ACTION_SAVE, and suggest a name such as
121 * "Untitled" with gtk_file_chooser_set_current_name().
123 * <listitem>To save a file under a different name, as for a
124 * <guimenuitem>File/Save As</guimenuitem> command. Use
125 * #GTK_FILE_CHOOSER_ACTION_SAVE, and set the existing filename
126 * with gtk_file_chooser_set_filename().
128 * <listitem>To choose a folder instead of a file. Use
129 * #GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER.
130 * </listitem></itemizedlist>
133 * Old versions of the file chooser's documentation suggested
134 * using gtk_file_chooser_set_current_folder() in various
135 * situations, with the intention of letting the application
136 * suggest a reasonable default folder. This is no longer
137 * considered to be a good policy, as now the file chooser is
138 * able to make good suggestions on its own. In general, you
139 * should only cause the file chooser to show a specific folder
140 * when it is appropriate to use gtk_file_chooser_set_filename(),
141 * i.e. when you are doing a <guimenuitem>File/Save
142 * As</guimenuitem> command <emphasis>and</emphasis> you already
143 * have a file saved somewhere.
147 * <section id="gtkfilechooserdialog-response-codes">
148 * <title>Response Codes</title>
149 * #GtkFileChooserDialog inherits from #GtkDialog, so buttons that
150 * go in its action area have response codes such as
151 * #GTK_RESPONSE_ACCEPT and #GTK_RESPONSE_CANCEL. For example, you
152 * could call gtk_file_chooser_dialog_new() as follows:
154 * <informalexample><programlisting>
157 * dialog = gtk_file_chooser_dialog_new ("Open File",
159 * GTK_FILE_CHOOSER_ACTION_OPEN,
160 * GTK_STOCK_CANCEL, GTK_RESPONSE_CANCEL,
161 * GTK_STOCK_OPEN, GTK_RESPONSE_ACCEPT,
163 * </programlisting></informalexample>
165 * This will create buttons for "Cancel" and "Open" that use stock
166 * response identifiers from #GtkResponseType. For most dialog
167 * boxes you can use your own custom response codes rather than the
168 * ones in #GtkResponseType, but #GtkFileChooserDialog assumes that
169 * its "accept"-type action, e.g. an "Open" or "Save" button,
170 * <emphasis>will</emphasis> have one of the following response
173 * <simplelist id="gtkfilechooserdialog-responses">
174 * <member>#GTK_RESPONSE_ACCEPT</member>
175 * <member>#GTK_RESPONSE_OK</member>
176 * <member>#GTK_RESPONSE_YES</member>
177 * <member>#GTK_RESPONSE_APPLY</member>
180 * This is because #GtkFileChooserDialog must intercept responses
181 * and switch to folders if appropriate, rather than letting the
182 * dialog terminate — the implementation uses these known
183 * response codes to know which responses can be blocked if
187 * To summarize, make sure you use a
188 * <link linkend="gtkfilechooserdialog-responses">stock response code</link>
189 * when you use #GtkFileChooserDialog to ensure proper operation.
196 #define GTK_FILE_CHOOSER_DIALOG_GET_PRIVATE(o) (GTK_FILE_CHOOSER_DIALOG (o)->priv)
198 static void gtk_file_chooser_dialog_finalize (GObject *object);
200 static GObject* gtk_file_chooser_dialog_constructor (GType type,
201 guint n_construct_properties,
202 GObjectConstructParam *construct_params);
203 static void gtk_file_chooser_dialog_set_property (GObject *object,
207 static void gtk_file_chooser_dialog_get_property (GObject *object,
212 static void gtk_file_chooser_dialog_map (GtkWidget *widget);
214 static void response_cb (GtkDialog *dialog,
217 G_DEFINE_TYPE_WITH_CODE (GtkFileChooserDialog, gtk_file_chooser_dialog, GTK_TYPE_DIALOG,
218 G_IMPLEMENT_INTERFACE (GTK_TYPE_FILE_CHOOSER,
219 _gtk_file_chooser_delegate_iface_init))
222 gtk_file_chooser_dialog_class_init (GtkFileChooserDialogClass *class)
224 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
225 GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (class);
227 gobject_class->constructor = gtk_file_chooser_dialog_constructor;
228 gobject_class->set_property = gtk_file_chooser_dialog_set_property;
229 gobject_class->get_property = gtk_file_chooser_dialog_get_property;
230 gobject_class->finalize = gtk_file_chooser_dialog_finalize;
232 widget_class->map = gtk_file_chooser_dialog_map;
234 gtk_widget_class_set_accessible_role (widget_class, ATK_ROLE_FILE_CHOOSER);
236 _gtk_file_chooser_install_properties (gobject_class);
238 g_type_class_add_private (class, sizeof (GtkFileChooserDialogPrivate));
242 gtk_file_chooser_dialog_init (GtkFileChooserDialog *dialog)
244 GtkWidget *action_area, *content_area;
245 GtkFileChooserDialogPrivate *priv = G_TYPE_INSTANCE_GET_PRIVATE (dialog,
246 GTK_TYPE_FILE_CHOOSER_DIALOG,
247 GtkFileChooserDialogPrivate);
248 GtkDialog *fc_dialog = GTK_DIALOG (dialog);
251 dialog->priv->response_requested = FALSE;
253 content_area = gtk_dialog_get_content_area (fc_dialog);
254 action_area = gtk_dialog_get_action_area (fc_dialog);
256 gtk_container_set_border_width (GTK_CONTAINER (fc_dialog), 5);
257 gtk_box_set_spacing (GTK_BOX (content_area), 2); /* 2 * 5 + 2 = 12 */
258 gtk_container_set_border_width (GTK_CONTAINER (action_area), 5);
260 gtk_window_set_role (GTK_WINDOW (dialog), "GtkFileChooserDialog");
262 /* We do a signal connection here rather than overriding the method in
263 * class_init because GtkDialog::response is a RUN_LAST signal. We want *our*
264 * handler to be run *first*, regardless of whether the user installs response
265 * handlers of his own.
267 g_signal_connect (dialog, "response",
268 G_CALLBACK (response_cb), NULL);
272 gtk_file_chooser_dialog_finalize (GObject *object)
274 GtkFileChooserDialog *dialog = GTK_FILE_CHOOSER_DIALOG (object);
276 g_free (dialog->priv->file_system);
278 G_OBJECT_CLASS (gtk_file_chooser_dialog_parent_class)->finalize (object);
282 is_stock_accept_response_id (int response_id)
284 return (response_id == GTK_RESPONSE_ACCEPT
285 || response_id == GTK_RESPONSE_OK
286 || response_id == GTK_RESPONSE_YES
287 || response_id == GTK_RESPONSE_APPLY);
290 /* Callback used when the user activates a file in the file chooser widget */
292 file_chooser_widget_file_activated (GtkFileChooser *chooser,
293 GtkFileChooserDialog *dialog)
295 GtkDialog *fc_dialog = GTK_DIALOG (dialog);
296 GtkWidget *action_area;
299 if (gtk_window_activate_default (GTK_WINDOW (dialog)))
302 /* There probably isn't a default widget, so make things easier for the
303 * programmer by looking for a reasonable button on our own.
305 action_area = gtk_dialog_get_action_area (fc_dialog);
306 children = gtk_container_get_children (GTK_CONTAINER (action_area));
308 for (l = children; l; l = l->next)
313 widget = GTK_WIDGET (l->data);
314 response_id = gtk_dialog_get_response_for_widget (fc_dialog, widget);
315 if (gtk_widget_is_sensitive (widget) &&
316 is_stock_accept_response_id (response_id))
318 gtk_widget_activate (widget); /* Should we gtk_dialog_response (dialog, response_id) instead? */
323 g_list_free (children);
327 /* FIXME: to see why this function is ifdef-ed out, see the comment below in
328 * file_chooser_widget_default_size_changed().
331 load_position (int *out_xpos, int *out_ypos)
333 GtkFileChooserSettings *settings;
334 int x, y, width, height;
336 settings = _gtk_file_chooser_settings_new ();
337 _gtk_file_chooser_settings_get_geometry (settings, &x, &y, &width, &height);
338 g_object_unref (settings);
346 file_chooser_widget_default_size_changed (GtkWidget *widget,
347 GtkFileChooserDialog *dialog)
349 GtkFileChooserDialogPrivate *priv;
350 gint default_width, default_height;
351 GtkRequisition req, widget_req;
353 priv = GTK_FILE_CHOOSER_DIALOG_GET_PRIVATE (dialog);
355 /* Unset any previously set size */
356 gtk_widget_set_size_request (GTK_WIDGET (dialog), -1, -1);
358 if (gtk_widget_is_drawable (widget))
360 /* Force a size request of everything before we start. This will make sure
361 * that widget->requisition is meaningful. */
362 gtk_widget_get_preferred_size (GTK_WIDGET (dialog),
364 gtk_widget_get_preferred_size (widget,
368 _gtk_file_chooser_embed_get_default_size (GTK_FILE_CHOOSER_EMBED (priv->widget),
369 &default_width, &default_height);
371 gtk_window_resize (GTK_WINDOW (dialog), default_width, default_height);
373 if (!gtk_widget_get_mapped (GTK_WIDGET (dialog)))
376 /* FIXME: the code to restore the position does not work yet. It is not
377 * clear whether it is actually desirable --- if enabled, applications
378 * would not be able to say "center the file chooser on top of my toplevel
379 * window". So, we don't use this code at all.
381 load_position (&xpos, &ypos);
382 if (xpos >= 0 && ypos >= 0)
384 gtk_window_set_position (GTK_WINDOW (dialog), GTK_WIN_POS_NONE);
385 gtk_window_move (GTK_WINDOW (dialog), xpos, ypos);
392 file_chooser_widget_response_requested (GtkWidget *widget,
393 GtkFileChooserDialog *dialog)
395 GtkDialog *fc_dialog = GTK_DIALOG (dialog);
396 GtkWidget *action_area;
399 dialog->priv->response_requested = TRUE;
401 if (gtk_window_activate_default (GTK_WINDOW (dialog)))
404 /* There probably isn't a default widget, so make things easier for the
405 * programmer by looking for a reasonable button on our own.
407 action_area = gtk_dialog_get_action_area (fc_dialog);
408 children = gtk_container_get_children (GTK_CONTAINER (action_area));
410 for (l = children; l; l = l->next)
415 widget = GTK_WIDGET (l->data);
416 response_id = gtk_dialog_get_response_for_widget (fc_dialog, widget);
417 if (gtk_widget_is_sensitive (widget) &&
418 is_stock_accept_response_id (response_id))
420 gtk_widget_activate (widget); /* Should we gtk_dialog_response (dialog, response_id) instead? */
426 dialog->priv->response_requested = FALSE;
428 g_list_free (children);
432 gtk_file_chooser_dialog_constructor (GType type,
433 guint n_construct_properties,
434 GObjectConstructParam *construct_params)
436 GtkFileChooserDialogPrivate *priv;
437 GtkWidget *content_area;
440 object = G_OBJECT_CLASS (gtk_file_chooser_dialog_parent_class)->constructor (type,
441 n_construct_properties,
443 priv = GTK_FILE_CHOOSER_DIALOG_GET_PRIVATE (object);
445 gtk_widget_push_composite_child ();
447 if (priv->file_system)
448 priv->widget = g_object_new (GTK_TYPE_FILE_CHOOSER_WIDGET,
451 priv->widget = g_object_new (GTK_TYPE_FILE_CHOOSER_WIDGET, NULL);
453 g_signal_connect (priv->widget, "file-activated",
454 G_CALLBACK (file_chooser_widget_file_activated), object);
455 g_signal_connect (priv->widget, "default-size-changed",
456 G_CALLBACK (file_chooser_widget_default_size_changed), object);
457 g_signal_connect (priv->widget, "response-requested",
458 G_CALLBACK (file_chooser_widget_response_requested), object);
460 content_area = gtk_dialog_get_content_area (GTK_DIALOG (object));
462 gtk_container_set_border_width (GTK_CONTAINER (priv->widget), 5);
463 gtk_box_pack_start (GTK_BOX (content_area), priv->widget, TRUE, TRUE, 0);
465 gtk_widget_show (priv->widget);
467 _gtk_file_chooser_set_delegate (GTK_FILE_CHOOSER (object),
468 GTK_FILE_CHOOSER (priv->widget));
470 gtk_widget_pop_composite_child ();
476 gtk_file_chooser_dialog_set_property (GObject *object,
482 GtkFileChooserDialogPrivate *priv = GTK_FILE_CHOOSER_DIALOG_GET_PRIVATE (object);
487 g_object_set_property (G_OBJECT (priv->widget), pspec->name, value);
493 gtk_file_chooser_dialog_get_property (GObject *object,
498 GtkFileChooserDialogPrivate *priv = GTK_FILE_CHOOSER_DIALOG_GET_PRIVATE (object);
500 g_object_get_property (G_OBJECT (priv->widget), pspec->name, value);
504 foreach_ensure_default_response_cb (GtkWidget *widget,
507 GtkFileChooserDialog *dialog = GTK_FILE_CHOOSER_DIALOG (data);
510 response_id = gtk_dialog_get_response_for_widget (GTK_DIALOG (dialog), widget);
511 if (is_stock_accept_response_id (response_id))
512 gtk_dialog_set_default_response (GTK_DIALOG (dialog), response_id);
516 ensure_default_response (GtkFileChooserDialog *dialog)
518 GtkWidget *action_area;
520 action_area = gtk_dialog_get_action_area (GTK_DIALOG (dialog));
521 gtk_container_foreach (GTK_CONTAINER (action_area),
522 foreach_ensure_default_response_cb,
526 /* GtkWidget::map handler */
528 gtk_file_chooser_dialog_map (GtkWidget *widget)
530 GtkFileChooserDialog *dialog = GTK_FILE_CHOOSER_DIALOG (widget);
531 GtkFileChooserDialogPrivate *priv = GTK_FILE_CHOOSER_DIALOG_GET_PRIVATE (dialog);
533 ensure_default_response (dialog);
535 _gtk_file_chooser_embed_initial_focus (GTK_FILE_CHOOSER_EMBED (priv->widget));
537 GTK_WIDGET_CLASS (gtk_file_chooser_dialog_parent_class)->map (widget);
540 /* GtkDialog::response handler */
542 response_cb (GtkDialog *dialog,
545 GtkFileChooserDialogPrivate *priv;
547 priv = GTK_FILE_CHOOSER_DIALOG_GET_PRIVATE (dialog);
549 /* Act only on response IDs we recognize */
550 if (is_stock_accept_response_id (response_id)
551 && !priv->response_requested
552 && !_gtk_file_chooser_embed_should_respond (GTK_FILE_CHOOSER_EMBED (priv->widget)))
554 g_signal_stop_emission_by_name (dialog, "response");
557 priv->response_requested = FALSE;
561 gtk_file_chooser_dialog_new_valist (const gchar *title,
563 GtkFileChooserAction action,
564 const gchar *first_button_text,
568 const char *button_text = first_button_text;
571 result = g_object_new (GTK_TYPE_FILE_CHOOSER_DIALOG,
577 gtk_window_set_transient_for (GTK_WINDOW (result), parent);
581 response_id = va_arg (varargs, gint);
582 gtk_dialog_add_button (GTK_DIALOG (result), button_text, response_id);
583 button_text = va_arg (varargs, const gchar *);
590 * gtk_file_chooser_dialog_new:
591 * @title: (allow-none): Title of the dialog, or %NULL
592 * @parent: (allow-none): Transient parent of the dialog, or %NULL
593 * @action: Open or save mode for the dialog
594 * @first_button_text: (allow-none): stock ID or text to go in the first button, or %NULL
595 * @...: response ID for the first button, then additional (button, id) pairs, ending with %NULL
597 * Creates a new #GtkFileChooserDialog. This function is analogous to
598 * gtk_dialog_new_with_buttons().
600 * Return value: a new #GtkFileChooserDialog
605 gtk_file_chooser_dialog_new (const gchar *title,
607 GtkFileChooserAction action,
608 const gchar *first_button_text,
614 va_start (varargs, first_button_text);
615 result = gtk_file_chooser_dialog_new_valist (title, parent, action,