1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
|
/****************************************************************************
**
** Copyright (C) 2021 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Assistant of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:COMM$
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** $QT_END_LICENSE$
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
****************************************************************************/
#ifndef QHELPSEARCHENGINE_H
#define QHELPSEARCHENGINE_H
#include <QtHelp/qhelp_global.h>
#include <QtCore/QMap>
#include <QtCore/QUrl>
#include <QtCore/QObject>
#include <QtCore/QSharedDataPointer>
#include <QtCore/QString>
#include <QtCore/QStringList>
QT_BEGIN_NAMESPACE
class QHelpEngineCore;
class QHelpSearchQueryWidget;
class QHelpSearchEnginePrivate;
class QHelpSearchResultData;
class QHelpSearchResultWidget;
class QHELP_EXPORT QHelpSearchQuery
{
public:
enum FieldName { DEFAULT = 0, FUZZY, WITHOUT, PHRASE, ALL, ATLEAST };
QHelpSearchQuery()
: fieldName(DEFAULT) { wordList.clear(); }
QHelpSearchQuery(FieldName field, const QStringList &wordList_)
: fieldName(field), wordList(wordList_) {}
FieldName fieldName;
QStringList wordList;
};
class QHELP_EXPORT QHelpSearchResult
{
public:
QHelpSearchResult();
QHelpSearchResult(const QHelpSearchResult &other);
QHelpSearchResult(const QUrl &url, const QString &title, const QString &snippet);
~QHelpSearchResult();
QHelpSearchResult &operator=(const QHelpSearchResult &other);
QString title() const;
QUrl url() const;
QString snippet() const;
private:
QSharedDataPointer<QHelpSearchResultData> d;
};
class QHELP_EXPORT QHelpSearchEngine : public QObject
{
Q_OBJECT
public:
explicit QHelpSearchEngine(QHelpEngineCore *helpEngine, QObject *parent = nullptr);
~QHelpSearchEngine();
QHelpSearchQueryWidget* queryWidget();
QHelpSearchResultWidget* resultWidget();
#if QT_DEPRECATED_SINCE(5, 9)
typedef QPair<QString, QString> SearchHit;
QT_DEPRECATED int hitsCount() const;
QT_DEPRECATED int hitCount() const;
QT_DEPRECATED QList<SearchHit> hits(int start, int end) const;
QT_DEPRECATED QList<QHelpSearchQuery> query() const;
#endif
int searchResultCount() const;
QVector<QHelpSearchResult> searchResults(int start, int end) const;
QString searchInput() const;
public Q_SLOTS:
void reindexDocumentation();
void cancelIndexing();
#if QT_DEPRECATED_SINCE(5, 9)
QT_DEPRECATED void search(const QList<QHelpSearchQuery> &queryList);
#endif
void search(const QString &searchInput);
void cancelSearching();
void scheduleIndexDocumentation();
Q_SIGNALS:
void indexingStarted();
void indexingFinished();
void searchingStarted();
void searchingFinished(int searchResultCount);
private Q_SLOTS:
void indexDocumentation();
private:
QHelpSearchEnginePrivate *d;
};
QT_END_NAMESPACE
#endif // QHELPSEARCHENGINE_H
|
