1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/msw/filedlg.cpp
3 // Purpose: wxFileDialog
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"
27 #if wxUSE_FILEDLG && !(defined(__SMARTPHONE__) && defined(__WXWINCE__))
29 #include "wx/filedlg.h"
32 #include "wx/msw/wrapcdlg.h"
33 #include "wx/msw/missing.h"
35 #include "wx/msgdlg.h"
36 #include "wx/filefn.h"
46 #include "wx/filename.h"
47 #include "wx/tokenzr.h"
49 // ----------------------------------------------------------------------------
51 // ----------------------------------------------------------------------------
54 # define wxMAXPATH 65534
56 # define wxMAXPATH 1024
59 # define wxMAXFILE 1024
63 // ----------------------------------------------------------------------------
65 // ----------------------------------------------------------------------------
67 // standard dialog size for the old Windows systems where the dialog wasn't
69 static wxRect
gs_rectDialog(0, 0, 428, 266);
71 // ============================================================================
73 // ============================================================================
75 IMPLEMENT_CLASS(wxFileDialog
, wxFileDialogBase
)
77 // ----------------------------------------------------------------------------
78 // hook function for moving the dialog
79 // ----------------------------------------------------------------------------
82 wxFileDialogHookFunction(HWND hDlg
,
84 WPARAM
WXUNUSED(wParam
),
91 OFNOTIFY
*pNotifyCode
= wx_reinterpret_cast(OFNOTIFY
*, lParam
);
92 if ( pNotifyCode
->hdr
.code
== CDN_INITDONE
)
94 wx_reinterpret_cast(wxFileDialog
*,
95 pNotifyCode
->lpOFN
->lCustData
)
96 ->MSWOnInitDone((WXHWND
)hDlg
);
102 // reuse the position used for the dialog the next time by default
104 // NB: at least under Windows 2003 this is useless as after the
105 // first time it's shown the dialog always remembers its size
106 // and position itself and ignores any later SetWindowPos calls
107 wxCopyRECTToRect(wxGetWindowRect(::GetParent(hDlg
)), gs_rectDialog
);
111 // do the default processing
115 // ----------------------------------------------------------------------------
117 // ----------------------------------------------------------------------------
119 wxFileDialog::wxFileDialog(wxWindow
*parent
,
120 const wxString
& message
,
121 const wxString
& defaultDir
,
122 const wxString
& defaultFileName
,
123 const wxString
& wildCard
,
127 const wxString
& name
)
128 : wxFileDialogBase(parent
, message
, defaultDir
, defaultFileName
,
129 wildCard
, style
, pos
, sz
, name
)
132 // NB: all style checks are done by wxFileDialogBase::Create
134 m_bMovedWindow
= false;
137 // Must set to zero, otherwise the wx routines won't size the window
138 // the second time you call the file dialog, because it thinks it is
139 // already at the requested size.. (when centering)
144 void wxFileDialog::GetPaths(wxArrayString
& paths
) const
149 if ( m_dir
.Last() != _T('\\') )
152 size_t count
= m_fileNames
.GetCount();
153 for ( size_t n
= 0; n
< count
; n
++ )
155 if (wxFileName(m_fileNames
[n
]).IsAbsolute())
156 paths
.Add(m_fileNames
[n
]);
158 paths
.Add(dir
+ m_fileNames
[n
]);
162 void wxFileDialog::GetFilenames(wxArrayString
& files
) const
167 void wxFileDialog::SetPath(const wxString
& path
)
170 wxSplitPath(path
, &m_dir
, &m_fileName
, &ext
);
172 m_fileName
<< _T('.') << ext
;
175 void wxFileDialog::DoGetPosition(int *x
, int *y
) const
178 *x
= gs_rectDialog
.x
;
180 *y
= gs_rectDialog
.y
;
183 void wxFileDialog::DoGetSize(int *width
, int *height
) const
186 *width
= gs_rectDialog
.width
;
188 *height
= gs_rectDialog
.height
;
191 void wxFileDialog::DoMoveWindow(int x
, int y
, int WXUNUSED(w
), int WXUNUSED(h
))
196 // our HWND is only set when we're called from MSWOnInitDone(), test if
198 HWND hwnd
= GetHwnd();
201 // size of the dialog can't be changed because the controls are not
202 // laid out correctly then
203 ::SetWindowPos(hwnd
, HWND_TOP
, x
, y
, 0, 0, SWP_NOZORDER
| SWP_NOSIZE
);
205 else // just remember that we were requested to move the window
207 m_bMovedWindow
= true;
209 // if Centre() had been called before, it shouldn't be taken into
215 void wxFileDialog::DoCentre(int dir
)
218 m_bMovedWindow
= true;
220 // it's unnecessary to do anything else at this stage as we'll redo it in
221 // MSWOnInitDone() anyhow
224 void wxFileDialog::MSWOnInitDone(WXHWND hDlg
)
226 // note the the dialog is the parent window: hDlg is a child of it when
227 // OFN_EXPLORER is used
228 HWND hFileDlg
= ::GetParent((HWND
)hDlg
);
230 // set HWND so that our DoMoveWindow() works correctly
231 SetHWND((WXHWND
)hFileDlg
);
235 // now we have the real dialog size, remember it
237 GetWindowRect(hFileDlg
, &rect
);
238 gs_rectDialog
= wxRectFromRECT(rect
);
240 // and position the window correctly: notice that we must use the base
241 // class version as our own doesn't do anything except setting flags
242 wxFileDialogBase::DoCentre(m_centreDir
);
244 else // need to just move it to the correct place
246 SetPosition(gs_rectDialog
.GetPosition());
249 // we shouldn't destroy this HWND
253 // helper used below in ShowCommFileDialog(): style is used to determine
254 // whether to show the "Save file" dialog (if it contains wxFD_SAVE bit) or
255 // "Open file" one; returns true on success or false on failure in which case
256 // err is filled with the CDERR_XXX constant
257 static bool DoShowCommFileDialog(OPENFILENAME
*of
, long style
, DWORD
*err
)
259 if ( style
& wxFD_SAVE
? GetSaveFileName(of
) : GetOpenFileName(of
) )
265 // according to MSDN, CommDlgExtendedError() should work under CE as
266 // well but apparently in practice it doesn't (anybody has more
268 *err
= GetLastError();
270 *err
= CommDlgExtendedError();
277 // We want to use OPENFILENAME struct version 5 (Windows 2000/XP) but we don't
278 // know if the OPENFILENAME declared in the currently used headers is a V5 or
279 // V4 (smaller) one so we try to manually extend the struct in case it is the
282 // We don't do this on Windows CE nor under Win64, however, as there are no
283 // compilers with old headers for these architectures
284 #if defined(__WXWINCE__) || defined(__WIN64__)
285 typedef OPENFILENAME wxOPENFILENAME
;
287 static const DWORD gs_ofStructSize
= sizeof(OPENFILENAME
);
288 #else // !__WXWINCE__ || __WIN64__
289 #define wxTRY_SMALLER_OPENFILENAME
291 struct wxOPENFILENAME
: public OPENFILENAME
293 // fields added in Windows 2000/XP comdlg32.dll version
299 // hardcoded sizeof(OPENFILENAME) in the Platform SDK: we have to do it
300 // because sizeof(OPENFILENAME) in the headers we use when compiling the
301 // library could be less if _WIN32_WINNT is not >= 0x500
302 static const DWORD wxOPENFILENAME_V5_SIZE
= 88;
304 // this is hardcoded sizeof(OPENFILENAME_NT4) from Platform SDK
305 static const DWORD wxOPENFILENAME_V4_SIZE
= 76;
307 // always try the new one first
308 static DWORD gs_ofStructSize
= wxOPENFILENAME_V5_SIZE
;
309 #endif // __WXWINCE__ || __WIN64__/!...
311 static bool ShowCommFileDialog(OPENFILENAME
*of
, long style
)
314 bool success
= DoShowCommFileDialog(of
, style
, &errCode
);
316 #ifdef wxTRY_SMALLER_OPENFILENAME
317 // the system might be too old to support the new version file dialog
318 // boxes, try with the old size
319 if ( !success
&& errCode
== CDERR_STRUCTSIZE
&&
320 of
->lStructSize
!= wxOPENFILENAME_V4_SIZE
)
322 of
->lStructSize
= wxOPENFILENAME_V4_SIZE
;
324 success
= DoShowCommFileDialog(of
, style
, &errCode
);
326 if ( success
|| !errCode
)
328 // use this struct size for subsequent dialogs
329 gs_ofStructSize
= of
->lStructSize
;
332 #endif // wxTRY_SMALLER_OPENFILENAME
334 if ( !success
&& errCode
== FNERR_INVALIDFILENAME
&& of
->lpstrFile
[0] )
336 // this can happen if the default file name is invalid, try without it
338 of
->lpstrFile
[0] = _T('\0');
339 success
= DoShowCommFileDialog(of
, style
, &errCode
);
344 // common dialog failed - why?
347 wxLogError(_("File dialog failed with error code %0lx."), errCode
);
349 //else: it was just cancelled
357 int wxFileDialog::ShowModal()
360 if (m_parent
) hWnd
= (HWND
) m_parent
->GetHWND();
361 if (!hWnd
&& wxTheApp
->GetTopWindow())
362 hWnd
= (HWND
) wxTheApp
->GetTopWindow()->GetHWND();
364 static wxChar fileNameBuffer
[ wxMAXPATH
]; // the file-name
365 wxChar titleBuffer
[ wxMAXFILE
+1+wxMAXEXT
]; // the file-name, without path
367 *fileNameBuffer
= wxT('\0');
368 *titleBuffer
= wxT('\0');
370 long msw_flags
= OFN_HIDEREADONLY
;
372 if ( HasFdFlag(wxFD_FILE_MUST_EXIST
) )
373 msw_flags
|= OFN_PATHMUSTEXIST
| OFN_FILEMUSTEXIST
;
375 If the window has been moved the programmer is probably
376 trying to center or position it. Thus we set the callback
377 or hook function so that we can actually adjust the position.
378 Without moving or centering the dlg, it will just stay
379 in the upper left of the frame, it does not center
382 if (m_bMovedWindow
) // we need these flags.
384 msw_flags
|= OFN_EXPLORER
|OFN_ENABLEHOOK
;
386 msw_flags
|= OFN_ENABLESIZING
;
390 if ( HasFdFlag(wxFD_MULTIPLE
) )
392 // OFN_EXPLORER must always be specified with OFN_ALLOWMULTISELECT
393 msw_flags
|= OFN_EXPLORER
| OFN_ALLOWMULTISELECT
;
396 // if wxFD_CHANGE_DIR flag is not given we shouldn't change the CWD which the
397 // standard dialog does by default (notice that under NT it does it anyhow,
398 // OFN_NOCHANGEDIR or not, see below)
399 if ( !HasFdFlag(wxFD_CHANGE_DIR
) )
401 msw_flags
|= OFN_NOCHANGEDIR
;
404 if ( HasFdFlag(wxFD_OVERWRITE_PROMPT
) )
406 msw_flags
|= OFN_OVERWRITEPROMPT
;
412 of
.lStructSize
= gs_ofStructSize
;
414 of
.lpstrTitle
= m_message
.wx_str();
415 of
.lpstrFileTitle
= titleBuffer
;
416 of
.nMaxFileTitle
= wxMAXFILE
+ 1 + wxMAXEXT
;
418 // Convert forward slashes to backslashes (file selector doesn't like
419 // forward slashes) and also squeeze multiple consecutive slashes into one
420 // as it doesn't like two backslashes in a row neither
423 size_t i
, len
= m_dir
.length();
425 for ( i
= 0; i
< len
; i
++ )
427 wxChar ch
= m_dir
[i
];
431 // convert to backslash
437 while ( i
< len
- 1 )
439 wxChar chNext
= m_dir
[i
+ 1];
440 if ( chNext
!= _T('\\') && chNext
!= _T('/') )
443 // ignore the next one, unless it is at the start of a UNC path
457 of
.lpstrInitialDir
= dir
.c_str();
459 of
.Flags
= msw_flags
;
460 of
.lpfnHook
= wxFileDialogHookFunction
;
461 of
.lCustData
= (LPARAM
)this;
463 wxArrayString wildDescriptions
, wildFilters
;
465 size_t items
= wxParseCommonDialogsFilter(m_wildCard
, wildDescriptions
, wildFilters
);
467 wxASSERT_MSG( items
> 0 , _T("empty wildcard list") );
469 wxString filterBuffer
;
471 for (i
= 0; i
< items
; i
++)
473 filterBuffer
+= wildDescriptions
[i
];
474 filterBuffer
+= wxT("|");
475 filterBuffer
+= wildFilters
[i
];
476 filterBuffer
+= wxT("|");
480 for (i
= 0; i
< filterBuffer
.length(); i
++ ) {
481 if ( filterBuffer
.GetChar(i
) == wxT('|') ) {
482 filterBuffer
[i
] = wxT('\0');
486 of
.lpstrFilter
= (LPTSTR
)filterBuffer
.wx_str();
487 of
.nFilterIndex
= m_filterIndex
+ 1;
489 //=== Setting defaultFileName >>=========================================
491 wxStrncpy(fileNameBuffer
, m_fileName
, wxMAXPATH
-1);
492 fileNameBuffer
[ wxMAXPATH
-1 ] = wxT('\0');
494 of
.lpstrFile
= fileNameBuffer
; // holds returned filename
495 of
.nMaxFile
= wxMAXPATH
;
497 // we must set the default extension because otherwise Windows would check
498 // for the existing of a wrong file with wxFD_OVERWRITE_PROMPT (i.e. if the
499 // user types "foo" and the default extension is ".bar" we should force it
500 // to check for "foo.bar" existence and not "foo")
501 wxString defextBuffer
; // we need it to be alive until GetSaveFileName()!
502 if (HasFdFlag(wxFD_SAVE
))
504 const wxChar
* extension
= filterBuffer
.wx_str();
505 int maxFilter
= (int)(of
.nFilterIndex
*2L) - 1;
507 for( int i
= 0; i
< maxFilter
; i
++ ) // get extension
508 extension
= extension
+ wxStrlen( extension
) + 1;
510 // use dummy name a to avoid assert in AppendExtension
511 defextBuffer
= AppendExtension(wxT("a"), extension
);
512 if (defextBuffer
.StartsWith(wxT("a.")))
514 defextBuffer
= defextBuffer
.Mid(2); // remove "a."
515 of
.lpstrDefExt
= defextBuffer
.c_str();
519 // store off before the standard windows dialog can possibly change it
520 const wxString cwdOrig
= wxGetCwd();
522 //== Execute FileDialog >>=================================================
524 if ( !ShowCommFileDialog(&of
, m_windowStyle
) )
527 // GetOpenFileName will always change the current working directory on
528 // (according to MSDN) "Windows NT 4.0/2000/XP" because the flag
529 // OFN_NOCHANGEDIR has no effect. If the user did not specify
530 // wxFD_CHANGE_DIR let's restore the current working directory to what it
531 // was before the dialog was shown.
532 if ( msw_flags
& OFN_NOCHANGEDIR
)
534 wxSetWorkingDirectory(cwdOrig
);
539 if ( ( HasFdFlag(wxFD_MULTIPLE
) ) &&
540 #if defined(OFN_EXPLORER)
541 ( fileNameBuffer
[of
.nFileOffset
-1] == wxT('\0') )
543 ( fileNameBuffer
[of
.nFileOffset
-1] == wxT(' ') )
544 #endif // OFN_EXPLORER
547 #if defined(OFN_EXPLORER)
548 m_dir
= fileNameBuffer
;
550 m_fileName
= &fileNameBuffer
[i
];
551 m_fileNames
.Add(m_fileName
);
552 i
+= m_fileName
.length() + 1;
554 while (fileNameBuffer
[i
] != wxT('\0'))
556 m_fileNames
.Add(&fileNameBuffer
[i
]);
557 i
+= wxStrlen(&fileNameBuffer
[i
]) + 1;
560 wxStringTokenizer
toke(fileNameBuffer
, _T(" \t\r\n"));
561 m_dir
= toke
.GetNextToken();
562 m_fileName
= toke
.GetNextToken();
563 m_fileNames
.Add(m_fileName
);
565 while (toke
.HasMoreTokens())
566 m_fileNames
.Add(toke
.GetNextToken());
567 #endif // OFN_EXPLORER
570 if ( m_dir
.Last() != _T('\\') )
573 m_path
= dir
+ m_fileName
;
574 m_filterIndex
= (int)of
.nFilterIndex
- 1;
578 //=== Adding the correct extension >>=================================
580 m_filterIndex
= (int)of
.nFilterIndex
- 1;
582 if ( !of
.nFileExtension
||
583 (of
.nFileExtension
&& fileNameBuffer
[of
.nFileExtension
] == wxT('\0')) )
585 // User has typed a filename without an extension:
586 const wxChar
* extension
= filterBuffer
.wx_str();
587 int maxFilter
= (int)(of
.nFilterIndex
*2L) - 1;
589 for( int i
= 0; i
< maxFilter
; i
++ ) // get extension
590 extension
= extension
+ wxStrlen( extension
) + 1;
592 m_fileName
= AppendExtension(fileNameBuffer
, extension
);
593 wxStrncpy(fileNameBuffer
, m_fileName
.c_str(), wxMin(m_fileName
.length(), wxMAXPATH
-1));
594 fileNameBuffer
[wxMin(m_fileName
.length(), wxMAXPATH
-1)] = wxT('\0');
597 m_path
= fileNameBuffer
;
598 m_fileName
= wxFileNameFromPath(fileNameBuffer
);
599 m_fileNames
.Add(m_fileName
);
600 m_dir
= wxPathOnly(fileNameBuffer
);
607 #endif // wxUSE_FILEDLG && !(__SMARTPHONE__ && __WXWINCE__)