diff options
Diffstat (limited to 'src/core/api/qwebenginenewwindowrequest.cpp')
| -rw-r--r-- | src/core/api/qwebenginenewwindowrequest.cpp | 206 |
1 files changed, 206 insertions, 0 deletions
diff --git a/src/core/api/qwebenginenewwindowrequest.cpp b/src/core/api/qwebenginenewwindowrequest.cpp new file mode 100644 index 000000000..7ef7601d7 --- /dev/null +++ b/src/core/api/qwebenginenewwindowrequest.cpp @@ -0,0 +1,206 @@ +/**************************************************************************** +** +** 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 "qwebenginenewwindowrequest.h" + +#include "web_contents_adapter.h" + +QT_BEGIN_NAMESPACE + +struct QWebEngineNewWindowRequestPrivate +{ + QWebEngineNewWindowRequest::DestinationType destination; + QRect requestedGeometry; + QUrl requestedUrl; + QSharedPointer<QtWebEngineCore::WebContentsAdapter> adapter; + bool isUserInitiated; + bool isRequestHandled = false; +}; + +/*! + \class QWebEngineNewWindowRequest + \brief A utility type for the QWebEnginePage::newPageRequested signal. + \since 6.2 + + \inmodule QtWebEngineCore + + Contains information about a request to load a page in a separate web engine view. + + \sa QWebEnginePage::newPageRequested +*/ + +/*! + \qmltype WebEngineNewViewRequest + \instantiates QWebEngineNewWindowRequest + \inqmlmodule QtWebEngine + \since QtWebEngine 1.1 + + \brief A utility type for the WebEngineView::newViewRequested signal. + + Contains information about a request to load a page in a separate web engine view. + + \sa WebEngineView::newViewRequested +*/ + +/*! + \enum QWebEngineNewWindowRequest::DestinationType + + This enum describes the type of window requested: + + \value InNewWindow + In a separate window. + \value InNewTab + In a tab of the same window. + \value InNewDialog + In a window without a tab bar, toolbar, or URL bar. + \value InNewBackgroundTab + In a tab of the same window, without hiding the currently visible web engine view. +*/ + +/*! + \qmlproperty enumeration WebEngineNewViewRequest::DestinationType + + Describes how to open a new view: + + \value WebEngineNewViewRequest.InNewWindow + In a separate window. + \value WebEngineNewViewRequest.InNewTab + In a tab of the same window. + \value WebEngineNewViewRequest.InNewDialog + In a window without a tab bar, toolbar, or URL bar. + \value WebEngineNewViewRequest.InNewBackgroundTab + In a tab of the same window, without hiding the currently visible web engine view. +*/ + +QWebEngineNewWindowRequest::QWebEngineNewWindowRequest(QWebEngineNewWindowRequest::DestinationType destination, + const QRect &geometry, + const QUrl &url, + bool userInitiated, + QSharedPointer<QtWebEngineCore::WebContentsAdapter> adapter, + QObject *parent) + : QObject(parent) + , d_ptr(new QWebEngineNewWindowRequestPrivate{destination, geometry, url, adapter, userInitiated}) +{ +} + +QWebEngineNewWindowRequest::~QWebEngineNewWindowRequest() +{ +} + +/*! + \property QWebEngineNewWindowRequest::destination + \brief The type of window that is requested. +*/ +/*! + \qmlproperty WebEngineNewViewRequest::DestinationType WebEngineNewViewRequest::destination + \brief The type of window that is requested. +*/ +QWebEngineNewWindowRequest::DestinationType QWebEngineNewWindowRequest::destination() const +{ + return d_ptr->destination; +} + +/*! + \property QWebEngineNewWindowRequest::requestedUrl + \brief The URL that is requested for the new page. +*/ +/*! + \qmlproperty QUrl WebEngineNewViewRequest::requestedUrl + \brief The URL that is requested for the new page. + \since QtWebEngine 1.5 + */ +QUrl QWebEngineNewWindowRequest::requestedUrl() const +{ + return d_ptr->requestedUrl; +} + +/*! + \property QWebEngineNewWindowRequest::requestedGeometry + \brief The size that is requested for the new page. +*/ +/*! + \qmlproperty QRect WebEngineNewViewRequest::requestedGeometry + \brief The size that is requested for the new page. + \since QtWebEngine 2.0 + */ +QRect QWebEngineNewWindowRequest::requestedGeometry() const +{ + return d_ptr->requestedGeometry; +} + +/*! + \property QWebEngineNewWindowRequest::userInitiated + Whether this page request was directly triggered as the result of a keyboard or mouse event. + + You can use this property to block automatic \e popups. +*/ +/*! + \qmlproperty bool WebEngineNewViewRequest::userInitiated + Whether this window request was directly triggered as the result of a keyboard or mouse event. + + You can use this property to block automatic \e popups. + */ +bool QWebEngineNewWindowRequest::isUserInitiated() const +{ + return d_ptr->isUserInitiated; +} + +/*! \internal +*/ +QSharedPointer<QtWebEngineCore::WebContentsAdapter> QWebEngineNewWindowRequest::adapter() +{ + return d_ptr->adapter; +} + +/*! \internal +*/ +bool QWebEngineNewWindowRequest::isHandled() const +{ + return d_ptr->isRequestHandled; +} + +/*! \internal +*/ +void QWebEngineNewWindowRequest::setHandled() +{ + d_ptr->isRequestHandled = true; + d_ptr->adapter.reset(); +} + +QT_END_NAMESPACE |