diff options
author | Kirill Burtsev <kirill.burtsev@qt.io> | 2021-02-19 20:38:07 +0100 |
---|---|---|
committer | Kirill Burtsev <kirill.burtsev@qt.io> | 2021-06-04 19:05:00 +0200 |
commit | 7a57358683ee3a04c15d55b6475594aa81febf6f (patch) | |
tree | ca7c4f47606de2970fb14462e347ebfca33f77f7 /src/webenginequick/doc/src/loading_info.qdoc | |
parent | b3909c2d860a53e85eea51e77ee40ed8adf60842 (diff) |
Rename WebEngineLoadRequest to WebEngineLoadingInfo
Rename it, since it's not a real request (in a sense that there is
nothing to accept or reject), and it is also emitted on loading start
and failure.
[ChangeLog][QWebEngineQuick] WebEngineLoadRequest is renamed to
WebEngineLoadingInfo
Change-Id: I75b25da456eb4507451014070525a6a8e9d6753d
Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>
Diffstat (limited to 'src/webenginequick/doc/src/loading_info.qdoc')
-rw-r--r-- | src/webenginequick/doc/src/loading_info.qdoc | 89 |
1 files changed, 89 insertions, 0 deletions
diff --git a/src/webenginequick/doc/src/loading_info.qdoc b/src/webenginequick/doc/src/loading_info.qdoc new file mode 100644 index 000000000..9666b2020 --- /dev/null +++ b/src/webenginequick/doc/src/loading_info.qdoc @@ -0,0 +1,89 @@ +/**************************************************************************** +** +** Copyright (C) 2021 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: https://www.gnu.org/licenses/fdl-1.3.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \qmltype WebEngineLoadingInfo + \instantiates QWebEngineLoadingInfo + \inqmlmodule QtWebEngine + \since QtWebEngine 1.0 + + \brief A utility type for the WebEngineView::loadingChanged signal. + + Contains information about a request for loading a web page, such as the URL and + current loading status (started, succeeded, failed). + + \sa WebEngineView::loadingChanged +*/ +/*! + \qmlproperty url WebEngineLoadingInfo::url + \brief Holds the URL of the load request. + */ +/*! + \qmlproperty enumeration WebEngineLoadingInfo::status + + This enumeration represents the load status of a web page load request: + + \value WebEngineView.LoadStartedStatus Page is currently loading. + \value WebEngineView.LoadStoppedStatus + Loading the page was stopped by the stop() method or by the loader + code or network stack in Chromium. + \value WebEngineView.LoadSucceededStatus + Page has been loaded with success. + \value WebEngineView.LoadFailedStatus Page could not be loaded. + + \sa WebEngineView::loadingChanged +*/ +/*! + \qmlproperty Indicates if the load's resulted in an error page. +*/ +/*! + \qmlproperty string WebEngineLoadingInfo::errorString + \brief Holds the error message. +*/ +/*! + \qmlproperty enumeration WebEngineLoadingInfo::errorDomain + This enumeration holds the type of a load request error: + + \value WebEngineLoadingInfo.NoErrorDomain + Error type is not known. + \value WebEngineLoadingInfo.InternalErrorDomain + Content cannot be interpreted by \QWE. + \value WebEngineLoadingInfo.ConnectionErrorDomain + Error results from a faulty network connection. + \value WebEngineLoadingInfo.CertificateErrorDomain + Error is related to the SSL/TLS certificate. + \value WebEngineLoadingInfo.HttpErrorDomain + Error is related to the HTTP connection. + \value WebEngineLoadingInfo.FtpErrorDomain + Error is related to the FTP connection. + \value WebEngineLoadingInfo.DnsErrorDomain + Error is related to the DNS connection. +*/ +/*! + \qmlproperty int WebEngineLoadingInfo::errorCode + \brief Holds the error code. +*/ |