src/gtk/filedlg.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/gtk/filedlg.cpp
   3 // Purpose:     native implementation of wxFileDialog
   4 // Author:      Robert Roebling, Zbigniew Zagorski, Mart Raudsepp
   5 // Copyright:   (c) 1998 Robert Roebling, 2004 Zbigniew Zagorski, 2005 Mart Raudsepp
   6 // Licence:     wxWindows licence
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 // For compilers that support precompilation, includes "wx.h".
  10 #include "wx/wxprec.h"
  11
  12 #if wxUSE_FILEDLG
  13
  14 #include "wx/filedlg.h"
  15
  16 #ifndef WX_PRECOMP
  17     #include "wx/intl.h"
  18     #include "wx/msgdlg.h"
  19 #endif
  20
  21 #include <gtk/gtk.h>
  22 #include "wx/gtk/private.h"
  23
  24 #ifdef __UNIX__
  25 #include <unistd.h> // chdir
  26 #endif
  27
  28 #include "wx/filename.h" // wxFilename
  29 #include "wx/tokenzr.h" // wxStringTokenizer
  30 #include "wx/filefn.h" // ::wxGetCwd
  31 #include "wx/modalhook.h"
  32
  33 //-----------------------------------------------------------------------------
  34 // "clicked" for OK-button
  35 //-----------------------------------------------------------------------------
  36
  37 extern "C" {
  38 static void gtk_filedialog_ok_callback(GtkWidget *widget, wxFileDialog *dialog)
  39 {
  40     int style = dialog->GetWindowStyle();
  41     wxGtkString filename(gtk_file_chooser_get_filename(GTK_FILE_CHOOSER(widget)));
  42
  43     // gtk version numbers must be identical with the one in ctor (that calls set_do_overwrite_confirmation)
  44 #ifndef __WXGTK3__
  45 #if GTK_CHECK_VERSION(2,7,3)
  46     if (gtk_check_version(2, 7, 3) != NULL)
  47 #endif
  48     {
  49         if ((style & wxFD_SAVE) && (style & wxFD_OVERWRITE_PROMPT))
  50         {
  51             if ( g_file_test(filename, G_FILE_TEST_EXISTS) )
  52             {
  53                 wxString msg;
  54
  55                 msg.Printf(
  56                     _("File '%s' already exists, do you really want to overwrite it?"),
  57                     wxString::FromUTF8(filename));
  58
  59                 wxMessageDialog dlg(dialog, msg, _("Confirm"),
  60                                    wxYES_NO | wxICON_QUESTION);
  61                 if (dlg.ShowModal() != wxID_YES)
  62                     return;
  63             }
  64         }
  65     }
  66 #endif
  67
  68     if (style & wxFD_FILE_MUST_EXIST)
  69     {
  70         if ( !g_file_test(filename, G_FILE_TEST_EXISTS) )
  71         {
  72             wxMessageDialog dlg( dialog, _("Please choose an existing file."),
  73                                  _("Error"), wxOK| wxICON_ERROR);
  74             dlg.ShowModal();
  75             return;
  76         }
  77     }
  78
  79     // change to the directory where the user went if asked
  80     if (style & wxFD_CHANGE_DIR)
  81     {
  82         // Use chdir to not care about filename encodings
  83         wxGtkString folder(g_path_get_dirname(filename));
  84         chdir(folder);
  85     }
  86
  87     wxCommandEvent event(wxEVT_BUTTON, wxID_OK);
  88     event.SetEventObject(dialog);
  89     dialog->HandleWindowEvent(event);
  90 }
  91 }
  92
  93 //-----------------------------------------------------------------------------
  94 // "clicked" for Cancel-button
  95 //-----------------------------------------------------------------------------
  96
  97 extern "C"
  98 {
  99
 100 static void
 101 gtk_filedialog_cancel_callback(GtkWidget * WXUNUSED(w), wxFileDialog *dialog)
 102 {
 103     wxCommandEvent event(wxEVT_COMMAND_BUTTON_CLICKED, wxID_CANCEL);
 104     event.SetEventObject(dialog);
 105     dialog->HandleWindowEvent(event);
 106 }
 107
 108 static void gtk_filedialog_response_callback(GtkWidget *w,
 109                                              gint response,
 110                                              wxFileDialog *dialog)
 111 {
 112     if (response == GTK_RESPONSE_ACCEPT)
 113         gtk_filedialog_ok_callback(w, dialog);
 114     else    // GTK_RESPONSE_CANCEL or GTK_RESPONSE_NONE
 115         gtk_filedialog_cancel_callback(w, dialog);
 116 }
 117
 118 static void gtk_filedialog_selchanged_callback(GtkFileChooser *chooser,
 119                                                wxFileDialog *dialog)
 120 {
 121     wxGtkString filename(gtk_file_chooser_get_preview_filename(chooser));
 122
 123     dialog->GTKSelectionChanged(wxString::FromUTF8(filename));
 124 }
 125
 126
 127 static void gtk_filedialog_update_preview_callback(GtkFileChooser *chooser,
 128                                                    gpointer user_data)
 129 {
 130     GtkWidget *preview = GTK_WIDGET(user_data);
 131
 132     wxGtkString filename(gtk_file_chooser_get_preview_filename(chooser));
 133
 134     if ( !filename )
 135         return;
 136
 137     GdkPixbuf *pixbuf = gdk_pixbuf_new_from_file_at_size(filename, 128, 128, NULL);
 138     gboolean have_preview = pixbuf != NULL;
 139
 140     gtk_image_set_from_pixbuf(GTK_IMAGE(preview), pixbuf);
 141     if ( pixbuf )
 142         g_object_unref (pixbuf);
 143
 144     gtk_file_chooser_set_preview_widget_active(chooser, have_preview);
 145 }
 146
 147 } // extern "C"
 148
 149 void wxFileDialog::AddChildGTK(wxWindowGTK* child)
 150 {
 151     // allow dialog to be resized smaller horizontally
 152     gtk_widget_set_size_request(
 153         child->m_widget, child->GetMinWidth(), child->m_height);
 154
 155     gtk_file_chooser_set_extra_widget(
 156         GTK_FILE_CHOOSER(m_widget), child->m_widget);
 157 }
 158
 159 //-----------------------------------------------------------------------------
 160 // wxFileDialog
 161 //-----------------------------------------------------------------------------
 162
 163 IMPLEMENT_DYNAMIC_CLASS(wxFileDialog,wxFileDialogBase)
 164
 165 BEGIN_EVENT_TABLE(wxFileDialog,wxFileDialogBase)
 166     EVT_BUTTON(wxID_OK, wxFileDialog::OnFakeOk)
 167     EVT_SIZE(wxFileDialog::OnSize)
 168 END_EVENT_TABLE()
 169
 170 wxFileDialog::wxFileDialog(wxWindow *parent, const wxString& message,
 171                            const wxString& defaultDir,
 172                            const wxString& defaultFileName,
 173                            const wxString& wildCard,
 174                            long style, const wxPoint& pos,
 175                            const wxSize& sz,
 176                            const wxString& name)
 177     : wxFileDialogBase()
 178 {
 179     Create(parent, message, defaultDir, defaultFileName, wildCard, style, pos, sz, name);
 180 }
 181
 182 bool wxFileDialog::Create(wxWindow *parent, const wxString& message,
 183                            const wxString& defaultDir,
 184                            const wxString& defaultFileName,
 185                            const wxString& wildCard,
 186                            long style, const wxPoint& pos,
 187                            const wxSize& sz,
 188                            const wxString& name)
 189 {
 190     parent = GetParentForModalDialog(parent, style);
 191
 192     if (!wxFileDialogBase::Create(parent, message, defaultDir, defaultFileName,
 193                                   wildCard, style, pos, sz, name))
 194     {
 195         return false;
 196     }
 197
 198     if (!PreCreation(parent, pos, wxDefaultSize) ||
 199         !CreateBase(parent, wxID_ANY, pos, wxDefaultSize, style,
 200                 wxDefaultValidator, wxT("filedialog")))
 201     {
 202         wxFAIL_MSG( wxT("wxFileDialog creation failed") );
 203         return false;
 204     }
 205
 206     GtkFileChooserAction gtk_action;
 207     GtkWindow* gtk_parent = NULL;
 208     if (parent)
 209         gtk_parent = GTK_WINDOW( gtk_widget_get_toplevel(parent->m_widget) );
 210
 211     const gchar* ok_btn_stock;
 212     if ( style & wxFD_SAVE )
 213     {
 214         gtk_action = GTK_FILE_CHOOSER_ACTION_SAVE;
 215         ok_btn_stock = GTK_STOCK_SAVE;
 216     }
 217     else
 218     {
 219         gtk_action = GTK_FILE_CHOOSER_ACTION_OPEN;
 220         ok_btn_stock = GTK_STOCK_OPEN;
 221     }
 222
 223     m_widget = gtk_file_chooser_dialog_new(
 224                    wxGTK_CONV(m_message),
 225                    gtk_parent,
 226                    gtk_action,
 227                    GTK_STOCK_CANCEL, GTK_RESPONSE_CANCEL,
 228                    ok_btn_stock, GTK_RESPONSE_ACCEPT,
 229                    NULL);
 230     g_object_ref(m_widget);
 231     GtkFileChooser* file_chooser = GTK_FILE_CHOOSER(m_widget);
 232
 233     m_fc.SetWidget(file_chooser);
 234
 235     gtk_dialog_set_default_response(GTK_DIALOG(m_widget), GTK_RESPONSE_ACCEPT);
 236
 237     if ( style & wxFD_MULTIPLE )
 238         gtk_file_chooser_set_select_multiple(file_chooser, true);
 239
 240     // gtk_widget_hide_on_delete is used here to avoid that Gtk automatically
 241     // destroys the dialog when the user press ESC on the dialog: in that case
 242     // a second call to ShowModal() would result in a bunch of Gtk-CRITICAL
 243     // errors...
 244     g_signal_connect(m_widget,
 245                     "delete_event",
 246                     G_CALLBACK (gtk_widget_hide_on_delete),
 247                     this);
 248
 249     // local-only property could be set to false to allow non-local files to be
 250     // loaded. In that case get/set_uri(s) should be used instead of
 251     // get/set_filename(s) everywhere and the GtkFileChooserDialog should
 252     // probably also be created with a backend, e.g. "gnome-vfs", "default", ...
 253     // (gtk_file_chooser_dialog_new_with_backend). Currently local-only is kept
 254     // as the default - true:
 255     // gtk_file_chooser_set_local_only(GTK_FILE_CHOOSER(m_widget), true);
 256
 257     g_signal_connect (m_widget, "response",
 258         G_CALLBACK (gtk_filedialog_response_callback), this);
 259
 260     g_signal_connect (m_widget, "selection-changed",
 261         G_CALLBACK (gtk_filedialog_selchanged_callback), this);
 262
 263     // deal with extensions/filters
 264     SetWildcard(wildCard);
 265
 266     wxString defaultFileNameWithExt = defaultFileName;
 267     if ( !wildCard.empty() && !defaultFileName.empty() &&
 268             !wxFileName(defaultFileName).HasExt() )
 269     {
 270         // append the default extension, if any, to the initial file name: GTK
 271         // won't do it for us by default (unlike e.g. MSW)
 272         const wxFileName fnWC(m_fc.GetCurrentWildCard());
 273         if ( fnWC.HasExt() )
 274         {
 275             // Notice that we shouldn't append the extension if it's a wildcard
 276             // because this is not useful: the user would need to change it to use
 277             // some fixed extension anyhow.
 278             const wxString& ext = fnWC.GetExt();
 279             if ( ext.find_first_of("?*") == wxString::npos )
 280                 defaultFileNameWithExt << "." << ext;
 281         }
 282     }
 283
 284
 285     // if defaultDir is specified it should contain the directory and
 286     // defaultFileName should contain the default name of the file, however if
 287     // directory is not given, defaultFileName contains both
 288     wxFileName fn;
 289     if ( defaultDir.empty() )
 290         fn.Assign(defaultFileNameWithExt);
 291     else if ( !defaultFileNameWithExt.empty() )
 292         fn.Assign(defaultDir, defaultFileNameWithExt);
 293     else
 294         fn.AssignDir(defaultDir);
 295
 296     // set the initial file name and/or directory
 297     fn.MakeAbsolute(); // GTK+ needs absolute path
 298     const wxString dir = fn.GetPath();
 299     if ( !dir.empty() )
 300     {
 301         gtk_file_chooser_set_current_folder(file_chooser, wxGTK_CONV_FN(dir));
 302     }
 303
 304     const wxString fname = fn.GetFullName();
 305     if ( style & wxFD_SAVE )
 306     {
 307         if ( !fname.empty() )
 308         {
 309             gtk_file_chooser_set_current_name(file_chooser, wxGTK_CONV_FN(fname));
 310         }
 311
 312 #if GTK_CHECK_VERSION(2,7,3)
 313         if ((style & wxFD_OVERWRITE_PROMPT)
 314 #ifndef __WXGTK3__
 315             && gtk_check_version(2,7,3) == NULL
 316 #endif
 317             )
 318         {
 319             gtk_file_chooser_set_do_overwrite_confirmation(file_chooser, true);
 320         }
 321 #endif
 322     }
 323     else // wxFD_OPEN
 324     {
 325         if ( !fname.empty() )
 326         {
 327             gtk_file_chooser_set_filename(file_chooser,
 328                                           wxGTK_CONV_FN(fn.GetFullPath()));
 329         }
 330     }
 331
 332     if ( style & wxFD_PREVIEW )
 333     {
 334         GtkWidget *previewImage = gtk_image_new();
 335
 336         gtk_file_chooser_set_preview_widget(file_chooser, previewImage);
 337         g_signal_connect(m_widget, "update-preview",
 338                          G_CALLBACK(gtk_filedialog_update_preview_callback),
 339                          previewImage);
 340     }
 341
 342     return true;
 343 }
 344
 345 wxFileDialog::~wxFileDialog()
 346 {
 347     if (m_extraControl)
 348     {
 349         // get chooser to drop its reference right now, allowing wxWindow dtor
 350         // to verify that ref count drops to zero
 351         gtk_file_chooser_set_extra_widget(
 352             GTK_FILE_CHOOSER(m_widget), NULL);
 353     }
 354 }
 355
 356 void wxFileDialog::OnFakeOk(wxCommandEvent& WXUNUSED(event))
 357 {
 358     // Update the current directory from here, accessing it later may not work
 359     // due to the strange way GtkFileChooser works.
 360     wxGtkString
 361         str(gtk_file_chooser_get_current_folder(GTK_FILE_CHOOSER(m_widget)));
 362     m_dir = wxString::FromUTF8(str);
 363
 364     EndDialog(wxID_OK);
 365 }
 366
 367 int wxFileDialog::ShowModal()
 368 {
 369     WX_HOOK_MODAL_DIALOG();
 370
 371     CreateExtraControl();
 372
 373     return wxDialog::ShowModal();
 374 }
 375
 376 void wxFileDialog::DoSetSize(int WXUNUSED(x), int WXUNUSED(y),
 377                              int WXUNUSED(width), int WXUNUSED(height),
 378                              int WXUNUSED(sizeFlags))
 379 {
 380 }
 381
 382 void wxFileDialog::OnSize(wxSizeEvent&)
 383 {
 384     // avoid calling DoLayout(), which will set the (wrong) size of
 385     // m_extraControl, its size is managed by GtkFileChooser
 386 }
 387
 388 wxString wxFileDialog::GetPath() const
 389 {
 390     return m_fc.GetPath();
 391 }
 392
 393 void wxFileDialog::GetFilenames(wxArrayString& files) const
 394 {
 395     m_fc.GetFilenames( files );
 396 }
 397
 398 void wxFileDialog::GetPaths(wxArrayString& paths) const
 399 {
 400     m_fc.GetPaths( paths );
 401 }
 402
 403 void wxFileDialog::SetMessage(const wxString& message)
 404 {
 405     m_message = message;
 406     SetTitle(message);
 407 }
 408
 409 void wxFileDialog::SetPath(const wxString& path)
 410 {
 411     wxFileDialogBase::SetPath(path);
 412
 413     // Don't do anything if no path is specified, in particular don't set the
 414     // path to m_dir below as this would result in opening the dialog in the
 415     // parent directory of this one instead of m_dir itself.
 416     if ( path.empty() )
 417         return;
 418
 419     // we need an absolute path for GTK native chooser so ensure that we have
 420     // it: use the initial directory if it was set or just CWD otherwise (this
 421     // is the default behaviour if m_dir is empty)
 422     wxFileName fn(path);
 423     fn.MakeAbsolute(m_dir);
 424     m_fc.SetPath(fn.GetFullPath());
 425 }
 426
 427 void wxFileDialog::SetDirectory(const wxString& dir)
 428 {
 429     wxFileDialogBase::SetDirectory(dir);
 430
 431     m_fc.SetDirectory(dir);
 432 }
 433
 434 void wxFileDialog::SetFilename(const wxString& name)
 435 {
 436     wxFileDialogBase::SetFilename(name);
 437
 438     if (HasFdFlag(wxFD_SAVE))
 439     {
 440         gtk_file_chooser_set_current_name(GTK_FILE_CHOOSER(m_widget), wxGTK_CONV(name));
 441     }
 442
 443     else
 444     {
 445         wxString path( GetDirectory() );
 446         if (path.empty())
 447         {
 448             // SetPath() fires an assert if fed other than filepaths
 449             return;
 450         }
 451         SetPath(wxFileName(path, name).GetFullPath());
 452     }
 453 }
 454
 455 wxString wxFileDialog::GetFilename() const
 456 {
 457     wxString currentFilename( m_fc.GetFilename() );
 458     if (currentFilename.empty())
 459     {
 460         // m_fc.GetFilename() will return empty until the dialog has been shown
 461         // in which case use any previously provided value
 462         currentFilename = m_fileName;
 463     }
 464     return currentFilename;
 465 }
 466
 467 void wxFileDialog::SetWildcard(const wxString& wildCard)
 468 {
 469     wxFileDialogBase::SetWildcard(wildCard);
 470     m_fc.SetWildcard( GetWildcard() );
 471 }
 472
 473 void wxFileDialog::SetFilterIndex(int filterIndex)
 474 {
 475     m_fc.SetFilterIndex( filterIndex);
 476 }
 477
 478 int wxFileDialog::GetFilterIndex() const
 479 {
 480     return m_fc.GetFilterIndex();
 481 }
 482
 483 void wxFileDialog::GTKSelectionChanged(const wxString& filename)
 484 {
 485     m_currentlySelectedFilename = filename;
 486
 487     if (m_extraControl)
 488         m_extraControl->UpdateWindowUI(wxUPDATE_UI_RECURSE);
 489 }
 490
 491 #endif // wxUSE_FILEDLG