Allow wxAutomationObject::GetInstance() create new instance if needed.
When getting an instance of an OLE automation object, it is often useful to connect to the existing instance if any or start a new one otherwise. Make GetInstance() behave like this by default while still allowing to use the wxAutomationInstance_UseExistingOnly flag to reestablish the old behaviour. Also improve the error reporting in wxAutomationObject. See #12489. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@66262 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
@@ -6,6 +6,35 @@
|
||||
// Licence: wxWindows licence
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
/**
|
||||
Automation object creation flags.
|
||||
|
||||
These flags can be used with wxAutomationObject::GetInstance().
|
||||
|
||||
@since 2.9.2
|
||||
*/
|
||||
enum wxAutomationInstanceFlags
|
||||
{
|
||||
/**
|
||||
Only use the existing instance, never create a new one.
|
||||
|
||||
This flag can be used to forbid the creation of a new instance if none
|
||||
is currently running.
|
||||
*/
|
||||
wxAutomationInstance_UseExistingOnly = 0,
|
||||
|
||||
/**
|
||||
Create a new instance if there are no existing ones.
|
||||
|
||||
This flag corresponds to the default behaviour of
|
||||
wxAutomationObject::GetInstance() and means that if getting an existing
|
||||
instance failed, we should call wxAutomationObject::CreateInstance() to
|
||||
create a new one.
|
||||
*/
|
||||
wxAutomationInstance_CreateIfNeeded = 1
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
@class wxAutomationObject
|
||||
|
||||
@@ -103,14 +132,23 @@ public:
|
||||
Retrieves the current object associated with the specified ProgID, and
|
||||
attaches the IDispatch pointer to this object.
|
||||
|
||||
If attaching to an existing object failed and @a flags includes
|
||||
wxAutomationInstance_CreateIfNeeded flag, a new object will be created.
|
||||
|
||||
Returns @true if a pointer was successfully retrieved, @false
|
||||
otherwise.
|
||||
|
||||
Note that this cannot cope with two instances of a given OLE object being
|
||||
active simultaneously,
|
||||
such as two copies of Excel running. Which object is referenced cannot
|
||||
currently be specified.
|
||||
|
||||
@param progId COM ProgID, e.g. "Excel.Application"
|
||||
@param flags The creation flags (this parameters was added in wxWidgets
|
||||
2.9.2)
|
||||
*/
|
||||
bool GetInstance(const wxString& progId) const;
|
||||
bool GetInstance(const wxString& progId,
|
||||
int flags = wxAutomationInstance_CreateIfNeeded) const;
|
||||
|
||||
/**
|
||||
Retrieves a property from this object, assumed to be a dispatch pointer, and
|
||||
|
Reference in New Issue
Block a user