1 /****************************************************************************
2 **
3 ** Copyright (C) 2015 The Qt Company Ltd.
4 ** Contact: http://www.qt.io/licensing/
5 **
6 ** This file is part of the Qt Assistant of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and The Qt Company. For licensing terms
14 ** and conditions see http://www.qt.io/terms-conditions. For further
15 ** information use the contact form at http://www.qt.io/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 2.1 or version 3 as published by the Free
20 ** Software Foundation and appearing in the file LICENSE.LGPLv21 and
21 ** LICENSE.LGPLv3 included in the packaging of this file. Please review the
22 ** following information to ensure the GNU Lesser General Public License
23 ** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
24 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
25 **
26 ** As a special exception, The Qt Company gives you certain additional
27 ** rights. These rights are described in The Qt Company LGPL Exception
28 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
29 **
30 ** GNU General Public License Usage
31 ** Alternatively, this file may be used under the terms of the GNU
32 ** General Public License version 3.0 as published by the Free Software
33 ** Foundation and appearing in the file LICENSE.GPL included in the
34 ** packaging of this file.  Please review the following information to
35 ** ensure the GNU General Public License version 3.0 requirements will be
36 ** met: http://www.gnu.org/copyleft/gpl.html.
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41 
42 #ifndef QHELPSEARCHENGINE_H
43 #define QHELPSEARCHENGINE_H
44 
45 #include <QtHelp/qhelp_global.h>
46 
47 #include <QtCore/QMap>
48 #include <QtCore/QUrl>
49 #include <QtCore/QObject>
50 #include <QtCore/QString>
51 #include <QtCore/QStringList>
52 
53 QT_BEGIN_HEADER
54 
55 QT_BEGIN_NAMESPACE
56 
57 QT_MODULE(Help)
58 
59 class QHelpEngineCore;
60 class QHelpSearchQueryWidget;
61 class QHelpSearchResultWidget;
62 class QHelpSearchEnginePrivate;
63 
64 class QHELP_EXPORT QHelpSearchQuery
65 {
66 public:
67     enum FieldName { DEFAULT = 0, FUZZY, WITHOUT, PHRASE, ALL, ATLEAST };
68 
QHelpSearchQuery()69     QHelpSearchQuery()
70         : fieldName(DEFAULT) { wordList.clear(); }
QHelpSearchQuery(FieldName field,const QStringList & wordList)71     QHelpSearchQuery(FieldName field, const QStringList &wordList)
72         : fieldName(field), wordList(wordList) {}
73 
74     FieldName fieldName;
75     QStringList wordList;
76 };
77 
78 class QHELP_EXPORT QHelpSearchEngine : public QObject
79 {
80     Q_OBJECT
81 
82 public:
83     explicit QHelpSearchEngine(QHelpEngineCore *helpEngine,
84         QObject *parent = 0);
85     ~QHelpSearchEngine();
86 
87     QHelpSearchQueryWidget* queryWidget();
88     QHelpSearchResultWidget* resultWidget();
89 
90 #ifdef QT_DEPRECATED
91     QT_DEPRECATED int hitsCount() const;
92 #endif
93     int hitCount() const;
94 
95     typedef QPair<QString, QString> SearchHit;
96     QList<SearchHit> hits(int start, int end) const;
97 
98     QList<QHelpSearchQuery> query() const;
99 
100 public Q_SLOTS:
101     void reindexDocumentation();
102     void cancelIndexing();
103 
104     void search(const QList<QHelpSearchQuery> &queryList);
105     void cancelSearching();
106 
107 Q_SIGNALS:
108     void indexingStarted();
109     void indexingFinished();
110 
111     void searchingStarted();
112     void searchingFinished(int hits);
113 
114 private Q_SLOTS:
115     void indexDocumentation();
116 
117 private:
118     QHelpSearchEnginePrivate *d;
119 };
120 
121 QT_END_NAMESPACE
122 
123 QT_END_HEADER
124 
125 #endif  // QHELPSEARCHENGINE_H
126