QHelpFilterEngine Class
QHelpFilterEngineクラスは、ヘルプ内容のフィルタリングされたビューを提供します。詳細...
| Header: | #include <QHelpFilterEngine> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS Help)target_link_libraries(mytarget PRIVATE Qt6::Help) |
| qmake: | QT += help |
| Inherits: | 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()も参照してください 。
©2024 The Qt Company Ltd. 本文書に含まれる文書の著作権は、それぞれの所有者に帰属します。 本書で提供されるドキュメントは、Free Software Foundation が発行したGNU Free Documentation License version 1.3に基づいてライセンスされています。 Qtおよびそれぞれのロゴは、フィンランドおよびその他の国におけるThe Qt Company Ltd.の 商標です。その他すべての商標は、それぞれの所有者に帰属します。
