YSSCore::Editor::FileTemplateProvider Class
class YSSCore::Editor::FileTemplateProviderFileTemplateProvider向编辑器提供一个文件模板. 详情...
| 头文件： | #include <FileTemplateProvider> |
| 自以下版本： | YSS 0.13.0 |
| 继承自： | Visindigo::General::PluginModule |
- 所有成员列表（包含继承成员）
- FileTemplateProvider 是该集合的一部分：创建服务框架.
公开成员函数
(自 YSS 0.13.0 引入) | FileTemplateProvider(const QString &name, const QString &id, YSSCore::Editor::EditorPlugin *plugin) |
(自 YSS 0.13.0 引入) virtual | ~FileTemplateProvider() |
(自 YSS 0.13.0 引入) QString | getTemplateDescription() const |
(自 YSS 0.13.0 引入) QString | getTemplateID() const |
(自 YSS 0.13.0 引入) QString | getTemplateIconPath() const |
(自 YSS 0.13.0 引入) QString | getTemplateName() const |
(自 YSS 0.13.0 引入) QStringList | getTemplateTags() const |
(自 YSS 0.13.0 引入) void | setTemplateDescription(const QString &description) |
(自 YSS 0.13.0 引入) void | setTemplateID(const QString &id) |
(自 YSS 0.13.0 引入) void | setTemplateIconPath(const QString &iconPath) |
(自 YSS 0.13.0 引入) void | setTemplateName(const QString &name) |
(自 YSS 0.13.0 引入) void | setTemplateTags(const QStringList &tags) |
详细说明
FileTemplateProvider是一个插件模块，向编辑器提供一个文件模板。编辑器会在新建文件界面展示所有注册的FileTemplateProvider， 用户可以选择一个模板来创建文件。
值得指出的是，YSS假定了所有创建操作都需要通过一个UI来解决，所以这个Provider类本身主要用于记录 文件的相关信息（如图标、ID、名称、描述、标签等），以及提供一个UI界面来引导用户完成创建过程。真正的创建逻辑应该在FileTemplateInitWidget中实现。
Warning: 这类在0.14.0完善了const语义，因此ABI与此前不兼容。
成员函数文档
[since YSS 0.13.0] FileTemplateProvider::FileTemplateProvider(const QString &name, const QString &id, YSSCore::Editor::EditorPlugin *plugin)
name 模板名称 id 模板ID，必须唯一 plugin 提供该模板的插件实例
构造函数
这个function 从 YSS 0.13.0 开始支持。
[virtual noexcept, since YSS 0.13.0] FileTemplateProvider::~FileTemplateProvider()
析构函数
这个function 从 YSS 0.13.0 开始支持。
[since YSS 0.13.0] QString FileTemplateProvider::getTemplateDescription() const
return 模板描述
这个function 从 YSS 0.13.0 开始支持。
[since YSS 0.13.0] QString FileTemplateProvider::getTemplateID() const
return 模板ID
这个function 从 YSS 0.13.0 开始支持。
[since YSS 0.13.0] QString FileTemplateProvider::getTemplateIconPath() const
return 模板图标路径
这个function 从 YSS 0.13.0 开始支持。
[since YSS 0.13.0] QString FileTemplateProvider::getTemplateName() const
return 模板名称
这个function 从 YSS 0.13.0 开始支持。
[since YSS 0.13.0] QStringList FileTemplateProvider::getTemplateTags() const
return 模板标签列表
这个function 从 YSS 0.13.0 开始支持。
[since YSS 0.13.0] void FileTemplateProvider::setTemplateDescription(const QString &description)
description 模板描述
设置模板描述。这个描述会在新建文件界面展示，帮助用户了解这个模板的用途和特点。
这个function 从 YSS 0.13.0 开始支持。
[since YSS 0.13.0] void FileTemplateProvider::setTemplateID(const QString &id)
id 模板ID，必须唯一
设置模板ID
这个function 从 YSS 0.13.0 开始支持。
[since YSS 0.13.0] void FileTemplateProvider::setTemplateIconPath(const QString &iconPath)
iconPath 模板图标路径
设置模板图标路径。这个图标会在新建文件界面展示，帮助用户识别不同的模板。建议使用相对于插件资源目录的相对路径。
这个function 从 YSS 0.13.0 开始支持。
[since YSS 0.13.0] void FileTemplateProvider::setTemplateName(const QString &name)
name 模板名称
设置模板名称
这个function 从 YSS 0.13.0 开始支持。
[since YSS 0.13.0] void FileTemplateProvider::setTemplateTags(const QStringList &tags)
tags 模板标签列表
设置模板标签列表。标签可以帮助用户在新建文件界面通过筛选来快速找到想要的模板。
这个function 从 YSS 0.13.0 开始支持。