include/wx/msw/ole/automtn.h

   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 // Flags used with wxAutomationObject::GetInstance()
  30 enum wxAutomationInstanceFlags
  31 {
  32     // Only use the existing instance, never create a new one.
  33     wxAutomationInstance_UseExistingOnly = 0,
  34
  35     // Create a new instance if there are no existing ones.
  36     wxAutomationInstance_CreateIfNeeded = 1
  37 };
  38
  39 /*
  40  * wxAutomationObject
  41  * Wraps up an IDispatch pointer and invocation; does variant conversion.
  42  */
  43
  44 class WXDLLIMPEXP_CORE wxAutomationObject: public wxObject
  45 {
  46 public:
  47     wxAutomationObject(WXIDISPATCH* dispatchPtr = NULL);
  48     virtual ~wxAutomationObject();
  49
  50     // Set/get dispatch pointer
  51     void SetDispatchPtr(WXIDISPATCH* dispatchPtr) { m_dispatchPtr = dispatchPtr; }
  52     WXIDISPATCH* GetDispatchPtr() const { return m_dispatchPtr; }
  53     bool IsOk() const { return m_dispatchPtr != NULL; }
  54
  55     // Get a dispatch pointer from the current object associated
  56     // with a ProgID, such as "Excel.Application"
  57     bool GetInstance(const wxString& progId,
  58                      int flags = wxAutomationInstance_CreateIfNeeded) const;
  59
  60     // Get a dispatch pointer from a new instance of the class
  61     bool CreateInstance(const wxString& progId) const;
  62
  63     // Low-level invocation function. Pass either an array of variants,
  64     // or an array of pointers to variants.
  65     bool Invoke(const wxString& member, int action,
  66         wxVariant& retValue, int noArgs, wxVariant args[], const wxVariant* ptrArgs[] = 0) const;
  67
  68     // Invoke a member function
  69     wxVariant CallMethod(const wxString& method, int noArgs, wxVariant args[]);
  70     wxVariant CallMethodArray(const wxString& method, int noArgs, const wxVariant **args);
  71
  72     // Convenience function
  73     wxVariant CallMethod(const wxString& method,
  74         const wxVariant& arg1 = wxNullVariant, const wxVariant& arg2 = wxNullVariant,
  75         const wxVariant& arg3 = wxNullVariant, const wxVariant& arg4 = wxNullVariant,
  76         const wxVariant& arg5 = wxNullVariant, const wxVariant& arg6 = wxNullVariant);
  77
  78     // Get/Put property
  79     wxVariant GetProperty(const wxString& property, int noArgs = 0, wxVariant args[] = NULL) const;
  80     wxVariant GetPropertyArray(const wxString& property, int noArgs, const wxVariant **args) const;
  81     wxVariant GetProperty(const wxString& property,
  82         const wxVariant& arg1, const wxVariant& arg2 = wxNullVariant,
  83         const wxVariant& arg3 = wxNullVariant, const wxVariant& arg4 = wxNullVariant,
  84         const wxVariant& arg5 = wxNullVariant, const wxVariant& arg6 = wxNullVariant);
  85
  86     bool PutPropertyArray(const wxString& property, int noArgs, const wxVariant **args);
  87     bool PutProperty(const wxString& property, int noArgs, wxVariant args[]) ;
  88     bool PutProperty(const wxString& property,
  89         const wxVariant& arg1, const wxVariant& arg2 = wxNullVariant,
  90         const wxVariant& arg3 = wxNullVariant, const wxVariant& arg4 = wxNullVariant,
  91         const wxVariant& arg5 = wxNullVariant, const wxVariant& arg6 = wxNullVariant);
  92
  93     // Uses DISPATCH_PROPERTYGET
  94     // and returns a dispatch pointer. The calling code should call Release
  95     // on the pointer, though this could be implicit by constructing an wxAutomationObject
  96     // with it and letting the destructor call Release.
  97     WXIDISPATCH* GetDispatchProperty(const wxString& property, int noArgs, wxVariant args[]) const;
  98     WXIDISPATCH* GetDispatchProperty(const wxString& property, int noArgs, const wxVariant **args) const;
  99
 100     // A way of initialising another wxAutomationObject with a dispatch object,
 101     // without having to deal with nasty IDispatch pointers.
 102     bool GetObject(wxAutomationObject& obj, const wxString& property, int noArgs = 0, wxVariant args[] = NULL) const;
 103     bool GetObject(wxAutomationObject& obj, const wxString& property, int noArgs, const wxVariant **args) const;
 104
 105 public:
 106     WXIDISPATCH*  m_dispatchPtr;
 107
 108     wxDECLARE_NO_COPY_CLASS(wxAutomationObject);
 109 };
 110
 111 #endif // wxUSE_OLE_AUTOMATION
 112
 113 #endif // _WX_AUTOMTN_H_