src/msw/dirdlg.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/msw/dirdlg.cpp
   3 // Purpose:     wxDirDialog
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     01/02/97
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 // For compilers that support precompilation, includes "wx.h".
  21 #include "wx/wxprec.h"
  22
  23 #ifdef __BORLANDC__
  24     #pragma hdrstop
  25 #endif
  26
  27 #if wxUSE_DIRDLG
  28
  29 #if wxUSE_OLE && !defined(__GNUWIN32_OLD__) && (!defined(__WXWINCE__) || \
  30     (defined(__HANDHELDPC__) && (_WIN32_WCE >= 500)))
  31
  32 #include "wx/dirdlg.h"
  33
  34 #ifndef WX_PRECOMP
  35     #include "wx/utils.h"
  36     #include "wx/dialog.h"
  37     #include "wx/log.h"
  38     #include "wx/app.h"     // for GetComCtl32Version()
  39 #endif
  40
  41 #include "wx/msw/private.h"
  42 #include "wx/msw/wrapshl.h"
  43 #include "wx/msw/private/comptr.h"
  44 #include "wx/dynlib.h"
  45
  46 #include <initguid.h>
  47
  48 // We can only use IFileDialog under desktop Windows and we need
  49 // wxDynamicLibrary for it.
  50 #if wxUSE_DYNLIB_CLASS && !defined(__WXWINCE__)
  51     #define wxUSE_IFILEDIALOG 1
  52 #else
  53     #define wxUSE_IFILEDIALOG 0
  54 #endif
  55
  56 #if wxUSE_IFILEDIALOG
  57 // IFileDialog related declarations missing from some compilers headers.
  58
  59 // IShellItem
  60 #ifndef __IShellItem_INTERFACE_DEFINED__
  61
  62 #ifndef SIGDN_FILESYSPATH
  63     #define SIGDN_FILESYSPATH 0x80058000
  64 #endif
  65
  66 struct IShellItem : public IUnknown
  67 {
  68     virtual HRESULT wxSTDCALL BindToHandler(IBindCtx*, REFGUID, REFIID, void**) = 0;
  69     virtual HRESULT wxSTDCALL GetParent(IShellItem**) = 0;
  70     virtual HRESULT wxSTDCALL GetDisplayName(DWORD, LPWSTR*) = 0;
  71     virtual HRESULT wxSTDCALL GetAttributes(ULONG, ULONG*) = 0;
  72     virtual HRESULT wxSTDCALL Compare(IShellItem*, DWORD, int*) = 0;
  73 };
  74
  75 #endif // #ifndef __IShellItem_INTERFACE_DEFINED__
  76
  77 // Define this GUID in any case, even when __IShellItem_INTERFACE_DEFINED__ is
  78 // defined in the headers we might still not have it in the actual uuid.lib,
  79 // this happens with at least VC7 used with its original (i.e. not updated) SDK
  80 // and there is no harm in defining the GUID unconditionally.
  81 DEFINE_GUID(IID_IShellItem,
  82     0x43826D1E, 0xE718, 0x42EE, 0xBC, 0x55, 0xA1, 0xE2, 0x61, 0xC3, 0x7B, 0xFE);
  83
  84 struct IShellItemFilter;
  85 struct IFileDialogEvents;
  86
  87 // IModalWindow
  88 #ifndef __IModalWindow_INTERFACE_DEFINED__
  89
  90 struct IModalWindow : public IUnknown
  91 {
  92     virtual HRESULT wxSTDCALL Show(HWND) = 0;
  93 };
  94
  95 #endif // #ifndef __IModalWindow_INTERFACE_DEFINED__
  96
  97 // IFileDialog
  98 #ifndef __IFileDialog_INTERFACE_DEFINED__
  99
 100 #ifndef FOS_PICKFOLDERS
 101     #define FOS_PICKFOLDERS 0x20
 102 #endif
 103
 104 #ifndef FOS_FORCEFILESYSTEM
 105     #define FOS_FORCEFILESYSTEM 0x40
 106 #endif
 107
 108 struct COMDLG_FILTERSPEC;
 109
 110 struct IFileDialog : public IModalWindow
 111 {
 112     virtual HRESULT wxSTDCALL SetFileTypes(UINT, const COMDLG_FILTERSPEC*) = 0;
 113     virtual HRESULT wxSTDCALL SetFileTypeIndex(UINT) = 0;
 114     virtual HRESULT wxSTDCALL GetFileTypeIndex(UINT*) = 0;
 115     virtual HRESULT wxSTDCALL Advise(IFileDialogEvents*, DWORD*) = 0;
 116     virtual HRESULT wxSTDCALL Unadvise(DWORD) = 0;
 117     virtual HRESULT wxSTDCALL SetOptions(DWORD) = 0;
 118     virtual HRESULT wxSTDCALL GetOptions(DWORD*) = 0;
 119     virtual HRESULT wxSTDCALL SetDefaultFolder(IShellItem*) = 0;
 120     virtual HRESULT wxSTDCALL SetFolder(IShellItem*) = 0;
 121     virtual HRESULT wxSTDCALL GetFolder(IShellItem**) = 0;
 122     virtual HRESULT wxSTDCALL GetCurrentSelection(IShellItem**) = 0;
 123     virtual HRESULT wxSTDCALL SetFileName(LPCWSTR) = 0;
 124     virtual HRESULT wxSTDCALL GetFileName(LPWSTR*) = 0;
 125     virtual HRESULT wxSTDCALL SetTitle(LPCWSTR) = 0;
 126     virtual HRESULT wxSTDCALL SetOkButtonLabel(LPCWSTR) = 0;
 127     virtual HRESULT wxSTDCALL SetFileNameLabel(LPCWSTR) = 0;
 128     virtual HRESULT wxSTDCALL GetResult(IShellItem**) = 0;
 129     virtual HRESULT wxSTDCALL AddPlace(IShellItem*, DWORD) = 0;
 130     virtual HRESULT wxSTDCALL SetDefaultExtension(LPCWSTR) = 0;
 131     virtual HRESULT wxSTDCALL Close(HRESULT) = 0;
 132     virtual HRESULT wxSTDCALL SetClientGuid(REFGUID) = 0;
 133     virtual HRESULT wxSTDCALL ClearClientData() = 0;
 134     virtual HRESULT wxSTDCALL SetFilter(IShellItemFilter*) = 0;
 135 };
 136
 137 DEFINE_GUID(CLSID_FileOpenDialog,
 138     0xDC1C5A9C, 0xE88A, 0x4dde, 0xA5, 0xA1, 0x60, 0xF8, 0x2A, 0x20, 0xAE, 0xF7);
 139
 140 DEFINE_GUID(IID_IFileDialog,
 141     0x42F85136, 0xDB7E, 0x439C, 0x85, 0xF1, 0xE4, 0x07, 0x5D, 0x13, 0x5F, 0xC8);
 142
 143 #endif // #ifndef __IFileDialog_INTERFACE_DEFINED__
 144
 145 #endif // wxUSE_IFILEDIALOG
 146
 147 // ----------------------------------------------------------------------------
 148 // constants
 149 // ----------------------------------------------------------------------------
 150
 151 #ifndef BIF_NEWDIALOGSTYLE
 152     #define BIF_NEWDIALOGSTYLE 0x0040
 153 #endif
 154
 155 #ifndef BIF_NONEWFOLDERBUTTON
 156     #define BIF_NONEWFOLDERBUTTON  0x0200
 157 #endif
 158
 159 #ifndef BIF_EDITBOX
 160     #define BIF_EDITBOX 16
 161 #endif
 162
 163 // ----------------------------------------------------------------------------
 164 // wxWidgets macros
 165 // ----------------------------------------------------------------------------
 166
 167 IMPLEMENT_CLASS(wxDirDialog, wxDialog)
 168
 169 // ----------------------------------------------------------------------------
 170 // private functions prototypes
 171 // ----------------------------------------------------------------------------
 172
 173 // the callback proc for the dir dlg
 174 static int CALLBACK BrowseCallbackProc(HWND hwnd, UINT uMsg, LPARAM lp,
 175                                        LPARAM pData);
 176
 177
 178 // ============================================================================
 179 // implementation
 180 // ============================================================================
 181
 182 // ----------------------------------------------------------------------------
 183 // wxDirDialog
 184 // ----------------------------------------------------------------------------
 185
 186 wxDirDialog::wxDirDialog(wxWindow *parent,
 187                          const wxString& message,
 188                          const wxString& defaultPath,
 189                          long style,
 190                          const wxPoint& WXUNUSED(pos),
 191                          const wxSize& WXUNUSED(size),
 192                          const wxString& WXUNUSED(name))
 193 {
 194     m_message = message;
 195     m_parent = parent;
 196
 197     SetWindowStyle(style);
 198     SetPath(defaultPath);
 199 }
 200
 201 void wxDirDialog::SetPath(const wxString& path)
 202 {
 203     m_path = path;
 204
 205     // SHBrowseForFolder doesn't like '/'s nor the trailing backslashes
 206     m_path.Replace(wxT("/"), wxT("\\"));
 207
 208     while ( !m_path.empty() && (*(m_path.end() - 1) == wxT('\\')) )
 209     {
 210         m_path.erase(m_path.length() - 1);
 211     }
 212
 213     // but the root drive should have a trailing slash (again, this is just
 214     // the way the native dialog works)
 215     if ( !m_path.empty() && (*(m_path.end() - 1) == wxT(':')) )
 216     {
 217         m_path += wxT('\\');
 218     }
 219 }
 220
 221 int wxDirDialog::ShowModal()
 222 {
 223     wxWindow* const parent = GetParent();
 224     WXHWND hWndParent = parent ? GetHwndOf(parent) : NULL;
 225
 226     // Use IFileDialog under new enough Windows, it's more user-friendly.
 227     int rc;
 228 #if wxUSE_IFILEDIALOG
 229     if ( wxGetWinVersion() >= wxWinVersion_Vista )
 230     {
 231         rc = ShowIFileDialog(hWndParent);
 232     }
 233     else
 234     {
 235         rc = wxID_NONE;
 236     }
 237
 238     if ( rc == wxID_NONE )
 239 #endif // wxUSE_IFILEDIALOG
 240     {
 241         rc = ShowSHBrowseForFolder(hWndParent);
 242     }
 243
 244     // change current working directory if asked so
 245     if ( rc == wxID_OK && HasFlag(wxDD_CHANGE_DIR) )
 246         wxSetWorkingDirectory(m_path);
 247
 248     return rc;
 249 }
 250
 251 int wxDirDialog::ShowSHBrowseForFolder(WXHWND owner)
 252 {
 253     BROWSEINFO bi;
 254     bi.hwndOwner      = owner;
 255     bi.pidlRoot       = NULL;
 256     bi.pszDisplayName = NULL;
 257     // Please don't change this without checking it compiles
 258     // with eVC++ first.
 259 #if defined(__POCKETPC__) || defined(__SMARTPHONE__)
 260     bi.lpszTitle      = m_message.mb_str();
 261 #else
 262     bi.lpszTitle      = m_message.c_str();
 263 #endif
 264     bi.ulFlags        = BIF_RETURNONLYFSDIRS | BIF_STATUSTEXT;
 265     bi.lpfn           = BrowseCallbackProc;
 266     bi.lParam         = wxMSW_CONV_LPARAM(m_path); // param for the callback
 267
 268     static const int verComCtl32 = wxApp::GetComCtl32Version();
 269
 270     // we always add the edit box (it doesn't hurt anybody, does it?) if it is
 271     // supported by the system
 272     if ( verComCtl32 >= 471 )
 273     {
 274         bi.ulFlags |= BIF_EDITBOX;
 275     }
 276
 277     // to have the "New Folder" button we must use the "new" dialog style which
 278     // is also the only way to have a resizable dialog
 279     //
 280     // "new" style is only available in the version 5.0+ of comctl32.dll
 281     const bool needNewDir = !HasFlag(wxDD_DIR_MUST_EXIST);
 282     if ( (needNewDir || HasFlag(wxRESIZE_BORDER)) && (verComCtl32 >= 500) )
 283     {
 284         if (needNewDir)
 285         {
 286             bi.ulFlags |= BIF_NEWDIALOGSTYLE;
 287         }
 288         else
 289         {
 290             // Versions < 600 doesn't support BIF_NONEWFOLDERBUTTON
 291             // The only way to get rid of the Make New Folder button is use
 292             // the old dialog style which doesn't have the button thus we
 293             // simply don't set the New Dialog Style for such comctl versions.
 294             if (verComCtl32 >= 600)
 295             {
 296                 bi.ulFlags |= BIF_NEWDIALOGSTYLE;
 297                 bi.ulFlags |= BIF_NONEWFOLDERBUTTON;
 298             }
 299         }
 300     }
 301
 302     // do show the dialog
 303     wxItemIdList pidl(SHBrowseForFolder(&bi));
 304
 305     wxItemIdList::Free((LPITEMIDLIST)bi.pidlRoot);
 306
 307     if ( !pidl )
 308     {
 309         // Cancel button pressed
 310         return wxID_CANCEL;
 311     }
 312
 313     m_path = pidl.GetPath();
 314
 315     return m_path.empty() ? wxID_CANCEL : wxID_OK;
 316 }
 317
 318 // Function for obtaining folder name on Vista and newer.
 319 //
 320 // Returns wxID_OK on success, wxID_CANCEL if cancelled by user or wxID_NONE if
 321 // an error occurred and we should fall back onto the old dialog.
 322 #if wxUSE_IFILEDIALOG
 323
 324 int wxDirDialog::ShowIFileDialog(WXHWND owner)
 325 {
 326     HRESULT hr;
 327     wxCOMPtr<IFileDialog> fileDialog;
 328
 329     hr = ::CoCreateInstance(CLSID_FileOpenDialog, NULL, CLSCTX_INPROC_SERVER,
 330                             wxIID_PPV_ARGS(IFileDialog, &fileDialog));
 331     if ( FAILED(hr) )
 332     {
 333         wxLogApiError(wxS("CoCreateInstance(CLSID_FileOpenDialog)"), hr);
 334         return wxID_NONE;
 335     }
 336
 337     // allow user to select only a file system folder
 338     hr = fileDialog->SetOptions(FOS_PICKFOLDERS | FOS_FORCEFILESYSTEM);
 339     if ( FAILED(hr) )
 340     {
 341         wxLogApiError(wxS("IFileDialog::SetOptions"), hr);
 342         return wxID_NONE;
 343     }
 344
 345     hr = fileDialog->SetTitle(m_message.wc_str());
 346     if ( FAILED(hr) )
 347     {
 348         // This error is not serious, let's just log it and continue even
 349         // without the title set.
 350         wxLogApiError(wxS("IFileDialog::SetTitle"), hr);
 351     }
 352
 353     // set the initial path
 354     if ( !m_path.empty() )
 355     {
 356         // We need to link SHCreateItemFromParsingName() dynamically as it's
 357         // not available on pre-Vista systems.
 358         typedef HRESULT
 359         (WINAPI *SHCreateItemFromParsingName_t)(PCWSTR,
 360                                                 IBindCtx*,
 361                                                 REFIID,
 362                                                 void**);
 363
 364         SHCreateItemFromParsingName_t pfnSHCreateItemFromParsingName = NULL;
 365         wxDynamicLibrary dllShell32;
 366         if ( dllShell32.Load(wxS("shell32.dll"), wxDL_VERBATIM | wxDL_QUIET) )
 367         {
 368             wxDL_INIT_FUNC(pfn, SHCreateItemFromParsingName, dllShell32);
 369         }
 370
 371         if ( !pfnSHCreateItemFromParsingName )
 372         {
 373             wxLogLastError(wxS("SHCreateItemFromParsingName() not found"));
 374             return wxID_NONE;
 375         }
 376
 377         wxCOMPtr<IShellItem> folder;
 378         hr = pfnSHCreateItemFromParsingName(m_path.wc_str(),
 379                                               NULL,
 380                                               wxIID_PPV_ARGS(IShellItem,
 381                                                              &folder));
 382         if ( FAILED(hr) )
 383         {
 384             wxLogApiError(wxS("SHCreateItemFromParsingName"), hr);
 385             return wxID_NONE;
 386         }
 387
 388         hr = fileDialog->SetFolder(folder);
 389         if ( FAILED(hr) )
 390         {
 391             wxLogApiError(wxS("IFileDialog::SetFolder"), hr);
 392             return wxID_NONE;
 393         }
 394     }
 395
 396
 397     wxString path;
 398
 399     hr = fileDialog->Show(owner);
 400     if ( SUCCEEDED(hr) )
 401     {
 402         wxCOMPtr<IShellItem> folder;
 403
 404         hr = fileDialog->GetResult(&folder);
 405         if ( SUCCEEDED(hr) )
 406         {
 407             LPOLESTR pathOLE = NULL;
 408
 409             hr = folder->GetDisplayName(SIGDN_FILESYSPATH, &pathOLE);
 410             if ( SUCCEEDED(hr) )
 411             {
 412                 path = pathOLE;
 413                 CoTaskMemFree(pathOLE);
 414             }
 415             else
 416             {
 417                 wxLogApiError(wxS("IShellItem::GetDisplayName"), hr);
 418             }
 419         }
 420         else
 421         {
 422             wxLogApiError(wxS("IFileDialog::GetResult"), hr);
 423         }
 424     }
 425     else if ( hr == HRESULT_FROM_WIN32(ERROR_CANCELLED) )
 426     {
 427         return wxID_CANCEL; // the user cancelled the dialog
 428     }
 429     else
 430     {
 431         wxLogApiError(wxS("IFileDialog::Show"), hr);
 432     }
 433
 434     if ( path.empty() )
 435     {
 436         // the user didn't cancel the dialog and yet the path is empty
 437         // it means there was an error, already logged by wxLogApiError()
 438         // now report the error to the user and return
 439         wxLogSysError(_("Couldn't obtain folder name"), hr);
 440         return wxID_CANCEL;
 441     }
 442
 443     m_path = path;
 444     return wxID_OK;
 445 }
 446
 447 #endif // wxUSE_IFILEDIALOG
 448
 449 // ----------------------------------------------------------------------------
 450 // private functions
 451 // ----------------------------------------------------------------------------
 452
 453 static int CALLBACK
 454 BrowseCallbackProc(HWND hwnd, UINT uMsg, LPARAM lp, LPARAM pData)
 455 {
 456     switch(uMsg)
 457     {
 458 #ifdef BFFM_SETSELECTION
 459         case BFFM_INITIALIZED:
 460             // sent immediately after initialisation and so we may set the
 461             // initial selection here
 462             //
 463             // wParam = TRUE => lParam is a string and not a PIDL
 464             ::SendMessage(hwnd, BFFM_SETSELECTION, TRUE, pData);
 465             break;
 466 #endif // BFFM_SETSELECTION
 467
 468
 469         case BFFM_SELCHANGED:
 470             // note that this doesn't work with the new style UI (MSDN doesn't
 471             // say anything about it, but the comments in shlobj.h do!) but we
 472             // still execute this code in case it starts working again with the
 473             // "new new UI" (or would it be "NewUIEx" according to tradition?)
 474             {
 475                 // Set the status window to the currently selected path.
 476                 wxString strDir;
 477                 if ( SHGetPathFromIDList((LPITEMIDLIST)lp,
 478                                          wxStringBuffer(strDir, MAX_PATH)) )
 479                 {
 480                     // NB: this shouldn't be necessary with the new style box
 481                     //     (which is resizable), but as for now it doesn't work
 482                     //     anyhow (see the comment above) no harm in doing it
 483
 484                     // need to truncate or it displays incorrectly
 485                     static const size_t maxChars = 37;
 486                     if ( strDir.length() > maxChars )
 487                     {
 488                         strDir = strDir.Right(maxChars);
 489                         strDir = wxString(wxT("...")) + strDir;
 490                     }
 491
 492                     SendMessage(hwnd, BFFM_SETSTATUSTEXT,
 493                                 0, wxMSW_CONV_LPARAM(strDir));
 494                 }
 495             }
 496             break;
 497
 498         //case BFFM_VALIDATEFAILED: -- might be used to provide custom message
 499         //                             if the user types in invalid dir name
 500     }
 501
 502     return 0;
 503 }
 504
 505 #endif // compiler/platform on which the code here compiles
 506
 507 #endif // wxUSE_DIRDLG