Visindigo::General::Plugin Class

extern "C" YSSCore::Editor::Plugin* VisindigoPluginMain() {
        return new YourPluginClass();
}

{
        "ID": "YourPluginID",
        "Depend": [
                “PluginID1",
                “PluginID2"
        ]
}

成员函数文档

[since Visindigo 0.13.0] Plugin::Plugin(Visindigo::General::Version apiVersion = Compiled_VIAPI_Version, Visindigo::General::Version abiVersion = Compiled_VIABI_Version, QString extID = "Visindigo_Base", QObject *parent = nullptr)

apiVersion 插件的API版本 abiVersion 插件的ABI版本 extID 插件的扩展ID parent 插件的父对象

对于abiVersion，其已经在头文件中被默认填充为Compiled_YSSABI_Version，代表您的插件编译时Visindigo对应的ABI版本。

apiVersion和abiVersion拥有相同行为。它们都是用来确保插件与Visindigo之间的二进制接口兼容性的。Visindigo在加载插件时会检查 API和ABI版本，以确保插件能够正确地与当前运行的Visindigo版本进行交互。

插件的扩展ID，是提供给插件扩展开发者的一个标识符，用于确定该插件到底属于哪一类插件。

例如，如果您继承了Plugin并实现了一个Plugin的扩展（姑且称之为PluginV2），然后将PluginV2提供给他人继续开发， 则您的PluginV2的默认构造函数中，就可以将extID设置为"Visindigo_PluginV2"，以便后续开发者能够识别这是一个PluginV2类型的插件。

这已经有所实践。在Yayin Story Studio中，插件的extID即为"YayinStoryStudio"，标识这是一个继承了YSSCore::Editor::EditorPlugin 所实现的插件。

这个function 从 Visindigo 0.13.0 开始支持。

[virtual noexcept, since Visindigo 0.13.0] Plugin::~Plugin()

析构函数

这个function 从 Visindigo 0.13.0 开始支持。

[virtual, since Visindigo 0.13.0] QWidget *Plugin::getConfigWidget()

return 插件的配置界面，如果插件没有提供配置界面，则默认返回nullptr

关于此虚函数建议如下原则实现：

懒初始化您的插件配置页面，即在第一次有人调用此函数前， 不要创建您的插件配置页面，这有助于节省内存和提高性能。 与此同时，建议持久化存储该指针并在disable时再销毁它。 调用此函数以获取指针的调用方不会接管该指针的生命周期。

与此同时，不要对该函数调用时机和目的做任何特殊假定 （例如认为它只会在即将需要显示该页面前调用从而做一些 显示前的准备操作），这个函数很有可能在Visindigo检查 插件配置页面是否可用时或其他情况下被调用。如果您需要一些 展示前工作，请考虑重写或拦截该页面的showEvent。

这个function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] Visindigo::General::Logger *Plugin::getLogger() const

return 插件的日志记录器

这个function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] Visindigo::General::PluginModule *Plugin::getModuleByID(const QString &id) const

id 模块的ID return 插件中ID为 id 的模块，如果没有找到，则返回nullptr

请注意，出于从ID搜索模块可能并不常用考虑，在注册模块到插件时， 并不会立即将他们存入Map中以节省空间和提高性能，因此使用此 函数第一次搜索某个ID时会很慢，因为插件需要现场遍历一次模块列表。

但搜索到后会将结果存入Map中，因此第二次搜索同一个ID时性能会相对较好。

这个function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] QList<Visindigo::General::PluginModule *> Plugin::getModuleByTypeID(const QString &typeID) const

typeID 特定类型的ID return 插件中全部类型ID为 typeID 的模块列表，如果没有找到，则返回一个空列表

请注意，出于从类型ID搜索模块可能并不常用考虑，在注册模块到插件时， 并不会立即将他们存入Map中以节省空间和提高性能，因此使用此 函数第一次搜索某个类型ID时会很慢，因为插件需要现场遍历一次模块列表。

但搜索到后会将结果存入Map中，因此第二次搜索同一个类型ID时性能会相对较好。

这个function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] QList<Visindigo::General::PluginModule *> Plugin::getModules() const

return 插件包含的模块列表

这个function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] Visindigo::General::Version Plugin::getPluginABIVersion() const

return 插件的ABI版本号

这个function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] Visindigo::General::Version Plugin::getPluginAPIVersion() const

return 插件的API版本号

这个function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] QStringList Plugin::getPluginAuthor() const

return 插件的作者，这是一个列表。

这个function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] Visindigo::Utility::JsonConfig *Plugin::getPluginConfig()

return 插件的设置

这个function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] QString Plugin::getPluginDescription() const

return 插件的描述信息

这个function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.15.0] QString Plugin::getPluginDescriptionI18N() const

return 插件的国际化描述信息

这个function 从 Visindigo 0.15.0 开始支持。

[since Visindigo 0.13.0] QString Plugin::getPluginExtensionID() const

return 插件的扩展ID

这个function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] QDir Plugin::getPluginFolder() const

return 插件的根目录

这个function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] QString Plugin::getPluginID() const

return 插件的ID

这个function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] Visindigo::General::Plugin::LoadType Plugin::getPluginLoadType() const

return 插件的加载方式

这个function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] QString Plugin::getPluginName() const

return 插件的名称

这个function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.15.0] QString Plugin::getPluginNameI18N() const

return 插件的国际化名称

这个function 从 Visindigo 0.15.0 开始支持。

[since Visindigo 0.13.0] Visindigo::General::Version Plugin::getPluginVersion() const

return 插件的版本号

这个function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] bool Plugin::isTestEnable() const

return 插件是否为测试模式

这个function 从 Visindigo 0.13.0 开始支持。

[virtual, since Visindigo 0.13.0] void Plugin::onApplicationInit()

当整个应用程序所有的插件都被启用后调用此函数。此时，您可以安全地调用其他插件的功能。

如果您的插件需要与其他插件交互，则应在此函数中进行相关操作，而不是在onPluginEnable()中进行。

这个function 从 Visindigo 0.13.0 开始支持。

[virtual, since Visindigo 0.13.0] void Plugin::onPluginDisable()

禁用插件时调用此函数。大部分涉及到Visindigo内部资源调用的清理都应该在此函数中进行。 如果在析构函数中清理，则有可能因为Visindigo已经开始析构而导致崩溃。此外，此函数 还会被Visindigo捕获异常并输出到日志中。

这个function 从 Visindigo 0.13.0 开始支持。

[virtual, since Visindigo 0.13.0] void Plugin::onPluginEnable()

启用插件时调用此函数。大部分涉及到Visindigo内部资源调用的初始化都应该在此函数中进行。

如果在构造函数中初始化，则有可能因为Visindigo尚未完全初始化而导致崩溃。此外，此函数 还会被Visindigo捕获异常并输出到日志中。

这个function 从 Visindigo 0.13.0 开始支持。

[virtual, since Visindigo 0.13.0] void Plugin::onTest()

如果插件被设置为测试模式（通过调用setTestEnable()函数），则在所有插件的onApplicationInit()函数调用完毕后调用此函数。

您可以在此函数中执行一些测试代码，例如输出日志信息、弹出对话框等。

这个function 从 Visindigo 0.13.0 开始支持。

[protected, since Visindigo 0.13.0] void Plugin::registerColorScheme(const QString &schemeFilePath)

schemeFilePath 颜色方案文件路径 注册一个颜色方案

这个function 从 Visindigo 0.13.0 开始支持。

[protected, since Visindigo 0.13.0] void Plugin::registerPluginModule(Visindigo::General::PluginModule *module)

module 要注册的模块 注册一个插件模块

这个function 从 Visindigo 0.13.0 开始支持。

[protected, since Visindigo 0.13.0] void Plugin::registerStyleTemplate(const QString &templateFilePath)

templateFilePath 样式模板文件路径 注册一个样式模板

这个function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] void Plugin::reloadPluginConfig()

从磁盘重新加载插件的设置。

如果你的插件实现了getConfigWidget，允许用UI配置可视化文件，那么就强烈建议你的 配置页面在保存之后调用此函数以确保加载到内存中的设置与磁盘上的一致， 避免出现配置页面显示的设置与实际设置不一致的情况。

这个function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] void Plugin::savePluginConfig()

保存插件的设置到磁盘

这个function 从 Visindigo 0.13.0 开始支持。

[protected, since Visindigo 0.13.0] void Plugin::setPluginAuthor(const QStringList &author)

author 插件的作者 设置插件的作者

这个function 从 Visindigo 0.13.0 开始支持。

[protected, since Visindigo 0.13.0] void Plugin::setPluginDescription(const QString &description)

description 插件的描述信息 设置插件的描述信息。你可以按VI18N的格式给定描述信息的引用名称， 这样在调用getPluginDescriptionI18N()函数时就会返回国际化后的描述信息。

有关VI18N格式的详细信息，请参阅Visindigo::General::Translatior类的文档说明。

这个function 从 Visindigo 0.13.0 开始支持。

[protected, since Visindigo 0.13.0] void Plugin::setPluginID(const QString &id)

id 插件的ID 设置插件的ID

这个function 从 Visindigo 0.13.0 开始支持。

[protected, since Visindigo 0.13.0] void Plugin::setPluginName(const QString &name)

name 插件的名称 设置插件的名称。你可以按VI18N的格式给定名称的引用名称， 这样在调用getPluginNameI18N()函数时就会返回国际化后的名称。

有关VI18N格式的详细信息，请参阅Visindigo::General::Translatior类的文档说明。

这个function 从 Visindigo 0.13.0 开始支持。

[protected, since Visindigo 0.13.0] void Plugin::setPluginVersion(const Visindigo::General::Version &version)

version 插件的版本号 设置插件的版本号

这个function 从 Visindigo 0.13.0 开始支持。

[since Visindigo 0.13.0] void Plugin::setTestEnable()

设置插件为测试模式。只有在测试模式下，onTest函数才会被调用。

这个function 从 Visindigo 0.13.0 开始支持。

另请参阅 isTestEnable().

[protected, since Visindigo 0.13.0] void Plugin::unregisterPluginModule(Visindigo::General::PluginModule *module)

module 要注销的模块 注销一个插件模块

这个function 从 Visindigo 0.13.0 开始支持。