Pileus Git - ~andy/gtk/blob - gtk/gtkfilechooserdialog.c

   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.
   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 #include "config.h"
  23 #include "gtkfilechooserprivate.h"
  24 #include "gtkfilechooserdialog.h"
  25 #include "gtkfilechooserwidget.h"
  26 #include "gtkfilechooserutils.h"
  27 #include "gtkfilechooserembed.h"
  28 #include "gtkfilechoosersettings.h"
  29 #include "gtkfilesystem.h"
  30 #include "gtktypebuiltins.h"
  31 #include "gtkintl.h"
  32 #include "gtkalias.h"
  33
  34 #include <stdarg.h>
  35
  36 #define GTK_FILE_CHOOSER_DIALOG_GET_PRIVATE(o)  (GTK_FILE_CHOOSER_DIALOG (o)->priv)
  37
  38 static void gtk_file_chooser_dialog_finalize   (GObject                   *object);
  39
  40 static GObject* gtk_file_chooser_dialog_constructor  (GType                  type,
  41                                                       guint                  n_construct_properties,
  42                                                       GObjectConstructParam *construct_params);
  43 static void     gtk_file_chooser_dialog_set_property (GObject               *object,
  44                                                       guint                  prop_id,
  45                                                       const GValue          *value,
  46                                                       GParamSpec            *pspec);
  47 static void     gtk_file_chooser_dialog_get_property (GObject               *object,
  48                                                       guint                  prop_id,
  49                                                       GValue                *value,
  50                                                       GParamSpec            *pspec);
  51
  52 static void     gtk_file_chooser_dialog_map          (GtkWidget             *widget);
  53 static void     gtk_file_chooser_dialog_unmap        (GtkWidget             *widget);
  54
  55 static void response_cb (GtkDialog *dialog,
  56                          gint       response_id);
  57
  58 G_DEFINE_TYPE_WITH_CODE (GtkFileChooserDialog, gtk_file_chooser_dialog, GTK_TYPE_DIALOG,
  59                          G_IMPLEMENT_INTERFACE (GTK_TYPE_FILE_CHOOSER,
  60                                                 _gtk_file_chooser_delegate_iface_init))
  61
  62 static void
  63 gtk_file_chooser_dialog_class_init (GtkFileChooserDialogClass *class)
  64 {
  65   GObjectClass *gobject_class = G_OBJECT_CLASS (class);
  66   GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (class);
  67
  68   gobject_class->constructor = gtk_file_chooser_dialog_constructor;
  69   gobject_class->set_property = gtk_file_chooser_dialog_set_property;
  70   gobject_class->get_property = gtk_file_chooser_dialog_get_property;
  71   gobject_class->finalize = gtk_file_chooser_dialog_finalize;
  72
  73   widget_class->map       = gtk_file_chooser_dialog_map;
  74   widget_class->unmap     = gtk_file_chooser_dialog_unmap;
  75
  76   _gtk_file_chooser_install_properties (gobject_class);
  77
  78   g_type_class_add_private (class, sizeof (GtkFileChooserDialogPrivate));
  79 }
  80
  81 static void
  82 gtk_file_chooser_dialog_init (GtkFileChooserDialog *dialog)
  83 {
  84   GtkFileChooserDialogPrivate *priv = G_TYPE_INSTANCE_GET_PRIVATE (dialog,
  85                                                                    GTK_TYPE_FILE_CHOOSER_DIALOG,
  86                                                                    GtkFileChooserDialogPrivate);
  87   GtkDialog *fc_dialog = GTK_DIALOG (dialog);
  88
  89   dialog->priv = priv;
  90   dialog->priv->response_requested = FALSE;
  91
  92   gtk_dialog_set_has_separator (fc_dialog, FALSE);
  93   gtk_container_set_border_width (GTK_CONTAINER (fc_dialog), 5);
  94   gtk_box_set_spacing (GTK_BOX (fc_dialog->vbox), 2); /* 2 * 5 + 2 = 12 */
  95   gtk_container_set_border_width (GTK_CONTAINER (fc_dialog->action_area), 5);
  96
  97   /* We do a signal connection here rather than overriding the method in
  98    * class_init because GtkDialog::response is a RUN_LAST signal.  We want *our*
  99    * handler to be run *first*, regardless of whether the user installs response
 100    * handlers of his own.
 101    */
 102   g_signal_connect (dialog, "response",
 103                     G_CALLBACK (response_cb), NULL);
 104 }
 105
 106 static void
 107 gtk_file_chooser_dialog_finalize (GObject *object)
 108 {
 109   GtkFileChooserDialog *dialog = GTK_FILE_CHOOSER_DIALOG (object);
 110
 111   g_free (dialog->priv->file_system);
 112
 113   G_OBJECT_CLASS (gtk_file_chooser_dialog_parent_class)->finalize (object);
 114 }
 115
 116 static gboolean
 117 is_stock_accept_response_id (int response_id)
 118 {
 119   return (response_id == GTK_RESPONSE_ACCEPT
 120           || response_id == GTK_RESPONSE_OK
 121           || response_id == GTK_RESPONSE_YES
 122           || response_id == GTK_RESPONSE_APPLY);
 123 }
 124
 125 /* Callback used when the user activates a file in the file chooser widget */
 126 static void
 127 file_chooser_widget_file_activated (GtkFileChooser       *chooser,
 128                                     GtkFileChooserDialog *dialog)
 129 {
 130   GList *children, *l;
 131
 132   if (gtk_window_activate_default (GTK_WINDOW (dialog)))
 133     return;
 134
 135   /* There probably isn't a default widget, so make things easier for the
 136    * programmer by looking for a reasonable button on our own.
 137    */
 138
 139   children = gtk_container_get_children (GTK_CONTAINER (GTK_DIALOG (dialog)->action_area));
 140
 141   for (l = children; l; l = l->next)
 142     {
 143       GtkWidget *widget;
 144       int response_id;
 145
 146       widget = GTK_WIDGET (l->data);
 147       response_id = gtk_dialog_get_response_for_widget (GTK_DIALOG (dialog), widget);
 148       if (is_stock_accept_response_id (response_id))
 149         {
 150           gtk_widget_activate (widget); /* Should we gtk_dialog_response (dialog, response_id) instead? */
 151           break;
 152         }
 153     }
 154
 155   g_list_free (children);
 156 }
 157
 158 #if 0
 159 /* FIXME: to see why this function is ifdef-ed out, see the comment below in
 160  * file_chooser_widget_default_size_changed().
 161  */
 162 static void
 163 load_position (int *out_xpos, int *out_ypos)
 164 {
 165   GtkFileChooserSettings *settings;
 166   int x, y, width, height;
 167
 168   settings = _gtk_file_chooser_settings_new ();
 169   _gtk_file_chooser_settings_get_geometry (settings, &x, &y, &width, &height);
 170   g_object_unref (settings);
 171
 172   *out_xpos = x;
 173   *out_ypos = y;
 174 }
 175 #endif
 176
 177 static void
 178 file_chooser_widget_default_size_changed (GtkWidget            *widget,
 179                                           GtkFileChooserDialog *dialog)
 180 {
 181   GtkFileChooserDialogPrivate *priv;
 182   gint default_width, default_height;
 183   GtkRequisition req, widget_req;
 184   int xpos, ypos;
 185
 186   priv = GTK_FILE_CHOOSER_DIALOG_GET_PRIVATE (dialog);
 187
 188   /* Unset any previously set size */
 189   gtk_widget_set_size_request (GTK_WIDGET (dialog), -1, -1);
 190
 191   if (GTK_WIDGET_DRAWABLE (widget))
 192     {
 193       /* Force a size request of everything before we start.  This will make sure
 194        * that widget->requisition is meaningful. */
 195       gtk_widget_size_request (GTK_WIDGET (dialog), &req);
 196       gtk_widget_size_request (widget, &widget_req);
 197     }
 198
 199   _gtk_file_chooser_embed_get_default_size (GTK_FILE_CHOOSER_EMBED (priv->widget),
 200                                             &default_width, &default_height);
 201
 202   gtk_window_resize (GTK_WINDOW (dialog), default_width, default_height);
 203
 204   if (!GTK_WIDGET_MAPPED (dialog))
 205     {
 206 #if 0
 207       /* FIXME: the code to restore the position does not work yet.  It is not
 208        * clear whether it is actually desirable --- if enabled, applications
 209        * would not be able to say "center the file chooser on top of my toplevel
 210        * window".  So, we don't use this code at all.
 211        */
 212       load_position (&xpos, &ypos);
 213       if (xpos >= 0 && ypos >= 0)
 214         {
 215           gtk_window_set_position (GTK_WINDOW (dialog), GTK_WIN_POS_NONE);
 216           gtk_window_move (GTK_WINDOW (dialog), xpos, ypos);
 217         }
 218 #endif
 219     }
 220 }
 221
 222 static void
 223 file_chooser_widget_response_requested (GtkWidget            *widget,
 224                                         GtkFileChooserDialog *dialog)
 225 {
 226   GList *children, *l;
 227
 228   /* There probably isn't a default widget, so make things easier for the
 229    * programmer by looking for a reasonable button on our own.
 230    */
 231
 232   children = gtk_container_get_children (GTK_CONTAINER (GTK_DIALOG (dialog)->action_area));
 233
 234   for (l = children; l; l = l->next)
 235     {
 236       GtkWidget *widget;
 237       int response_id;
 238
 239       widget = GTK_WIDGET (l->data);
 240       response_id = gtk_dialog_get_response_for_widget (GTK_DIALOG (dialog), widget);
 241       if (is_stock_accept_response_id (response_id))
 242         {
 243           dialog->priv->response_requested = TRUE;
 244           gtk_widget_activate (widget); /* Should we gtk_dialog_response (dialog, response_id) instead? */
 245           break;
 246         }
 247     }
 248
 249   g_list_free (children);
 250 }
 251
 252 static GObject*
 253 gtk_file_chooser_dialog_constructor (GType                  type,
 254                                      guint                  n_construct_properties,
 255                                      GObjectConstructParam *construct_params)
 256 {
 257   GtkFileChooserDialogPrivate *priv;
 258   GObject *object;
 259
 260   object = G_OBJECT_CLASS (gtk_file_chooser_dialog_parent_class)->constructor (type,
 261                                                                                n_construct_properties,
 262                                                                                construct_params);
 263   priv = GTK_FILE_CHOOSER_DIALOG_GET_PRIVATE (object);
 264
 265   gtk_widget_push_composite_child ();
 266
 267   if (priv->file_system)
 268     priv->widget = g_object_new (GTK_TYPE_FILE_CHOOSER_WIDGET,
 269                                  "file-system-backend", priv->file_system,
 270                                  NULL);
 271   else
 272     priv->widget = g_object_new (GTK_TYPE_FILE_CHOOSER_WIDGET, NULL);
 273
 274   g_signal_connect (priv->widget, "file-activated",
 275                     G_CALLBACK (file_chooser_widget_file_activated), object);
 276   g_signal_connect (priv->widget, "default-size-changed",
 277                     G_CALLBACK (file_chooser_widget_default_size_changed), object);
 278   g_signal_connect (priv->widget, "response-requested",
 279                     G_CALLBACK (file_chooser_widget_response_requested), object);
 280
 281   gtk_container_set_border_width (GTK_CONTAINER (priv->widget), 5);
 282   gtk_box_pack_start (GTK_BOX (GTK_DIALOG (object)->vbox), priv->widget, TRUE, TRUE, 0);
 283
 284   gtk_widget_show (priv->widget);
 285
 286   _gtk_file_chooser_set_delegate (GTK_FILE_CHOOSER (object),
 287                                   GTK_FILE_CHOOSER (priv->widget));
 288
 289   gtk_widget_pop_composite_child ();
 290
 291   return object;
 292 }
 293
 294 static void
 295 gtk_file_chooser_dialog_set_property (GObject         *object,
 296                                       guint            prop_id,
 297                                       const GValue    *value,
 298                                       GParamSpec      *pspec)
 299
 300 {
 301   GtkFileChooserDialogPrivate *priv = GTK_FILE_CHOOSER_DIALOG_GET_PRIVATE (object);
 302
 303   switch (prop_id)
 304     {
 305     case GTK_FILE_CHOOSER_PROP_FILE_SYSTEM_BACKEND:
 306       g_free (priv->file_system);
 307       priv->file_system = g_value_dup_string (value);
 308       break;
 309     default:
 310       g_object_set_property (G_OBJECT (priv->widget), pspec->name, value);
 311       break;
 312     }
 313 }
 314
 315 static void
 316 gtk_file_chooser_dialog_get_property (GObject         *object,
 317                                       guint            prop_id,
 318                                       GValue          *value,
 319                                       GParamSpec      *pspec)
 320 {
 321   GtkFileChooserDialogPrivate *priv = GTK_FILE_CHOOSER_DIALOG_GET_PRIVATE (object);
 322
 323   g_object_get_property (G_OBJECT (priv->widget), pspec->name, value);
 324 }
 325
 326 static void
 327 foreach_ensure_default_response_cb (GtkWidget *widget,
 328                                     gpointer   data)
 329 {
 330   GtkFileChooserDialog *dialog = GTK_FILE_CHOOSER_DIALOG (data);
 331   int response_id;
 332
 333   response_id = gtk_dialog_get_response_for_widget (GTK_DIALOG (dialog), widget);
 334   if (is_stock_accept_response_id (response_id))
 335     gtk_dialog_set_default_response (GTK_DIALOG (dialog), response_id);
 336 }
 337
 338 static void
 339 ensure_default_response (GtkFileChooserDialog *dialog)
 340 {
 341   gtk_container_foreach (GTK_CONTAINER (GTK_DIALOG (dialog)->action_area),
 342                          foreach_ensure_default_response_cb,
 343                          dialog);
 344 }
 345
 346 /* GtkWidget::map handler */
 347 static void
 348 gtk_file_chooser_dialog_map (GtkWidget *widget)
 349 {
 350   GtkFileChooserDialog *dialog = GTK_FILE_CHOOSER_DIALOG (widget);
 351   GtkFileChooserDialogPrivate *priv = GTK_FILE_CHOOSER_DIALOG_GET_PRIVATE (dialog);
 352
 353   ensure_default_response (dialog);
 354
 355   if (!GTK_WIDGET_MAPPED (priv->widget))
 356     gtk_widget_map (priv->widget);
 357
 358   _gtk_file_chooser_embed_initial_focus (GTK_FILE_CHOOSER_EMBED (priv->widget));
 359
 360   GTK_WIDGET_CLASS (gtk_file_chooser_dialog_parent_class)->map (widget);
 361 }
 362
 363 /* GtkWidget::unmap handler */
 364 static void
 365 gtk_file_chooser_dialog_unmap (GtkWidget *widget)
 366 {
 367   GtkFileChooserDialog *dialog = GTK_FILE_CHOOSER_DIALOG (widget);
 368   GtkFileChooserDialogPrivate *priv = GTK_FILE_CHOOSER_DIALOG_GET_PRIVATE (dialog);
 369
 370   GTK_WIDGET_CLASS (gtk_file_chooser_dialog_parent_class)->unmap (widget);
 371
 372   /* See bug #145470.  We unmap the GtkFileChooserWidget so that if the dialog
 373    * is remapped, the widget will be remapped as well.  Implementations should
 374    * refresh their contents when this happens, as some applications keep a
 375    * single file chooser alive and map/unmap it as needed, rather than creating
 376    * a new file chooser every time they need one.
 377    */
 378   gtk_widget_unmap (priv->widget);
 379 }
 380
 381 /* GtkDialog::response handler */
 382 static void
 383 response_cb (GtkDialog *dialog,
 384              gint       response_id)
 385 {
 386   GtkFileChooserDialogPrivate *priv;
 387
 388   priv = GTK_FILE_CHOOSER_DIALOG_GET_PRIVATE (dialog);
 389
 390   /* Act only on response IDs we recognize */
 391   if (is_stock_accept_response_id (response_id)
 392       && !priv->response_requested
 393       && !_gtk_file_chooser_embed_should_respond (GTK_FILE_CHOOSER_EMBED (priv->widget)))
 394     {
 395       g_signal_stop_emission_by_name (dialog, "response");
 396     }
 397
 398   priv->response_requested = FALSE;
 399 }
 400
 401 static GtkWidget *
 402 gtk_file_chooser_dialog_new_valist (const gchar          *title,
 403                                     GtkWindow            *parent,
 404                                     GtkFileChooserAction  action,
 405                                     const gchar          *backend,
 406                                     const gchar          *first_button_text,
 407                                     va_list               varargs)
 408 {
 409   GtkWidget *result;
 410   const char *button_text = first_button_text;
 411   gint response_id;
 412
 413   result = g_object_new (GTK_TYPE_FILE_CHOOSER_DIALOG,
 414                          "title", title,
 415                          "action", action,
 416                          NULL);
 417
 418   if (parent)
 419     gtk_window_set_transient_for (GTK_WINDOW (result), parent);
 420
 421   while (button_text)
 422     {
 423       response_id = va_arg (varargs, gint);
 424       gtk_dialog_add_button (GTK_DIALOG (result), button_text, response_id);
 425       button_text = va_arg (varargs, const gchar *);
 426     }
 427
 428   return result;
 429 }
 430
 431 /**
 432  * gtk_file_chooser_dialog_new:
 433  * @title: Title of the dialog, or %NULL
 434  * @parent: Transient parent of the dialog, or %NULL
 435  * @action: Open or save mode for the dialog
 436  * @first_button_text: stock ID or text to go in the first button, or %NULL
 437  * @Varargs: response ID for the first button, then additional (button, id) pairs, ending with %NULL
 438  *
 439  * Creates a new #GtkFileChooserDialog.  This function is analogous to
 440  * gtk_dialog_new_with_buttons().
 441  *
 442  * Return value: a new #GtkFileChooserDialog
 443  *
 444  * Since: 2.4
 445  **/
 446 GtkWidget *
 447 gtk_file_chooser_dialog_new (const gchar         *title,
 448                              GtkWindow           *parent,
 449                              GtkFileChooserAction action,
 450                              const gchar         *first_button_text,
 451                              ...)
 452 {
 453   GtkWidget *result;
 454   va_list varargs;
 455
 456   va_start (varargs, first_button_text);
 457   result = gtk_file_chooser_dialog_new_valist (title, parent, action,
 458                                                NULL, first_button_text,
 459                                                varargs);
 460   va_end (varargs);
 461
 462   return result;
 463 }
 464
 465 /**
 466  * gtk_file_chooser_dialog_new_with_backend:
 467  * @title: Title of the dialog, or %NULL
 468  * @parent: Transient parent of the dialog, or %NULL
 469  * @action: Open or save mode for the dialog
 470  * @backend: The name of the specific filesystem backend to use.
 471  * @first_button_text: stock ID or text to go in the first button, or %NULL
 472  * @Varargs: response ID for the first button, then additional (button, id) pairs, ending with %NULL
 473  *
 474  * Creates a new #GtkFileChooserDialog with a specified backend. This is
 475  * especially useful if you use gtk_file_chooser_set_local_only() to allow
 476  * non-local files and you use a more expressive vfs, such as gnome-vfs,
 477  * to load files.
 478  *
 479  * Return value: a new #GtkFileChooserDialog
 480  *
 481  * Since: 2.4
 482  * Deprecated: 2.14
 483  **/
 484 GtkWidget *
 485 gtk_file_chooser_dialog_new_with_backend (const gchar          *title,
 486                                           GtkWindow            *parent,
 487                                           GtkFileChooserAction  action,
 488                                           const gchar          *backend,
 489                                           const gchar          *first_button_text,
 490                                           ...)
 491 {
 492   GtkWidget *result;
 493   va_list varargs;
 494
 495   va_start (varargs, first_button_text);
 496   result = gtk_file_chooser_dialog_new_valist (title, parent, action,
 497                                                backend, first_button_text,
 498                                                varargs);
 499   va_end (varargs);
 500
 501   return result;
 502 }
 503
 504 #define __GTK_FILE_CHOOSER_DIALOG_C__
 505 #include "gtkaliasdef.c"