Rename QWebEngineDownloadItem -> QWebEngineDownloadRequest

This fits better with other QWebEngine*Requests.

[ChangeLog] QWebEngineDownloadItem is now QWebEngineDownloadRequest,
also in qml.

Change-Id: I506e9fac746b4f23ac0936c2fbe1c7472f4fda36
Reviewed-by: Michael Brüning <michael.bruning@qt.io>

1 files changed, 178 insertions, 0 deletions

diff --git a/src/core/api/qwebenginedownloadrequest.h b/src/core/api/qwebenginedownloadrequest.h
new file mode 100644
index 000000000..38d43cf1f
--- /dev/null
+++ b/src/core/api/qwebenginedownloadrequest.h
@@ -0,0 +1,178 @@
+/****************************************************************************
+**
+** Copyright (C) 2020 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the QtWebEngine module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** 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 Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 3 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL3 included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 3 requirements
+** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 2.0 or (at your option) the GNU General
+** Public license version 3 or any later version approved by the KDE Free
+** Qt Foundation. The licenses are as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
+** included in the packaging of this file. Please review the following
+** information to ensure the GNU General Public License requirements will
+** be met: https://www.gnu.org/licenses/gpl-2.0.html and
+** https://www.gnu.org/licenses/gpl-3.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#ifndef QWEBENGINEDOWNLOADREQUEST_H
+#define QWEBENGINEDOWNLOADREQUEST_H
+
+#include <QtWebEngineCore/qtwebenginecoreglobal.h>
+
+#include <QtCore/qobject.h>
+#include <QtCore/QUrl>
+
+QT_BEGIN_NAMESPACE
+
+//TODO: class QWebEnginePage;
+class QWebEngineDownloadRequestPrivate;
+class QWebEngineProfilePrivate;
+
+class Q_WEBENGINECORE_EXPORT QWebEngineDownloadRequest : public QObject
+{
+    Q_OBJECT
+public:
+    Q_PROPERTY(quint32 id READ id CONSTANT FINAL)
+    Q_PROPERTY(DownloadState state READ state NOTIFY stateChanged FINAL)
+    Q_PROPERTY(SavePageFormat savePageFormat READ savePageFormat WRITE setSavePageFormat NOTIFY savePageFormatChanged FINAL)
+    Q_PROPERTY(qint64 totalBytes READ totalBytes NOTIFY totalBytesChanged FINAL)
+    Q_PROPERTY(qint64 receivedBytes READ receivedBytes NOTIFY receivedBytesChanged FINAL)
+    Q_PROPERTY(QString mimeType READ mimeType FINAL)
+    Q_PROPERTY(DownloadInterruptReason interruptReason READ interruptReason NOTIFY interruptReasonChanged FINAL)
+    Q_PROPERTY(QString interruptReasonString READ interruptReasonString NOTIFY interruptReasonChanged FINAL)
+    Q_PROPERTY(bool isFinished READ isFinished NOTIFY isFinishedChanged FINAL)
+    Q_PROPERTY(bool isPaused READ isPaused NOTIFY isPausedChanged FINAL)
+    Q_PROPERTY(bool isSavePageDownload READ isSavePageDownload CONSTANT FINAL)
+    //TODO: Q_PROPERTY(QQuickWebEngineView *view READ view CONSTANT REVISION 7 FINAL)
+    Q_PROPERTY(QUrl url READ url CONSTANT FINAL)
+    Q_PROPERTY(QString suggestedFileName READ suggestedFileName CONSTANT FINAL)
+    Q_PROPERTY(QString downloadDirectory READ downloadDirectory WRITE setDownloadDirectory NOTIFY downloadDirectoryChanged FINAL)
+    Q_PROPERTY(QString downloadFileName READ downloadFileName WRITE setDownloadFileName NOTIFY downloadFileNameChanged FINAL)
+
+    ~QWebEngineDownloadRequest();
+
+    enum DownloadState {
+        DownloadRequested,
+        DownloadInProgress,
+        DownloadCompleted,
+        DownloadCancelled,
+        DownloadInterrupted
+    };
+    Q_ENUM(DownloadState)
+
+    enum SavePageFormat {
+        UnknownSaveFormat = -1,
+        SingleHtmlSaveFormat,
+        CompleteHtmlSaveFormat,
+        MimeHtmlSaveFormat
+    };
+    Q_ENUM(SavePageFormat)
+
+    enum DownloadInterruptReason {
+        NoReason = 0,
+        FileFailed = 1,
+        FileAccessDenied = 2,
+        FileNoSpace = 3,
+        FileNameTooLong = 5,
+        FileTooLarge = 6,
+        FileVirusInfected = 7,
+        FileTransientError = 10,
+        FileBlocked = 11,
+        FileSecurityCheckFailed = 12,
+        FileTooShort = 13,
+        FileHashMismatch = 14,
+        NetworkFailed = 20,
+        NetworkTimeout = 21,
+        NetworkDisconnected = 22,
+        NetworkServerDown = 23,
+        NetworkInvalidRequest = 24,
+        ServerFailed = 30,
+        //ServerNoRange = 31,
+        ServerBadContent = 33,
+        ServerUnauthorized = 34,
+        ServerCertProblem = 35,
+        ServerForbidden = 36,
+        ServerUnreachable = 37,
+        UserCanceled = 40,
+        //UserShutdown = 41,
+        //Crash = 50
+    };
+    Q_ENUM(DownloadInterruptReason)
+
+    quint32 id() const;
+    DownloadState state() const;
+    qint64 totalBytes() const;
+    qint64 receivedBytes() const;
+    QUrl url() const;
+    QString mimeType() const;
+    bool isFinished() const;
+    bool isPaused() const;
+    SavePageFormat savePageFormat() const;
+    void setSavePageFormat(SavePageFormat format);
+    DownloadInterruptReason interruptReason() const;
+    QString interruptReasonString() const;
+    bool isSavePageDownload() const;
+    QString suggestedFileName() const;
+    QString downloadDirectory() const;
+    void setDownloadDirectory(const QString &directory);
+    QString downloadFileName() const;
+    void setDownloadFileName(const QString &fileName);
+
+    //TODO:
+    QObject *page() const;
+
+public Q_SLOTS:
+    void accept();
+    void cancel();
+    void pause();
+    void resume();
+
+Q_SIGNALS:
+    void stateChanged(QWebEngineDownloadRequest::DownloadState state);
+    //TODO: fix it for qml
+    void downloadProgress(qint64 bytesReceived, qint64 bytesTotal);
+    void savePageFormatChanged();
+    void receivedBytesChanged();
+    void totalBytesChanged();
+    void interruptReasonChanged();
+    void isFinishedChanged();
+    void isPausedChanged();
+    void downloadDirectoryChanged();
+    void downloadFileNameChanged();
+
+private:
+    Q_DISABLE_COPY(QWebEngineDownloadRequest)
+    Q_DECLARE_PRIVATE(QWebEngineDownloadRequest)
+
+    friend class QWebEngineProfilePrivate;
+    friend class QQuickWebEngineProfilePrivate;
+    QWebEngineDownloadRequest(QWebEngineDownloadRequestPrivate*, QObject *parent = Q_NULLPTR);
+    QScopedPointer<QWebEngineDownloadRequestPrivate> d_ptr;
+};
+
+QT_END_NAMESPACE
+
+#endif // QWEBENGINEDOWNLOADREQUEST_H