Visindigo::General::PluginModule Class
class Visindigo::General::PluginModule此类为Yayin Story Studio 提供插件模块基类. 详情...
| 头文件： | #include <General/PluginModule.h> |
| 自以下版本： | Visindigo 0.13.0 |
| 被继承： | Visindigo::General::CommandHandler, Visindigo::General::PlaceholderProvider, Visindigo::General::Translator, YSSCore::Editor::DebugServer, YSSCore::Editor::FileServer, YSSCore::Editor::FileTemplateProvider, and YSSCore::Editor::LangServer |
- 所有成员列表（包含继承成员）
- PluginModule 是该集合的一部分：VIPlugin插件系统子模块.
公开成员函数
(自 Visindigo 0.13.0 引入) | PluginModule(Visindigo::General::Plugin *parent, const QString &moduleID, const QString &typeID = VIModuleType_Unknown, const QString &moduleName = QString()) |
(自 Visindigo 0.13.0 引入) virtual | ~PluginModule() |
(自 Visindigo 0.13.0 引入) QString | getModuleID() const |
(自 Visindigo 0.13.0 引入) QString | getModuleName() const |
(自 Visindigo 0.15.0 引入) QString | getModuleNameI18N() const |
(自 Visindigo 0.13.0 引入) QString | getModuleTypeID() const |
(自 Visindigo 0.13.0 引入) Visindigo::General::Plugin * | getPlugin() const |
(自 Visindigo 0.13.0 引入) virtual void | onModuleDisable() |
(自 Visindigo 0.13.0 引入) virtual void | onModuleEnable() |
相关的非成员内容
(自 Visindigo 0.13.0 引入) | PackageModule |
详细说明
PluginModule是插件模块的基类，所有插件模块都需要继承此类。
插件模块是插件的组成部分，提供了插件的具体功能实现。每个插件模块都属于一个插件。
moduleID是插件模块在当前插件内的唯一标识符，用于区分同一插件内的不同模块。 typeID是插件模块的类型标识符，用于区分不同类型的模块。
moduleID在插件内必须唯一，但不同插件之间则可重复，因此moduleID应该尽量短， 并建议只用小写下划线命名法，以提高可读性和易用性。而typeID则需要在整个应用程序 内保持唯一，因此建议使用带有域名限定的命名方式，如"cn.yxgeneral.visindigo.placeholder_provider"。
插件模块可以在被启用或禁用时执行特定的操作，以实现动态加载和卸载功能。
成员函数文档
[since Visindigo 0.13.0] PluginModule::PluginModule(Visindigo::General::Plugin *parent, const QString &moduleID, const QString &typeID = VIModuleType_Unknown, const QString &moduleName = QString())
parent 所属插件对象指针 moduleID 模块唯一标识符 typeID 模块类型标识符 moduleName 模块名称
构造函数，创建一个插件模块对象。
这个function 从 Visindigo 0.13.0 开始支持。
[virtual noexcept, since Visindigo 0.13.0] PluginModule::~PluginModule()
析构函数。
这个function 从 Visindigo 0.13.0 开始支持。
[since Visindigo 0.13.0] QString PluginModule::getModuleID() const
return 模块唯一标识符。
这个function 从 Visindigo 0.13.0 开始支持。
[since Visindigo 0.13.0] QString PluginModule::getModuleName() const
return 模块名称。
这个function 从 Visindigo 0.13.0 开始支持。
[since Visindigo 0.15.0] QString PluginModule::getModuleNameI18N() const
尝试实用VI18N宏处理模块名称的国际化版本，如果处理失败，则返回原始模块名称。
这个function 从 Visindigo 0.15.0 开始支持。
[since Visindigo 0.13.0] QString PluginModule::getModuleTypeID() const
return 模块类型标识符。
这个function 从 Visindigo 0.13.0 开始支持。
[since Visindigo 0.13.0] Visindigo::General::Plugin *PluginModule::getPlugin() const
return 所属插件对象指针。
这个function 从 Visindigo 0.13.0 开始支持。
[virtual, since Visindigo 0.13.0] void PluginModule::onModuleDisable()
模块被禁用时调用的函数。
默认实现为空函数，子类可重载此函数以实现自定义行为。
这个function 从 Visindigo 0.13.0 开始支持。
[virtual, since Visindigo 0.13.0] void PluginModule::onModuleEnable()
模块被启用时调用的函数。
默认实现为空函数，子类可重载此函数以实现自定义行为。
这个function 从 Visindigo 0.13.0 开始支持。
相关的非成员内容
[alias, since Visindigo 0.13.0] PackageModule
作为Visindigo::General::PluginModule类的别名，方便用户将其称为“应用程序包模块”。
这个typedef 从 Visindigo 0.13.0 开始支持。