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