Yayin Story Studio logo Yayin Story Studio 项目文档
回到主页 用户手册

PluginModule Class

class Visindigo::General::PluginModule

此类为Yayin Story Studio 提供插件模块基类。 PluginModule是插件模块的基类,所有插件模块都需要继承此类。. 详情...

头文件: #include <General/PluginModule.h>
自以下版本: Visindigo 0.13.0
被继承:

YSSCore::Editor::FileServer

公开成员函数

PluginModule(const QString &moduleName, const QString &moduleID, Visindigo::General::Plugin *plugin = nullptr)
virtual ~PluginModule()
QString getModuleID() const
QString getModuleName() const
Visindigo::General::Plugin *getPlugin() const
virtual void onModuleDisable()
virtual void onModuleEnable()
void setPlugin(Visindigo::General::Plugin *plugin)
(自 Visindigo 0.13.0 引入) PackageModule

详细说明

成员函数文档

PluginModule::PluginModule(const QString &moduleName, const QString &moduleID, Visindigo::General::Plugin *plugin = nullptr)

moduleName 模块名称 moduleID 模块唯一标识符 plugin 所属插件对象指针

构造函数,创建一个插件模块对象。

[virtual noexcept] PluginModule::~PluginModule()

析构函数。

QString PluginModule::getModuleID() const

返回模块唯一标识符。

QString PluginModule::getModuleName() const

返回模块名称。

Visindigo::General::Plugin *PluginModule::getPlugin() const

返回所属插件对象指针。

[virtual] void PluginModule::onModuleDisable()

模块被禁用时调用的函数。

默认实现为空函数,子类可重载此函数以实现自定义行为。

[virtual] void PluginModule::onModuleEnable()

模块被启用时调用的函数。

默认实现为空函数,子类可重载此函数以实现自定义行为。

void PluginModule::setPlugin(Visindigo::General::Plugin *plugin)

plugin 所属插件对象指针。

设置所属插件对象。

相关的非成员内容

[alias, since Visindigo 0.13.0] PackageModule

作为Visindigo::General::PluginModule类的别名,方便用户将其称为“应用程序包模块”。

这个 typedef 从 Visindigo 0.13.0 开始支持。