1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/msw/dirdlg.cpp
3 // Purpose: wxDirDialog
4 // Author: Julian Smart
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 // ============================================================================
14 // ============================================================================
16 // ----------------------------------------------------------------------------
18 // ----------------------------------------------------------------------------
20 // For compilers that support precompilation, includes "wx.h".
21 #include "wx/wxprec.h"
29 #if wxUSE_OLE && !defined(__GNUWIN32_OLD__) && (!defined(__WXWINCE__) || \
30 (defined(__HANDHELDPC__) && (_WIN32_WCE >= 500)))
32 #include "wx/dirdlg.h"
36 #include "wx/dialog.h"
38 #include "wx/app.h" // for GetComCtl32Version()
41 #include "wx/msw/private.h"
42 #include "wx/msw/wrapshl.h"
43 #include "wx/msw/private/comptr.h"
44 #include "wx/dynlib.h"
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
53 #define wxUSE_IFILEDIALOG
57 // IFileDialog related declarations missing from some compilers headers.
60 #ifndef __IShellItem_INTERFACE_DEFINED__
62 #ifndef SIGDN_FILESYSPATH
63 #define SIGDN_FILESYSPATH 0x80058000
66 struct IShellItem
: public IUnknown
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;
75 DEFINE_GUID(IID_IShellItem
,
76 0x43826D1E, 0xE718, 0x42EE, 0xBC, 0x55, 0xA1, 0xE2, 0x61, 0xC3, 0x7B, 0xFE);
78 #endif // #ifndef __IShellItem_INTERFACE_DEFINED__
80 struct IShellItemFilter
;
81 struct IFileDialogEvents
;
84 #ifndef __IModalWindow_INTERFACE_DEFINED__
86 struct IModalWindow
: public IUnknown
88 virtual HRESULT wxSTDCALL
Show(HWND
) = 0;
91 #endif // #ifndef __IModalWindow_INTERFACE_DEFINED__
94 #ifndef __IFileDialog_INTERFACE_DEFINED__
96 #ifndef FOS_PICKFOLDERS
97 #define FOS_PICKFOLDERS 0x20
100 #ifndef FOS_FORCEFILESYSTEM
101 #define FOS_FORCEFILESYSTEM 0x40
104 struct COMDLG_FILTERSPEC
;
106 struct IFileDialog
: public IModalWindow
108 virtual HRESULT wxSTDCALL
SetFileTypes(UINT
, const COMDLG_FILTERSPEC
*) = 0;
109 virtual HRESULT wxSTDCALL
SetFileTypeIndex(UINT
) = 0;
110 virtual HRESULT wxSTDCALL
GetFileTypeIndex(UINT
*) = 0;
111 virtual HRESULT wxSTDCALL
Advise(IFileDialogEvents
*, DWORD
*) = 0;
112 virtual HRESULT wxSTDCALL
Unadvise(DWORD
) = 0;
113 virtual HRESULT wxSTDCALL
SetOptions(DWORD
) = 0;
114 virtual HRESULT wxSTDCALL
GetOptions(DWORD
*) = 0;
115 virtual HRESULT wxSTDCALL
SetDefaultFolder(IShellItem
*) = 0;
116 virtual HRESULT wxSTDCALL
SetFolder(IShellItem
*) = 0;
117 virtual HRESULT wxSTDCALL
GetFolder(IShellItem
**) = 0;
118 virtual HRESULT wxSTDCALL
GetCurrentSelection(IShellItem
**) = 0;
119 virtual HRESULT wxSTDCALL
SetFileName(LPCWSTR
) = 0;
120 virtual HRESULT wxSTDCALL
GetFileName(LPWSTR
*) = 0;
121 virtual HRESULT wxSTDCALL
SetTitle(LPCWSTR
) = 0;
122 virtual HRESULT wxSTDCALL
SetOkButtonLabel(LPCWSTR
) = 0;
123 virtual HRESULT wxSTDCALL
SetFileNameLabel(LPCWSTR
) = 0;
124 virtual HRESULT wxSTDCALL
GetResult(IShellItem
**) = 0;
125 virtual HRESULT wxSTDCALL
AddPlace(IShellItem
*, DWORD
) = 0;
126 virtual HRESULT wxSTDCALL
SetDefaultExtension(LPCWSTR
) = 0;
127 virtual HRESULT wxSTDCALL
Close(HRESULT
) = 0;
128 virtual HRESULT wxSTDCALL
SetClientGuid(REFGUID
) = 0;
129 virtual HRESULT wxSTDCALL
ClearClientData() = 0;
130 virtual HRESULT wxSTDCALL
SetFilter(IShellItemFilter
*) = 0;
133 DEFINE_GUID(CLSID_FileOpenDialog
,
134 0xDC1C5A9C, 0xE88A, 0x4dde, 0xA5, 0xA1, 0x60, 0xF8, 0x2A, 0x20, 0xAE, 0xF7);
136 DEFINE_GUID(IID_IFileDialog
,
137 0x42F85136, 0xDB7E, 0x439C, 0x85, 0xF1, 0xE4, 0x07, 0x5D, 0x13, 0x5F, 0xC8);
139 #endif // #ifndef __IFileDialog_INTERFACE_DEFINED__
141 #endif // wxUSE_IFILEDIALOG
143 // ----------------------------------------------------------------------------
145 // ----------------------------------------------------------------------------
147 #ifndef BIF_NEWDIALOGSTYLE
148 #define BIF_NEWDIALOGSTYLE 0x0040
151 #ifndef BIF_NONEWFOLDERBUTTON
152 #define BIF_NONEWFOLDERBUTTON 0x0200
156 #define BIF_EDITBOX 16
159 // ----------------------------------------------------------------------------
161 // ----------------------------------------------------------------------------
163 IMPLEMENT_CLASS(wxDirDialog
, wxDialog
)
165 // ----------------------------------------------------------------------------
166 // private functions prototypes
167 // ----------------------------------------------------------------------------
169 // the callback proc for the dir dlg
170 static int CALLBACK
BrowseCallbackProc(HWND hwnd
, UINT uMsg
, LPARAM lp
,
174 // ============================================================================
176 // ============================================================================
178 // ----------------------------------------------------------------------------
180 // ----------------------------------------------------------------------------
182 wxDirDialog::wxDirDialog(wxWindow
*parent
,
183 const wxString
& message
,
184 const wxString
& defaultPath
,
186 const wxPoint
& WXUNUSED(pos
),
187 const wxSize
& WXUNUSED(size
),
188 const wxString
& WXUNUSED(name
))
193 SetWindowStyle(style
);
194 SetPath(defaultPath
);
197 void wxDirDialog::SetPath(const wxString
& path
)
201 // SHBrowseForFolder doesn't like '/'s nor the trailing backslashes
202 m_path
.Replace(wxT("/"), wxT("\\"));
204 while ( !m_path
.empty() && (*(m_path
.end() - 1) == wxT('\\')) )
206 m_path
.erase(m_path
.length() - 1);
209 // but the root drive should have a trailing slash (again, this is just
210 // the way the native dialog works)
211 if ( !m_path
.empty() && (*(m_path
.end() - 1) == wxT(':')) )
217 int wxDirDialog::ShowModal()
219 wxWindow
* const parent
= GetParent();
220 WXHWND hWndParent
= parent
? GetHwndOf(parent
) : NULL
;
222 // Use IFileDialog under new enough Windows, it's more user-friendly.
224 #if wxUSE_IFILEDIALOG
225 if ( wxGetWinVersion() >= wxWinVersion_Vista
)
227 rc
= ShowIFileDialog(hWndParent
);
234 if ( rc
== wxID_NONE
)
235 #endif // wxUSE_IFILEDIALOG
237 rc
= ShowSHBrowseForFolder(hWndParent
);
240 // change current working directory if asked so
241 if ( rc
== wxID_OK
&& HasFlag(wxDD_CHANGE_DIR
) )
242 wxSetWorkingDirectory(m_path
);
247 int wxDirDialog::ShowSHBrowseForFolder(WXHWND owner
)
250 bi
.hwndOwner
= owner
;
252 bi
.pszDisplayName
= NULL
;
253 // Please don't change this without checking it compiles
255 #if defined(__POCKETPC__) || defined(__SMARTPHONE__)
256 bi
.lpszTitle
= m_message
.mb_str();
258 bi
.lpszTitle
= m_message
.c_str();
260 bi
.ulFlags
= BIF_RETURNONLYFSDIRS
| BIF_STATUSTEXT
;
261 bi
.lpfn
= BrowseCallbackProc
;
262 bi
.lParam
= (LPARAM
)m_path
.wx_str(); // param for the callback
264 static const int verComCtl32
= wxApp::GetComCtl32Version();
266 // we always add the edit box (it doesn't hurt anybody, does it?) if it is
267 // supported by the system
268 if ( verComCtl32
>= 471 )
270 bi
.ulFlags
|= BIF_EDITBOX
;
273 // to have the "New Folder" button we must use the "new" dialog style which
274 // is also the only way to have a resizable dialog
276 // "new" style is only available in the version 5.0+ of comctl32.dll
277 const bool needNewDir
= !HasFlag(wxDD_DIR_MUST_EXIST
);
278 if ( (needNewDir
|| HasFlag(wxRESIZE_BORDER
)) && (verComCtl32
>= 500) )
282 bi
.ulFlags
|= BIF_NEWDIALOGSTYLE
;
286 // Versions < 600 doesn't support BIF_NONEWFOLDERBUTTON
287 // The only way to get rid of the Make New Folder button is use
288 // the old dialog style which doesn't have the button thus we
289 // simply don't set the New Dialog Style for such comctl versions.
290 if (verComCtl32
>= 600)
292 bi
.ulFlags
|= BIF_NEWDIALOGSTYLE
;
293 bi
.ulFlags
|= BIF_NONEWFOLDERBUTTON
;
298 // do show the dialog
299 wxItemIdList
pidl(SHBrowseForFolder(&bi
));
301 wxItemIdList::Free((LPITEMIDLIST
)bi
.pidlRoot
);
305 // Cancel button pressed
309 m_path
= pidl
.GetPath();
311 return m_path
.empty() ? wxID_CANCEL
: wxID_OK
;
314 // Function for obtaining folder name on Vista and newer.
316 // Returns wxID_OK on success, wxID_CANCEL if cancelled by user or wxID_NONE if
317 // an error occurred and we should fall back onto the old dialog.
318 #if wxUSE_IFILEDIALOG
320 int wxDirDialog::ShowIFileDialog(WXHWND owner
)
323 wxCOMPtr
<IFileDialog
> fileDialog
;
325 hr
= ::CoCreateInstance(CLSID_FileOpenDialog
, NULL
, CLSCTX_INPROC_SERVER
,
326 wxIID_PPV_ARGS(IFileDialog
, &fileDialog
));
329 wxLogApiError(wxS("CoCreateInstance(CLSID_FileOpenDialog)"), hr
);
333 // allow user to select only a file system folder
334 hr
= fileDialog
->SetOptions(FOS_PICKFOLDERS
| FOS_FORCEFILESYSTEM
);
337 wxLogApiError(wxS("IFileDialog::SetOptions"), hr
);
341 hr
= fileDialog
->SetTitle(m_message
.wc_str());
344 // This error is not serious, let's just log it and continue even
345 // without the title set.
346 wxLogApiError(wxS("IFileDialog::SetTitle"), hr
);
349 // set the initial path
350 if ( !m_path
.empty() )
352 // We need to link SHCreateItemFromParsingName() dynamically as it's
353 // not available on pre-Vista systems.
355 (WINAPI
*SHCreateItemFromParsingName_t
)(PCWSTR
,
360 SHCreateItemFromParsingName_t s_pfnSHCreateItemFromParsingName
= NULL
;
361 wxDynamicLibrary dllShell32
;
362 if ( dllShell32
.Load(wxS("shell32.dll"), wxDL_VERBATIM
| wxDL_QUIET
) )
364 wxDL_INIT_FUNC(s_pfn
, SHCreateItemFromParsingName
, dllShell32
);
367 if ( !s_pfnSHCreateItemFromParsingName
)
369 wxLogLastError(wxS("SHCreateItemFromParsingName() not found"));
373 wxCOMPtr
<IShellItem
> folder
;
374 hr
= s_pfnSHCreateItemFromParsingName(m_path
.wc_str(),
376 wxIID_PPV_ARGS(IShellItem
,
380 wxLogApiError(wxS("SHCreateItemFromParsingName"), hr
);
384 hr
= fileDialog
->SetFolder(folder
);
387 wxLogApiError(wxS("IFileDialog::SetFolder"), hr
);
395 hr
= fileDialog
->Show(owner
);
398 wxCOMPtr
<IShellItem
> folder
;
400 hr
= fileDialog
->GetResult(&folder
);
403 LPOLESTR pathOLE
= NULL
;
405 hr
= folder
->GetDisplayName(SIGDN_FILESYSPATH
, &pathOLE
);
409 CoTaskMemFree(pathOLE
);
413 wxLogApiError(wxS("IShellItem::GetDisplayName"), hr
);
418 wxLogApiError(wxS("IFileDialog::GetResult"), hr
);
421 else if ( hr
== HRESULT_FROM_WIN32(ERROR_CANCELLED
) )
423 return wxID_CANCEL
; // the user cancelled the dialog
427 wxLogApiError(wxS("IFileDialog::Show"), hr
);
432 // the user didn't cancel the dialog and yet the path is empty
433 // it means there was an error, already logged by wxLogApiError()
434 // now report the error to the user and return
435 wxLogSysError(_("Couldn't obtain folder name"), hr
);
443 #endif // wxUSE_IFILEDIALOG
445 // ----------------------------------------------------------------------------
447 // ----------------------------------------------------------------------------
450 BrowseCallbackProc(HWND hwnd
, UINT uMsg
, LPARAM lp
, LPARAM pData
)
454 #ifdef BFFM_SETSELECTION
455 case BFFM_INITIALIZED
:
456 // sent immediately after initialisation and so we may set the
457 // initial selection here
459 // wParam = TRUE => lParam is a string and not a PIDL
460 ::SendMessage(hwnd
, BFFM_SETSELECTION
, TRUE
, pData
);
462 #endif // BFFM_SETSELECTION
465 case BFFM_SELCHANGED
:
466 // note that this doesn't work with the new style UI (MSDN doesn't
467 // say anything about it, but the comments in shlobj.h do!) but we
468 // still execute this code in case it starts working again with the
469 // "new new UI" (or would it be "NewUIEx" according to tradition?)
471 // Set the status window to the currently selected path.
473 if ( SHGetPathFromIDList((LPITEMIDLIST
)lp
,
474 wxStringBuffer(strDir
, MAX_PATH
)) )
476 // NB: this shouldn't be necessary with the new style box
477 // (which is resizable), but as for now it doesn't work
478 // anyhow (see the comment above) no harm in doing it
480 // need to truncate or it displays incorrectly
481 static const size_t maxChars
= 37;
482 if ( strDir
.length() > maxChars
)
484 strDir
= strDir
.Right(maxChars
);
485 strDir
= wxString(wxT("...")) + strDir
;
488 SendMessage(hwnd
, BFFM_SETSTATUSTEXT
,
489 0, (LPARAM
)strDir
.wx_str());
494 //case BFFM_VALIDATEFAILED: -- might be used to provide custom message
495 // if the user types in invalid dir name
501 #endif // compiler/platform on which the code here compiles
503 #endif // wxUSE_DIRDLG