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
|
/****************************************************************************
**
** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation ([email protected])
**
** This file is part of the Qt Assistant of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial Usage
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Nokia.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
** If you have questions regarding the use of this file, please contact
** Nokia at [email protected].
** $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/QString>
#include <QtCore/QStringList>
QT_BEGIN_HEADER
QT_BEGIN_NAMESPACE
QT_MODULE(Help)
class QHelpEngineCore;
class QHelpSearchQueryWidget;
class QHelpSearchResultWidget;
class QHelpSearchEnginePrivate;
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 QHelpSearchEngine : public QObject
{
Q_OBJECT
public:
QHelpSearchEngine(QHelpEngineCore *helpEngine, QObject *parent = 0);
~QHelpSearchEngine();
QHelpSearchQueryWidget* queryWidget();
QHelpSearchResultWidget* resultWidget();
#ifdef QT_DEPRECATED
QT_DEPRECATED int hitsCount() const;
#endif
int hitCount() const;
typedef QPair<QString, QString> SearchHit;
QList<SearchHit> hits(int start, int end) const;
QList<QHelpSearchQuery> query() const;
public Q_SLOTS:
void reindexDocumentation();
void cancelIndexing();
void search(const QList<QHelpSearchQuery> &queryList);
void cancelSearching();
Q_SIGNALS:
void indexingStarted();
void indexingFinished();
void searchingStarted();
void searchingFinished(int hits);
private Q_SLOTS:
void indexDocumentation();
private:
QHelpSearchEnginePrivate *d;
};
QT_END_NAMESPACE
QT_END_HEADER
#endif // QHELPSEARCHENGINE_H
|
