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()も参照 。

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