// 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
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
*/
void MyFrame::OnTest(wxCommandEvent& WXUNUSED(event))
{
- wxMessageBox(wxT("Please ensure Excel is running, then press OK.\nThe active cell should then say 'wxWidgets automation test!' in bold."));
+ wxMessageBox(wxT("Excel will be started if it is not running after you have pressed OK button.")
+ wxT("\nThe active cell should then say 'wxWidgets automation test!' in bold."),
+ wxT("Excel start"));
- wxAutomationObject excelObject, rangeObject;
- if (!excelObject.GetInstance(wxT("Excel.Application")))
+ wxAutomationObject excelObject;
+ if ( !excelObject.GetInstance(wxT("Excel.Application")) )
{
- // Start Excel if it is not running
- if (!excelObject.CreateInstance(wxT("Excel.Application")))
- {
- wxMessageBox(wxT("Could not create Excel object."));
- return;
- }
+ wxLogError(wxT("Could not create Excel object."));
+ return;
}
// Ensure that Excel is visible
if (!excelObject.PutProperty(wxT("Visible"), true))
{
- wxMessageBox(wxT("Could not make Excel object visible"));
+ wxLogError(wxT("Could not make Excel object visible"));
}
const wxVariant workbooksCountVariant = excelObject.GetProperty(wxT("Workbooks.Count"));
if (workbooksCountVariant.IsNull())
{
- wxMessageBox(wxT("Could not get workbooks count"));
+ wxLogError(wxT("Could not get workbooks count"));
return;
}
const long workbooksCount = workbooksCountVariant;
const wxVariant workbook = excelObject.CallMethod(wxT("Workbooks.Add"));
if (workbook.IsNull())
{
- wxMessageBox(wxT("Could not create new Workbook"));
+ wxLogError(wxT("Could not create new Workbook"));
return;
}
}
if (!excelObject.PutProperty(wxT("ActiveCell.Value"), wxT("wxWidgets automation test!")))
{
- wxMessageBox(wxT("Could not set active cell value."));
+ wxLogError(wxT("Could not set active cell value."));
return;
}
if (!excelObject.PutProperty(wxT("ActiveCell.Font.Bold"), wxVariant(true)) )
{
- wxMessageBox(wxT("Could not put Bold property to active cell."));
+ wxLogError(wxT("Could not put Bold property to active cell."));
return;
}
}
#if wxUSE_OLE_AUTOMATION
-// Report an OLE error to the user via wxLog.
+// Report an OLE error when calling the specified method to the user via wxLog.
static void
ShowException(const wxString& member,
HRESULT hr,
- EXCEPINFO *pexcep,
- unsigned int uiArgErr);
+ EXCEPINFO *pexcep = NULL,
+ unsigned int uiArgErr = 0);
// wxAutomationObject
1 + namedArgCount, LOCALE_SYSTEM_DEFAULT, dispIds);
if (FAILED(hr))
{
- ShowException(member, hr, NULL, 0);
+ ShowException(member, hr);
delete[] argNames;
delete[] dispIds;
return false;
return false;
}
+namespace
+{
+
+HRESULT wxCLSIDFromProgID(const wxString& progId, CLSID& clsId)
+{
+ HRESULT hr = CLSIDFromProgID(wxBasicString(progId), &clsId);
+ if ( FAILED(hr) )
+ {
+ wxLogSysError(hr, _("Failed to find CLSID of \"%s\""), progId);
+ }
+ return hr;
+}
+
+void *DoCreateInstance(const wxString& progId, const CLSID& clsId)
+{
+ // get the server IDispatch interface
+ //
+ // NB: using CLSCTX_INPROC_HANDLER results in failure when getting
+ // Automation interface for Microsoft Office applications so don't use
+ // CLSCTX_ALL which includes it
+ void *pDispatch = NULL;
+ HRESULT hr = CoCreateInstance(clsId, NULL, CLSCTX_SERVER,
+ IID_IDispatch, &pDispatch);
+ if (FAILED(hr))
+ {
+ wxLogSysError(hr, _("Failed to create an instance of \"%s\""), progId);
+ return NULL;
+ }
+
+ return pDispatch;
+}
+
+} // anonymous namespace
+
// Get a dispatch pointer from the current object associated
// with a ProgID
-bool wxAutomationObject::GetInstance(const wxString& progId) const
+bool wxAutomationObject::GetInstance(const wxString& progId, int flags) const
{
if (m_dispatchPtr)
return false;
- HRESULT hr;
CLSID clsId;
- IUnknown * pUnk = NULL;
-
- wxBasicString unicodeName(progId);
-
- hr = CLSIDFromProgID((BSTR) unicodeName, &clsId);
+ HRESULT hr = wxCLSIDFromProgID(progId, clsId);
if (FAILED(hr))
- {
- ShowException(progId, hr, NULL, 0);
- wxLogWarning(wxT("Cannot obtain CLSID from ProgID"));
return false;
- }
+ IUnknown *pUnk = NULL;
hr = GetActiveObject(clsId, NULL, &pUnk);
if (FAILED(hr))
{
- ShowException(progId, hr, NULL, 0);
- wxLogWarning(wxT("Cannot find an active object"));
+ if ( flags & wxAutomationInstance_CreateIfNeeded )
+ {
+ const_cast<wxAutomationObject *>(this)->
+ m_dispatchPtr = DoCreateInstance(progId, clsId);
+ if ( m_dispatchPtr )
+ return true;
+ }
+ else
+ {
+ wxLogSysError(hr,
+ _("Cannot get an active instance of \"%s\""), progId);
+ }
+
return false;
}
hr = pUnk->QueryInterface(IID_IDispatch, (LPVOID*) &m_dispatchPtr);
if (FAILED(hr))
{
- ShowException(progId, hr, NULL, 0);
- wxLogWarning(wxT("Cannot find IDispatch interface"));
+ wxLogSysError(hr,
+ _("Failed to get OLE automation interface for \"%s\""),
+ progId);
return false;
}
if (m_dispatchPtr)
return false;
- HRESULT hr;
CLSID clsId;
-
- wxBasicString unicodeName(progId);
-
- hr = CLSIDFromProgID((BSTR) unicodeName, &clsId);
+ HRESULT hr = wxCLSIDFromProgID(progId, clsId);
if (FAILED(hr))
- {
- ShowException(progId, hr, NULL, 0);
- wxLogWarning(wxT("Cannot obtain CLSID from ProgID"));
return false;
- }
- // get the server IDispatch interface
- //
- // NB: using CLSCTX_INPROC_HANDLER results in failure when getting
- // Automation interface for Microsoft Office applications so don't use
- // CLSCTX_ALL which includes it
- hr = CoCreateInstance(clsId, NULL, CLSCTX_SERVER, IID_IDispatch,
- (void**)&m_dispatchPtr);
- if (FAILED(hr))
- {
- ShowException(progId, hr, NULL, 0);
- wxLogWarning(wxT("Could not start an instance of this class."));
- return false;
- }
+ const_cast<wxAutomationObject *>(this)->
+ m_dispatchPtr = DoCreateInstance(progId, clsId);
- return true;
+ return m_dispatchPtr != NULL;
}
static void
switch (GetScode(hr))
{
case DISP_E_UNKNOWNNAME:
- message = wxT("Unknown name or named argument.");
+ message = _("Unknown name or named argument.");
break;
case DISP_E_BADPARAMCOUNT:
- message = wxT("Incorrect number of arguments.");
+ message = _("Incorrect number of arguments.");
break;
case DISP_E_EXCEPTION:
+ if ( pexcep )
+ {
+ if ( pexcep->bstrDescription )
+ message << pexcep->bstrDescription << wxS(" ");
+ message += wxString::Format(wxS("error code %u"), pexcep->wCode);
+ }
+ else
{
- message = wxT("Error Code (");
- message << pexcep->wCode ;// unsigned short
- message += wxT(")");
- if (pexcep->bstrDescription != NULL)
- message += pexcep->bstrDescription;
- else
- message += wxT("<<No Description>>");
+ message = _("Unknown exception");
}
break;
case DISP_E_MEMBERNOTFOUND:
- message = wxT("Method or property not found.");
+ message = _("Method or property not found.");
break;
case DISP_E_OVERFLOW:
- message = wxT("Overflow while coercing argument values.");
+ message = _("Overflow while coercing argument values.");
break;
case DISP_E_NONAMEDARGS:
- message = wxT("Object implementation does not support named arguments.");
+ message = _("Object implementation does not support named arguments.");
break;
case DISP_E_UNKNOWNLCID:
- message = wxT("The locale ID is unknown.");
+ message = _("The locale ID is unknown.");
break;
case DISP_E_PARAMNOTOPTIONAL:
- message = wxT("Missing a required parameter.");
+ message = _("Missing a required parameter.");
break;
case DISP_E_PARAMNOTFOUND:
- message = wxT("Argument not found, argument.");
- message << uiArgErr;
+ message.Printf(_("Argument %u not found."), uiArgErr);
break;
case DISP_E_TYPEMISMATCH:
- message = wxT("Type mismatch, argument.");
- message << uiArgErr;
+ message.Printf(_("Type mismatch in argument %u."), uiArgErr);
break;
case ERROR_FILE_NOT_FOUND:
- message = wxT("The system cannot find the file specified.");
+ message = _("The system cannot find the file specified.");
break;
case REGDB_E_CLASSNOTREG:
- message = wxT("Class not registered.");
+ message = _("Class not registered.");
break;
default:
- message = wxT("Unknown error occurred. Return value is ");
- message << hr;
+ message.Printf(_("Unknown error %08x"), hr);
break;
}
- wxLogDebug("OLE Automation error in %s: %s", member, message);
+ wxLogError(_("OLE Automation error in %s: %s"), member, message);
}
#endif // wxUSE_OLE_AUTOMATION
projects / wxWidgets.git / commitdiff
