| 1 | /**************************************************************************** |
|---|---|
| 2 | ** |
| 3 | ** Copyright (C) 2016 The Qt Company Ltd. |
| 4 | ** Contact: https://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 https://www.qt.io/terms-conditions. For further |
| 15 | ** information use the contact form at https://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 3 as published by the Free Software |
| 20 | ** Foundation and appearing in the file LICENSE.LGPL3 included in the |
| 21 | ** packaging of this file. Please review the following information to |
| 22 | ** ensure the GNU Lesser General Public License version 3 requirements |
| 23 | ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. |
| 24 | ** |
| 25 | ** GNU General Public License Usage |
| 26 | ** Alternatively, this file may be used under the terms of the GNU |
| 27 | ** General Public License version 2.0 or (at your option) the GNU General |
| 28 | ** Public license version 3 or any later version approved by the KDE Free |
| 29 | ** Qt Foundation. The licenses are as published by the Free Software |
| 30 | ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 |
| 31 | ** included in the packaging of this file. Please review the following |
| 32 | ** information to ensure the GNU General Public License requirements will |
| 33 | ** be met: https://www.gnu.org/licenses/gpl-2.0.html and |
| 34 | ** https://www.gnu.org/licenses/gpl-3.0.html. |
| 35 | ** |
| 36 | ** $QT_END_LICENSE$ |
| 37 | ** |
| 38 | ****************************************************************************/ |
| 39 | |
| 40 | #ifndef QHELPENGINE_H |
| 41 | #define QHELPENGINE_H |
| 42 | |
| 43 | #include <QtHelp/qhelpenginecore.h> |
| 44 | |
| 45 | QT_BEGIN_NAMESPACE |
| 46 | |
| 47 | |
| 48 | class QHelpContentModel; |
| 49 | class QHelpContentWidget; |
| 50 | class QHelpIndexModel; |
| 51 | class QHelpIndexWidget; |
| 52 | class QHelpEnginePrivate; |
| 53 | class QHelpSearchEngine; |
| 54 | |
| 55 | class QHELP_EXPORT QHelpEngine : public QHelpEngineCore |
| 56 | { |
| 57 | Q_OBJECT |
| 58 | |
| 59 | public: |
| 60 | explicit QHelpEngine(const QString &collectionFile, QObject *parent = nullptr); |
| 61 | ~QHelpEngine(); |
| 62 | |
| 63 | QHelpContentModel *contentModel() const; |
| 64 | QHelpIndexModel *indexModel() const; |
| 65 | |
| 66 | QHelpContentWidget *contentWidget(); |
| 67 | QHelpIndexWidget *indexWidget(); |
| 68 | |
| 69 | QHelpSearchEngine *searchEngine(); |
| 70 | |
| 71 | private: |
| 72 | QHelpEnginePrivate *d; |
| 73 | |
| 74 | friend class HelpEngineWrapper; |
| 75 | }; |
| 76 | |
| 77 | QT_END_NAMESPACE |
| 78 | |
| 79 | #endif |
| 80 |