synchronize GTK2 minimum version in docs

[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 a628ee50a4f1eafb1caa1432fa0ff5a3c7048e9c..973bbb9982172b0683dca9368b317607fefaff36 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:
 // 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
 
 #ifndef   _WX_OLEUTILS_H
 #define   _WX_OLEUTILS_H
 

-#ifdef __GNUG__
-#pragma interface "oleutils.h"
-#endif
-

 #include "wx/defs.h"
 
 #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
 // ============================================================================
 
 
 // ============================================================================
 // 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
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // misc helper functions/macros
 // ----------------------------------------------------------------------------


@@ -40,8 +81,8 @@ 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; };
 
 // 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
-extern bool IsIidFromList(REFIID riid, const IID *aIids[], size_t nCount);
+// return true if the iid is in the array
+extern WXDLLIMPEXP_CORE bool IsIidFromList(REFIID riid, const IID *aIids[], size_t nCount);

 
 // ============================================================================
 // IUnknown implementation helpers
 
 // ============================================================================
 // IUnknown implementation helpers


@@ -73,8 +114,8 @@ public:
     wxAutoULong(ULONG value = 0) : m_Value(value) { }
 
     operator ULONG&() { return m_Value; }
     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; }
 


@@ -99,9 +140,10 @@ private:
     wxAutoULong           m_cRef
 
 // macros for declaring supported interfaces
     wxAutoULong           m_cRef
 
 // macros for declaring supported interfaces

-// NB: you should write ADD_INTERFACE(Foo) and not ADD_INTERFACE(IID_IFoo)!
+// NB: ADD_IID prepends IID_I whereas ADD_RAW_IID does not

 #define BEGIN_IID_TABLE(cname)  const IID *cname::ms_aIids[] = {
 #define ADD_IID(iid)                                             &IID_I##iid,
 #define BEGIN_IID_TABLE(cname)  const IID *cname::ms_aIids[] = {
 #define ADD_IID(iid)                                             &IID_I##iid,

+#define ADD_RAW_IID(iid)                                         &iid,

 #define END_IID_TABLE                                          }
 
 // implementation is as straightforward as possible
 #define END_IID_TABLE                                          }
 
 // implementation is as straightforward as possible


@@ -109,7 +151,7 @@ private:
 #define   IMPLEMENT_IUNKNOWN_METHODS(classname)                               \
   STDMETHODIMP classname::QueryInterface(REFIID riid, void **ppv)             \
   {                                                                           \
 #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;                                                            \
                                                                               \
     if ( IsIidFromList(riid, ms_aIids, WXSIZEOF(ms_aIids)) ) {                \
       *ppv = this;                                                            \


@@ -126,16 +168,16 @@ private:
                                                                               \
   STDMETHODIMP_(ULONG) classname::AddRef()                                    \
   {                                                                           \
                                                                               \
   STDMETHODIMP_(ULONG) classname::AddRef()                                    \
   {                                                                           \

-    wxLogAddRef(_T(#classname), m_cRef);                                      \
+    wxLogAddRef(wxT(#classname), m_cRef);                                     \

                                                                               \
     return ++m_cRef;                                                          \
   }                                                                           \
                                                                               \
   STDMETHODIMP_(ULONG) classname::Release()                                   \
   {                                                                           \
                                                                               \
     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;                                                               \
     }                                                                         \
       delete this;                                                            \
       return 0;                                                               \
     }                                                                         \


@@ -150,23 +192,70 @@ private:
 // VZ: I don't know it's not done for compilers other than VC++ but I leave it
 //     as is. Please note, though, that tracing OLE interface calls may be
 //     incredibly useful when debugging OLE programs.
 // VZ: I don't know it's not done for compilers other than VC++ but I leave it
 //     as is. Please note, though, that tracing OLE interface calls may be
 //     incredibly useful when debugging OLE programs.

-#if defined(__WXDEBUG__) && ( ( defined(__VISUALC__) && (__VISUALC__ >= 1000) ) || defined(__MWERKS__) )
+#if defined(__WXDEBUG__) && (( defined(__VISUALC__) && (__VISUALC__ >= 1000) ))

 // ----------------------------------------------------------------------------
 // All OLE specific log functions have DebugTrace level (as LogTrace)
 // ----------------------------------------------------------------------------
 
 // tries to translate riid into a symbolic name, if possible
 // ----------------------------------------------------------------------------
 // All OLE specific log functions have DebugTrace level (as LogTrace)
 // ----------------------------------------------------------------------------
 
 // tries to translate riid into a symbolic name, if possible

-void wxLogQueryInterface(const wxChar *szInterface, REFIID riid);
+WXDLLIMPEXP_CORE void wxLogQueryInterface(const wxChar *szInterface, REFIID riid);

 
 // these functions print out the new value of reference counter
 
 // these functions print out the new value of reference counter

-void wxLogAddRef (const wxChar *szInterface, ULONG cRef);
-void wxLogRelease(const wxChar *szInterface, ULONG cRef);
+WXDLLIMPEXP_CORE void wxLogAddRef (const wxChar *szInterface, ULONG cRef);
+WXDLLIMPEXP_CORE void wxLogRelease(const wxChar *szInterface, ULONG cRef);

 
 

-#else   //!WXDEBUG
+#else   //!__WXDEBUG__

   #define   wxLogQueryInterface(szInterface, riid)
   #define   wxLogAddRef(szInterface, cRef)
   #define   wxLogRelease(szInterface, cRef)
   #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