DAWorkbench 0.0.1
DAWorkbench API
载入中...
搜索中...
未找到
DA::DAAbstractPlugin类 参考abstract

所有插件的基类 更多...

#include <DAAbstractPlugin.h>

类 DA::DAAbstractPlugin 继承关系图:
DA::DAAbstractNodePlugin

class  PrivateData
 

Public 成员函数

virtual QString getIID () const =0
 
virtual QString getName () const =0
 插件名
 
virtual QString getVersion () const =0
 插件版本
 
virtual QString getDescription () const =0
 插件描述
 
virtual void retranslate ()
 发生语言变更事件的时候调用此函数 默认没有实现,如果插件有涉及翻译,需要重载此函数
 
virtual bool initialize ()
 初始化
 
virtual bool finalize ()
 释放插件的回调函数
 
virtual DAAbstractSettingPagecreateSettingPage ()
 获取设置页,默认返回nullptr,代表没有设置页
 
virtual std::shared_ptr< DAAbstractArchiveTaskcreateArchiveTask (bool isSave)
 创建存档任务
 
DACoreInterfacecore () const
 获取core接口
 

Protected 成员函数

void setCore (DACoreInterface *c)
 设置core
 

友元

class DAPluginOption
 
class DAPluginManager
 

详细描述

所有插件的基类

所有支持插件的库都需要实现以下导出函数 DAAbstractPlugin* plugin_create(); void plugin_destory(DAAbstractPlugin* p);

成员函数说明

◆ core()

DACoreInterface * DA::DAAbstractPlugin::core ( ) const

获取core接口

返回

◆ createArchiveTask()

std::shared_ptr< DAAbstractArchiveTask > DA::DAAbstractPlugin::createArchiveTask ( bool  isSave)
virtual

创建存档任务

插件的所有存档操作都可以通过存档任务完成

参数
isSave是否是保存任务,此参数用于区分保存和加载
返回
默认返回nullptr,代表没有存档任务

◆ createSettingPage()

DAAbstractSettingPage * DA::DAAbstractPlugin::createSettingPage ( )
virtual

获取设置页,默认返回nullptr,代表没有设置页

注解
返回设置页要配合
参见
getConfig 一起使用,app会先调用getConfig获取配置类,在获取DAAbstractSettingPage后,调用
返回

◆ finalize()

bool DA::DAAbstractPlugin::finalize ( )
virtual

释放插件的回调函数

返回
如果初返回false,说明插件卸载失败,将不会进行卸载(一般是在执行某些运算还没结束的时候),默认返回true

◆ getDescription()

virtual QString DA::DAAbstractPlugin::getDescription ( ) const
pure virtual

插件描述

返回

◆ getName()

virtual QString DA::DAAbstractPlugin::getName ( ) const
pure virtual

插件名

返回

◆ getVersion()

virtual QString DA::DAAbstractPlugin::getVersion ( ) const
pure virtual

插件版本

返回

◆ initialize()

bool DA::DAAbstractPlugin::initialize ( )
virtual

初始化

所有针对界面的操作都应该在initialize里调用,这样能保证已有系统的基本界面框架都已经建立完成

返回
如果初始化返回false,将不会把插件放入管理中,默认返回true

◆ setCore()

void DA::DAAbstractPlugin::setCore ( DACoreInterface c)
protected

设置core

参数
c

该类的文档由以下文件生成: