diff options
author | Allan Sandfeld Jensen <allan.jensen@qt.io> | 2021-05-28 12:31:28 +0200 |
---|---|---|
committer | Allan Sandfeld Jensen <allan.jensen@qt.io> | 2021-06-04 01:54:46 +0200 |
commit | 227279bf2f22c740f3f2fdc34f1032d4177dc32a (patch) | |
tree | 76b69a5b72a12dffd95948dde232ac5f7f55cf96 /src | |
parent | a806467ff37414dc52b5a15a351bde5505afac6e (diff) |
Move QQuickWebEngineNavigationRequest to Core
Adds navigationRequested() to QWebEnginePage and exposes more
information about navigation requests than the old
acceptNavigationRequest() method.
Change-Id: Ibb8d750bacd1060c3086ffe2c85336abd216bab0
Reviewed-by: Kirill Burtsev <kirill.burtsev@qt.io>
Diffstat (limited to 'src')
-rw-r--r-- | src/core/api/CMakeLists.txt | 1 | ||||
-rw-r--r-- | src/core/api/qwebenginenavigationrequest.cpp (renamed from src/webenginequick/api/qquickwebenginenavigationrequest.cpp) | 87 | ||||
-rw-r--r-- | src/core/api/qwebenginenavigationrequest.h (renamed from src/webenginequick/api/qquickwebenginenavigationrequest_p.h) | 69 | ||||
-rw-r--r-- | src/core/api/qwebenginepage.cpp | 19 | ||||
-rw-r--r-- | src/core/api/qwebenginepage.h | 3 | ||||
-rw-r--r-- | src/webenginequick/CMakeLists.txt | 1 | ||||
-rw-r--r-- | src/webenginequick/api/qquickwebengineview.cpp | 4 | ||||
-rw-r--r-- | src/webenginequick/api/qquickwebengineview_p.h | 27 | ||||
-rw-r--r-- | src/webenginequick/plugin/plugin.cpp | 4 |
9 files changed, 128 insertions, 87 deletions
diff --git a/src/core/api/CMakeLists.txt b/src/core/api/CMakeLists.txt index 4074bdb51..f320cc803 100644 --- a/src/core/api/CMakeLists.txt +++ b/src/core/api/CMakeLists.txt @@ -26,6 +26,7 @@ qt_internal_add_module(WebEngineCore qwebenginehttprequest.cpp qwebenginehttprequest.h qwebengineloadrequest.cpp qwebengineloadrequest.h qwebenginemessagepumpscheduler.cpp qwebenginemessagepumpscheduler_p.h + qwebenginenavigationrequest.cpp qwebenginenavigationrequest.h qwebenginenewwindowrequest.cpp qwebenginenewwindowrequest.h qwebenginenotification.cpp qwebenginenotification.h qwebenginepage.cpp qwebenginepage.h qwebenginepage_p.h diff --git a/src/webenginequick/api/qquickwebenginenavigationrequest.cpp b/src/core/api/qwebenginenavigationrequest.cpp index 03c1d3d78..dac68bd72 100644 --- a/src/webenginequick/api/qquickwebenginenavigationrequest.cpp +++ b/src/core/api/qwebenginenavigationrequest.cpp @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2016 The Qt Company Ltd. +** Copyright (C) 2021 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the QtWebEngine module of the Qt Toolkit. @@ -37,35 +37,48 @@ ** ****************************************************************************/ -#include "qquickwebenginenavigationrequest_p.h" +#include "qwebenginenavigationrequest.h" -#include "qquickwebengineview_p.h" +#include "qwebenginepage.h" QT_BEGIN_NAMESPACE -class QQuickWebEngineNavigationRequestPrivate { +class QWebEngineNavigationRequestPrivate { public: - QQuickWebEngineNavigationRequestPrivate(const QUrl& url, QQuickWebEngineView::NavigationType navigationType, bool mainFrame) + QWebEngineNavigationRequestPrivate(const QUrl& url, QWebEngineNavigationRequest::NavigationType navigationType, bool mainFrame) : url(url) - , action(QQuickWebEngineView::AcceptRequest) + , action(QWebEngineNavigationRequest::AcceptRequest) , navigationType(navigationType) , isMainFrame(mainFrame) - { - } - - ~QQuickWebEngineNavigationRequestPrivate() - { - } + {} QUrl url; - QQuickWebEngineView::NavigationRequestAction action; - QQuickWebEngineView::NavigationType navigationType; + QWebEngineNavigationRequest::NavigationRequestAction action; + QWebEngineNavigationRequest::NavigationType navigationType; bool isMainFrame; }; /*! + \class QWebEngineNavigationRequest + \brief A utility type for the QWebEnginePage::navigationRequested signal. + \since 6.2 + + \inmodule QtWebEngineCore + + Contains information about a navigation request. + + To accept or reject a request, set \l action to + \c QWebEngineNavigationRequest::AcceptRequest or + \c QWebEngineNavigationRequest::IgnoreRequest. + + The default if not handled is to accept the navigation. + + \sa QWebEnginePage::navigationRequested +*/ + +/*! \qmltype WebEngineNavigationRequest - \instantiates QQuickWebEngineNavigationRequest + \instantiates QWebEngineNavigationRequest \inqmlmodule QtWebEngine \since QtWebEngine 1.0 @@ -77,17 +90,23 @@ public: \c WebEngineNavigationRequest.IgnoreRequest. */ -QQuickWebEngineNavigationRequest::QQuickWebEngineNavigationRequest(const QUrl& url, QQuickWebEngineView::NavigationType navigationType, bool mainFrame, QObject* parent) +/*! \internal +*/ +QWebEngineNavigationRequest::QWebEngineNavigationRequest(const QUrl& url, QWebEngineNavigationRequest::NavigationType navigationType, bool mainFrame, QObject* parent) : QObject(parent) - , d_ptr(new QQuickWebEngineNavigationRequestPrivate(url, navigationType, mainFrame)) + , d_ptr(new QWebEngineNavigationRequestPrivate(url, navigationType, mainFrame)) { } -QQuickWebEngineNavigationRequest::~QQuickWebEngineNavigationRequest() +QWebEngineNavigationRequest::~QWebEngineNavigationRequest() { } /*! + \property QWebEngineNavigationRequest::action + \brief Whether to accept or ignore the navigation request. +*/ +/*! \qmlproperty enumeration WebEngineNavigationRequest::action Whether to accept or ignore the navigation request. @@ -98,9 +117,9 @@ QQuickWebEngineNavigationRequest::~QQuickWebEngineNavigationRequest() Ignores a navigation request. */ -void QQuickWebEngineNavigationRequest::setAction(QQuickWebEngineView::NavigationRequestAction action) +void QWebEngineNavigationRequest::setAction(QWebEngineNavigationRequest::NavigationRequestAction action) { - Q_D(QQuickWebEngineNavigationRequest); + Q_D(QWebEngineNavigationRequest); if (d->action == action) return; @@ -109,25 +128,33 @@ void QQuickWebEngineNavigationRequest::setAction(QQuickWebEngineView::Navigation } /*! + \property QWebEngineNavigationRequest::url + \brief The URL of the web page to go to. +*/ +/*! \qmlproperty url WebEngineNavigationRequest::url \readonly The URL of the web page to go to. */ -QUrl QQuickWebEngineNavigationRequest::url() const +QUrl QWebEngineNavigationRequest::url() const { - Q_D(const QQuickWebEngineNavigationRequest); + Q_D(const QWebEngineNavigationRequest); return d->url; } -QQuickWebEngineView::NavigationRequestAction QQuickWebEngineNavigationRequest::action() const +QWebEngineNavigationRequest::NavigationRequestAction QWebEngineNavigationRequest::action() const { - Q_D(const QQuickWebEngineNavigationRequest); + Q_D(const QWebEngineNavigationRequest); return d->action; } /*! + \property QWebEngineNavigationRequest::navigationType + \brief The method used to navigate to a web page. +*/ +/*! \qmlproperty enumeration WebEngineNavigationRequest::navigationType \readonly @@ -149,22 +176,26 @@ QQuickWebEngineView::NavigationRequestAction QQuickWebEngineNavigationRequest::a Using some other method to go to a page. */ -QQuickWebEngineView::NavigationType QQuickWebEngineNavigationRequest::navigationType() const +QWebEngineNavigationRequest::NavigationType QWebEngineNavigationRequest::navigationType() const { - Q_D(const QQuickWebEngineNavigationRequest); + Q_D(const QWebEngineNavigationRequest); return d->navigationType; } /*! + \property QWebEngineNavigationRequest::isMainFrame + \brief Whether the navigation issue is requested for a top level page. +*/ +/*! \qmlproperty bool WebEngineNavigationRequest::isMainFrame \readonly Whether the navigation issue is requested for a top level page. */ -bool QQuickWebEngineNavigationRequest::isMainFrame() const +bool QWebEngineNavigationRequest::isMainFrame() const { - Q_D(const QQuickWebEngineNavigationRequest); + Q_D(const QWebEngineNavigationRequest); return d->isMainFrame; } diff --git a/src/webenginequick/api/qquickwebenginenavigationrequest_p.h b/src/core/api/qwebenginenavigationrequest.h index 55e3ca673..45ed4fe6d 100644 --- a/src/webenginequick/api/qquickwebenginenavigationrequest_p.h +++ b/src/core/api/qwebenginenavigationrequest.h @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2016 The Qt Company Ltd. +** Copyright (C) 2021 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the QtWebEngine module of the Qt Toolkit. @@ -37,57 +37,66 @@ ** ****************************************************************************/ -#ifndef QQUICKWEBENGINENAVIGATIONREQUEST_P_H -#define QQUICKWEBENGINENAVIGATIONREQUEST_P_H - -// -// W A R N I N G -// ------------- -// -// This file is not part of the Qt API. It exists purely as an -// implementation detail. This header file may change from version to -// version without notice, or even be removed. -// -// We mean it. -// - -#include "qquickwebengineview_p.h" +#ifndef QWEBENGINENAVIGATIONREQUEST_H +#define QWEBENGINENAVIGATIONREQUEST_H +#include <qtwebenginecoreglobal.h> #include <QtCore/QObject> #include <QtCore/QUrl> QT_BEGIN_NAMESPACE -class QQuickWebEngineNavigationRequestPrivate; +class QWebEngineNavigationRequestPrivate; -class Q_WEBENGINE_EXPORT QQuickWebEngineNavigationRequest : public QObject { +class Q_WEBENGINECORE_EXPORT QWebEngineNavigationRequest : public QObject +{ Q_OBJECT Q_PROPERTY(QUrl url READ url CONSTANT FINAL) Q_PROPERTY(bool isMainFrame READ isMainFrame CONSTANT FINAL) - Q_PROPERTY(QQuickWebEngineView::NavigationRequestAction action READ action WRITE setAction NOTIFY actionChanged FINAL) - Q_PROPERTY(QQuickWebEngineView::NavigationType navigationType READ navigationType CONSTANT FINAL) + Q_PROPERTY(NavigationRequestAction action READ action WRITE setAction NOTIFY actionChanged FINAL) + Q_PROPERTY(NavigationType navigationType READ navigationType CONSTANT FINAL) public: - QQuickWebEngineNavigationRequest(const QUrl& url, QQuickWebEngineView::NavigationType navigationType, bool mainFrame, QObject* parent = 0); - ~QQuickWebEngineNavigationRequest(); + ~QWebEngineNavigationRequest(); + + // must match WebContentsAdapterClient::NavigationRequestAction + enum NavigationRequestAction { + AcceptRequest, + IgnoreRequest = 0xFF + }; + Q_ENUM(NavigationRequestAction) + + // must match WebContentsAdapterClient::NavigationType + enum NavigationType { + LinkClickedNavigation, + TypedNavigation, + FormSubmittedNavigation, + BackForwardNavigation, + ReloadNavigation, + OtherNavigation, + RedirectNavigation, + }; + Q_ENUM(NavigationType) QUrl url() const; bool isMainFrame() const; - QQuickWebEngineView::NavigationRequestAction action() const; + NavigationType navigationType() const; + NavigationRequestAction action() const; - void setAction(QQuickWebEngineView::NavigationRequestAction action); - QQuickWebEngineView::NavigationType navigationType() const; + void setAction(NavigationRequestAction action); Q_SIGNALS: void actionChanged(); private: - Q_DECLARE_PRIVATE(QQuickWebEngineNavigationRequest) - QScopedPointer<QQuickWebEngineNavigationRequestPrivate> d_ptr; + QWebEngineNavigationRequest(const QUrl& url, NavigationType navigationType, bool mainFrame, QObject *parent = nullptr); + + Q_DECLARE_PRIVATE(QWebEngineNavigationRequest) + QScopedPointer<QWebEngineNavigationRequestPrivate> d_ptr; + friend class QWebEnginePagePrivate; + friend class QQuickWebEngineViewPrivate; }; QT_END_NAMESPACE -QML_DECLARE_TYPE(QQuickWebEngineNavigationRequest) - -#endif // QQUICKWEBENGINENAVIGATIONREQUEST_P_H +#endif // QWEBENGINENAVIGATIONREQUEST_H diff --git a/src/core/api/qwebenginepage.cpp b/src/core/api/qwebenginepage.cpp index f04a0943c..6e2b37514 100644 --- a/src/core/api/qwebenginepage.cpp +++ b/src/core/api/qwebenginepage.cpp @@ -53,6 +53,7 @@ #include "qwebenginefullscreenrequest.h" #include "qwebenginehistory.h" #include "qwebenginehistory_p.h" +#include "qwebenginenavigationrequest.h" #include "qwebenginenewwindowrequest.h" #include "qwebenginenotification.h" #include "qwebengineprofile.h" @@ -1563,10 +1564,28 @@ void QWebEnginePagePrivate::contextMenuRequested(QWebEngineContextMenuRequest *d view->contextMenuRequested(data); } +/*! + \fn void QWebEnginePage::navigationRequested(QWebEngineNavigationRequest &request) + \since 6.2 + + This signal is emitted on navigation together with the call the acceptNavigationRequest(). + It can be used to accept or ignore the request. The default is to accept. + + \sa acceptNavigationRequest() + +*/ + void QWebEnginePagePrivate::navigationRequested(int navigationType, const QUrl &url, int &navigationRequestAction, bool isMainFrame) { Q_Q(QWebEnginePage); + bool accepted = q->acceptNavigationRequest(url, static_cast<QWebEnginePage::NavigationType>(navigationType), isMainFrame); + if (accepted) { + QWebEngineNavigationRequest navigationRequest(url, static_cast<QWebEngineNavigationRequest::NavigationType>(navigationType), isMainFrame); + Q_EMIT q->navigationRequested(navigationRequest); + accepted = (navigationRequest.action() == QWebEngineNavigationRequest::AcceptRequest); + } + if (accepted && adapter->findTextHelper()->isFindTextInProgress()) adapter->findTextHelper()->stopFinding(); navigationRequestAction = accepted ? WebContentsAdapterClient::AcceptRequest : WebContentsAdapterClient::IgnoreRequest; diff --git a/src/core/api/qwebenginepage.h b/src/core/api/qwebenginepage.h index 94a78aa67..9b9e6a3d3 100644 --- a/src/core/api/qwebenginepage.h +++ b/src/core/api/qwebenginepage.h @@ -63,6 +63,7 @@ class QWebEngineClientCertificateSelection; class QWebEngineFindTextResult; class QWebEngineFullScreenRequest; class QWebEngineHistory; +class QWebEngineNavigationRequest; class QWebEngineNewWindowRequest; class QWebEnginePage; class QWebEnginePagePrivate; @@ -341,6 +342,7 @@ Q_SIGNALS: void renderProcessTerminated(RenderProcessTerminationStatus terminationStatus, int exitCode); void certificateError(const QWebEngineCertificateError &certificateError); + bool navigationRequested(QWebEngineNavigationRequest &request); void newWindowRequested(QWebEngineNewWindowRequest &request); // Ex-QWebFrame signals @@ -373,6 +375,7 @@ protected: virtual bool javaScriptPrompt(const QUrl &securityOrigin, const QString& msg, const QString& defaultValue, QString* result); virtual void javaScriptConsoleMessage(JavaScriptConsoleMessageLevel level, const QString& message, int lineNumber, const QString& sourceID); virtual bool acceptNavigationRequest(const QUrl &url, NavigationType type, bool isMainFrame); + private: Q_DISABLE_COPY(QWebEnginePage) Q_DECLARE_PRIVATE(QWebEnginePage) diff --git a/src/webenginequick/CMakeLists.txt b/src/webenginequick/CMakeLists.txt index 3dfa36dc0..f133c0a42 100644 --- a/src/webenginequick/CMakeLists.txt +++ b/src/webenginequick/CMakeLists.txt @@ -14,7 +14,6 @@ qt_internal_add_module(WebEngineQuick api/qquickwebenginefaviconprovider.cpp api/qquickwebenginefaviconprovider_p_p.h api/qquickwebenginehistory.cpp api/qquickwebenginehistory_p.h - api/qquickwebenginenavigationrequest.cpp api/qquickwebenginenavigationrequest_p.h api/qquickwebengineprofile.cpp api/qquickwebengineprofile.h api/qquickwebengineprofile_p.h api/qquickwebenginescriptcollection.cpp api/qquickwebenginescriptcollection.h api/qquickwebenginesettings.cpp api/qquickwebenginesettings_p.h diff --git a/src/webenginequick/api/qquickwebengineview.cpp b/src/webenginequick/api/qquickwebengineview.cpp index 4eaa5e28b..5524b8954 100644 --- a/src/webenginequick/api/qquickwebengineview.cpp +++ b/src/webenginequick/api/qquickwebengineview.cpp @@ -52,7 +52,6 @@ #include "qquickwebengineclientcertificateselection_p.h" #include "qquickwebenginedialogrequests_p.h" #include "qquickwebenginefaviconprovider_p_p.h" -#include "qquickwebenginenavigationrequest_p.h" #include "qquickwebengineprofile_p.h" #include "qquickwebenginesettings_p.h" #include "qquickwebenginetouchhandleprovider_p_p.h" @@ -60,6 +59,7 @@ #include "qwebenginefindtextresult.h" #include "qwebenginefullscreenrequest.h" #include "qwebengineloadrequest.h" +#include "qwebenginenavigationrequest.h" #include "qwebenginenewwindowrequest.h" #include "qwebenginequotarequest.h" #include "qwebenginescriptcollection.h" @@ -290,7 +290,7 @@ void QQuickWebEngineViewPrivate::contextMenuRequested(QWebEngineContextMenuReque void QQuickWebEngineViewPrivate::navigationRequested(int navigationType, const QUrl &url, int &navigationRequestAction, bool isMainFrame) { Q_Q(QQuickWebEngineView); - QQuickWebEngineNavigationRequest navigationRequest(url, static_cast<QQuickWebEngineView::NavigationType>(navigationType), isMainFrame); + QWebEngineNavigationRequest navigationRequest(url, static_cast<QWebEngineNavigationRequest::NavigationType>(navigationType), isMainFrame); Q_EMIT q->navigationRequested(&navigationRequest); navigationRequestAction = navigationRequest.action(); diff --git a/src/webenginequick/api/qquickwebengineview_p.h b/src/webenginequick/api/qquickwebengineview_p.h index 3d83035bd..ca3b5349e 100644 --- a/src/webenginequick/api/qquickwebengineview_p.h +++ b/src/webenginequick/api/qquickwebengineview_p.h @@ -74,8 +74,6 @@ class QQuickWebEngineFaviconProvider; class QQuickWebEngineFileDialogRequest; class QQuickWebEngineHistory; class QQuickWebEngineJavaScriptDialogRequest; -class QWebEngineLoadRequest; -class QQuickWebEngineNavigationRequest; class QQuickWebEngineSettings; class QQuickWebEngineTooltipRequest; class QQuickWebEngineFormValidationMessageRequest; @@ -84,6 +82,8 @@ class QWebEngineCertificateError; class QWebEngineContextMenuRequest; class QWebEngineFindTextResult; class QWebEngineFullScreenRequest; +class QWebEngineLoadRequest; +class QWebEngineNavigationRequest; class QWebEngineNewWindowRequest; class QWebEngineQuotaRequest; class QWebEngineRegisterProtocolHandlerRequest; @@ -151,27 +151,6 @@ public: QSizeF contentsSize() const; QPointF scrollPosition() const; - // must match WebContentsAdapterClient::NavigationRequestAction - enum NavigationRequestAction { - AcceptRequest, - // Make room in the valid range of the enum so - // we can expose extra actions. - IgnoreRequest = 0xFF - }; - Q_ENUM(NavigationRequestAction) - - // must match WebContentsAdapterClient::NavigationType - enum NavigationType { - LinkClickedNavigation, - TypedNavigation, - FormSubmittedNavigation, - BackForwardNavigation, - ReloadNavigation, - OtherNavigation, - RedirectNavigation, - }; - Q_ENUM(NavigationType) - enum LoadStatus { LoadStartedStatus, LoadStoppedStatus, @@ -524,7 +503,7 @@ Q_SIGNALS: void loadingChanged(const QWebEngineLoadRequest &loadRequest); void loadProgressChanged(); void linkHovered(const QUrl &hoveredUrl); - void navigationRequested(QQuickWebEngineNavigationRequest *request); + void navigationRequested(QWebEngineNavigationRequest *request); void javaScriptConsoleMessage(JavaScriptConsoleMessageLevel level, const QString &message, int lineNumber, const QString &sourceID); Q_REVISION(1,1) void certificateError(const QWebEngineCertificateError &error); Q_REVISION(1,1) void fullScreenRequested(const QWebEngineFullScreenRequest &request); diff --git a/src/webenginequick/plugin/plugin.cpp b/src/webenginequick/plugin/plugin.cpp index 1e54dbd2f..7865f9863 100644 --- a/src/webenginequick/plugin/plugin.cpp +++ b/src/webenginequick/plugin/plugin.cpp @@ -44,7 +44,6 @@ #include <QtWebEngineQuick/private/qquickwebenginedialogrequests_p.h> #include <QtWebEngineQuick/private/qquickwebenginehistory_p.h> #include <QtWebEngineQuick/private/qquickwebenginefaviconprovider_p_p.h> -#include <QtWebEngineQuick/private/qquickwebenginenavigationrequest_p.h> #include <QtWebEngineQuick/private/qquickwebenginesettings_p.h> #include <QtWebEngineQuick/private/qquickwebenginesingleton_p.h> #include <QtWebEngineQuick/private/qquickwebenginetouchhandleprovider_p_p.h> @@ -54,6 +53,7 @@ #include <QtWebEngineCore/qwebenginefindtextresult.h> #include <QtWebEngineCore/qwebenginefullscreenrequest.h> #include <QtWebEngineCore/qwebengineloadrequest.h> +#include <QtWebEngineCore/qwebenginenavigationrequest.h> #include <QtWebEngineCore/qwebenginenewwindowrequest.h> #include <QtWebEngineCore/qwebenginenotification.h> #include <QtWebEngineCore/qwebenginequotarequest.h> @@ -87,7 +87,7 @@ public: qmlRegisterType<QQuickWebEngineView>(uri, 1, 0, "WebEngineView"); qmlRegisterUncreatableType<QWebEngineLoadRequest>(uri, 1, 0, "WebEngineLoadRequest", msgUncreatableType("WebEngineLoadRequest")); - qmlRegisterUncreatableType<QQuickWebEngineNavigationRequest>(uri, 1, 0, "WebEngineNavigationRequest", msgUncreatableType("WebEngineNavigationRequest")); + qmlRegisterUncreatableType<QWebEngineNavigationRequest>(uri, 1, 0, "WebEngineNavigationRequest", msgUncreatableType("WebEngineNavigationRequest")); qmlRegisterType<QQuickWebEngineView, 1>(uri, 1, 1, "WebEngineView"); qmlRegisterType<QQuickWebEngineView, 2>(uri, 1, 2, "WebEngineView"); |