include/wx/msw/ole/automtn.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/msw/ole/automtn.h
   3 // Purpose:     OLE automation utilities
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     11/6/98
   7 // Copyright:   (c) 1998, Julian Smart
   8 // Licence:     wxWindows licence
   9 /////////////////////////////////////////////////////////////////////////////
  10
  11 #ifndef _WX_AUTOMTN_H_
  12 #define _WX_AUTOMTN_H_
  13
  14 #include "wx/defs.h"
  15
  16 #if wxUSE_OLE_AUTOMATION
  17
  18 #include "wx/object.h"
  19 #include "wx/variant.h"
  20
  21 typedef void            WXIDISPATCH;
  22 typedef unsigned short* WXBSTR;
  23 typedef unsigned long   WXLCID;
  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     // Do not log errors if we failed to get the existing instance because none
  39     // is available.
  40     wxAutomationInstance_SilentIfNone = 2
  41 };
  42
  43 /*
  44  * wxAutomationObject
  45  * Wraps up an IDispatch pointer and invocation; does variant conversion.
  46  */
  47
  48 class WXDLLIMPEXP_CORE wxAutomationObject: public wxObject
  49 {
  50 public:
  51     wxAutomationObject(WXIDISPATCH* dispatchPtr = NULL);
  52     virtual ~wxAutomationObject();
  53
  54     // Set/get dispatch pointer
  55     void SetDispatchPtr(WXIDISPATCH* dispatchPtr) { m_dispatchPtr = dispatchPtr; }
  56     WXIDISPATCH* GetDispatchPtr() const { return m_dispatchPtr; }
  57     bool IsOk() const { return m_dispatchPtr != NULL; }
  58
  59     // Get a dispatch pointer from the current object associated
  60     // with a ProgID, such as "Excel.Application"
  61     bool GetInstance(const wxString& progId,
  62                      int flags = wxAutomationInstance_CreateIfNeeded) const;
  63
  64     // Get a dispatch pointer from a new instance of the class
  65     bool CreateInstance(const wxString& progId) const;
  66
  67     // Low-level invocation function. Pass either an array of variants,
  68     // or an array of pointers to variants.
  69     bool Invoke(const wxString& member, int action,
  70         wxVariant& retValue, int noArgs, wxVariant args[], const wxVariant* ptrArgs[] = 0) const;
  71
  72     // Invoke a member function
  73     wxVariant CallMethod(const wxString& method, int noArgs, wxVariant args[]);
  74     wxVariant CallMethodArray(const wxString& method, int noArgs, const wxVariant **args);
  75
  76     // Convenience function
  77     wxVariant CallMethod(const wxString& method,
  78         const wxVariant& arg1 = wxNullVariant, const wxVariant& arg2 = wxNullVariant,
  79         const wxVariant& arg3 = wxNullVariant, const wxVariant& arg4 = wxNullVariant,
  80         const wxVariant& arg5 = wxNullVariant, const wxVariant& arg6 = wxNullVariant);
  81
  82     // Get/Put property
  83     wxVariant GetProperty(const wxString& property, int noArgs = 0, wxVariant args[] = NULL) const;
  84     wxVariant GetPropertyArray(const wxString& property, int noArgs, const wxVariant **args) const;
  85     wxVariant GetProperty(const wxString& property,
  86         const wxVariant& arg1, const wxVariant& arg2 = wxNullVariant,
  87         const wxVariant& arg3 = wxNullVariant, const wxVariant& arg4 = wxNullVariant,
  88         const wxVariant& arg5 = wxNullVariant, const wxVariant& arg6 = wxNullVariant);
  89
  90     bool PutPropertyArray(const wxString& property, int noArgs, const wxVariant **args);
  91     bool PutProperty(const wxString& property, int noArgs, wxVariant args[]) ;
  92     bool PutProperty(const wxString& property,
  93         const wxVariant& arg1, const wxVariant& arg2 = wxNullVariant,
  94         const wxVariant& arg3 = wxNullVariant, const wxVariant& arg4 = wxNullVariant,
  95         const wxVariant& arg5 = wxNullVariant, const wxVariant& arg6 = wxNullVariant);
  96
  97     // Uses DISPATCH_PROPERTYGET
  98     // and returns a dispatch pointer. The calling code should call Release
  99     // on the pointer, though this could be implicit by constructing an wxAutomationObject
 100     // with it and letting the destructor call Release.
 101     WXIDISPATCH* GetDispatchProperty(const wxString& property, int noArgs, wxVariant args[]) const;
 102     WXIDISPATCH* GetDispatchProperty(const wxString& property, int noArgs, const wxVariant **args) const;
 103
 104     // A way of initialising another wxAutomationObject with a dispatch object,
 105     // without having to deal with nasty IDispatch pointers.
 106     bool GetObject(wxAutomationObject& obj, const wxString& property, int noArgs = 0, wxVariant args[] = NULL) const;
 107     bool GetObject(wxAutomationObject& obj, const wxString& property, int noArgs, const wxVariant **args) const;
 108
 109     // Returns the locale identifier used in automation calls. The default is
 110     // LOCALE_SYSTEM_DEFAULT. Objects obtained by GetObject() inherit the
 111     // locale identifier from the one that created them.
 112     WXLCID GetLCID() const;
 113
 114     // Sets the locale identifier to be used in automation calls performed by
 115     // this object. The default is LOCALE_SYSTEM_DEFAULT.
 116     void SetLCID(WXLCID lcid);
 117
 118 public: // public for compatibility only, don't use m_dispatchPtr directly.
 119     WXIDISPATCH*  m_dispatchPtr;
 120
 121 private:
 122     WXLCID m_lcid;
 123
 124     wxDECLARE_NO_COPY_CLASS(wxAutomationObject);
 125 };
 126
 127 #endif // wxUSE_OLE_AUTOMATION
 128
 129 #endif // _WX_AUTOMTN_H_