Fix stc doxygen warnings and regen stc files.

[wxWidgets.git] / src / msw / dirdlg.cpp

diff --git a/src/msw/dirdlg.cpp b/src/msw/dirdlg.cpp
index 622e34b051f5091c3c04f60846f6d84d1e6b1a69..620d74b8eac451a7717dcf3cec273a0ee1813491 100644 (file)
--- a/src/msw/dirdlg.cpp
+++ b/src/msw/dirdlg.cpp
@@ -1,10 +1,9 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        dirdlg.cpp
+// Name:        src/msw/dirdlg.cpp

 // Purpose:     wxDirDialog
 // Author:      Julian Smart
 // Modified by:
 // Created:     01/02/97
 // Purpose:     wxDirDialog
 // Author:      Julian Smart
 // Modified by:
 // Created:     01/02/97

-// RCS-ID:      $Id$

 // Copyright:   (c) Julian Smart
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 // Copyright:   (c) Julian Smart
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////


@@ -17,10 +16,6 @@
 // headers
 // ----------------------------------------------------------------------------
 
 // headers
 // ----------------------------------------------------------------------------
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma implementation "dirdlg.h"
-#endif
-

 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 


@@ -28,35 +23,131 @@
     #pragma hdrstop
 #endif
 
     #pragma hdrstop
 #endif
 

-#if wxUSE_DIRDLG && !(defined(__SMARTPHONE__) && defined(__WXWINCE__))
+#if wxUSE_DIRDLG

 
 

-#if defined(__WIN95__) && !defined(__GNUWIN32_OLD__) && wxUSE_OLE
+#if wxUSE_OLE && !defined(__GNUWIN32_OLD__) && (!defined(__WXWINCE__) || \
+    (defined(__HANDHELDPC__) && (_WIN32_WCE >= 500)))
+
+#include "wx/dirdlg.h"
+#include "wx/modalhook.h"

 
 #ifndef WX_PRECOMP
     #include "wx/utils.h"
     #include "wx/dialog.h"
 
 #ifndef WX_PRECOMP
     #include "wx/utils.h"
     #include "wx/dialog.h"

-    #include "wx/dirdlg.h"

     #include "wx/log.h"
     #include "wx/app.h"     // for GetComCtl32Version()
 #endif
 
 #include "wx/msw/private.h"
     #include "wx/log.h"
     #include "wx/app.h"     // for GetComCtl32Version()
 #endif
 
 #include "wx/msw/private.h"

+#include "wx/msw/wrapshl.h"
+#include "wx/msw/private/comptr.h"
+#include "wx/dynlib.h"
+
+#include <initguid.h>
+
+// We can only use IFileDialog under desktop Windows and we need
+// wxDynamicLibrary for it.
+#if wxUSE_DYNLIB_CLASS && !defined(__WXWINCE__)
+    #define wxUSE_IFILEDIALOG 1
+#else
+    #define wxUSE_IFILEDIALOG 0
+#endif
+
+#if wxUSE_IFILEDIALOG
+// IFileDialog related declarations missing from some compilers headers.
+
+// IShellItem
+#ifndef __IShellItem_INTERFACE_DEFINED__
+
+#ifndef SIGDN_FILESYSPATH
+    #define SIGDN_FILESYSPATH 0x80058000
+#endif
+
+struct IShellItem : public IUnknown
+{
+    virtual HRESULT wxSTDCALL BindToHandler(IBindCtx*, REFGUID, REFIID, void**) = 0;
+    virtual HRESULT wxSTDCALL GetParent(IShellItem**) = 0;
+    virtual HRESULT wxSTDCALL GetDisplayName(DWORD, LPWSTR*) = 0;
+    virtual HRESULT wxSTDCALL GetAttributes(ULONG, ULONG*) = 0;
+    virtual HRESULT wxSTDCALL Compare(IShellItem*, DWORD, int*) = 0;
+};
+
+#endif // #ifndef __IShellItem_INTERFACE_DEFINED__
+
+// Define this GUID in any case, even when __IShellItem_INTERFACE_DEFINED__ is
+// defined in the headers we might still not have it in the actual uuid.lib,
+// this happens with at least VC7 used with its original (i.e. not updated) SDK
+// and there is no harm in defining the GUID unconditionally.
+DEFINE_GUID(IID_IShellItem,
+    0x43826D1E, 0xE718, 0x42EE, 0xBC, 0x55, 0xA1, 0xE2, 0x61, 0xC3, 0x7B, 0xFE);

 
 

-#ifdef __WXWINCE__
-#include <winreg.h>
-#include <objbase.h>
-#include <shlguid.h>
+struct IShellItemFilter;
+struct IFileDialogEvents;
+
+// IModalWindow
+#ifndef __IModalWindow_INTERFACE_DEFINED__
+
+struct IModalWindow : public IUnknown
+{
+    virtual HRESULT wxSTDCALL Show(HWND) = 0;
+};
+
+#endif // #ifndef __IModalWindow_INTERFACE_DEFINED__
+
+// IFileDialog
+#ifndef __IFileDialog_INTERFACE_DEFINED__
+
+#ifndef FOS_PICKFOLDERS
+    #define FOS_PICKFOLDERS 0x20
+#endif
+
+#ifndef FOS_FORCEFILESYSTEM
+    #define FOS_FORCEFILESYSTEM 0x40

 #endif
 #endif

-#include <shlobj.h> // Win95 shell
+
+struct COMDLG_FILTERSPEC;
+
+struct IFileDialog : public IModalWindow
+{
+    virtual HRESULT wxSTDCALL SetFileTypes(UINT, const COMDLG_FILTERSPEC*) = 0;
+    virtual HRESULT wxSTDCALL SetFileTypeIndex(UINT) = 0;
+    virtual HRESULT wxSTDCALL GetFileTypeIndex(UINT*) = 0;
+    virtual HRESULT wxSTDCALL Advise(IFileDialogEvents*, DWORD*) = 0;
+    virtual HRESULT wxSTDCALL Unadvise(DWORD) = 0;
+    virtual HRESULT wxSTDCALL SetOptions(DWORD) = 0;
+    virtual HRESULT wxSTDCALL GetOptions(DWORD*) = 0;
+    virtual HRESULT wxSTDCALL SetDefaultFolder(IShellItem*) = 0;
+    virtual HRESULT wxSTDCALL SetFolder(IShellItem*) = 0;
+    virtual HRESULT wxSTDCALL GetFolder(IShellItem**) = 0;
+    virtual HRESULT wxSTDCALL GetCurrentSelection(IShellItem**) = 0;
+    virtual HRESULT wxSTDCALL SetFileName(LPCWSTR) = 0;
+    virtual HRESULT wxSTDCALL GetFileName(LPWSTR*) = 0;
+    virtual HRESULT wxSTDCALL SetTitle(LPCWSTR) = 0;
+    virtual HRESULT wxSTDCALL SetOkButtonLabel(LPCWSTR) = 0;
+    virtual HRESULT wxSTDCALL SetFileNameLabel(LPCWSTR) = 0;
+    virtual HRESULT wxSTDCALL GetResult(IShellItem**) = 0;
+    virtual HRESULT wxSTDCALL AddPlace(IShellItem*, DWORD) = 0;
+    virtual HRESULT wxSTDCALL SetDefaultExtension(LPCWSTR) = 0;
+    virtual HRESULT wxSTDCALL Close(HRESULT) = 0;
+    virtual HRESULT wxSTDCALL SetClientGuid(REFGUID) = 0;
+    virtual HRESULT wxSTDCALL ClearClientData() = 0;
+    virtual HRESULT wxSTDCALL SetFilter(IShellItemFilter*) = 0;
+};
+
+DEFINE_GUID(CLSID_FileOpenDialog,
+    0xDC1C5A9C, 0xE88A, 0x4dde, 0xA5, 0xA1, 0x60, 0xF8, 0x2A, 0x20, 0xAE, 0xF7);
+
+DEFINE_GUID(IID_IFileDialog,
+    0x42F85136, 0xDB7E, 0x439C, 0x85, 0xF1, 0xE4, 0x07, 0x5D, 0x13, 0x5F, 0xC8);
+
+#endif // #ifndef __IFileDialog_INTERFACE_DEFINED__
+
+#endif // wxUSE_IFILEDIALOG

 
 // ----------------------------------------------------------------------------
 // constants
 // ----------------------------------------------------------------------------
 
 
 // ----------------------------------------------------------------------------
 // constants
 // ----------------------------------------------------------------------------
 

-#ifndef MAX_PATH
-    #define MAX_PATH 4096      // be generous
-#endif
-

 #ifndef BIF_NEWDIALOGSTYLE
     #define BIF_NEWDIALOGSTYLE 0x0040
 #endif
 #ifndef BIF_NEWDIALOGSTYLE
     #define BIF_NEWDIALOGSTYLE 0x0040
 #endif


@@ -79,9 +170,6 @@ IMPLEMENT_CLASS(wxDirDialog, wxDialog)
 // private functions prototypes
 // ----------------------------------------------------------------------------
 
 // private functions prototypes
 // ----------------------------------------------------------------------------
 

-// free the parameter
-static void ItemListFree(LPITEMIDLIST pidl);
-

 // the callback proc for the dir dlg
 static int CALLBACK BrowseCallbackProc(HWND hwnd, UINT uMsg, LPARAM lp,
                                        LPARAM pData);
 // the callback proc for the dir dlg
 static int CALLBACK BrowseCallbackProc(HWND hwnd, UINT uMsg, LPARAM lp,
                                        LPARAM pData);


@@ -106,7 +194,7 @@ wxDirDialog::wxDirDialog(wxWindow *parent,
     m_message = message;
     m_parent = parent;
 
     m_message = message;
     m_parent = parent;
 

-    SetStyle(style);
+    SetWindowStyle(style);

     SetPath(defaultPath);
 }
 
     SetPath(defaultPath);
 }
 


@@ -115,35 +203,69 @@ void wxDirDialog::SetPath(const wxString& path)
     m_path = path;
 
     // SHBrowseForFolder doesn't like '/'s nor the trailing backslashes
     m_path = path;
 
     // SHBrowseForFolder doesn't like '/'s nor the trailing backslashes

-    m_path.Replace(_T("/"), _T("\\"));
-    if ( !m_path.empty() )
+    m_path.Replace(wxT("/"), wxT("\\"));
+
+    while ( !m_path.empty() && (*(m_path.end() - 1) == wxT('\\')) )

     {
     {

-        while ( *(m_path.end() - 1) == _T('\\') )
-        {
-            m_path.erase(m_path.length() - 1);
-        }
+        m_path.erase(m_path.length() - 1);
+    }

 
 

-        // but the root drive should have a trailing slash (again, this is just
-        // the way the native dialog works)
-        if ( *(m_path.end() - 1) == _T(':') )
-        {
-            m_path += _T('\\');
-        }
+    // but the root drive should have a trailing slash (again, this is just
+    // the way the native dialog works)
+    if ( !m_path.empty() && (*(m_path.end() - 1) == wxT(':')) )
+    {
+        m_path += wxT('\\');

     }
 }
 
 int wxDirDialog::ShowModal()
 {
     }
 }
 
 int wxDirDialog::ShowModal()
 {

-    wxWindow *parent = GetParent();
+    WX_HOOK_MODAL_DIALOG();
+
+    wxWindow* const parent = GetParent();
+    WXHWND hWndParent = parent ? GetHwndOf(parent) : NULL;

 
 

+    // Use IFileDialog under new enough Windows, it's more user-friendly.
+    int rc;
+#if wxUSE_IFILEDIALOG
+    if ( wxGetWinVersion() >= wxWinVersion_Vista )
+    {
+        rc = ShowIFileDialog(hWndParent);
+    }
+    else
+    {
+        rc = wxID_NONE;
+    }
+
+    if ( rc == wxID_NONE )
+#endif // wxUSE_IFILEDIALOG
+    {
+        rc = ShowSHBrowseForFolder(hWndParent);
+    }
+
+    // change current working directory if asked so
+    if ( rc == wxID_OK && HasFlag(wxDD_CHANGE_DIR) )
+        wxSetWorkingDirectory(m_path);
+
+    return rc;
+}
+
+int wxDirDialog::ShowSHBrowseForFolder(WXHWND owner)
+{

     BROWSEINFO bi;
     BROWSEINFO bi;

-    bi.hwndOwner      = parent ? GetHwndOf(parent) : NULL;
+    bi.hwndOwner      = owner;

     bi.pidlRoot       = NULL;
     bi.pszDisplayName = NULL;
     bi.pidlRoot       = NULL;
     bi.pszDisplayName = NULL;

+    // Please don't change this without checking it compiles
+    // with eVC++ first.
+#if defined(__POCKETPC__) || defined(__SMARTPHONE__)
+    bi.lpszTitle      = m_message.mb_str();
+#else

     bi.lpszTitle      = m_message.c_str();
     bi.lpszTitle      = m_message.c_str();

+#endif

     bi.ulFlags        = BIF_RETURNONLYFSDIRS | BIF_STATUSTEXT;
     bi.lpfn           = BrowseCallbackProc;
     bi.ulFlags        = BIF_RETURNONLYFSDIRS | BIF_STATUSTEXT;
     bi.lpfn           = BrowseCallbackProc;

-    bi.lParam         = (LPARAM)m_path.c_str();    // param for the callback
+    bi.lParam         = wxMSW_CONV_LPARAM(m_path); // param for the callback

 
     static const int verComCtl32 = wxApp::GetComCtl32Version();
 
 
     static const int verComCtl32 = wxApp::GetComCtl32Version();
 


@@ -158,7 +280,7 @@ int wxDirDialog::ShowModal()
     // is also the only way to have a resizable dialog
     //
     // "new" style is only available in the version 5.0+ of comctl32.dll
     // is also the only way to have a resizable dialog
     //
     // "new" style is only available in the version 5.0+ of comctl32.dll

-    const bool needNewDir = HasFlag(wxDD_NEW_DIR_BUTTON);
+    const bool needNewDir = !HasFlag(wxDD_DIR_MUST_EXIST);

     if ( (needNewDir || HasFlag(wxRESIZE_BORDER)) && (verComCtl32 >= 500) )
     {
         if (needNewDir)
     if ( (needNewDir || HasFlag(wxRESIZE_BORDER)) && (verComCtl32 >= 500) )
     {
         if (needNewDir)


@@ -180,12 +302,9 @@ int wxDirDialog::ShowModal()
     }
 
     // do show the dialog
     }
 
     // do show the dialog

-    LPITEMIDLIST pidl = SHBrowseForFolder(&bi);
+    wxItemIdList pidl(SHBrowseForFolder(&bi));

 
 

-    if ( bi.pidlRoot )
-    {
-        ItemListFree((LPITEMIDLIST)bi.pidlRoot);
-    }
+    wxItemIdList::Free((LPITEMIDLIST)bi.pidlRoot);

 
     if ( !pidl )
     {
 
     if ( !pidl )
     {


@@ -193,20 +312,142 @@ int wxDirDialog::ShowModal()
         return wxID_CANCEL;
     }
 
         return wxID_CANCEL;
     }
 

-    BOOL ok = SHGetPathFromIDList(pidl, wxStringBuffer(m_path, MAX_PATH));
+    m_path = pidl.GetPath();
+
+    return m_path.empty() ? wxID_CANCEL : wxID_OK;
+}

 
 

-    ItemListFree(pidl);
+// Function for obtaining folder name on Vista and newer.
+//
+// Returns wxID_OK on success, wxID_CANCEL if cancelled by user or wxID_NONE if
+// an error occurred and we should fall back onto the old dialog.
+#if wxUSE_IFILEDIALOG

 
 

-    if ( !ok )
+int wxDirDialog::ShowIFileDialog(WXHWND owner)
+{
+    HRESULT hr;
+    wxCOMPtr<IFileDialog> fileDialog;
+
+    hr = ::CoCreateInstance(CLSID_FileOpenDialog, NULL, CLSCTX_INPROC_SERVER,
+                            wxIID_PPV_ARGS(IFileDialog, &fileDialog));
+    if ( FAILED(hr) )

     {
     {

-        wxLogLastError(wxT("SHGetPathFromIDList"));
+        wxLogApiError(wxS("CoCreateInstance(CLSID_FileOpenDialog)"), hr);
+        return wxID_NONE;
+    }

 
 

+    // allow user to select only a file system folder
+    hr = fileDialog->SetOptions(FOS_PICKFOLDERS | FOS_FORCEFILESYSTEM);
+    if ( FAILED(hr) )
+    {
+        wxLogApiError(wxS("IFileDialog::SetOptions"), hr);
+        return wxID_NONE;
+    }
+
+    hr = fileDialog->SetTitle(m_message.wc_str());
+    if ( FAILED(hr) )
+    {
+        // This error is not serious, let's just log it and continue even
+        // without the title set.
+        wxLogApiError(wxS("IFileDialog::SetTitle"), hr);
+    }
+
+    // set the initial path
+    if ( !m_path.empty() )
+    {
+        // We need to link SHCreateItemFromParsingName() dynamically as it's
+        // not available on pre-Vista systems.
+        typedef HRESULT
+        (WINAPI *SHCreateItemFromParsingName_t)(PCWSTR,
+                                                IBindCtx*,
+                                                REFIID,
+                                                void**);
+
+        SHCreateItemFromParsingName_t pfnSHCreateItemFromParsingName = NULL;
+        wxDynamicLibrary dllShell32;
+        if ( dllShell32.Load(wxS("shell32.dll"), wxDL_VERBATIM | wxDL_QUIET) )
+        {
+            wxDL_INIT_FUNC(pfn, SHCreateItemFromParsingName, dllShell32);
+        }
+
+        if ( !pfnSHCreateItemFromParsingName )
+        {
+            wxLogLastError(wxS("SHCreateItemFromParsingName() not found"));
+            return wxID_NONE;
+        }
+
+        wxCOMPtr<IShellItem> folder;
+        hr = pfnSHCreateItemFromParsingName(m_path.wc_str(),
+                                              NULL,
+                                              wxIID_PPV_ARGS(IShellItem,
+                                                             &folder));
+        if ( FAILED(hr) )
+        {
+            wxLogApiError(wxS("SHCreateItemFromParsingName"), hr);
+            return wxID_NONE;
+        }
+
+        hr = fileDialog->SetFolder(folder);
+        if ( FAILED(hr) )
+        {
+            wxLogApiError(wxS("IFileDialog::SetFolder"), hr);
+            return wxID_NONE;
+        }
+    }
+
+
+    wxString path;
+
+    hr = fileDialog->Show(owner);
+    if ( SUCCEEDED(hr) )
+    {
+        wxCOMPtr<IShellItem> folder;
+
+        hr = fileDialog->GetResult(&folder);
+        if ( SUCCEEDED(hr) )
+        {
+            LPOLESTR pathOLE = NULL;
+
+            hr = folder->GetDisplayName(SIGDN_FILESYSPATH, &pathOLE);
+            if ( SUCCEEDED(hr) )
+            {
+                path = pathOLE;
+                CoTaskMemFree(pathOLE);
+            }
+            else
+            {
+                wxLogApiError(wxS("IShellItem::GetDisplayName"), hr);
+            }
+        }
+        else
+        {
+            wxLogApiError(wxS("IFileDialog::GetResult"), hr);
+        }
+    }
+    else if ( hr == HRESULT_FROM_WIN32(ERROR_CANCELLED) )
+    {
+        return wxID_CANCEL; // the user cancelled the dialog
+    }
+    else
+    {
+        wxLogApiError(wxS("IFileDialog::Show"), hr);
+    }
+
+    if ( path.empty() )
+    {
+        // the user didn't cancel the dialog and yet the path is empty
+        // it means there was an error, already logged by wxLogApiError()
+        // now report the error to the user and return
+        wxLogSysError(_("Couldn't obtain folder name"), hr);

         return wxID_CANCEL;
     }
 
         return wxID_CANCEL;
     }
 

+    m_path = path;

     return wxID_OK;
 }
 
     return wxID_OK;
 }
 

+#endif // wxUSE_IFILEDIALOG
+

 // ----------------------------------------------------------------------------
 // private functions
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // private functions
 // ----------------------------------------------------------------------------


@@ -216,15 +457,16 @@ BrowseCallbackProc(HWND hwnd, UINT uMsg, LPARAM lp, LPARAM pData)
 {
     switch(uMsg)
     {
 {
     switch(uMsg)
     {

+#ifdef BFFM_SETSELECTION

         case BFFM_INITIALIZED:
             // sent immediately after initialisation and so we may set the
             // initial selection here
             //
             // wParam = TRUE => lParam is a string and not a PIDL
         case BFFM_INITIALIZED:
             // sent immediately after initialisation and so we may set the
             // initial selection here
             //
             // wParam = TRUE => lParam is a string and not a PIDL

-#ifndef __WXWINCE__

             ::SendMessage(hwnd, BFFM_SETSELECTION, TRUE, pData);
             ::SendMessage(hwnd, BFFM_SETSELECTION, TRUE, pData);

-#endif

             break;
             break;

+#endif // BFFM_SETSELECTION
+

 
         case BFFM_SELCHANGED:
             // note that this doesn't work with the new style UI (MSDN doesn't
 
         case BFFM_SELCHANGED:
             // note that this doesn't work with the new style UI (MSDN doesn't


@@ -250,7 +492,7 @@ BrowseCallbackProc(HWND hwnd, UINT uMsg, LPARAM lp, LPARAM pData)
                     }
 
                     SendMessage(hwnd, BFFM_SETSTATUSTEXT,
                     }
 
                     SendMessage(hwnd, BFFM_SETSTATUSTEXT,

-                                0, (LPARAM)strDir.c_str());
+                                0, wxMSW_CONV_LPARAM(strDir));

                 }
             }
             break;
                 }
             }
             break;


@@ -262,27 +504,6 @@ BrowseCallbackProc(HWND hwnd, UINT uMsg, LPARAM lp, LPARAM pData)
     return 0;
 }
 
     return 0;
 }
 

-
-static void ItemListFree(LPITEMIDLIST pidl)
-{
-    if ( pidl )
-    {
-        LPMALLOC pMalloc;
-        SHGetMalloc(&pMalloc);
-        if ( pMalloc )
-        {
-            pMalloc->Free(pidl);
-            pMalloc->Release();
-        }
-        else
-        {
-            wxLogLastError(wxT("SHGetMalloc"));
-        }
-    }
-}
-
-#else
-    #include "../generic/dirdlgg.cpp"

 #endif // compiler/platform on which the code here compiles
 
 #endif // compiler/platform on which the code here compiles
 

-#endif // wxUSE_DIRDLG && !(__SMARTPHONE__ && __WXWINCE__)
+#endif // wxUSE_DIRDLG