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

YSSCore::Editor::FileTemplateInitWidget Class

class YSSCore::Editor::FileTemplateInitWidget

FileTemplateInitWidget是一个QFrame,作为FileTemplateProvider的初始化界面. 详情...

头文件: #include <FileTemplateInitWidget>
自以下版本: YSS 0.13.0

公开成员函数

(自 YSS 0.13.0 引入) FileTemplateInitWidget(const QString &initFolder, QWidget *parent)
(自 YSS 0.13.0 引入) virtual ~FileTemplateInitWidget()
(自 YSS 0.13.0 引入) QString getInitFolder() const

信号

(自 YSS 0.13.0 引入) void filePrepared(QString filePath)

详细说明

FileTemplateInitWidget是一个QFrame,作为FileTemplateProvider的初始化界面。 当用户选择某个文件模板来创建文件时,编辑器会调用该模板的fileInitWidget函数, return 一个FileTemplateInitWidget实例,并将其显示在界面上。用户可以在这个界面上进行一些必要的配置(如文件名称、保存路径等), 然后点击“创建”按钮来完成文件的创建过程。

请注意,为了与YSS解耦,这个类设计上并未采用要求用户必须创建持续存活YSSCore::Editor::FileEditWidget实例 并在初始化完毕后将其传递给编辑器的方式来完成文件创建。

相反,你可以在这个页面上收集到足够的信息之后自由的根据需要创建文件,填充文件内容等, 最后通过filePrepared信号,将文件路径推送出去,编辑器会监测这个信号,并使用标准的从磁盘打开文件的流程来打开这个新文件。 这种设计也使得YSS可以拥有统一的文件加载流程,而不需要担心不同模板的创建流程可能会导致的兼容性问题。

至于此类的生命周期,编辑器会在显示它之前通过QWidget::setAttribute将其设置为关闭时自动销毁。

如果你认为根据用户的输入,无法创建文件, 那么只需要不发出任何信号即可。用户直接关闭 此页面会被编辑器视为取消创建操作,不会有任何后续操作发生。

Warning: 这类在0.14.0调整了虚函数,因此ABI与此前不兼容。

成员函数文档

[since YSS 0.13.0] FileTemplateInitWidget::FileTemplateInitWidget(const QString &initFolder, QWidget *parent)

initFolder 用户希望文件被创建的初始路径。你也可以选择不尊重这个参数。 parent 父对象

构造函数

这个function 从 YSS 0.13.0 开始支持。

[virtual noexcept, since YSS 0.13.0] FileTemplateInitWidget::~FileTemplateInitWidget()

析构函数

这个function 从 YSS 0.13.0 开始支持。

[signal, since YSS 0.13.0] void FileTemplateInitWidget::filePrepared(QString filePath)

filePath 文件路径

当文件准备就绪时(如用户点击了“创建”按钮,并且文件已经生成),你应该发出这个信号,并将文件路径作为参数传递出去。

这个function 从 YSS 0.13.0 开始支持。

[since YSS 0.13.0] QString FileTemplateInitWidget::getInitFolder() const

return 用户希望文件被创建的初始路径。你也可以选择不尊重这个参数。

这个function 从 YSS 0.13.0 开始支持。