src/gtk/filepicker.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/gtk/filepicker.cpp
   3 // Purpose:     implementation of wxFileButton and wxDirButton
   4 // Author:      Francesco Montorsi
   5 // Modified By:
   6 // Created:     15/04/2006
   7 // Copyright:   (c) Francesco Montorsi
   8 // Licence:     wxWindows licence
   9 /////////////////////////////////////////////////////////////////////////////
  10
  11
  12 // ----------------------------------------------------------------------------
  13 // headers
  14 // ----------------------------------------------------------------------------
  15
  16 // For compilers that support precompilation, includes "wx.h".
  17 #include "wx/wxprec.h"
  18
  19 #if wxUSE_FILEPICKERCTRL
  20
  21 #include "wx/filepicker.h"
  22 #include "wx/tooltip.h"
  23
  24 #include <gtk/gtk.h>
  25 #include "wx/gtk/private.h"
  26
  27 // ============================================================================
  28 // implementation
  29 // ============================================================================
  30
  31 //-----------------------------------------------------------------------------
  32 // wxFileButton
  33 //-----------------------------------------------------------------------------
  34
  35 IMPLEMENT_DYNAMIC_CLASS(wxFileButton, wxButton)
  36
  37 bool wxFileButton::Create( wxWindow *parent, wxWindowID id,
  38                         const wxString &label, const wxString &path,
  39                         const wxString &message, const wxString &wildcard,
  40                         const wxPoint &pos, const wxSize &size,
  41                         long style, const wxValidator& validator,
  42                         const wxString &name )
  43 {
  44     // we can't use the native button for wxFLP_SAVE pickers as it can only
  45     // open existing files and there is no way to create a new file using it
  46     if (!(style & wxFLP_SAVE) && !(style & wxFLP_USE_TEXTCTRL))
  47     {
  48         // VERY IMPORTANT: this code is identical to relative code in wxDirButton;
  49         //                 if you find a problem here, fix it also in wxDirButton !
  50
  51         if (!PreCreation( parent, pos, size ) ||
  52             !wxControl::CreateBase(parent, id, pos, size, style & wxWINDOW_STYLE_MASK,
  53                                     validator, name))
  54         {
  55             wxFAIL_MSG( wxT("wxFileButton creation failed") );
  56             return false;
  57         }
  58
  59         // create the dialog associated with this button
  60         // NB: unlike generic implementation, native GTK implementation needs to create
  61         //     the filedialog here as it needs to use gtk_file_chooser_button_new_with_dialog()
  62         SetWindowStyle(style);
  63         m_path = path;
  64         m_message = message;
  65         m_wildcard = wildcard;
  66         if ((m_dialog = CreateDialog()) == NULL)
  67             return false;
  68
  69         // little trick used to avoid problems when there are other GTK windows 'grabbed':
  70         // GtkFileChooserDialog won't be responsive to user events if there is another
  71         // window which called gtk_grab_add (and this happens if e.g. a wxDialog is running
  72         // in modal mode in the application - see wxDialogGTK::ShowModal).
  73         // An idea could be to put the grab on the m_dialog->m_widget when the GtkFileChooserButton
  74         // is clicked and then remove it as soon as the user closes the dialog itself.
  75         // Unfortunately there's no way to hook in the 'clicked' event of the GtkFileChooserButton,
  76         // thus we add grab on m_dialog->m_widget when it's shown and remove it when it's
  77         // hidden simply using its "show" and "hide" events - clean & simple :)
  78         g_signal_connect(m_dialog->m_widget, "show", G_CALLBACK(gtk_grab_add), NULL);
  79         g_signal_connect(m_dialog->m_widget, "hide", G_CALLBACK(gtk_grab_remove), NULL);
  80
  81         //       use as label the currently selected file
  82         m_widget = gtk_file_chooser_button_new_with_dialog( m_dialog->m_widget );
  83         g_object_ref(m_widget);
  84
  85         // we need to know when the dialog has been dismissed clicking OK...
  86         // NOTE: the "clicked" signal is not available for a GtkFileChooserButton
  87         //       thus we are forced to use wxFileDialog's event
  88         m_dialog->Connect(wxEVT_BUTTON,
  89                 wxCommandEventHandler(wxFileButton::OnDialogOK),
  90                 NULL, this);
  91
  92         m_parent->DoAddChild( this );
  93
  94         PostCreation(size);
  95         SetInitialSize(size);
  96     }
  97     else
  98         return wxGenericFileButton::Create(parent, id, label, path, message, wildcard,
  99                                            pos, size, style, validator, name);
 100     return true;
 101 }
 102
 103 wxFileButton::~wxFileButton()
 104 {
 105     if ( m_dialog )
 106     {
 107         // when m_dialog is deleted, it will destroy the widget it is sharing
 108         // with GtkFileChooserButton, which results in a bunch of Gtk-CRITICAL
 109         // errors from GtkFileChooserButton. To avoid this, call gtk_widget_destroy()
 110         // on GtkFileChooserButton first (our base dtor will do it again, but
 111         // that does no harm). m_dialog holds a reference to the shared widget,
 112         // so it won't go away until m_dialog base dtor unrefs it.
 113         gtk_widget_destroy(m_widget);
 114         delete m_dialog;
 115     }
 116 }
 117
 118 void wxFileButton::OnDialogOK(wxCommandEvent& ev)
 119 {
 120     // the wxFileDialog associated with the GtkFileChooserButton has been closed
 121     // using the OK button, thus the selected file has changed...
 122     if (ev.GetId() == wxID_OK)
 123     {
 124         // ...update our path
 125         UpdatePathFromDialog(m_dialog);
 126
 127         // ...and fire an event
 128         wxFileDirPickerEvent event(wxEVT_FILEPICKER_CHANGED, this, GetId(), m_path);
 129         HandleWindowEvent(event);
 130     }
 131 }
 132
 133 void wxFileButton::SetPath(const wxString &str)
 134 {
 135     m_path = str;
 136
 137     if (m_dialog)
 138         UpdateDialogPath(m_dialog);
 139 }
 140
 141 void wxFileButton::SetInitialDirectory(const wxString& dir)
 142 {
 143     if (m_dialog)
 144     {
 145         // Only change the directory if the default file name doesn't have any
 146         // directory in it, otherwise it takes precedence.
 147         if ( m_path.find_first_of(wxFileName::GetPathSeparators()) ==
 148                 wxString::npos )
 149         {
 150             static_cast<wxFileDialog*>(m_dialog)->SetDirectory(dir);
 151         }
 152     }
 153     else
 154         wxGenericFileButton::SetInitialDirectory(dir);
 155 }
 156
 157 #endif // wxUSE_FILEPICKERCTRL
 158
 159 #if wxUSE_DIRPICKERCTRL
 160
 161 #ifdef __UNIX__
 162 #include <unistd.h> // chdir
 163 #endif
 164
 165 //-----------------------------------------------------------------------------
 166 // "current-folder-changed"
 167 //-----------------------------------------------------------------------------
 168
 169 extern "C" {
 170 static void gtk_dirbutton_currentfolderchanged_callback(GtkFileChooserButton *widget,
 171                                                         wxDirButton *p)
 172 {
 173     // update the m_path member of the wxDirButtonGTK
 174     // unless the path was changed by wxDirButton::SetPath()
 175     if (p->m_bIgnoreNextChange)
 176     {
 177         p->m_bIgnoreNextChange=false;
 178         return;
 179     }
 180     wxASSERT(p);
 181
 182     // NB: it's important to use gtk_file_chooser_get_filename instead of
 183     //     gtk_file_chooser_get_current_folder (see GTK docs) !
 184     wxGtkString filename(gtk_file_chooser_get_filename(GTK_FILE_CHOOSER(widget)));
 185     p->GTKUpdatePath(filename);
 186
 187     // since GtkFileChooserButton when used to pick directories also uses a combobox,
 188     // maybe that the current folder has been changed but not through the GtkFileChooserDialog
 189     // and thus the 'gtk_filedialog_ok_callback' could have not been called...
 190     // thus we need to make sure the current working directory is updated if wxDIRP_CHANGE_DIR
 191     // style was given.
 192     if (p->HasFlag(wxDIRP_CHANGE_DIR))
 193         chdir(filename);
 194
 195     // ...and fire an event
 196     wxFileDirPickerEvent event(wxEVT_DIRPICKER_CHANGED, p, p->GetId(), p->GetPath());
 197     p->HandleWindowEvent(event);
 198 }
 199 }
 200
 201
 202 //-----------------------------------------------------------------------------
 203 // wxDirButtonGTK
 204 //-----------------------------------------------------------------------------
 205
 206 IMPLEMENT_DYNAMIC_CLASS(wxDirButton, wxButton)
 207
 208 bool wxDirButton::Create( wxWindow *parent, wxWindowID id,
 209                         const wxString &label, const wxString &path,
 210                         const wxString &message, const wxString &wildcard,
 211                         const wxPoint &pos, const wxSize &size,
 212                         long style, const wxValidator& validator,
 213                         const wxString &name )
 214 {
 215     if (!(style & wxDIRP_USE_TEXTCTRL))
 216     {
 217         // VERY IMPORTANT: this code is identic to relative code in wxFileButton;
 218         //                 if you find a problem here, fix it also in wxFileButton !
 219
 220         if (!PreCreation( parent, pos, size ) ||
 221             !wxControl::CreateBase(parent, id, pos, size, style & wxWINDOW_STYLE_MASK,
 222                                     validator, name))
 223         {
 224             wxFAIL_MSG( wxT("wxDirButtonGTK creation failed") );
 225             return false;
 226         }
 227
 228         // create the dialog associated with this button
 229         SetWindowStyle(style);
 230         m_message = message;
 231         m_wildcard = wildcard;
 232         if ((m_dialog = CreateDialog()) == NULL)
 233             return false;
 234         SetPath(path);
 235
 236         // little trick used to avoid problems when there are other GTK windows 'grabbed':
 237         // GtkFileChooserDialog won't be responsive to user events if there is another
 238         // window which called gtk_grab_add (and this happens if e.g. a wxDialog is running
 239         // in modal mode in the application - see wxDialogGTK::ShowModal).
 240         // An idea could be to put the grab on the m_dialog->m_widget when the GtkFileChooserButton
 241         // is clicked and then remove it as soon as the user closes the dialog itself.
 242         // Unfortunately there's no way to hook in the 'clicked' event of the GtkFileChooserButton,
 243         // thus we add grab on m_dialog->m_widget when it's shown and remove it when it's
 244         // hidden simply using its "show" and "hide" events - clean & simple :)
 245         g_signal_connect(m_dialog->m_widget, "show", G_CALLBACK(gtk_grab_add), NULL);
 246         g_signal_connect(m_dialog->m_widget, "hide", G_CALLBACK(gtk_grab_remove), NULL);
 247
 248
 249         // NOTE: we deliberately ignore the given label as GtkFileChooserButton
 250         //       use as label the currently selected file
 251         m_widget = gtk_file_chooser_button_new_with_dialog( m_dialog->m_widget );
 252         g_object_ref(m_widget);
 253
 254         // GtkFileChooserButton signals
 255         g_signal_connect(m_widget, "current-folder-changed",
 256                          G_CALLBACK(gtk_dirbutton_currentfolderchanged_callback), this);
 257
 258         m_parent->DoAddChild( this );
 259
 260         PostCreation(size);
 261         SetInitialSize(size);
 262     }
 263     else
 264         return wxGenericDirButton::Create(parent, id, label, path, message, wildcard,
 265                                           pos, size, style, validator, name);
 266     return true;
 267 }
 268
 269 wxDirButton::~wxDirButton()
 270 {
 271     if (m_dialog)
 272     {
 273         // see ~wxFileButton() comment
 274         gtk_widget_destroy(m_widget);
 275         delete m_dialog;
 276     }
 277 }
 278
 279 void wxDirButton::GTKUpdatePath(const char *gtkpath)
 280 {
 281     m_path = wxString::FromUTF8(gtkpath);
 282 }
 283 void wxDirButton::SetPath(const wxString& str)
 284 {
 285     if ( m_path == str )
 286     {
 287         // don't do anything and especially don't set m_bIgnoreNextChange
 288         return;
 289     }
 290
 291     m_path = str;
 292
 293     // wxDirButton uses the "current-folder-changed" signal which is triggered also
 294     // when we set the path on the dialog associated with this button; thus we need
 295     // to set the following flag to avoid sending a wxFileDirPickerEvent from this
 296     // function (which would be inconsistent with wxFileButton's behaviour and in
 297     // general with all wxWidgets control-manipulation functions which do not send events).
 298     m_bIgnoreNextChange = true;
 299
 300     if (m_dialog)
 301         UpdateDialogPath(m_dialog);
 302 }
 303
 304 void wxDirButton::SetInitialDirectory(const wxString& dir)
 305 {
 306     if (m_dialog)
 307     {
 308         if (m_path.empty())
 309             static_cast<wxDirDialog*>(m_dialog)->SetPath(dir);
 310     }
 311     else
 312         wxGenericDirButton::SetInitialDirectory(dir);
 313 }
 314
 315 #endif // wxUSE_DIRPICKERCTRL