QScriptExtensionPlugin Class

The QScriptExtensionPlugin class provides an abstract base for custom QScript extension plugins. 更多...

头：	#include <QScriptExtensionPlugin>
qmake:	QT += script
Since:	Qt 4.3
继承：	QObject and QScriptExtensionInterface

公共函数

	QScriptExtensionPlugin (QObject * parent = nullptr)
virtual	~QScriptExtensionPlugin ()
QScriptValue	setupPackage (const QString & key , QScriptEngine * engine ) const

重实现公共函数

virtual void	initialize (const QString & key , QScriptEngine * engine ) = 0
virtual QStringList	keys () const = 0

31 公共函数继承自 QObject

静态公共成员

const QMetaObject

staticMetaObject

9 静态公共成员继承自 QObject

额外继承成员

1 特性继承自 QObject
1 公共槽继承自 QObject
2 信号继承自 QObject
9 保护函数继承自 QObject

详细描述

The QScriptExtensionPlugin class provides an abstract base for custom QScript extension plugins.

QScriptExtensionPlugin is a plugin interface that makes it possible to offer extensions that can be loaded dynamically into applications using the QScriptEngine 类。

Writing a script extension plugin is achieved by subclassing this base class, reimplementing the pure virtual keys () 和 initialize () functions, and exporting the class using the Q_PLUGIN_METADATA () macro. See 如何创建 Qt 插件了解细节。

另请参阅 QScriptEngine::importExtension () 和 Creating Qt Script Extensions .

成员函数文档编制

QScriptExtensionPlugin:: QScriptExtensionPlugin ( QObject * parent = nullptr)

Constructs a script extension plugin with the given parent .

Note that this constructor is invoked automatically by the Q_PLUGIN_METADATA () macro, so there is no need for calling it explicitly.

`[虚拟]` QScriptExtensionPlugin:: ~QScriptExtensionPlugin ()

Destroys the script extension plugin.

Note that Qt destroys a plugin automatically when it is no longer used, so there is no need for calling the destructor explicitly.

`[pure virtual]` void QScriptExtensionPlugin:: initialize (const QString & key , QScriptEngine * engine )

Initializes the extension specified by key 以给定 engine . The key must come from the set of keys ().

另请参阅 keys ().

`[pure virtual]` QStringList QScriptExtensionPlugin:: keys () const

Returns the list of keys this plugin supports.

These keys are usually the names of the "modules" or "packages" that are implemented in the plugin (e.g. com.mycompany.MyProduct ).

另请参阅 initialize ().

QScriptValue QScriptExtensionPlugin:: setupPackage (const QString & key , QScriptEngine * engine ) const

This function is provided for convenience when reimplementing initialize (). It splits the given key on '.' (dot), and ensures that there's a corresponding path of objects in the environment of the given engine , creating new objects to complete the path if necessary. E.g. if the key is "com.trolltech", after the call to setupPackage() the script expression com.trolltech will evaluate to an object. More specifically, the engine's Global Object will have a property called "com", which in turn has a property called "trolltech".

Use this function to avoid global namespace pollution when installing your extensions in the engine.