| 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:GPL-EXCEPT$ |
| 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 General Public License Usage |
| 18 | ** Alternatively, this file may be used under the terms of the GNU |
| 19 | ** General Public License version 3 as published by the Free Software |
| 20 | ** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT |
| 21 | ** included in the packaging of this file. Please review the following |
| 22 | ** information to ensure the GNU General Public License requirements will |
| 23 | ** be met: https://www.gnu.org/licenses/gpl-3.0.html. |
| 24 | ** |
| 25 | ** $QT_END_LICENSE$ |
| 26 | ** |
| 27 | ****************************************************************************/ |
| 28 | |
| 29 | #ifndef HELPBROWSERSUPPORT_H |
| 30 | #define HELPBROWSERSUPPORT_H |
| 31 | |
| 32 | #include <QtCore/QtGlobal> |
| 33 | |
| 34 | QT_BEGIN_NAMESPACE |
| 35 | |
| 36 | class QNetworkAccessManager; |
| 37 | class QObject; |
| 38 | class QString; |
| 39 | class QByteArray; |
| 40 | class QUrl; |
| 41 | |
| 42 | // Provide helper functions for feeding the QtHelp data stored in the help database |
| 43 | // into various browsers. |
| 44 | class HelpBrowserSupport |
| 45 | { |
| 46 | public: |
| 47 | enum ResolveUrlResult { |
| 48 | UrlRedirect, |
| 49 | UrlLocalData, |
| 50 | UrlResolveError |
| 51 | }; |
| 52 | |
| 53 | static QString msgError404(); |
| 54 | static QString msgPageNotFound(); |
| 55 | static QString msgAllDocumentationSets(); |
| 56 | static QString msgLoadError(const QUrl &url); |
| 57 | static QString msgHtmlErrorPage(const QUrl &url); |
| 58 | |
| 59 | static ResolveUrlResult resolveUrl(const QUrl &url, QUrl *targetUrl, |
| 60 | QByteArray *data); |
| 61 | static QByteArray fileDataForLocalUrl(const QUrl &url); |
| 62 | |
| 63 | // Create an instance of QNetworkAccessManager for WebKit-type browsers. |
| 64 | static QNetworkAccessManager *createNetworkAccessManager(QObject *parent = nullptr); |
| 65 | }; |
| 66 | |
| 67 | QT_END_NAMESPACE |
| 68 | |
| 69 | #endif // HELPBROWSERSUPPORT_H |
| 70 |