[2] | 1 | /****************************************************************************
|
---|
| 2 | **
|
---|
| 3 | ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
|
---|
[561] | 4 | ** All rights reserved.
|
---|
| 5 | ** Contact: Nokia Corporation ([email protected])
|
---|
[2] | 6 | **
|
---|
| 7 | ** This file is part of the Qt Assistant of the Qt Toolkit.
|
---|
| 8 | **
|
---|
| 9 | ** $QT_BEGIN_LICENSE:LGPL$
|
---|
| 10 | ** Commercial Usage
|
---|
| 11 | ** Licensees holding valid Qt Commercial licenses may use this file in
|
---|
| 12 | ** accordance with the Qt Commercial License Agreement provided with the
|
---|
| 13 | ** Software or, alternatively, in accordance with the terms contained in
|
---|
| 14 | ** a written agreement between you and Nokia.
|
---|
| 15 | **
|
---|
| 16 | ** GNU Lesser General Public License Usage
|
---|
| 17 | ** Alternatively, this file may be used under the terms of the GNU Lesser
|
---|
| 18 | ** General Public License version 2.1 as published by the Free Software
|
---|
| 19 | ** Foundation and appearing in the file LICENSE.LGPL included in the
|
---|
| 20 | ** packaging of this file. Please review the following information to
|
---|
| 21 | ** ensure the GNU Lesser General Public License version 2.1 requirements
|
---|
| 22 | ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
|
---|
| 23 | **
|
---|
[561] | 24 | ** In addition, as a special exception, Nokia gives you certain additional
|
---|
| 25 | ** rights. These rights are described in the Nokia Qt LGPL Exception
|
---|
| 26 | ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
|
---|
[2] | 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 | **
|
---|
[561] | 36 | ** If you have questions regarding the use of this file, please contact
|
---|
| 37 | ** Nokia at [email protected].
|
---|
[2] | 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 |
|
---|
| 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 |
|
---|
| 78 | class QHELP_EXPORT QHelpSearchEngine : public QObject
|
---|
| 79 | {
|
---|
| 80 | Q_OBJECT
|
---|
| 81 |
|
---|
| 82 | public:
|
---|
| 83 | QHelpSearchEngine(QHelpEngineCore *helpEngine, QObject *parent = 0);
|
---|
| 84 | ~QHelpSearchEngine();
|
---|
| 85 |
|
---|
| 86 | QHelpSearchQueryWidget* queryWidget();
|
---|
| 87 | QHelpSearchResultWidget* resultWidget();
|
---|
| 88 |
|
---|
[561] | 89 | #ifdef QT_DEPRECATED
|
---|
| 90 | QT_DEPRECATED int hitsCount() const;
|
---|
| 91 | #endif
|
---|
| 92 | int hitCount() const;
|
---|
[2] | 93 |
|
---|
| 94 | typedef QPair<QString, QString> SearchHit;
|
---|
| 95 | QList<SearchHit> hits(int start, int end) const;
|
---|
| 96 |
|
---|
| 97 | QList<QHelpSearchQuery> query() const;
|
---|
| 98 |
|
---|
| 99 | public Q_SLOTS:
|
---|
| 100 | void reindexDocumentation();
|
---|
| 101 | void cancelIndexing();
|
---|
| 102 |
|
---|
| 103 | void search(const QList<QHelpSearchQuery> &queryList);
|
---|
| 104 | void cancelSearching();
|
---|
| 105 |
|
---|
| 106 | Q_SIGNALS:
|
---|
| 107 | void indexingStarted();
|
---|
| 108 | void indexingFinished();
|
---|
| 109 |
|
---|
| 110 | void searchingStarted();
|
---|
| 111 | void searchingFinished(int hits);
|
---|
| 112 |
|
---|
| 113 | private Q_SLOTS:
|
---|
| 114 | void indexDocumentation();
|
---|
| 115 |
|
---|
| 116 | private:
|
---|
| 117 | QHelpSearchEnginePrivate *d;
|
---|
| 118 | };
|
---|
| 119 |
|
---|
| 120 | QT_END_NAMESPACE
|
---|
| 121 |
|
---|
| 122 | QT_END_HEADER
|
---|
| 123 |
|
---|
| 124 | #endif // QHELPSEARCHENGINE_H
|
---|