QHelpFilterEngine Class
QHelpFilterEngine 类提供了帮助内容的过滤视图。更多
| Header： | #include <QHelpFilterEngine> |
| CMake.QHelpFilterEngine | find_package(Qt6 REQUIRED COMPONENTS Help)target_link_libraries(mytarget PRIVATE Qt6::Help) |
| qmake： | QT += help |
| 继承： | QObject |
公共函数
| QString | activeFilter() const |
| QStringList | availableComponents() const |
| QList<QVersionNumber> | availableVersions() const |
| QHelpFilterData | filterData(const QString &filterName) const |
| QStringList | filters() const |
| QStringList | indices() const |
| QStringList | indices(const QString &filterName) const |
| QMap<QString, QString> | namespaceToComponent() const |
| QMap<QString, QVersionNumber> | namespaceToVersion() const |
| QStringList | namespacesForFilter(const QString &filterName) const |
| bool | removeFilter(const QString &filterName) |
| bool | setActiveFilter(const QString &filterName) |
| bool | setFilterData(const QString &filterName, const QHelpFilterData &filterData) |
信号
| void | filterActivated(const QString &newFilter) |
详细说明
过滤器引擎允许管理与QHelpEngineCore 实例相关联的过滤器。帮助引擎会在内部创建一个过滤器引擎实例，可通过调用QHelpEngineCore::filterEngine() 访问该实例。因此，该类的公共构造函数是禁用的。
过滤器由过滤器名称字符串标识。过滤器的详细信息由QHelpFilterData 类描述。
过滤器引擎允许通过setFilterData() 方法添加新过滤器和更改现有过滤器的数据。可以通过removeFilter() 方法删除现有的过滤器。
在已注册的过滤器中，可以将其中一个标记为活动过滤器。活动过滤器将被相关的帮助引擎用于返回许多不同功能的过滤结果，如内容、索引或搜索结果。如果没有标记为活动的过滤器，帮助引擎将返回全部可用结果列表。
activeFilter() 会返回激活的过滤器，setActiveFilter() 可以更改该过滤器。
另请参阅 QHelpEngineCore 。
成员函数文档
QString QHelpFilterEngine::activeFilter() const
返回当前活动过滤器的名称。
另请参阅 setActiveFilter()。
QStringList QHelpFilterEngine::availableComponents() const
返回所有已注册文档文件中定义的所有可用组件的列表。
QList<QVersionNumber> QHelpFilterEngine::availableVersions() const
返回所有已注册文档文件中定义的所有可用版本的列表。
[signal] void QHelpFilterEngine::filterActivated(const QString &newFilter)
newFilter 指定过滤器的名称。
另请参阅 setActiveFilter() 。
QHelpFilterData QHelpFilterEngine::filterData(const QString &filterName) const
返回与filterName 相关联的过滤器详细信息。
另请参阅 setFilterData() 。
QStringList QHelpFilterEngine::filters() const
返回过滤器引擎内定义的所有过滤器名称列表。
QStringList QHelpFilterEngine::indices() const
返回可用索引的排序列表。返回的列表内容取决于活动筛选器，因此只会返回为活动筛选器注册的索引。
QStringList QHelpFilterEngine::indices(const QString &filterName) const
返回按filterName 过滤的可用索引排序列表。返回的列表内容取决于传递的过滤器，因此只会返回为该过滤器注册的索引。如果想获取未过滤的所有可用索引，请将空字符串作为filterName 。
QMap<QString, QString> QHelpFilterEngine::namespaceToComponent() const
返回所有可用命名空间（键值）及其相关组件（值）的映射。
QMap<QString, QVersionNumber> QHelpFilterEngine::namespaceToVersion() const
以所有可用命名空间为键，以相关版本为值，返回这些命名空间的映射。
QStringList QHelpFilterEngine::namespacesForFilter(const QString &filterName) const
返回与filterName 识别的过滤器匹配的所有已注册文档名称空间的列表。
bool QHelpFilterEngine::removeFilter(const QString &filterName)
移除filterName 标识的过滤器。
如果删除过滤器成功，则返回true ，否则返回false 。
bool QHelpFilterEngine::setActiveFilter(const QString &filterName)
将当前激活的过滤器更改为filterName 。
如果更改过滤器成功，则返回true ，否则返回false 。
另请参阅 activeFilter() 。
bool QHelpFilterEngine::setFilterData(const QString &filterName, const QHelpFilterData &filterData)
将filterName 标识的过滤器的现有过滤器详细信息更改为filterData 。如果过滤器不存在，则创建一个新过滤器。
如果设置过滤器成功，则返回true ，否则返回false 。
另请参阅 filterData() 。
© 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.
