QHelpFilterEngine Class

成员函数文档

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()。