]>
Commit | Line | Data |
---|---|---|
1 | ///////////////////////////////////////////////////////////////////////////// | |
2 | // Name: automtn.h | |
3 | // Purpose: OLE automation utilities | |
4 | // Author: Julian Smart | |
5 | // Modified by: | |
6 | // Created: 11/6/98 | |
7 | // RCS-ID: $Id$ | |
8 | // Copyright: (c) 1998, Julian Smart | |
9 | // Licence: wxWindows licence | |
10 | ///////////////////////////////////////////////////////////////////////////// | |
11 | ||
12 | #ifndef _WX_AUTOMTN_H_ | |
13 | #define _WX_AUTOMTN_H_ | |
14 | ||
15 | #include "wx/defs.h" | |
16 | ||
17 | #if wxUSE_OLE_AUTOMATION | |
18 | ||
19 | #include "wx/object.h" | |
20 | #include "wx/variant.h" | |
21 | ||
22 | typedef void WXIDISPATCH; | |
23 | typedef unsigned short* WXBSTR; | |
24 | ||
25 | #ifdef GetObject | |
26 | #undef GetObject | |
27 | #endif | |
28 | ||
29 | /* | |
30 | * wxAutomationObject | |
31 | * Wraps up an IDispatch pointer and invocation; does variant conversion. | |
32 | */ | |
33 | ||
34 | class WXDLLIMPEXP_CORE wxAutomationObject: public wxObject | |
35 | { | |
36 | public: | |
37 | wxAutomationObject(WXIDISPATCH* dispatchPtr = NULL); | |
38 | virtual ~wxAutomationObject(); | |
39 | ||
40 | // Set/get dispatch pointer | |
41 | void SetDispatchPtr(WXIDISPATCH* dispatchPtr) { m_dispatchPtr = dispatchPtr; } | |
42 | WXIDISPATCH* GetDispatchPtr() const { return m_dispatchPtr; } | |
43 | bool IsOk() const { return m_dispatchPtr != NULL; } | |
44 | ||
45 | // Get a dispatch pointer from the current object associated | |
46 | // with a class id, such as "Excel.Application" | |
47 | bool GetInstance(const wxString& classId) const; | |
48 | ||
49 | // Get a dispatch pointer from a new instance of the the class | |
50 | bool CreateInstance(const wxString& classId) const; | |
51 | ||
52 | // Low-level invocation function. Pass either an array of variants, | |
53 | // or an array of pointers to variants. | |
54 | bool Invoke(const wxString& member, int action, | |
55 | wxVariant& retValue, int noArgs, wxVariant args[], const wxVariant* ptrArgs[] = 0) const; | |
56 | ||
57 | // Invoke a member function | |
58 | wxVariant CallMethod(const wxString& method, int noArgs, wxVariant args[]); | |
59 | wxVariant CallMethodArray(const wxString& method, int noArgs, const wxVariant **args); | |
60 | ||
61 | // Convenience function | |
62 | wxVariant CallMethod(const wxString& method, | |
63 | const wxVariant& arg1 = wxNullVariant, const wxVariant& arg2 = wxNullVariant, | |
64 | const wxVariant& arg3 = wxNullVariant, const wxVariant& arg4 = wxNullVariant, | |
65 | const wxVariant& arg5 = wxNullVariant, const wxVariant& arg6 = wxNullVariant); | |
66 | ||
67 | // Get/Put property | |
68 | wxVariant GetProperty(const wxString& property, int noArgs = 0, wxVariant args[] = NULL) const; | |
69 | wxVariant GetPropertyArray(const wxString& property, int noArgs, const wxVariant **args) const; | |
70 | wxVariant GetProperty(const wxString& property, | |
71 | const wxVariant& arg1, const wxVariant& arg2 = wxNullVariant, | |
72 | const wxVariant& arg3 = wxNullVariant, const wxVariant& arg4 = wxNullVariant, | |
73 | const wxVariant& arg5 = wxNullVariant, const wxVariant& arg6 = wxNullVariant); | |
74 | ||
75 | bool PutPropertyArray(const wxString& property, int noArgs, const wxVariant **args); | |
76 | bool PutProperty(const wxString& property, int noArgs, wxVariant args[]) ; | |
77 | bool PutProperty(const wxString& property, | |
78 | const wxVariant& arg1, const wxVariant& arg2 = wxNullVariant, | |
79 | const wxVariant& arg3 = wxNullVariant, const wxVariant& arg4 = wxNullVariant, | |
80 | const wxVariant& arg5 = wxNullVariant, const wxVariant& arg6 = wxNullVariant); | |
81 | ||
82 | // Uses DISPATCH_PROPERTYGET | |
83 | // and returns a dispatch pointer. The calling code should call Release | |
84 | // on the pointer, though this could be implicit by constructing an wxAutomationObject | |
85 | // with it and letting the destructor call Release. | |
86 | WXIDISPATCH* GetDispatchProperty(const wxString& property, int noArgs, wxVariant args[]) const; | |
87 | WXIDISPATCH* GetDispatchProperty(const wxString& property, int noArgs, const wxVariant **args) const; | |
88 | ||
89 | // A way of initialising another wxAutomationObject with a dispatch object, | |
90 | // without having to deal with nasty IDispatch pointers. | |
91 | bool GetObject(wxAutomationObject& obj, const wxString& property, int noArgs = 0, wxVariant args[] = NULL) const; | |
92 | bool GetObject(wxAutomationObject& obj, const wxString& property, int noArgs, const wxVariant **args) const; | |
93 | ||
94 | public: | |
95 | WXIDISPATCH* m_dispatchPtr; | |
96 | ||
97 | wxDECLARE_NO_COPY_CLASS(wxAutomationObject); | |
98 | }; | |
99 | ||
100 | #endif // wxUSE_OLE_AUTOMATION | |
101 | ||
102 | #endif // _WX_AUTOMTN_H_ |