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

이 신호는 검색 프로세스가 시작될 때 전송됩니다.