IOptionsPage 类
class Core::IOptionsPageIOptionsPage 类是提供 选项 对话框(在 macOS 上称为 首选项)页面的接口。更多...
头文件 | #include <coreplugin/dialogs/ioptionspage.h> |
公共函数
IOptionsPage(bool registerGlobally = true) | |
virtual void | apply() |
Utils::Id | category() const |
Utils::FilePath | categoryIconPath() const |
QString | displayCategory() const |
QString | displayName() const |
virtual void | finish() |
Utils::Id | id() const |
virtual bool | matches(const QRegularExpression ®exp) const |
void | setWidgetCreator(const Core::IOptionsPage::WidgetCreator &widgetCreator) |
virtual QWidget * | widget() |
静态公共成员
const QList<Core::IOptionsPage *> | allOptionsPages() |
受保护的函数
virtual QStringList | keywords() const |
void | setCategoryIconPath(const Utils::FilePath &categoryIconPath) |
void | setDisplayName(const QString &displayName) |
void | setId(Utils::Id id) |
成员函数说明
[explicit]
IOptionsPage::IOptionsPage(bool registerGlobally = true)
构建一个选项页面,如果 registerGlobally 为 true,则在全局选项页面池中注册。
[静态]
const QList<Core::IOptionsPage *> IOptionsPage::allOptionsPages()
返回所有选项页面的列表。
[虚拟]
void IOptionsPage::apply()
当在选项页面对话框中选择 应用 按钮时调用。应检测是否进行了任何更改并存储它们。
可以在派生类中覆盖此函数,或设置一个窗口创建器。
另请参阅setWidgetCreator().
Utils::Id IOptionsPage::category() const
返回选项页面应在其中显示的类别唯一标识符。此标识符用于在 选项 对话框的左侧对列表进行排序。
Utils::FilePath IOptionsPage::categoryIconPath() const
返回选项页面类别图标的路径。此图标将从该路径读取并显示在 选项 对话框左侧的列表中。
另请参阅setCategoryIconPath()。
QString IOptionsPage::displayCategory() const
返回选项页面翻译后的类别名称。此名称将显示在 选项 对话框左侧的列表中。
QString IOptionsPage::displayName() const
返回选项页面翻译后的显示名称。
另请参阅setDisplayName()。
[virtual]
void IOptionsPage::finish()
在 选项 对话框关闭之前直接调用。在此,您应该删除在 widget() 中创建的小部件以释放资源。
可以在派生类中覆盖此函数,或设置一个窗口创建器。
另请参阅setWidgetCreator().
Utils::Id IOptionsPage::id() const
返回用于引用选项页的唯一标识符。
另请参阅setId()。
[virtual protected]
QStringList IOptionsPage::keywords() const
返回用于小部件内部的 UI 字符串列表。
[virtual]
bool IOptionsPage::matches(const QRegularExpression ®exp) const
由 选项 对话框搜索过滤器用于将 regexp 匹配到此选项页。默认情况下,获取小部件然后查找所有子标签、复选框、按钮和分组框。找到匹配项时,应返回 true
。
[protected]
void IOptionsPage::setCategoryIconPath(const Utils::FilePath &categoryIconPath)
将 categoryIconPath 设置为选项页面类别图标的路径。
另请参阅categoryIconPath()。
[protected]
void IOptionsPage::setDisplayName(const QString &displayName)
设置 displayName 为选项页的显示名称。
另请参阅displayName()。
[protected]
void IOptionsPage::setId(Utils::Id id)
设置选项页的 id。
另请参阅id()。
void IOptionsPage::setWidgetCreator(const Core::IOptionsPage::WidgetCreator &widgetCreator)
设置widgetCreator回调以按需创建页面小部件。在完成时将销毁小部件。
[虚拟]
QWidget *IOptionsPage::widget()
返回要在完成()方法中重新创建的选项对话框中显示的小部件。你应该在这里懒加载地创建小部件,并在完成方法中再次删除它。此方法可能会被多次调用,因此只有在旧的小部件被删除的情况下才应创建新的小部件。
或者,使用setWidgetCreator()来设置一个回调函数,在适当的时间懒加载地创建小部件。
可以在派生类中覆盖此函数,或设置一个窗口创建器。
©2024 The Qt Company Ltd. 本文档中的文档贡献归各自所有者所有版权。本提供的文档根据自由软件基金会发布的GNU自由文档许可证第1.3版的条款进行许可。Qt及其标志是芬兰及其它国家/地区的Qt公司的商标。所有其他商标均属于其各自所有者。