source: branches/vendor/trolltech/qt/current/tools/assistant/lib/qhelpsearchengine.h @ 2

Last change on this file since 2 was 2, checked in by Dmitry A. Kuminov, 13 years ago

Initially imported qt-all-opensource-src-4.5.1 from Trolltech.

File size: 3.5 KB
Line 
1/****************************************************************************
2**
3** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
4** Contact: Qt Software Information (qt-info@nokia.com)
5**
6** This file is part of the Qt Assistant of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial Usage
10** Licensees holding valid Qt Commercial licenses may use this file in
11** accordance with the Qt Commercial License Agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and Nokia.
14**
15** GNU Lesser General Public License Usage
16** Alternatively, this file may be used under the terms of the GNU Lesser
17** General Public License version 2.1 as published by the Free Software
18** Foundation and appearing in the file LICENSE.LGPL included in the
19** packaging of this file.  Please review the following information to
20** ensure the GNU Lesser General Public License version 2.1 requirements
21** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
22**
23** In addition, as a special exception, Nokia gives you certain
24** additional rights. These rights are described in the Nokia Qt LGPL
25** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this
26** package.
27**
28** GNU General Public License Usage
29** Alternatively, this file may be used under the terms of the GNU
30** General Public License version 3.0 as published by the Free Software
31** Foundation and appearing in the file LICENSE.GPL included in the
32** packaging of this file.  Please review the following information to
33** ensure the GNU General Public License version 3.0 requirements will be
34** met: http://www.gnu.org/copyleft/gpl.html.
35**
36** If you are unsure which license is appropriate for your use, please
37** contact the sales department at qt-sales@nokia.com.
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
53QT_BEGIN_HEADER
54
55QT_BEGIN_NAMESPACE
56
57QT_MODULE(Help)
58
59class QHelpEngineCore;
60class QHelpSearchQueryWidget;
61class QHelpSearchResultWidget;
62class QHelpSearchEnginePrivate;
63
64class QHELP_EXPORT QHelpSearchQuery
65{
66public:
67    enum FieldName { DEFAULT = 0, FUZZY, WITHOUT, PHRASE, ALL, ATLEAST };
68
69    QHelpSearchQuery()
70        : fieldName(DEFAULT) { wordList.clear(); }
71    QHelpSearchQuery(FieldName field, const QStringList &wordList)
72        : fieldName(field), wordList(wordList) {}
73
74    FieldName fieldName;
75    QStringList wordList;
76};
77
78class QHELP_EXPORT QHelpSearchEngine : public QObject
79{
80    Q_OBJECT
81
82public:
83    QHelpSearchEngine(QHelpEngineCore *helpEngine, QObject *parent = 0);
84    ~QHelpSearchEngine();
85
86    QHelpSearchQueryWidget* queryWidget();
87    QHelpSearchResultWidget* resultWidget();
88
89    int hitsCount() const;
90
91    typedef QPair<QString, QString> SearchHit;
92    QList<SearchHit> hits(int start, int end) const;
93
94    QList<QHelpSearchQuery> query() const;
95
96public Q_SLOTS:
97    void reindexDocumentation();
98    void cancelIndexing();
99
100    void search(const QList<QHelpSearchQuery> &queryList);
101    void cancelSearching();
102
103Q_SIGNALS:
104    void indexingStarted();
105    void indexingFinished();
106
107    void searchingStarted();
108    void searchingFinished(int hits);
109
110private Q_SLOTS:
111    void indexDocumentation();
112
113private:
114    QHelpSearchEnginePrivate *d;
115};
116
117QT_END_NAMESPACE
118
119QT_END_HEADER
120
121#endif  // QHELPSEARCHENGINE_H
Note: See TracBrowser for help on using the repository browser.