4#ifndef QHELPSEARCHENGINE_H
5#define QHELPSEARCHENGINE_H
7#include <QtHelp/qhelp_global.h>
8#include <QtHelp/qhelpsearchresult.h>
10#include <QtCore/qobject.h>
11#include <QtCore/qshareddata.h>
12#include <QtCore/qstringlist.h>
18class QHelpSearchQueryWidget;
19class QHelpSearchResultWidget;
21#if QT_DEPRECATED_SINCE(6
, 7
)
22class QHELP_EXPORT QHelpSearchQuery
25 enum FieldName { DEFAULT = 0, FUZZY, WITHOUT, PHRASE, ALL, ATLEAST };
27 QT_DEPRECATED_VERSION_X_6_7(
"Use QString instead")
29 : fieldName(DEFAULT) { wordList.clear(); }
30 QT_DEPRECATED_VERSION_X_6_7(
"Use QString instead")
31 QHelpSearchQuery(FieldName field,
const QStringList &wordList_)
32 : fieldName(field), wordList(wordList_) {}
44 explicit QHelpSearchEngine(QHelpEngineCore *helpEngine, QObject *parent =
nullptr);
47 QHelpSearchQueryWidget *queryWidget();
48 QHelpSearchResultWidget *resultWidget();
50#if QT_DEPRECATED_SINCE(5
, 9
)
51 typedef QPair<QString, QString> SearchHit;
53 QT_DEPRECATED
int hitsCount()
const;
54 QT_DEPRECATED
int hitCount()
const;
55 QT_DEPRECATED QList<SearchHit> hits(
int start,
int end)
const;
56 QT_DEPRECATED QList<QHelpSearchQuery> query()
const;
59 int searchResultCount()
const;
60 QList<QHelpSearchResult> searchResults(
int start,
int end)
const;
61 QString searchInput()
const;
64 void reindexDocumentation();
65 void cancelIndexing();
67#if QT_DEPRECATED_SINCE(5
, 9
)
68 QT_DEPRECATED
void search(
const QList<QHelpSearchQuery> &queryList);
71 void search(
const QString &searchInput);
72 void cancelSearching();
74 void scheduleIndexDocumentation();
77 void indexingStarted();
78 void indexingFinished();
80 void searchingStarted();
81 void searchingFinished(
int searchResultCount);
84 void indexDocumentation();
87 QHelpSearchEnginePrivate *d;
QHelpSearchEngine * searchEngine
QHelpIndexWidget * indexWidget
QHelpContentModel * contentModel
QHelpEnginePrivate(QHelpEngineCore *helpEngineCore)
QHelpEngineCore * m_helpEngineCore
bool m_isApplyCurrentFilterScheduled
QHelpIndexModel * indexModel
QHelpContentWidget * contentWidget
The QHelpEngine class provides access to contents and indices of the help engine.
The QHelpFilterEngine class provides a filtered view of the help contents.
The QHelpIndexModel class provides a model that supplies index keywords to views.
The QHelpSearchEngine class provides access to widgets reusable to integrate fulltext search as well ...
Combined button and popup list for selecting options.