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