Member Function Documentation

QAxBase::QAxBase(IUnknown *iface = nullptr)

Creates a QAxBase object that wraps the COM object iface. If iface is 0 (the default), use setControl() to instantiate a COM object.

[signal] void QAxBase::exception(int code, const QString &source, const QString &desc, const QString &help)

This signal is emitted when the COM object throws an exception while called using the OLE automation interface IDispatch. code, source, desc and help provide information about the exception as provided by the COM server and can be used to provide useful feedback to the end user. help includes the help file, and the help context ID in brackets, e.g. "filename [id]".

[signal] void QAxBase::propertyChanged(const QString &name)

If the COM object supports property notification, this signal gets emitted when the property called name is changed.

[signal] void QAxBase::signal(const QString &name, int argc, void *argv)

This generic signal gets emitted when the COM object issues the event name. argc is the number of parameters provided by the event (DISPPARAMS.cArgs), and argv is the pointer to the parameter values (DISPPARAMS.rgvarg). Note that the order of parameter values is turned around, ie. the last element of the array is the first parameter in the function.

void Receiver::slot(const QString &name, int argc, void *argv)
{
    VARIANTARG *params = (VARIANTARG*)argv;
    if (name.startsWith("BeforeNavigate2(")) {
        IDispatch *pDisp = params[argc-1].pdispVal;
        VARIANTARG URL = *params[argc-2].pvarVal;
        VARIANTARG Flags = *params[argc-3].pvarVal;
        VARIANTARG TargetFrameName = *params[argc-4].pvarVal;
        VARIANTARG PostData = *params[argc-5].pvarVal;
        VARIANTARG Headers = *params[argc-6].pvarVal;
        bool *Cancel = params[argc-7].pboolVal;
    }
}

Use this signal if the event has parameters of unsupported data types. Otherwise, connect directly to the signal name.

[virtual] QAxBase::~QAxBase()

Shuts down the COM object and destroys the QAxBase object.

See also clear().

QVariant QAxBase::asVariant() const

Returns a QVariant that wraps the COM object. The variant can then be used as a parameter in e.g. dynamicCall().

unsigned long QAxBase::classContext() const

Returns the context the ActiveX control will run in (default CLSCTX_SERVER).

This function was introduced in Qt 5.13.

See also setClassContext().

[virtual] void QAxBase::clear()

Disconnects and destroys the COM object.

If you reimplement this function you must also reimplement the destructor to call clear(), and call this implementation at the end of your clear() function.

void QAxBase::disableClassInfo()

Disables the class info generation for this ActiveX container. If you don't require any class information about the ActiveX control use this function to speed up the meta object generation.

Note that this function must be called immediately after construction of the object

void QAxBase::disableEventSink()

Disables the event sink implementation for this ActiveX container. If you don't intend to listen to the ActiveX control's events use this function to speed up the meta object generation.

Some ActiveX controls might be unstable when connected to an event sink. To get OLE events you must use standard COM methods to register your own event sink. Use queryInterface() to get access to the raw COM object.

Note that this function should be called immediately after construction of the object.

void QAxBase::disableMetaObject()

Disables the meta object generation for this ActiveX container. This also disables the event sink and class info generation. If you don't intend to use the Qt meta object implementation call this function to speed up instantiation of the control. You will still be able to call the object through dynamicCall(), but signals, slots and properties will not be available with QObject APIs.

Some ActiveX controls might be unstable when used with OLE automation. Use standard COM methods to use those controls through the COM interfaces provided by queryInterface().

Note that this function must be called immediately after construction of the object.

QVariant QAxBase::dynamicCall(const char *function, const QVariant &var1 = QVariant(), const QVariant &var2 = QVariant(), const QVariant &var3 = QVariant(), const QVariant &var4 = QVariant(), const QVariant &var5 = QVariant(), const QVariant &var6 = QVariant(), const QVariant &var7 = QVariant(), const QVariant &var8 = QVariant())

Calls the COM object's method function, passing the parameters var1, var1, var2, var3, var4, var5, var6, var7 and var8, and returns the value returned by the method, or an invalid QVariant if the method does not return a value or when the function call failed.

If function is a method of the object the string must be provided as the full prototype, for example as it would be written in a QObject::connect() call.

activeX->dynamicCall("Navigate(const QString&)", "www.qt-project.org");

Alternatively a function can be called passing the parameters embedded in the string, e.g. above function can also be invoked using

activeX->dynamicCall("Navigate(\"www.qt-project.org\")");

All parameters are passed as strings; it depends on the control whether they are interpreted correctly, and is slower than using the prototype with correctly typed parameters.

If function is a property the string has to be the name of the property. The property setter is called when var1 is a valid QVariant, otherwise the getter is called.

activeX->dynamicCall("Value", 5);
QString text = activeX->dynamicCall("Text").toString();

Note that it is faster to get and set properties using QObject::property() and QObject::setProperty().

dynamicCall() can also be used to call objects with a disabled metaobject wrapper, which can improve performance significantely, esp. when calling many different objects of different types during an automation process. ActiveQt will then however not validate parameters.

It is only possible to call functions through dynamicCall() that have parameters or return values of datatypes supported by QVariant. See the QAxBase class documentation for a list of supported and unsupported datatypes. If you want to call functions that have unsupported datatypes in the parameter list, use queryInterface() to retrieve the appropriate COM interface, and use the function directly.

IWebBrowser2 *webBrowser = 0;
activeX->queryInterface(IID_IWebBrowser2, (void **)&webBrowser);
if (webBrowser) {
    webBrowser->Navigate2(pvarURL);
    webBrowser->Release();
}

This is also more efficient.

QVariant QAxBase::dynamicCall(const char *function, QList<QVariant> &vars)

This is an overloaded function.

Calls the COM object's method function, passing the parameters in vars, and returns the value returned by the method. If the method does not return a value or when the function call failed this function returns an invalid QVariant object.

The QVariant objects in vars are updated when the method has out-parameters.

QString QAxBase::generateDocumentation()

Returns a rich text string with documentation for the wrapped COM object. Dump the string to an HTML-file, or use it in e.g. a QTextBrowser widget.

[virtual protected] bool QAxBase::initialize(IUnknown **ptr)

This virtual function is called by setControl() and creates the requested COM object. ptr is set to the object's IUnknown implementation. The function returns true if the object initialization succeeded; otherwise the function returns false.

The default implementation interprets the string returned by control(), and calls initializeRemote(), initializeLicensed() or initializeActive() if the string matches the respective patterns. If control() is the name of an existing file, initializeFromFile() is called. If no pattern is matched, or if remote or licensed initialization fails, CoCreateInstance is used directly to create the object.

See the control property documentation for details about supported patterns.

The interface returned in ptr must be referenced exactly once when this function returns. The interface provided by e.g. CoCreateInstance is already referenced, and there is no need to reference it again.

[protected] bool QAxBase::initializeActive(IUnknown **ptr)

Connects to an active instance running on the current machine, and returns the IUnknown interface to the running object in ptr. This function returns true if successful, otherwise returns false.

This function is called by initialize() if the control string contains the substring "}&".

See also initialize().

[protected] bool QAxBase::initializeFromFile(IUnknown **ptr)

Creates the COM object handling the filename in the control property, and returns the IUnknown interface to the object in ptr. This function returns true if successful, otherwise returns false.

This function is called by initialize() if the control string is the name of an existing file.

See also initialize().

[protected] bool QAxBase::initializeLicensed(IUnknown **ptr)

Creates an instance of a licensed control, and returns the IUnknown interface to the object in ptr. This functions returns true if successful, otherwise returns false.

This function is called by initialize() if the control string contains the substring "}:". The license key needs to follow this substring.

See also initialize().

[protected] bool QAxBase::initializeRemote(IUnknown **ptr)

Creates the instance on a remote server, and returns the IUnknown interface to the object in ptr. This function returns true if successful, otherwise returns false.

This function is called by initialize() if the control string contains the substring "/{". The information about the remote machine needs to be provided in front of the substring.

See also initialize().

bool QAxBase::isNull() const

Returns true if there is no COM object loaded by this wrapper; otherwise return false.

See also control.

QAxBase::PropertyBag QAxBase::propertyBag() const

Returns a name:value map of all the properties exposed by the COM object.

This is more efficient than getting multiple properties individually if the COM object supports property bags.

Warning: It is not guaranteed that the property bag implementation of the COM object returns all properties, or that the properties returned are the same as those available through the IDispatch interface.

See also setPropertyBag().

[virtual] bool QAxBase::propertyWritable(const char *prop) const

Returns true if the property prop is writable; otherwise returns false. By default, all properties are writable.

Warning: Depending on the control implementation this setting might be ignored for some properties.

See also setPropertyWritable() and propertyChanged().

long QAxBase::queryInterface(const QUuid &uuid, void **iface) const

Requests the interface uuid from the COM object and sets the value of iface to the provided interface, or to 0 if the requested interface could not be provided.

Returns the result of the QueryInterface implementation of the COM object.

See also control.

QAxObject *QAxBase::querySubObject(const char *name, const QVariant &var1 = QVariant(), const QVariant &var2 = QVariant(), const QVariant &var3 = QVariant(), const QVariant &var4 = QVariant(), const QVariant &var5 = QVariant(), const QVariant &var6 = QVariant(), const QVariant &var7 = QVariant(), const QVariant &var8 = QVariant())

Returns a pointer to a QAxObject wrapping the COM object provided by the method or property name, passing passing the parameters var1, var1, var2, var3, var4, var5, var6, var7 and var8.

If name is provided by a method the string must include the full function prototype.

If name is a property the string must be the name of the property, and var1, ... var8 are ignored.

The returned QAxObject is a child of this object (which is either of type QAxObject or QAxWidget), and is deleted when this object is deleted. It is however safe to delete the returned object yourself, and you should do so when you iterate over lists of subobjects.

COM enabled applications usually have an object model publishing certain elements of the application as dispatch interfaces. Use this method to navigate the hierarchy of the object model, e.g.

QAxWidget outlook("Outlook.Application");
QAxObject *session = outlook.querySubObject("Session");
if (session) {
    QAxObject *defFolder = session->querySubObject(
                            "GetDefaultFolder(OlDefaultFolders)",
                            "olFolderContacts");
    //...
}

QAxObject *QAxBase::querySubObject(const char *name, QList<QVariant> &vars)

This is an overloaded function.

The QVariant objects in vars are updated when the method has out-parameters.

void QAxBase::setClassContext(unsigned long classContext)

Sets the context the ActiveX control will run in to classContext

Affects the "dwClsContext" argument when calling CoCreateInstance. This can be used to control in-proc vs. out-of-proc startup for controls supporting both alternatives. Also, it can be used to modify/reduce control permissions when used with CLSCTX_ENABLE_CLOAKING and an impersonation token.

Note that this function must be called before setControl() to have any effect.

This function was introduced in Qt 5.13.

See also classContext().

void QAxBase::setPropertyBag(const QAxBase::PropertyBag &bag)

Sets the properties of the COM object to the corresponding values in bag.

Warning: You should only set property bags that have been returned by the propertyBag function, as it cannot be guaranteed that the property bag implementation of the COM object supports the same properties that are available through the IDispatch interface.

See also propertyBag().

[virtual] void QAxBase::setPropertyWritable(const char *prop, bool ok)

Sets the property prop to writable if ok is true, otherwise sets prop to be read-only. By default, all properties are writable.

Warning: Depending on the control implementation this setting might be ignored for some properties.

See also propertyWritable() and propertyChanged().

QStringList QAxBase::verbs() const

Returns the list of verbs that the COM object can execute. If the object does not implement IOleObject, or does not support any verbs, then this function returns an empty stringlist.

Note that the OLE default verbs (OLEIVERB_SHOW etc) are not included in the list.

This function was introduced in Qt 4.1.