QAxFactory Class

Member Function Documentation

QAxFactory::QAxFactory(const QUuid &libid, const QUuid &appid)

Constructs a QAxFactory object that returns libid and appid in the implementation of the respective interface functions.

[override virtual noexcept] QAxFactory::~QAxFactory()

Destroys the QAxFactory object.

[virtual] QUuid QAxFactory::appID() const

Reimplement this function to return the ActiveX server's application identifier.

[virtual] QUuid QAxFactory::classID(const QString &key) const

Reimplement this function to return the class identifier for each key returned by the featureList() implementation, or an empty QUuid if this factory doesn't support the value of key.

The default implementation interprets key as the class name, and returns the value of the Q_CLASSINFO() entry "ClassID".

[pure virtual] QObject *QAxFactory::createObject(const QString &key)

Reimplement this function to return a new object for key, or 0 if this factory doesn't support the value of key.

If the object returned is a QWidget it will be exposed as an ActiveX control, otherwise the returned object will be exposed as a simple COM object.

[virtual] bool QAxFactory::createObjectWrapper(QObject *object, IDispatch **wrapper)

Reimplement this function to provide the COM object for object in wrapper. Return true if the function was successful; otherwise return false.

The default implementation creates a generic automation wrapper based on the meta object information of object.

[virtual] QUuid QAxFactory::eventsID(const QString &key) const

Reimplement this function to return the identifier of the event interface for each key returned by the featureList() implementation, or an empty QUuid if this factory doesn't support the value of key.

The default implementation interprets key as the class name, and returns the value of the Q_CLASSINFO() entry "EventsID".

[virtual] QString QAxFactory::exposeToSuperClass(const QString &key) const

Reimplement this function to return the name of the super class of key up to which methods and properties should be exposed by the ActiveX control.

The default implementation interprets key as the class name, and returns the value of the Q_CLASSINFO() entry "ToSuperClass". If no such value is set the null-string is returned, and the functions and properties of all the super classes including QWidget will be exposed.

To only expose the functions and properties of the class itself, reimplement this function to return key.

[pure virtual] QStringList QAxFactory::featureList() const

Reimplement this function to return a list of the widgets (class names) supported by this factory.

[virtual] bool QAxFactory::hasStockEvents(const QString &key) const

Reimplement this function to return true if the ActiveX control key should support the standard ActiveX events

• Click
• DblClick
• KeyDown
• KeyPress
• KeyUp
• MouseDown
• MouseUp
• MouseMove

The default implementation interprets key as the class name, and returns true if the value of the Q_CLASSINFO() entry "StockEvents" is "yes". Otherwise this function returns false.

[virtual] QUuid QAxFactory::interfaceID(const QString &key) const

Reimplement this function to return the interface identifier for each key returned by the featureList() implementation, or an empty QUuid if this factory doesn't support the value of key.

The default implementation interprets key as the class name, and returns the value of the Q_CLASSINFO() entry "InterfaceID".

[static] bool QAxFactory::isServer()

Returns true if the application has been started (by COM) as an ActiveX server, otherwise returns false.

int main(int argc, char *argv[])
{
    QApplication app(argc, argv);
    if (!QAxFactory::isServer()) {
        // initialize for stand-alone execution
    }
    return app.exec();
}

[virtual] bool QAxFactory::isService() const

Reimplement this function to return true if the server is running as a persistent service (e.g. an NT service) and should not terminate even when all objects provided have been released.

The default implementation returns false.

[pure virtual] const QMetaObject *QAxFactory::metaObject(const QString &key) const

Reimplement this function to return the QMetaObject corresponding to key, or 0 if this factory doesn't support the value of key.

[static] bool QAxFactory::registerActiveObject(QObject *object)

Registers the QObject object with COM as a running object, and returns true if the registration succeeded, otherwise returns false. The object is unregistered automatically when it is destroyed.

This function should only be called if the application has been started by the user (i.e. not by COM to respond to a request), and only for one object, usually the toplevel object of the application's object hierarchy.

This function does nothing and returns false if the object's class info for "RegisterObject" is not set to "yes", or if the server is an in-process server.

[virtual] void QAxFactory::registerClass(const QString &key, QSettings *settings) const

Registers additional values for the class key in the system registry using the settings object. The standard values have already been registered by the framework, but additional values, e.g. implemented categories, can be added in an implementation of this function.

settings->setValue("/CLSID/" + classID(key)
                   + "/Implemented Categories/"
                   + "/{00000000-0000-0000-000000000000}/.",
                   QString());

If you reimplement this function you must also reimplement unregisterClass() to remove the additional registry values.

See also QSettings.

[static] QString QAxFactory::serverDirPath()

Returns the directory that contains the server binary.

For out-of-process servers this is the same as QCoreApplication::applicationDirPath(). For in-process servers that function returns the directory that contains the hosting application.

[static] QString QAxFactory::serverFilePath()

Returns the file path of the server binary.

For out-of-process servers this is the same as QCoreApplication::applicationFilePath(). For in-process servers that function returns the file path of the hosting application.

[static] bool QAxFactory::startServer(QAxFactory::ServerType type = MultipleInstances)

Starts the COM server with type and returns true if successful, otherwise returns false.

Calling this function if the server is already running (or for an in-process server) does nothing and returns true.

The server is started automatically with type set to MultipleInstances if the server executable has been started with the -activex command line parameter. To switch to SingleInstance, call

if (QAxFactory::isServer()) {
    QAxFactory::stopServer();
    QAxFactory::startServer(QAxFactory::SingleInstance);
}

in your own main() entry point function.

[virtual] bool QAxFactory::stayTopLevel(const QString &key) const

Reimplement this function to return true if the ActiveX control key should be a top level window, e.g. a dialog. The default implementation returns false.

[static] bool QAxFactory::stopServer()

Stops the COM server and returns true if successful, otherwise returns false.

Calling this function if the server is not running (or for an in-process server) does nothing and returns true.

Stopping the server will not invalidate existing objects, but no new objects can be created from the existing server process. Usually COM will start a new server process if additional objects are requested.

The server is stopped automatically when the main() function returns.

[virtual] QUuid QAxFactory::typeLibID() const

Reimplement this function to return the ActiveX server's type library identifier.

[virtual] void QAxFactory::unregisterClass(const QString &key, QSettings *settings) const

Unregisters any additional values for the class key from the system registry using the settings object.

settings->remove("/CLSID/" + classID(key)
                 + "/Implemented Categories"
                 + "/{00000000-0000-0000-000000000000}/.");

See also registerClass() and QSettings.

[virtual] bool QAxFactory::validateLicenseKey(const QString &key, const QString &licenseKey) const

Reimplement this function to return true if licenseKey is a valid license for the class key, or if the current machine is licensed.

The default implementation returns true if the class key is not licensed (ie. no Q_CLASSINFO() attribute "LicenseKey"), or if licenseKey matches the value of the "LicenseKey" attribute, or if the machine is licensed through a .LIC file with the same filename as this COM server.