QHelpSearchEngine Class

メンバ関数ドキュメント

[explicit] QHelpSearchEngine::QHelpSearchEngine(QHelpEngineCore *helpEngine, QObject *parent = nullptr)

与えられたparent で新しい検索エンジンを構築する。検索エンジンは、インデックスが必要なドキュメントにアクセスするために、与えられたhelpEngine を使用します。QHelpEngine'のsetupFinished()シグナルは、自動的にQHelpSearchEngineのインデックス作成関数に接続されるので、シグナルが発せられた後、新しいドキュメントがインデックス作成されます。

[virtual noexcept] QHelpSearchEngine::~QHelpSearchEngine()

検索エンジンを破壊します。

[slot] void QHelpSearchEngine::cancelIndexing()

インデックス作成を停止します。

[slot] void QHelpSearchEngine::cancelSearching()

検索処理を停止します。

[signal] void QHelpSearchEngine::indexingFinished()

このシグナルは、インデックス作成処理が完了したときに発せられる。

[signal] void QHelpSearchEngine::indexingStarted()

インデックス作成処理が開始されると、このシグナルが発せられる。

QHelpSearchQueryWidget *QHelpSearchEngine::queryWidget()

入力ウィジェットとして使用するウィジェットを返します。検索エンジンの設定に応じて、多かれ少なかれサブウィジェットを持つ異なるウィジェットを取得します。

[slot] void QHelpSearchEngine::reindexDocumentation()

検索エンジンにすべてのドキュメントファイルの再インデックスを強制します。

QHelpSearchResultWidget *QHelpSearchEngine::resultWidget()

検索結果を保持し表示できるウィジェットを返します。

[slot] void QHelpSearchEngine::search(const QString &searchInput)

指定された検索フレーズsearchInput を使用して検索プロセスを開始します。

フレーズは複数の単語で構成することができます。デフォルトでは、検索エンジンは指定されたすべての単語を含むドキュメントのリストを返します。フレーズには論理演算子AND、OR、NOTの任意の組み合わせを含めることができます。演算子はすべて大文字で書く必要があり、そうしないと検索フレーズの一部とみなされます。

単語をグループ化するために二重引用符が使用されている場合、検索エンジンは引用符で囲まれたフレーズと完全に一致するものを検索します。

テキストクエリの構文についての詳細はSQLite FTS5 Extension を参照してください。

QString QHelpSearchEngine::searchInput() const

最後に検索されたフレーズを返します。

int QHelpSearchEngine::searchResultCount() const

検索エンジンが検索した結果の数を返します。

QList<QHelpSearchResult> QHelpSearchEngine::searchResults(int start, int end) const

start で指定されたインデックスからend で指定されたインデックスまでの範囲内の検索結果のリストを返します。

[signal] void QHelpSearchEngine::searchingFinished(int searchResultCount)

このシグナルは検索処理が完了したときに発せられる。検索結果のカウントはsearchResultCount に格納される。

[signal] void QHelpSearchEngine::searchingStarted()

このシグナルは、検索処理が開始されたときに発せられます。