QScriptExtensionPlugin Class

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

头文件: #include <QScriptExtensionPlugin>
qmake: QT += script
开始支持版本: Qt 4.3
基类: QObject and QScriptExtensionInterface

公有函数

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

重新实现的公有函数

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

其他继承的成员

  • 1 个属性继承自 QObject
  • 1 个公有槽函数继承自 QObject
  • 2 个信号继承自 QObject
  • 1 个公有变量继承自 QObject
  • 10 个静态公有成员继承自 QObject
  • 9 个受保护的函数继承自 QObject
  • 2 个受保护的变量继承自 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 class.

Writing a script extension plugin is achieved by subclassing this base class, reimplementing the pure virtual keys() and initialize() functions, and exporting the class using the Q_PLUGIN_METADATA() macro. See How to Create Qt Plugins for details.

参见 QScriptEngine::importExtension() and Creating Qt Script Extensions.

成员函数

QScriptExtensionPlugin::QScriptExtensionPlugin(QObject *parent = Q_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 in the given 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.

参见 initialize().