QHelpSearchEngineCore Class

メンバ関数ドキュメント

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

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

[override virtual noexcept] QHelpSearchEngineCore::~QHelpSearchEngineCore()

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

[slot] void QHelpSearchEngineCore::cancelIndexing()

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

[slot] void QHelpSearchEngineCore::cancelSearching()

検索処理を停止します。

[signal] void QHelpSearchEngineCore::indexingFinished()

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

[signal] void QHelpSearchEngineCore::indexingStarted()

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

[slot] void QHelpSearchEngineCore::reindexDocumentation()

検索エンジンにすべてのドキュメントファイルのインデックスを再作成させます。

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

指定された検索フレーズを使用して検索処理を開始するsearchInput 。

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

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

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

QString QHelpSearchEngineCore::searchInput() const

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

int QHelpSearchEngineCore::searchResultCount() const

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

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

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

[signal] void QHelpSearchEngineCore::searchingFinished()

検索処理が完了するとこのシグナルが発せられる。

[signal] void QHelpSearchEngineCore::searchingStarted()

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