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 拡張機能を参照してください。

// Connect using qOverload:
connect(sender, &SenderClass::signal,
        helpSearchEngine, qOverload(&QHelpSearchEngine::search));

// Or using a lambda as wrapper:
connect(sender, &SenderClass::signal,
        helpSearchEngine, [receiver = helpSearchEngine](const QString &searchInput) { receiver->search(searchInput); });

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()

このシグナルは、検索プロセスが開始されたときに送信されます。