summaryrefslogtreecommitdiffstats
path: root/src/core/api/qwebengineloadinginfo.cpp
blob: a72117e9d31995aaee7133e0e2948c8bf649c730 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
// Copyright (C) 2021 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only

#include <qwebengineloadinginfo.h>

#include <web_engine_error.h>

QT_BEGIN_NAMESPACE

using LoadStatus = QWebEngineLoadingInfo::LoadStatus;
using ErrorDomain = QWebEngineLoadingInfo::ErrorDomain;

Q_STATIC_ASSERT(static_cast<int>(WebEngineError::NoErrorDomain) == static_cast<int>(ErrorDomain::NoErrorDomain));
Q_STATIC_ASSERT(static_cast<int>(WebEngineError::InternalErrorDomain) == static_cast<int>(ErrorDomain::InternalErrorDomain));
Q_STATIC_ASSERT(static_cast<int>(WebEngineError::ConnectionErrorDomain) == static_cast<int>(ErrorDomain::ConnectionErrorDomain));
Q_STATIC_ASSERT(static_cast<int>(WebEngineError::CertificateErrorDomain) == static_cast<int>(ErrorDomain::CertificateErrorDomain));
Q_STATIC_ASSERT(static_cast<int>(WebEngineError::HttpErrorDomain) == static_cast<int>(ErrorDomain::HttpErrorDomain));
Q_STATIC_ASSERT(static_cast<int>(WebEngineError::FtpErrorDomain) == static_cast<int>(ErrorDomain::FtpErrorDomain));
Q_STATIC_ASSERT(static_cast<int>(WebEngineError::DnsErrorDomain) == static_cast<int>(ErrorDomain::DnsErrorDomain));
Q_STATIC_ASSERT(static_cast<int>(WebEngineError::HttpStatusCodeDomain) == static_cast<int>(ErrorDomain::HttpStatusCodeDomain));

class QWebEngineLoadingInfo::QWebEngineLoadingInfoPrivate : public QSharedData {
public:
    QWebEngineLoadingInfoPrivate(const QUrl& url, LoadStatus status, bool isErrorPage,
                                 const QString& errorString, int errorCode, ErrorDomain errorDomain,
                                 const QMultiMap<QByteArray,QByteArray>& responseHeaders)
        : url(url)
        , status(status)
        , isErrorPage(isErrorPage)
        , errorString(errorString)
        , errorCode(errorCode)
        , errorDomain(errorDomain)
        , responseHeaders(responseHeaders)
    {
    }

    QUrl url;
    LoadStatus status;
    bool isErrorPage;
    QString errorString;
    int errorCode;
    ErrorDomain errorDomain;
    QMultiMap<QByteArray,QByteArray> responseHeaders;
};

/*!
    \class QWebEngineLoadingInfo
    \brief A utility type for the WebEngineView::loadingChanged signal.
    \inmodule QtWebEngineCore
    \since 6.2

    Contains information about a web page loading status change, such as the URL and
    current loading status (started, succeeded, stopped, failed).

    \sa QWebEnginePage::loadStarted, QWebEnginePage::loadFinished, WebEngineView::loadingChanged
*/
QWebEngineLoadingInfo::QWebEngineLoadingInfo(const QUrl& url, LoadStatus status, bool isErrorPage,
                                             const QString& errorString, int errorCode, ErrorDomain errorDomain,
                                             const QMultiMap<QByteArray,QByteArray>& responseHeaders)
    : d_ptr(new QWebEngineLoadingInfoPrivate(url, status, isErrorPage, errorString, errorCode, errorDomain,
                                             responseHeaders))
{
}

QWebEngineLoadingInfo::QWebEngineLoadingInfo(const QWebEngineLoadingInfo &other) = default;
QWebEngineLoadingInfo& QWebEngineLoadingInfo::operator=(const QWebEngineLoadingInfo &other) = default;
QWebEngineLoadingInfo::QWebEngineLoadingInfo(QWebEngineLoadingInfo &&other) = default;
QWebEngineLoadingInfo& QWebEngineLoadingInfo::operator=(QWebEngineLoadingInfo &&other) = default;

QWebEngineLoadingInfo::~QWebEngineLoadingInfo()
{
}
/*!
    \property QWebEngineLoadingInfo::url
    \brief Holds the URL of the load request.
*/
/*!
    Returns the URL of the load request.
*/
QUrl QWebEngineLoadingInfo::url() const
{
    Q_D(const QWebEngineLoadingInfo);
    return d->url;
}
/*!
    \enum QWebEngineLoadingInfo::LoadStatus

    This enumeration represents the load status of a web page load request:

    \value  LoadStartedStatus Page is currently loading.
    \value  LoadStoppedStatus
            Loading the page was stopped by the stop() method or by the loader
            code or network stack in Chromium.
    \value  LoadSucceededStatus Page has been loaded with success.
    \value  LoadFailedStatus Page could not be loaded.
*/
/*!
    \property QWebEngineLoadingInfo::status
    \brief The load status of the page.
*/
LoadStatus QWebEngineLoadingInfo::status() const
{
    Q_D(const QWebEngineLoadingInfo);
    return d->status;
}
/*!
    \property QWebEngineLoadingInfo::isErrorPage
    \brief Indicates if the load resulted in an error page.
*/
bool QWebEngineLoadingInfo::isErrorPage() const
{
    Q_D(const QWebEngineLoadingInfo);
    return d->isErrorPage;
}
/*!
    \property QWebEngineLoadingInfo::errorString
    \brief Holds the error message.
*/
QString QWebEngineLoadingInfo::errorString() const
{
    Q_D(const QWebEngineLoadingInfo);
    return d->errorString;
}
/*!
    \enum QWebEngineLoadingInfo::ErrorDomain
    This enumeration holds the type of a load error:

    \value  NoErrorDomain
            Error type is not known.
    \value  InternalErrorDomain
            Content cannot be interpreted by \QWE.
    \value  ConnectionErrorDomain
            Error results from a faulty network connection.
    \value  CertificateErrorDomain
            Error is related to the SSL/TLS certificate.
    \value  HttpErrorDomain
            Error is related to the HTTP connection.
    \value  FtpErrorDomain
            Error is related to the FTP connection.
    \value  DnsErrorDomain
            Error is related to the DNS connection.
    \value  HttpStatusCodeDomain
            Error is the HTTP response status code, even in case of success e.g. the server replied with status 200.
*/
/*
    \property QWebEngineLoadingInfo::errorDomain
    \brief Holds the error domain.
*/
ErrorDomain QWebEngineLoadingInfo::errorDomain() const
{
    Q_D(const QWebEngineLoadingInfo);
    return d->errorDomain;
}

/*!
    \property QWebEngineLoadingInfo::errorCode
    \brief Holds the error code.
*/
int QWebEngineLoadingInfo::errorCode() const
{
    Q_D(const QWebEngineLoadingInfo);
    return d->errorCode;
}

/*!
    \property QWebEngineLoadingInfo::responseHeaders
    \since 6.6
    \brief Holds the response headers when \c QWebEngineLoadingInfo::status()
           is equal to \c QWebEngineLoadingInfo::LoadSucceededStatus or
           \c QWebEngineLoadingInfo::LoadFailedStatus.
*/
QMultiMap<QByteArray,QByteArray> QWebEngineLoadingInfo::responseHeaders() const
{
    Q_D(const QWebEngineLoadingInfo);
    return d->responseHeaders;
}

QT_END_NAMESPACE

#include "moc_qwebengineloadinginfo.cpp"