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