| 1 | // Copyright (C) 2016 The Qt Company Ltd. |
|---|---|
| 2 | // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0 |
| 3 | |
| 4 | #ifndef HELPBROWSERSUPPORT_H |
| 5 | #define HELPBROWSERSUPPORT_H |
| 6 | |
| 7 | #include <QtCore/QtGlobal> |
| 8 | |
| 9 | QT_BEGIN_NAMESPACE |
| 10 | |
| 11 | class QNetworkAccessManager; |
| 12 | class QObject; |
| 13 | class QString; |
| 14 | class QByteArray; |
| 15 | class QUrl; |
| 16 | |
| 17 | // Provide helper functions for feeding the QtHelp data stored in the help database |
| 18 | // into various browsers. |
| 19 | class HelpBrowserSupport |
| 20 | { |
| 21 | public: |
| 22 | enum ResolveUrlResult { |
| 23 | UrlRedirect, |
| 24 | UrlLocalData, |
| 25 | UrlResolveError |
| 26 | }; |
| 27 | |
| 28 | static QString msgError404(); |
| 29 | static QString msgPageNotFound(); |
| 30 | static QString msgAllDocumentationSets(); |
| 31 | static QString msgLoadError(const QUrl &url); |
| 32 | static QString msgHtmlErrorPage(const QUrl &url); |
| 33 | |
| 34 | static ResolveUrlResult resolveUrl(const QUrl &url, QUrl *targetUrl, |
| 35 | QByteArray *data); |
| 36 | static QByteArray fileDataForLocalUrl(const QUrl &url); |
| 37 | |
| 38 | // Create an instance of QNetworkAccessManager for WebKit-type browsers. |
| 39 | static QNetworkAccessManager *createNetworkAccessManager(QObject *parent = nullptr); |
| 40 | }; |
| 41 | |
| 42 | QT_END_NAMESPACE |
| 43 | |
| 44 | #endif // HELPBROWSERSUPPORT_H |
| 45 |