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
 185   priv = GTK_FILE_CHOOSER_DIALOG_GET_PRIVATE (dialog);
 186
 187   /* Unset any previously set size */
 188   gtk_widget_set_size_request (GTK_WIDGET (dialog), -1, -1);
 189
 190   if (GTK_WIDGET_DRAWABLE (widget))
 191     {
 192       /* Force a size request of everything before we start.  This will make sure
 193        * that widget->requisition is meaningful. */
 194       gtk_widget_size_request (GTK_WIDGET (dialog), &req);
 195       gtk_widget_size_request (widget, &widget_req);
 196     }
 197
 198   _gtk_file_chooser_embed_get_default_size (GTK_FILE_CHOOSER_EMBED (priv->widget),
 199                                             &default_width, &default_height);
 200
 201   gtk_window_resize (GTK_WINDOW (dialog), default_width, default_height);
 202
 203   if (!GTK_WIDGET_MAPPED (dialog))
 204     {
 205 #if 0
 206       /* FIXME: the code to restore the position does not work yet.  It is not
 207        * clear whether it is actually desirable --- if enabled, applications
 208        * would not be able to say "center the file chooser on top of my toplevel
 209        * window".  So, we don't use this code at all.
 210        */
 211       load_position (&xpos, &ypos);
 212       if (xpos >= 0 && ypos >= 0)
 213         {
 214           gtk_window_set_position (GTK_WINDOW (dialog), GTK_WIN_POS_NONE);
 215           gtk_window_move (GTK_WINDOW (dialog), xpos, ypos);
 216         }
 217 #endif
 218     }
 219 }
 220
 221 static void
 222 file_chooser_widget_response_requested (GtkWidget            *widget,
 223                                         GtkFileChooserDialog *dialog)
 224 {
 225   GList *children, *l;
 226
 227   /* There probably isn't a default widget, so make things easier for the
 228    * programmer by looking for a reasonable button on our own.
 229    */
 230
 231   children = gtk_container_get_children (GTK_CONTAINER (GTK_DIALOG (dialog)->action_area));
 232
 233   for (l = children; l; l = l->next)
 234     {
 235       GtkWidget *widget;
 236       int response_id;
 237
 238       widget = GTK_WIDGET (l->data);
 239       response_id = gtk_dialog_get_response_for_widget (GTK_DIALOG (dialog), widget);
 240       if (is_stock_accept_response_id (response_id))
 241         {
 242           dialog->priv->response_requested = TRUE;
 243           gtk_widget_activate (widget); /* Should we gtk_dialog_response (dialog, response_id) instead? */
 244           break;
 245         }
 246     }
 247
 248   g_list_free (children);
 249 }
 250
 251 static GObject*
 252 gtk_file_chooser_dialog_constructor (GType                  type,
 253                                      guint                  n_construct_properties,
 254                                      GObjectConstructParam *construct_params)
 255 {
 256   GtkFileChooserDialogPrivate *priv;
 257   GObject *object;
 258
 259   object = G_OBJECT_CLASS (gtk_file_chooser_dialog_parent_class)->constructor (type,
 260                                                                                n_construct_properties,
 261                                                                                construct_params);
 262   priv = GTK_FILE_CHOOSER_DIALOG_GET_PRIVATE (object);
 263
 264   gtk_widget_push_composite_child ();
 265
 266   if (priv->file_system)
 267     priv->widget = g_object_new (GTK_TYPE_FILE_CHOOSER_WIDGET,
 268                                  "file-system-backend", priv->file_system,
 269                                  NULL);
 270   else
 271     priv->widget = g_object_new (GTK_TYPE_FILE_CHOOSER_WIDGET, NULL);
 272
 273   g_signal_connect (priv->widget, "file-activated",
 274                     G_CALLBACK (file_chooser_widget_file_activated), object);
 275   g_signal_connect (priv->widget, "default-size-changed",
 276                     G_CALLBACK (file_chooser_widget_default_size_changed), object);
 277   g_signal_connect (priv->widget, "response-requested",
 278                     G_CALLBACK (file_chooser_widget_response_requested), object);
 279
 280   gtk_container_set_border_width (GTK_CONTAINER (priv->widget), 5);
 281   gtk_box_pack_start (GTK_BOX (GTK_DIALOG (object)->vbox), priv->widget, TRUE, TRUE, 0);
 282
 283   gtk_widget_show (priv->widget);
 284
 285   _gtk_file_chooser_set_delegate (GTK_FILE_CHOOSER (object),
 286                                   GTK_FILE_CHOOSER (priv->widget));
 287
 288   gtk_widget_pop_composite_child ();
 289
 290   return object;
 291 }
 292
 293 static void
 294 gtk_file_chooser_dialog_set_property (GObject         *object,
 295                                       guint            prop_id,
 296                                       const GValue    *value,
 297                                       GParamSpec      *pspec)
 298
 299 {
 300   GtkFileChooserDialogPrivate *priv = GTK_FILE_CHOOSER_DIALOG_GET_PRIVATE (object);
 301
 302   switch (prop_id)
 303     {
 304     case GTK_FILE_CHOOSER_PROP_FILE_SYSTEM_BACKEND:
 305       g_free (priv->file_system);
 306       priv->file_system = g_value_dup_string (value);
 307       break;
 308     default:
 309       g_object_set_property (G_OBJECT (priv->widget), pspec->name, value);
 310       break;
 311     }
 312 }
 313
 314 static void
 315 gtk_file_chooser_dialog_get_property (GObject         *object,
 316                                       guint            prop_id,
 317                                       GValue          *value,
 318                                       GParamSpec      *pspec)
 319 {
 320   GtkFileChooserDialogPrivate *priv = GTK_FILE_CHOOSER_DIALOG_GET_PRIVATE (object);
 321
 322   g_object_get_property (G_OBJECT (priv->widget), pspec->name, value);
 323 }
 324
 325 static void
 326 foreach_ensure_default_response_cb (GtkWidget *widget,
 327                                     gpointer   data)
 328 {
 329   GtkFileChooserDialog *dialog = GTK_FILE_CHOOSER_DIALOG (data);
 330   int response_id;
 331
 332   response_id = gtk_dialog_get_response_for_widget (GTK_DIALOG (dialog), widget);
 333   if (is_stock_accept_response_id (response_id))
 334     gtk_dialog_set_default_response (GTK_DIALOG (dialog), response_id);
 335 }
 336
 337 static void
 338 ensure_default_response (GtkFileChooserDialog *dialog)
 339 {
 340   gtk_container_foreach (GTK_CONTAINER (GTK_DIALOG (dialog)->action_area),
 341                          foreach_ensure_default_response_cb,
 342                          dialog);
 343 }
 344
 345 /* GtkWidget::map handler */
 346 static void
 347 gtk_file_chooser_dialog_map (GtkWidget *widget)
 348 {
 349   GtkFileChooserDialog *dialog = GTK_FILE_CHOOSER_DIALOG (widget);
 350   GtkFileChooserDialogPrivate *priv = GTK_FILE_CHOOSER_DIALOG_GET_PRIVATE (dialog);
 351
 352   ensure_default_response (dialog);
 353
 354   if (!GTK_WIDGET_MAPPED (priv->widget))
 355     gtk_widget_map (priv->widget);
 356
 357   _gtk_file_chooser_embed_initial_focus (GTK_FILE_CHOOSER_EMBED (priv->widget));
 358
 359   GTK_WIDGET_CLASS (gtk_file_chooser_dialog_parent_class)->map (widget);
 360 }
 361
 362 /* GtkWidget::unmap handler */
 363 static void
 364 gtk_file_chooser_dialog_unmap (GtkWidget *widget)
 365 {
 366   GtkFileChooserDialog *dialog = GTK_FILE_CHOOSER_DIALOG (widget);
 367   GtkFileChooserDialogPrivate *priv = GTK_FILE_CHOOSER_DIALOG_GET_PRIVATE (dialog);
 368
 369   GTK_WIDGET_CLASS (gtk_file_chooser_dialog_parent_class)->unmap (widget);
 370
 371   /* See bug #145470.  We unmap the GtkFileChooserWidget so that if the dialog
 372    * is remapped, the widget will be remapped as well.  Implementations should
 373    * refresh their contents when this happens, as some applications keep a
 374    * single file chooser alive and map/unmap it as needed, rather than creating
 375    * a new file chooser every time they need one.
 376    */
 377   gtk_widget_unmap (priv->widget);
 378 }
 379
 380 /* GtkDialog::response handler */
 381 static void
 382 response_cb (GtkDialog *dialog,
 383              gint       response_id)
 384 {
 385   GtkFileChooserDialogPrivate *priv;
 386
 387   priv = GTK_FILE_CHOOSER_DIALOG_GET_PRIVATE (dialog);
 388
 389   /* Act only on response IDs we recognize */
 390   if (is_stock_accept_response_id (response_id)
 391       && !priv->response_requested
 392       && !_gtk_file_chooser_embed_should_respond (GTK_FILE_CHOOSER_EMBED (priv->widget)))
 393     {
 394       g_signal_stop_emission_by_name (dialog, "response");
 395     }
 396
 397   priv->response_requested = FALSE;
 398 }
 399
 400 static GtkWidget *
 401 gtk_file_chooser_dialog_new_valist (const gchar          *title,
 402                                     GtkWindow            *parent,
 403                                     GtkFileChooserAction  action,
 404                                     const gchar          *backend,
 405                                     const gchar          *first_button_text,
 406                                     va_list               varargs)
 407 {
 408   GtkWidget *result;
 409   const char *button_text = first_button_text;
 410   gint response_id;
 411
 412   result = g_object_new (GTK_TYPE_FILE_CHOOSER_DIALOG,
 413                          "title", title,
 414                          "action", action,
 415                          NULL);
 416
 417   if (parent)
 418     gtk_window_set_transient_for (GTK_WINDOW (result), parent);
 419
 420   while (button_text)
 421     {
 422       response_id = va_arg (varargs, gint);
 423       gtk_dialog_add_button (GTK_DIALOG (result), button_text, response_id);
 424       button_text = va_arg (varargs, const gchar *);
 425     }
 426
 427   return result;
 428 }
 429
 430 /**
 431  * gtk_file_chooser_dialog_new:
 432  * @title: Title of the dialog, or %NULL
 433  * @parent: Transient parent of the dialog, or %NULL
 434  * @action: Open or save mode for the dialog
 435  * @first_button_text: stock ID or text to go in the first button, or %NULL
 436  * @Varargs: response ID for the first button, then additional (button, id) pairs, ending with %NULL
 437  *
 438  * Creates a new #GtkFileChooserDialog.  This function is analogous to
 439  * gtk_dialog_new_with_buttons().
 440  *
 441  * Return value: a new #GtkFileChooserDialog
 442  *
 443  * Since: 2.4
 444  **/
 445 GtkWidget *
 446 gtk_file_chooser_dialog_new (const gchar         *title,
 447                              GtkWindow           *parent,
 448                              GtkFileChooserAction action,
 449                              const gchar         *first_button_text,
 450                              ...)
 451 {
 452   GtkWidget *result;
 453   va_list varargs;
 454
 455   va_start (varargs, first_button_text);
 456   result = gtk_file_chooser_dialog_new_valist (title, parent, action,
 457                                                NULL, first_button_text,
 458                                                varargs);
 459   va_end (varargs);
 460
 461   return result;
 462 }
 463
 464 /**
 465  * gtk_file_chooser_dialog_new_with_backend:
 466  * @title: Title of the dialog, or %NULL
 467  * @parent: Transient parent of the dialog, or %NULL
 468  * @action: Open or save mode for the dialog
 469  * @backend: The name of the specific filesystem backend to use.
 470  * @first_button_text: stock ID or text to go in the first button, or %NULL
 471  * @Varargs: response ID for the first button, then additional (button, id) pairs, ending with %NULL
 472  *
 473  * Creates a new #GtkFileChooserDialog with a specified backend. This is
 474  * especially useful if you use gtk_file_chooser_set_local_only() to allow
 475  * non-local files and you use a more expressive vfs, such as gnome-vfs,
 476  * to load files.
 477  *
 478  * Return value: a new #GtkFileChooserDialog
 479  *
 480  * Since: 2.4
 481  * Deprecated: 2.14
 482  **/
 483 GtkWidget *
 484 gtk_file_chooser_dialog_new_with_backend (const gchar          *title,
 485                                           GtkWindow            *parent,
 486                                           GtkFileChooserAction  action,
 487                                           const gchar          *backend,
 488                                           const gchar          *first_button_text,
 489                                           ...)
 490 {
 491   GtkWidget *result;
 492   va_list varargs;
 493
 494   va_start (varargs, first_button_text);
 495   result = gtk_file_chooser_dialog_new_valist (title, parent, action,
 496                                                backend, first_button_text,
 497                                                varargs);
 498   va_end (varargs);
 499
 500   return result;
 501 }
 502
 503 #define __GTK_FILE_CHOOSER_DIALOG_C__
 504 #include "gtkaliasdef.c"