diff options
Diffstat (limited to 'src/core/api/qwebenginenavigationrequest.cpp')
| -rw-r--r-- | src/core/api/qwebenginenavigationrequest.cpp | 202 |
1 files changed, 202 insertions, 0 deletions
diff --git a/src/core/api/qwebenginenavigationrequest.cpp b/src/core/api/qwebenginenavigationrequest.cpp new file mode 100644 index 000000000..dac68bd72 --- /dev/null +++ b/src/core/api/qwebenginenavigationrequest.cpp @@ -0,0 +1,202 @@ +/**************************************************************************** +** +** 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. +** +** $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$ +** +****************************************************************************/ + +#include "qwebenginenavigationrequest.h" + +#include "qwebenginepage.h" + +QT_BEGIN_NAMESPACE + +class QWebEngineNavigationRequestPrivate { +public: + QWebEngineNavigationRequestPrivate(const QUrl& url, QWebEngineNavigationRequest::NavigationType navigationType, bool mainFrame) + : url(url) + , action(QWebEngineNavigationRequest::AcceptRequest) + , navigationType(navigationType) + , isMainFrame(mainFrame) + {} + + QUrl url; + 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 QWebEngineNavigationRequest + \inqmlmodule QtWebEngine + \since QtWebEngine 1.0 + + \brief Represents a request for navigating to a web page as part of + \l{WebEngineView::navigationRequested()}. + + To accept or reject a request, set \l action to + \c WebEngineNavigationRequest.AcceptRequest or + \c WebEngineNavigationRequest.IgnoreRequest. +*/ + +/*! \internal +*/ +QWebEngineNavigationRequest::QWebEngineNavigationRequest(const QUrl& url, QWebEngineNavigationRequest::NavigationType navigationType, bool mainFrame, QObject* parent) + : QObject(parent) + , d_ptr(new QWebEngineNavigationRequestPrivate(url, navigationType, mainFrame)) +{ +} + +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. + + \value WebEngineNavigationRequest.AcceptRequest + Accepts a navigation request. + \value WebEngineNavigationRequest.IgnoreRequest + Ignores a navigation request. +*/ + +void QWebEngineNavigationRequest::setAction(QWebEngineNavigationRequest::NavigationRequestAction action) +{ + Q_D(QWebEngineNavigationRequest); + if (d->action == action) + return; + + d->action = action; + emit actionChanged(); +} + +/*! + \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 QWebEngineNavigationRequest::url() const +{ + Q_D(const QWebEngineNavigationRequest); + return d->url; +} + +QWebEngineNavigationRequest::NavigationRequestAction QWebEngineNavigationRequest::action() const +{ + 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 + + The method used to navigate to a web page. + + \value WebEngineNavigationRequest.LinkClickedNavigation + Clicking a link. + \value WebEngineNavigationRequest.TypedNavigation + Entering an URL on the address bar. + \value WebEngineNavigationRequest.FormSubmittedNavigation + Submitting a form. + \value WebEngineNavigationRequest.BackForwardNavigation + Using navigation history to go to the previous or next page. + \value WebEngineNavigationRequest.ReloadNavigation + Reloading the page. + \value WebEngineNavigationRequest.RedirectNavigation + Page content or server triggered a redirection or page refresh. + \value WebEngineNavigationRequest.OtherNavigation + Using some other method to go to a page. +*/ + +QWebEngineNavigationRequest::NavigationType QWebEngineNavigationRequest::navigationType() const +{ + 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 QWebEngineNavigationRequest::isMainFrame() const +{ + Q_D(const QWebEngineNavigationRequest); + return d->isMainFrame; +} + +QT_END_NAMESPACE |