QAxFactory 类

QAxFactory 类定义用于创建 COM 组件的工厂。更多...

头：	#include <QAxFactory>
CMake:	find_package(Qt6 REQUIRED COMPONENTS AxServer) target_link_libraries(mytarget PRIVATE Qt6::AxServer)
qmake:	QT += axserver
继承：	QObject

公共类型

enum	ServerType { SingleInstance, MultipleInstances }

公共函数

	QAxFactory (const QUuid & libid , const QUuid & appid )
virtual	~QAxFactory () override
virtual QUuid	appID () const
virtual QUuid	classID (const QString & key ) const
virtual QObject *	createObject (const QString & key ) = 0
virtual bool	createObjectWrapper (QObject * object , IDispatch ** wrapper )
virtual QUuid	eventsID (const QString & key ) const
virtual QString	exposeToSuperClass (const QString & key ) const
virtual QStringList	featureList () const = 0
virtual bool	hasStockEvents (const QString & key ) const
virtual QUuid	interfaceID (const QString & key ) const
virtual bool	isService () const
virtual const QMetaObject *	metaObject (const QString & key ) const = 0
virtual void	registerClass (const QString & key , QSettings * settings ) const
virtual bool	stayTopLevel (const QString & key ) const
virtual QUuid	typeLibID () const
virtual void	unregisterClass (const QString & key , QSettings * settings ) const
virtual bool	validateLicenseKey (const QString & key , const QString & licenseKey ) const

静态公共成员

bool	isServer ()
bool	registerActiveObject (QObject * object )
QString	serverDirPath ()
QString	serverFilePath ()
bool	startServer (QAxFactory::ServerType type = MultipleInstances)
bool	stopServer ()

宏

	QAXCLASS ( Class )
	QAXFACTORY_BEGIN ( IDTypeLib , IDApp )
	QAXFACTORY_END
	QAXFACTORY_EXPORT ( Class , LibID , AppID )
	QAXTYPE ( Class )

详细描述

Implement this factory once in your COM server to provide information about the components the server can create. Subclass QAxFactory and implement the pure virtual functions in any implementation file (e.g. main.cpp), and export the factory using the 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() macro to provide the unique identifiers or other attributes for your class you can use the QAXFACTORY_BEGIN() , QAXCLASS() and QAXFACTORY_END() macros to expose one or more classes as COM objects.

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

Only one QAxFactory implementation may be instantiated and exported by an ActiveX server application. This instance is accessible through the global qAxFactory() function.

A factory can also reimplement the registerClass () 和 unregisterClass () functions to set additional flags for an ActiveX control in the registry. To limit the number of methods or properties a widget class exposes from its parent classes reimplement exposeToSuperClass ().

另请参阅 QAxAggregated , QAxBindable ，和 ActiveQt 框架 .

成员类型文档编制

enum QAxFactory:: ServerType

This enum specifies the different types of servers that can be started with startServer .

常量	值	描述
`QAxFactory::SingleInstance`	`0`	The server process can create only one instance of each exported class. COM starts a new process for each request. This is typically used in servers that export only one creatable class.
`QAxFactory::MultipleInstances`	`1`	The server can create multiple instances of each exported class. This is the default. All instances will live in the same thread, and will share static resources.

成员函数文档编制

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

Constructs a QAxFactory object that returns libid and appid 在各自接口函数的实现中。

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

销毁 QAxFactory 对象。

`[虚拟]` QUuid QAxFactory:: appID () const

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

`[虚拟]` 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* )

重实现此函数以返回新对象为 key ，或 0 若此工厂不支持值对于 key .

若返回对象是 QWidget 它会被暴露成 ActiveX 控件，否则返回对象将被暴露成简单 COM 对象。

`[虚拟]` 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 .

`[虚拟]` 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".

`[虚拟]` 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.

`[虚拟]` bool QAxFactory:: hasStockEvents (const QString & key ) const

重实现此函数以返回 true 若 ActiveX 控件 key 应支持标准 ActiveX 事件

点击
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.

`[虚拟]` 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();
}

`[虚拟]` 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.

默认实现返回 false。

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

重实现此函数以返回 QMetaObject 对应 key ，或 0 若此工厂不支持值对于 key .

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

注册 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.

`[虚拟]` 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.

另请参阅 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 ()

返回服务器二进制的文件路径。

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 设为 MultipleInstances if the server executable has been started with the -activex command line parameter. To switch to SingleInstance ，调用

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

in your own main() entry point function.

`[虚拟]` bool QAxFactory:: stayTopLevel (const QString & key ) const

重实现此函数以返回 true 若 ActiveX 控件 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.

`[虚拟]` QUuid QAxFactory:: typeLibID () const

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

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

Unregisters any additional values for the class key from the system registry using the settings 对象。

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

另请参阅 registerClass () 和 QSettings .

`[虚拟]` bool QAxFactory:: validateLicenseKey (const QString & key , const QString & licenseKey ) const

重实现此函数以返回 true 若 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.

宏文档编制

QAXCLASS ( Class )

此宏添加可创建 COM 类 Class 到 QAxFactory 声明采用 QAXFACTORY_BEGIN () 宏。

另请参阅 QAXFACTORY_BEGIN (), QAXTYPE (), QAXFACTORY_END ()，和 Q_CLASSINFO ().

QAXFACTORY_BEGIN ( IDTypeLib , IDApp )

此宏可以用于导出多个 QObject 类透过隐式声明 QAxFactory 实现。所有 QObject 类必须声明 ClassID、InterfaceID 和 EventsID (若适用) 透过 Q_CLASSINFO () 宏。类型库中的所有声明将具有 ID IDTypeLib ，且若服务器是可执行服务器那么它将拥有应用程序 ID IDApp .

需要一起使用此宏同 QAXCLASS (), QAXTYPE () 和 QAXFACTORY_END () 宏。

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

QAXFACTORY_END

完成 QAxFactory 声明开始采用 QAXFACTORY_BEGIN () 宏。

另请参阅 QAXFACTORY_BEGIN (), QAXCLASS ()，和 QAXTYPE ().

QAXFACTORY_EXPORT ( Class , LibID , AppID )

此宏可以用于导出 QAxFactory 实现 Class 从 COM 服务器。类型库中的所有声明将具有 ID LibID ，且若服务器是可执行服务器那么它将拥有应用程序 ID AppID .

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

另请参阅 QAXFACTORY_BEGIN ().

QAXTYPE ( Class )

此宏添加不可创建 COM 类 Class 到 QAxFactory 声明采用 QAXFACTORY_BEGIN ()。类 Class can be used in APIs of other COM classes exported through QAXTYPE() or QAXCLASS ().

实例化的类型 Class can only be retrieved using APIs of already instantiated objects.

另请参阅 QAXFACTORY_BEGIN (), QAXCLASS (), QAXFACTORY_END ()，和 Q_CLASSINFO ().

QAxFactory 类

公共类型

公共函数

静态公共成员

宏

详细描述

成员类型文档编制

enum QAxFactory:: ServerType

成员函数文档编制

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

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

[虚拟] QUuid QAxFactory:: appID () const

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

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

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

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

[虚拟] QString QAxFactory:: exposeToSuperClass (const QString & key ) const

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

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

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

[static] bool QAxFactory:: isServer ()

[虚拟] bool QAxFactory:: isService () const

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

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

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

[static] QString QAxFactory:: serverDirPath ()

[static] QString QAxFactory:: serverFilePath ()

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

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

[static] bool QAxFactory:: stopServer ()

[虚拟] QUuid QAxFactory:: typeLibID () const

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

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