QHelpFilterSettingsWidget Class

QHelpFilterSettingsWidget 类提供了一个用于创建、编辑和删除过滤器的部件。更多

Header: #include <QHelpFilterSettingsWidget>
CMake: find_package(Qt6 REQUIRED COMPONENTS Help)
target_link_libraries(mytarget PRIVATE Qt6::Help)
qmake: QT += help
继承: QWidget

公共函数

QHelpFilterSettingsWidget(QWidget *parent = nullptr)
virtual ~QHelpFilterSettingsWidget()
bool applySettings(QHelpFilterEngine *filterEngine) const
void readSettings(const QHelpFilterEngine *filterEngine)
void setAvailableComponents(const QStringList &components)
void setAvailableVersions(const QList<QVersionNumber> &versions)

详细说明

QHelpFilterSettingsWidget 的实例可能是首选项对话框的一部分。在显示对话框之前,应调用setAvailableComponents() 和setAvailableVersions() ,否则过滤器设置窗口小部件将只提供空过滤器的创建,而这是没有用的。此外,还应该调用readSettings ,用已存储在过滤器引擎中的过滤器列表来填充过滤器设置窗口小部件。创建新筛选器、修改现有筛选器和删除不需要的筛选器都是由 widget 自动处理的。如果您想存储 widget 的当前状态并将其应用到过滤器引擎,例如在用户点击应用按钮后,请调用applySettings()。

成员函数文档

[explicit] QHelpFilterSettingsWidget::QHelpFilterSettingsWidget(QWidget *parent = nullptr)

构建一个过滤器设置 widget,父 widget 为parent

[virtual noexcept] QHelpFilterSettingsWidget::~QHelpFilterSettingsWidget()

销毁过滤器设置 widget。

bool QHelpFilterSettingsWidget::applySettings(QHelpFilterEngine *filterEngine) const

将当前显示在此过滤器设置 widget 中的过滤器设置写入filterEngine 。存储在过滤器引擎中的旧设置将被覆盖。成功时返回true

void QHelpFilterSettingsWidget::readSettings(const QHelpFilterEngine *filterEngine)

读取存储在filterEngine 中的过滤器设置,并相应设置此过滤器设置部件。

void QHelpFilterSettingsWidget::setAvailableComponents(const QStringList &components)

将所有可用组件的列表设置为components

另请参阅 QHelpFilterEngine::availableComponents() 。

void QHelpFilterSettingsWidget::setAvailableVersions(const QList<QVersionNumber> &versions)

将所有可用版本号列表设置为versions

另请参阅 QHelpFilterEngine::availableVersions() 。

© 2025 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.