Remove SetPageTitle and GetPageTitle and make GetCurrentTitle actually return the...

[wxWidgets.git] / include / wx / msw / ole / oleutils.h

diff --git a/include/wx/msw/ole/oleutils.h b/include/wx/msw/ole/oleutils.h
index 1d19f4f763cc010e23a8456546334e470f73f2df..1b4d5e6d7ea34cedf6a35ccbdb9d0faa51a8f313 100644 (file)
--- a/include/wx/msw/ole/oleutils.h
+++ b/include/wx/msw/ole/oleutils.h
@@ -1,5 +1,5 @@
 ///////////////////////////////////////////////////////////////////////////////
-// Name:        oleutils.h
+// Name:        wx/msw/ole/oleutils.h
 // Purpose:     OLE helper routines, OLE debugging support &c
 // Author:      Vadim Zeitlin
 // Modified by:
@@ -12,20 +12,61 @@
 #ifndef   _WX_OLEUTILS_H
 #define   _WX_OLEUTILS_H
 
-#ifdef __GNUG__
-#pragma interface "oleutils.h"
-#endif
-
 #include "wx/defs.h"
 
-#if wxUSE_NORLANDER_HEADERS
-    #include <ole2.h>
-#endif
+#if wxUSE_OLE
+
+// ole2.h includes windows.h, so include wrapwin.h first
+#include "wx/msw/wrapwin.h"
+// get IUnknown, REFIID &c
+#include <ole2.h>
+#include "wx/intl.h"
+#include "wx/log.h"
 
 // ============================================================================
 // General purpose functions and macros
 // ============================================================================
 
+// ----------------------------------------------------------------------------
+// initialize/cleanup OLE
+// ----------------------------------------------------------------------------
+
+// call OleInitialize() or CoInitialize[Ex]() depending on the platform
+//
+// return true if ok, false otherwise
+inline bool wxOleInitialize()
+{
+    HRESULT
+#ifdef __WXWINCE__
+     hr = ::CoInitializeEx(NULL, COINIT_MULTITHREADED);
+#else
+     hr = ::OleInitialize(NULL);
+#endif
+
+    // RPC_E_CHANGED_MODE indicates that OLE had been already initialized
+    // before, albeit with different mode. Don't consider it to be an error as
+    // we don't actually care ourselves about the mode used so this allows the
+    // main application to call OleInitialize() on its own before we do if it
+    // needs non-default mode.
+    if ( hr != RPC_E_CHANGED_MODE && FAILED(hr) )
+    {
+        wxLogError(_("Cannot initialize OLE"));
+
+        return false;
+    }
+
+    return true;
+}
+
+inline void wxOleUninitialize()
+{
+#ifdef __WXWINCE__
+    ::CoUninitialize();
+#else
+    ::OleUninitialize();
+#endif
+}
+
 // ----------------------------------------------------------------------------
 // misc helper functions/macros
 // ----------------------------------------------------------------------------
@@ -40,7 +81,7 @@ inline void ReleaseInterface(IUnknown *pIUnk)
 // release the interface pointer (if !NULL) and make it NULL
 #define   RELEASE_AND_NULL(p)   if ( (p) != NULL ) { p->Release(); p = NULL; };
 
-// return TRUE if the iid is in the array
+// return true if the iid is in the array
 extern bool IsIidFromList(REFIID riid, const IID *aIids[], size_t nCount);
 
 // ============================================================================
@@ -73,7 +114,13 @@ public:
     wxAutoULong(ULONG value = 0) : m_Value(value) { }
 
     operator ULONG&() { return m_Value; }
-    ULONG& operator=(ULONG value) { return m_Value = value; }
+    ULONG& operator=(ULONG value) { m_Value = value; return m_Value;  }
+
+    wxAutoULong& operator++() { ++m_Value; return *this; }
+    const wxAutoULong operator++( int ) { wxAutoULong temp = *this; ++m_Value; return temp; }
+
+    wxAutoULong& operator--() { --m_Value; return *this; }
+    const wxAutoULong operator--( int ) { wxAutoULong temp = *this; --m_Value; return temp; }
 
 private:
     ULONG m_Value;
@@ -103,7 +150,7 @@ private:
 #define   IMPLEMENT_IUNKNOWN_METHODS(classname)                               \
   STDMETHODIMP classname::QueryInterface(REFIID riid, void **ppv)             \
   {                                                                           \
-    wxLogQueryInterface(_T(#classname), riid);                                \
+    wxLogQueryInterface(wxT(#classname), riid);                               \
                                                                               \
     if ( IsIidFromList(riid, ms_aIids, WXSIZEOF(ms_aIids)) ) {                \
       *ppv = this;                                                            \
@@ -120,16 +167,16 @@ private:
                                                                               \
   STDMETHODIMP_(ULONG) classname::AddRef()                                    \
   {                                                                           \
-    wxLogAddRef(_T(#classname), m_cRef);                                      \
+    wxLogAddRef(wxT(#classname), m_cRef);                                     \
                                                                               \
     return ++m_cRef;                                                          \
   }                                                                           \
                                                                               \
   STDMETHODIMP_(ULONG) classname::Release()                                   \
   {                                                                           \
-    wxLogRelease(_T(#classname), m_cRef);                                     \
+    wxLogRelease(wxT(#classname), m_cRef);                                    \
                                                                               \
-    if ( --m_cRef == 0 ) {                                                    \
+    if ( --m_cRef == wxAutoULong(0) ) {                                                    \
       delete this;                                                            \
       return 0;                                                               \
     }                                                                         \
@@ -156,11 +203,58 @@ void wxLogQueryInterface(const wxChar *szInterface, REFIID riid);
 void wxLogAddRef (const wxChar *szInterface, ULONG cRef);
 void wxLogRelease(const wxChar *szInterface, ULONG cRef);
 
-#else   //!WXDEBUG
+#else   //!__WXDEBUG__
   #define   wxLogQueryInterface(szInterface, riid)
   #define   wxLogAddRef(szInterface, cRef)
   #define   wxLogRelease(szInterface, cRef)
-#endif  //WXDEBUG
+#endif  //__WXDEBUG__
 
-#endif  //_WX_OLEUTILS_H
+// wrapper around BSTR type (by Vadim Zeitlin)
+
+class WXDLLIMPEXP_CORE wxBasicString
+{
+public:
+    // ctors & dtor
+    wxBasicString(const wxString& str);
+    wxBasicString(const wxBasicString& bstr);
+    ~wxBasicString();
+
+    wxBasicString& operator=(const wxBasicString& bstr);
+
+    // accessors
+        // just get the string
+    operator BSTR() const { return m_bstrBuf; }
+        // retrieve a copy of our string - caller must SysFreeString() it later!
+    BSTR Get() const { return SysAllocString(m_bstrBuf); }
+
+private:
+    // actual string
+    BSTR m_bstrBuf;
+};
+
+#if wxUSE_VARIANT
+// Convert variants
+class WXDLLIMPEXP_FWD_BASE wxVariant;
 
+WXDLLIMPEXP_CORE bool wxConvertVariantToOle(const wxVariant& variant, VARIANTARG& oleVariant);
+WXDLLIMPEXP_CORE bool wxConvertOleToVariant(const VARIANTARG& oleVariant, wxVariant& variant);
+#endif // wxUSE_VARIANT
+
+// Convert string to Unicode
+WXDLLIMPEXP_CORE BSTR wxConvertStringToOle(const wxString& str);
+
+// Convert string from BSTR to wxString
+WXDLLIMPEXP_CORE wxString wxConvertStringFromOle(BSTR bStr);
+
+#else // !wxUSE_OLE
+
+// ----------------------------------------------------------------------------
+// stub functions to avoid #if wxUSE_OLE in the main code
+// ----------------------------------------------------------------------------
+
+inline bool wxOleInitialize() { return false; }
+inline void wxOleUninitialize() { }
+
+#endif // wxUSE_OLE/!wxUSE_OLE
+
+#endif  //_WX_OLEUTILS_H