~neon/qt/qttools

« back to all changes in this revision

Viewing changes to src/assistant/assistant/helpbrowsersupport.h

  • Committer: Friedemann Kleint
  • Date: 2014-12-09 11:07:11 UTC
  • Revision ID: git-v1:dd45163e883d9db55ce0361db81b96a0c0f97bd7
Assistant: Factor out web browser support.

Task-number: QTBUG-41130
Change-Id: Ia1d29b6eaa56e0f9eb569326e05f4c56411db6a7
Reviewed-by: Christian Kandeler <christian.kandeler@theqtcompany.com>

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
/****************************************************************************
 
2
**
 
3
** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
 
4
** Contact: http://www.qt-project.org/legal
 
5
**
 
6
** This file is part of the Qt Assistant of the Qt Toolkit.
 
7
**
 
8
** $QT_BEGIN_LICENSE:LGPL21$
 
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 Digia. For licensing terms and
 
14
** conditions see http://qt.digia.com/licensing. For further information
 
15
** use the contact form at http://qt.digia.com/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 2.1 or version 3 as published by the Free
 
20
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
 
21
** LICENSE.LGPLv3 included in the packaging of this file. Please review the
 
22
** following information to ensure the GNU Lesser General Public License
 
23
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
 
24
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
 
25
**
 
26
** In addition, as a special exception, Digia gives you certain additional
 
27
** rights. These rights are described in the Digia Qt LGPL Exception
 
28
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
 
29
**
 
30
** $QT_END_LICENSE$
 
31
**
 
32
****************************************************************************/
 
33
 
 
34
#ifndef HELPBROWSERSUPPORT_H
 
35
#define HELPBROWSERSUPPORT_H
 
36
 
 
37
#include <QtCore/QtGlobal>
 
38
 
 
39
QT_BEGIN_NAMESPACE
 
40
 
 
41
class QNetworkAccessManager;
 
42
class QObject;
 
43
class QString;
 
44
class QByteArray;
 
45
class QUrl;
 
46
 
 
47
// Provide helper functions for feeding the QtHelp data stored in the help database
 
48
// into various browsers.
 
49
class HelpBrowserSupport
 
50
{
 
51
public:
 
52
    enum ResolveUrlResult {
 
53
        UrlRedirect,
 
54
        UrlLocalData,
 
55
        UrlResolveError
 
56
    };
 
57
 
 
58
    static QString msgError404();
 
59
    static QString msgPageNotFound();
 
60
    static QString msgAllDocumentationSets();
 
61
    static QString msgLoadError(const QUrl &url);
 
62
    static QString msgHtmlErrorPage(const QUrl &url);
 
63
 
 
64
    static ResolveUrlResult resolveUrl(const QUrl &url, QUrl *targetUrl,
 
65
                                       QByteArray *data);
 
66
    static QByteArray fileDataForLocalUrl(const QUrl &url);
 
67
 
 
68
    // Create an instance of QNetworkAccessManager for WebKit-type browsers.
 
69
    static QNetworkAccessManager *createNetworkAccessManager(QObject *parent = 0);
 
70
};
 
71
 
 
72
QT_END_NAMESPACE
 
73
 
 
74
#endif // HELPBROWSERSUPPORT_H