QHelpFilterEngine Class

QHelpFilterEngine クラスは、ヘルプコンテンツをフィルタリングして表示する機能を提供します。詳細...

ヘッダー:	`#include <QHelpFilterEngine>`

CMake:	`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() メソッドを使用して削除できます。

登録されたフィルタのうち、1つをアクティブなフィルタとして指定できます。アクティブなフィルタは、関連付けられたヘルプエンジンによって、コンテンツ、インデックス、検索結果など、さまざまな機能のフィルタリング済み結果を返す際に使用されます。アクティブなフィルタが指定されていない場合、ヘルプエンジンは利用可能な結果リスト全体を返します。

アクティブなフィルターは `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()も参照してください 。

© 2026 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.