]> git.saurik.com Git - wxWidgets.git/blob - include/wx/msw/ole/activex.h
Document wxPerl interface differences for wxRichTextCtrl.
[wxWidgets.git] / include / wx / msw / ole / activex.h
1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: wx/msw/ole/activex.h
3 // Purpose: wxActiveXContainer class
4 // Author: Ryan Norton <wxprojects@comcast.net>
5 // Modified by:
6 // Created: 8/18/05
7 // RCS-ID: $Id$
8 // Copyright: (c) Ryan Norton
9 // Licence: wxWindows licence
10 ///////////////////////////////////////////////////////////////////////////////
11
12 // ============================================================================
13 // Definitions
14 // ============================================================================
15
16 #ifndef _WX_MSW_OLE_ACTIVEXCONTAINER_H_
17 #define _WX_MSW_OLE_ACTIVEXCONTAINER_H_
18
19 #if wxUSE_ACTIVEX
20
21 //---------------------------------------------------------------------------
22 // wx includes
23 //---------------------------------------------------------------------------
24
25 #include "wx/msw/ole/oleutils.h" // wxBasicString &c
26 #include "wx/msw/ole/uuid.h"
27 #include "wx/window.h"
28 #include "wx/variant.h"
29
30 class FrameSite;
31
32 //---------------------------------------------------------------------------
33 // MSW COM includes
34 //---------------------------------------------------------------------------
35 #include <oleidl.h>
36 #include <olectl.h>
37
38 #if !defined(__WXWINCE__) || defined(__WINCE_STANDARDSDK__)
39 #include <exdisp.h>
40 #endif
41
42 #include <docobj.h>
43
44 #ifndef STDMETHOD
45 #define STDMETHOD(funcname) virtual HRESULT wxSTDCALL funcname
46 #endif
47
48 //
49 // These defines are from another ole header - but its not in the
50 // latest sdk. Also the ifndef DISPID_READYSTATE is here because at
51 // least on my machine with the latest sdk olectl.h defines these 3
52 //
53 #ifndef DISPID_READYSTATE
54 #define DISPID_READYSTATE (-525)
55 #define DISPID_READYSTATECHANGE (-609)
56 #define DISPID_AMBIENT_TRANSFERPRIORITY (-728)
57 #endif
58
59 #define DISPID_AMBIENT_OFFLINEIFNOTCONNECTED (-5501)
60 #define DISPID_AMBIENT_SILENT (-5502)
61
62 #ifndef DISPID_AMBIENT_CODEPAGE
63 #define DISPID_AMBIENT_CODEPAGE (-725)
64 #define DISPID_AMBIENT_CHARSET (-727)
65 #endif
66
67
68 //---------------------------------------------------------------------------
69 //
70 // wxActiveXContainer
71 //
72 //---------------------------------------------------------------------------
73
74 #define WX_DECLARE_AUTOOLE(wxAutoOleInterface, I) \
75 class wxAutoOleInterface \
76 { \
77 protected: \
78 I *m_interface; \
79 \
80 public: \
81 explicit wxAutoOleInterface(I *pInterface = NULL) : m_interface(pInterface) {} \
82 wxAutoOleInterface(REFIID riid, IUnknown *pUnk) : m_interface(NULL) \
83 { QueryInterface(riid, pUnk); } \
84 wxAutoOleInterface(REFIID riid, IDispatch *pDispatch) : m_interface(NULL) \
85 { QueryInterface(riid, pDispatch); } \
86 wxAutoOleInterface(REFCLSID clsid, REFIID riid) : m_interface(NULL)\
87 { CreateInstance(clsid, riid); }\
88 wxAutoOleInterface(const wxAutoOleInterface& ti) : m_interface(NULL)\
89 { operator = (ti); }\
90 \
91 wxAutoOleInterface& operator = (const wxAutoOleInterface& ti)\
92 {\
93 if (ti.m_interface)\
94 ti.m_interface->AddRef();\
95 Free();\
96 m_interface = ti.m_interface;\
97 return *this;\
98 }\
99 \
100 wxAutoOleInterface& operator = (I *&ti)\
101 {\
102 Free();\
103 m_interface = ti;\
104 return *this;\
105 }\
106 \
107 ~wxAutoOleInterface() { Free(); }\
108 \
109 inline void Free()\
110 {\
111 if (m_interface)\
112 m_interface->Release();\
113 m_interface = NULL;\
114 }\
115 \
116 HRESULT QueryInterface(REFIID riid, IUnknown *pUnk)\
117 {\
118 Free();\
119 wxASSERT(pUnk != NULL);\
120 return pUnk->QueryInterface(riid, (void **) &m_interface);\
121 }\
122 \
123 HRESULT CreateInstance(REFCLSID clsid, REFIID riid)\
124 {\
125 Free();\
126 return CoCreateInstance(clsid, NULL, CLSCTX_ALL, riid, (void **) &m_interface);\
127 }\
128 \
129 inline operator I *() const {return m_interface;}\
130 inline I* operator ->() {return m_interface;}\
131 inline I** GetRef() {return &m_interface;}\
132 inline bool Ok() const { return IsOk(); }\
133 inline bool IsOk() const {return m_interface != NULL;}\
134 };
135
136 WX_DECLARE_AUTOOLE(wxAutoIDispatch, IDispatch)
137 WX_DECLARE_AUTOOLE(wxAutoIOleClientSite, IOleClientSite)
138 WX_DECLARE_AUTOOLE(wxAutoIUnknown, IUnknown)
139 WX_DECLARE_AUTOOLE(wxAutoIOleObject, IOleObject)
140 WX_DECLARE_AUTOOLE(wxAutoIOleInPlaceObject, IOleInPlaceObject)
141 WX_DECLARE_AUTOOLE(wxAutoIOleInPlaceActiveObject, IOleInPlaceActiveObject)
142 WX_DECLARE_AUTOOLE(wxAutoIOleDocumentView, IOleDocumentView)
143 WX_DECLARE_AUTOOLE(wxAutoIViewObject, IViewObject)
144
145 class WXDLLIMPEXP_CORE wxActiveXContainer : public wxWindow
146 {
147 public:
148 wxActiveXContainer(wxWindow * parent, REFIID iid, IUnknown* pUnk);
149 virtual ~wxActiveXContainer();
150
151 void OnSize(wxSizeEvent&);
152 void OnPaint(wxPaintEvent&);
153 void OnSetFocus(wxFocusEvent&);
154 void OnKillFocus(wxFocusEvent&);
155
156 protected:
157 friend class FrameSite;
158 friend class wxActiveXEvents;
159
160 FrameSite *m_frameSite;
161 wxAutoIDispatch m_Dispatch;
162 wxAutoIOleClientSite m_clientSite;
163 wxAutoIUnknown m_ActiveX;
164 wxAutoIOleObject m_oleObject;
165 wxAutoIOleInPlaceObject m_oleInPlaceObject;
166 wxAutoIOleInPlaceActiveObject m_oleInPlaceActiveObject;
167 wxAutoIOleDocumentView m_docView;
168 wxAutoIViewObject m_viewObject;
169 HWND m_oleObjectHWND;
170 bool m_bAmbientUserMode;
171 DWORD m_docAdviseCookie;
172 wxWindow* m_realparent;
173
174 void CreateActiveX(REFIID, IUnknown*);
175 };
176
177 ///\brief Store native event parameters.
178 ///\detail Store OLE 'Invoke' parameters for event handlers that need to access them.
179 /// These are the exact values for the event as they are passed to the wxActiveXContainer.
180 struct wxActiveXEventNativeMSW
181 {
182 DISPID dispIdMember;
183 REFIID riid;
184 LCID lcid;
185 WORD wFlags;
186 DISPPARAMS *pDispParams;
187 VARIANT *pVarResult;
188 EXCEPINFO *pExcepInfo;
189 unsigned int *puArgErr;
190
191 wxActiveXEventNativeMSW
192 (DISPID a_dispIdMember, REFIID a_riid, LCID a_lcid, WORD a_wFlags, DISPPARAMS *a_pDispParams,
193 VARIANT *a_pVarResult, EXCEPINFO *a_pExcepInfo, unsigned int *a_puArgErr)
194 :dispIdMember(a_dispIdMember), riid(a_riid), lcid(a_lcid), wFlags(a_wFlags), pDispParams(a_pDispParams),
195 pVarResult(a_pVarResult), pExcepInfo(a_pExcepInfo), puArgErr(a_puArgErr)
196 { }
197 };
198
199 // Events
200 class WXDLLIMPEXP_CORE wxActiveXEvent : public wxCommandEvent
201 {
202 private:
203 friend class wxActiveXEvents;
204 wxVariant m_params;
205 DISPID m_dispid;
206
207 public:
208 virtual wxEvent *Clone() const
209 { return new wxActiveXEvent(*this); }
210
211 size_t ParamCount() const;
212
213 wxString ParamType(size_t idx) const
214 {
215 wxASSERT(idx < ParamCount());
216 return m_params[idx].GetType();
217 }
218
219 wxString ParamName(size_t idx) const
220 {
221 wxASSERT(idx < ParamCount());
222 return m_params[idx].GetName();
223 }
224
225 wxVariant& operator[] (size_t idx);
226
227 DISPID GetDispatchId() const
228 { return m_dispid; }
229
230 wxActiveXEventNativeMSW *GetNativeParameters() const
231 { return (wxActiveXEventNativeMSW*)GetClientData(); }
232 };
233
234 // #define wxACTIVEX_ID 14001
235 wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_ACTIVEX, wxActiveXEvent );
236
237 typedef void (wxEvtHandler::*wxActiveXEventFunction)(wxActiveXEvent&);
238
239 #define wxActiveXEventHandler(func) \
240 wxEVENT_HANDLER_CAST( wxActiveXEventFunction, func )
241
242 #define EVT_ACTIVEX(id, fn) DECLARE_EVENT_TABLE_ENTRY(wxEVT_ACTIVEX, id, -1, wxActiveXEventHandler( fn ), NULL ),
243
244 #endif // wxUSE_ACTIVEX
245
246 #endif // _WX_MSW_OLE_ACTIVEXCONTAINER_H_