Класс QAxFactory

Класс QAxFactory определяет фабрику для создания компонентов COM. Подробнее...

• Список всех членов, включая унаследованные

Открытые типы

Открытые функции

• 31 открытых функций, унаследованных от QObject

Статические открытые члены

• 11 статических открытых членов, унаследованных от QObject

Макросы

Дополнительные унаследованные члены

• 1 свойство, унаследованное от QObject
• 1 открытый слот, унаследованный от QObject
• 2 сигнала, унаследованные от QObject
• 9 защищенных функций, унаследованных от QObject

Подробное описание

Класс QAxFactory определяет фабрику для создания компонентов COM.

Реализуйте эту фабрику один раз в вашем сервере COM, чтобы предоставить информацию о компонентах, которые сервер может создать. Подклассируйте QAxFactory и реализуйте чистые виртуальные функции в любом файле реализации (например, main.cpp), и экспортируйте фабрику, используя макрос QAXFACTORY_EXPORT().

QStringList ActiveQtFactory::featureList() const
{
    QStringList list;
    list << "ActiveX1";
    list << "ActiveX2";
    return list;
}

QObject *ActiveQtFactory::createObject(const QString &key)
{
    if (key == "ActiveX1")
        return new ActiveX1(parent);
    if (key == "ActiveX2")
        return new ActiveX2(parent);
    return 0;
}

const QMetaObject *ActiveQtFactory::metaObject(const QString &key) const
{
    if (key == "ActiveX1")
        return &ActiveX1::staticMetaObject;
    if (key == "ActiveX2")
        return &ActiveX2::staticMetaObject;
}

QUuid ActiveQtFactory::classID(const QString &key) const
{
    if (key == "ActiveX1")
        return "{01234567-89AB-CDEF-0123-456789ABCDEF}";
    ...
    return QUuid();
}

QUuid ActiveQtFactory::interfaceID(const QString &key) const
{
    if (key == "ActiveX1")
        return "{01234567-89AB-CDEF-0123-456789ABCDEF}";
    ...
    return QUuid();
}

QUuid ActiveQtFactory::eventsID(const QString &key) const
{
    if (key == "ActiveX1")
        return "{01234567-89AB-CDEF-0123-456789ABCDEF}";
    ...
    return QUuid();
}

QAXFACTORY_EXPORT(
    ActiveQtFactory,                          // factory class
    "{01234567-89AB-CDEF-0123-456789ABCDEF}", // type library ID
    "{01234567-89AB-CDEF-0123-456789ABCDEF}"  // application ID
)

Если вы используете макрос Q_CLASSINFO() для предоставления уникальных идентификаторов или других атрибутов для вашего класса, вы можете использовать макросы QAXFACTORY_BEGIN(), QAXCLASS() и QAXFACTORY_END() для экспонирования одного или нескольких классов как объектов COM.

QAXFACTORY_BEGIN(
    "{01234567-89AB-CDEF-0123-456789ABCDEF}", // type library ID
    "{01234567-89AB-CDEF-0123-456789ABCDEF}"  // application ID
)
    QAXCLASS(Class1)
    QAXCLASS(Class2)
QAXFACTORY_END()

Если ваш сервер поддерживает только один объект COM, вы можете использовать реализацию по умолчанию для фабрики через макрос QAXFACTORY_DEFAULT().

#include <qapplication.h>
#include <qaxfactory.h>

#include "theactivex.h"

QAXFACTORY_DEFAULT(
    TheActiveX,                               // widget class
    "{01234567-89AB-CDEF-0123-456789ABCDEF}", // class ID
    "{01234567-89AB-CDEF-0123-456789ABCDEF}", // interface ID
    "{01234567-89AB-CDEF-0123-456789ABCDEF}", // event interface ID
    "{01234567-89AB-CDEF-0123-456789ABCDEF}", // type library ID
    "{01234567-89AB-CDEF-0123-456789ABCDEF}"  // application ID
)

Только одна реализация QAxFactory может быть инстанцирована и экспортирована приложением сервера ActiveX. Этот экземпляр доступен через глобальную функцию qAxFactory().

Фабрика также может переопределить функции registerClass() и unregisterClass(), чтобы установить дополнительные флаги для ActiveX-контроля в реестре. Чтобы ограничить количество методов или свойств, которые класс виджета экспонирует от своих родительских классов, переопределите exposeToSuperClass().

См. также QAxAggregated, QAxBindable и Фреймворк ActiveQt.

Документация по типам членов

перечисление QAxFactory::ServerType

Это перечисление определяет разные типы серверов, которые можно запустить с помощью startServer.

Документация по функциям членов

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

Конструирует объект QAxFactory, который возвращает libid и appid в реализации соответствующих функций интерфейса.

[virtual] QAxFactory::~QAxFactory()

Уничтожает объект QAxFactory.

[virtual] QUuid QAxFactory::appID() const

Переопределите эту функцию, чтобы вернуть идентификатор приложения сервера ActiveX.

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

Переопределите эту функцию, чтобы вернуть идентификатор класса для каждого key, возвращаемого реализацией featureList(), или пустой QUuid, если этот фабрика не поддерживает значение key.

По умолчанию эта реализация интерпретирует key как имя класса и возвращает значение записи Q_CLASSINFO() "ClassID".

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

Переопределите эту функцию, чтобы вернуть новый объект для key, или 0, если эта фабрика не поддерживает значение key.

Если возвращаемый объект является QWidget, он будет представлен как ActiveX-контроль, в противном случае возвращаемый объект будет представлен как обычный COM-объект.

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

Переопределите эту функцию, чтобы предоставить COM-объект для object в wrapper. Верните true, если функция выполнилась успешно; в противном случае верните false.

По умолчанию эта реализация создаёт оболочку автоматизации на основе метаобъектной информации object.

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

Переопределите эту функцию, чтобы вернуть идентификатор интерфейса события для каждого key, возвращаемого реализацией featureList(), или пустой QUuid, если эта фабрика не поддерживает значение key.

По умолчанию эта реализация интерпретирует key как имя класса и возвращает значение записи Q_CLASSINFO() "EventsID".

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

Переопределите эту функцию, чтобы вернуть имя суперкласса key, до которого должны быть экспонированы методы и свойства ActiveX-контролем.

По умолчанию эта реализация интерпретирует key как имя класса и возвращает значение записи Q_CLASSINFO() "ToSuperClass". Если такого значения нет, возвращается пустая строка, и функции и свойства всех суперклассов, включая QWidget, будут экспонированы.

Чтобы экспонировать только функции и свойства самого класса, переопределите эту функцию, чтобы вернуть key.

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

Переопределите эту функцию, чтобы вернуть список виджетов (имён классов), поддерживаемых этой фабрикой.

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

Переопределите эту функцию, чтобы вернуть true, если ActiveX-контроль key должен поддерживать стандартные события ActiveX

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

По умолчанию эта реализация интерпретирует key как имя класса и возвращает true, если значение записи Q_CLASSINFO() "StockEvents" равно "yes". В противном случае функция возвращает false.

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

Переопределите эту функцию, чтобы вернуть идентификатор интерфейса для каждого key, возвращаемого реализацией featureList(), или пустой QUuid, если эта фабрика не поддерживает значение key.

По умолчанию эта реализация интерпретирует key как имя класса и возвращает значение записи Q_CLASSINFO() "InterfaceID".

[static] bool QAxFactory::isServer()

Возвращает true, если приложение было запущено (COM) как ActiveX-сервер, в противном случае возвращает 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

Переопределите эту функцию, чтобы вернуть true, если сервер работает как постоянная служба (например, служба NT) и не должен завершаться, даже когда все предоставленные объекты были освобождены.

По умолчанию эта реализация возвращает false.

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

Переопределите эту функцию, чтобы вернуть QMetaObject, соответствующий key, или 0, если эта фабрика не поддерживает значение key.

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

Регистрирует QObject object в COM как работающий объект и возвращает true, если регистрация прошла успешно, в противном случае возвращает false. Объект автоматически аннулируется при уничтожении.

Эта функция должна вызываться только в том случае, если приложение запущено пользователем (т.е. не COM для ответа на запрос) и только для одного объекта, обычно для верхнего объекта иерархии объектов приложения.

Эта функция ничего не делает и возвращает false, если информация о классе объекта для "RegisterObject" не установлена в "yes", или если сервер является сервером внутри процесса.

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

Регистрирует дополнительные значения для класса key в системном реестре с использованием объекта settings. Стандартные значения уже зарегистрированы фреймворком, но дополнительные значения, например, реализованные категории, могут быть добавлены в реализации этой функции.

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

Если вы переопределяете эту функцию, вы должны также переопределить unregisterClass() для удаления дополнительных значений реестра.

См. такжеQSettings.

[static] QString QAxFactory::serverDirPath()

Возвращает директорию, содержащую двоичный файл сервера.

Для серверов вне процесса это то же, что и QCoreApplication::applicationDirPath(). Для серверов внутри процесса эта функция возвращает директорию, содержащую приложение-хост.

[static] QString QAxFactory::serverFilePath()

Возвращает путь к файлу двоичного файла сервера.

Для серверов вне процесса это то же, что и QCoreApplication::applicationFilePath(). Для серверов внутри процесса эта функция возвращает путь к файлу приложения-хоста.

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

Запускает COM-сервер с type и возвращает true, если успешно, в противном случае возвращает false.

Вызов этой функции, если сервер уже запущен (или для сервера внутри процесса), ничего не делает и возвращает true.

Сервер автоматически запускается с type, установленным в MultipleInstances, если исполняемый файл сервера был запущен с параметром командной строки -activex. Чтобы переключиться на SingleInstance, вызовите

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

в собственной функции main() точки входа.

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

Переопределите эту функцию, чтобы вернуть true, если ActiveX-контроль key должен быть окном верхнего уровня, например, диалоговым окном. По умолчанию реализация возвращает false.

[static] bool QAxFactory::stopServer()

Останавливает COM-сервер и возвращает true, если успешно, в противном случае возвращает false.

Вызов этой функции, если сервер не запущен (или для сервера внутри процесса), ничего не делает и возвращает true.

Остановка сервера не аннулирует существующие объекты, но новые объекты не могут быть созданы из существующего процесса сервера. Обычно COM запустит новый процесс сервера, если будут запрошены дополнительные объекты.

Сервер останавливается автоматически при возвращении функции main().

[virtual] QUuid QAxFactory::typeLibID() const

Переопределите эту функцию, чтобы вернуть идентификатор библиотеки типов ActiveX-сервера.

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

Удаляет любые дополнительные значения для класса key из системного реестра с использованием объекта settings.

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

См. такжеregisterClass() и QSettings.

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

Переопределите эту функцию, чтобы вернуть true, если licenseKey является допустимой лицензией для класса key, или если текущая машина лицензирована.

По умолчанию реализация возвращает true, если класс key не лицензирован (т. е. нет атрибута Q_CLASSINFO()"LicenseKey"), или если licenseKey совпадает со значением атрибута "LicenseKey", или если машина лицензирована через файл .LIC с таким же именем файла, как у этого COM-сервера.

QAXFACTORY_BEGIN(
    "{01234567-89AB-CDEF-0123-456789ABCDEF}", // type library ID
    "{01234567-89AB-CDEF-0123-456789ABCDEF}"  // application ID
)
    QAXCLASS(Class1)
    QAXCLASS(Class2)
QAXFACTORY_END()

#include <qaxfactory.h>

#include "theactivex.h"

QAXFACTORY_DEFAULT(
    TheActiveX,                               // widget class
    "{01234567-89AB-CDEF-0123-456789ABCDEF}", // class ID
    "{01234567-89AB-CDEF-0123-456789ABCDEF}", // interface ID
    "{01234567-89AB-CDEF-0123-456789ABCDEF}", // event interface ID
    "{01234567-89AB-CDEF-0123-456789ABCDEF}", // type library ID
    "{01234567-89AB-CDEF-0123-456789ABCDEF}"  // application ID
)

QAXFACTORY_EXPORT(
    MyFactory,                                // factory class
    "{01234567-89AB-CDEF-0123-456789ABCDEF}", // type library ID
    "{01234567-89AB-CDEF-0123-456789ABCDEF}"  // application ID
)