diff options
author | Michal Klocek <michal.klocek@qt.io> | 2020-08-06 10:37:45 +0200 |
---|---|---|
committer | Michal Klocek <michal.klocek@qt.io> | 2020-08-12 15:58:14 +0200 |
commit | 5189f03b0078567f6a0c1fa32780314cb7451102 (patch) | |
tree | a4f098a0fedb583e084ddae55928e487811a3760 /src/webengine | |
parent | 62eeabdcf58f3eb1c00ff2efd5bc05453dfb2bf8 (diff) |
Split docs in webengine qml
Move some qml type docs out of webengineview_lgpl,
these are separated types, moreover they do not belong
to initial lgpl import of webkit docs.
Change-Id: If90f68b8c0c163081a2d535645295e4e4ecf45f8
Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>
Diffstat (limited to 'src/webengine')
-rw-r--r-- | src/webengine/doc/src/fullscreen_request.qdoc | 82 | ||||
-rw-r--r-- | src/webengine/doc/src/quota_request.qdoc | 74 | ||||
-rw-r--r-- | src/webengine/doc/src/register_protocol_handler_request.qdoc | 66 | ||||
-rw-r--r-- | src/webengine/doc/src/webengineview_lgpl.qdoc | 141 |
4 files changed, 222 insertions, 141 deletions
diff --git a/src/webengine/doc/src/fullscreen_request.qdoc b/src/webengine/doc/src/fullscreen_request.qdoc new file mode 100644 index 000000000..230d62e50 --- /dev/null +++ b/src/webengine/doc/src/fullscreen_request.qdoc @@ -0,0 +1,82 @@ +/**************************************************************************** +** +** Copyright (C) 2020 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 FullScreenRequest + \instantiates QQuickWebEngineFullScreenRequest + \inqmlmodule QtWebEngine + \since QtWebEngine 1.1 + + \brief A utility type for the WebEngineView::fullScreenRequested() signal. + + \sa WebEngineView::fullScreenRequested() +*/ + +/*! + \qmlproperty url FullScreenRequest::origin + \readonly + The URL of the web page that issued the fullscreen request. +*/ + +/*! + \qmlproperty bool FullScreenRequest::toggleOn + \readonly + + Returns \c{true} if the application should toggle fullscreen mode on, \c{false} otherwise. + + \sa accept() +*/ + +/*! + \qmlmethod void FullScreenRequest::accept() + + Call this method to accept the fullscreen request. It sets the WebEngineView::isFullScreen + property to be equal to toggleOn. + + \qml + ApplicationWindow { + id: window + WebEngineView { + onFullScreenRequested: function(request) { + if (request.toggleOn) + window.showFullScreen() + else + window.showNormal() + request.accept() + } + } + } + \endqml + + \sa toggleOn +*/ + +/*! + \qmlmethod void FullScreenRequest::reject() + Rejects a fullscreen request. +*/ + diff --git a/src/webengine/doc/src/quota_request.qdoc b/src/webengine/doc/src/quota_request.qdoc new file mode 100644 index 000000000..ee64c0484 --- /dev/null +++ b/src/webengine/doc/src/quota_request.qdoc @@ -0,0 +1,74 @@ +/**************************************************************************** +** +** Copyright (C) 2020 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 QuotaRequest + \instantiates QWebEngineQuotaRequest + \inqmlmodule QtWebEngine + \since QtWebEngine 1.7 + + \brief A utility type for the WebEngineView::quotaRequested() signal. + + \sa WebEngineView::quotaRequested() +*/ + +/*! + \qmlproperty url QuotaRequest::origin + \readonly + + The URL of the web page that issued the quota request. +*/ + +/*! + \qmlproperty qint64 QuotaRequest::requestedSize + \readonly + + Contains the size of the requested disk space in bytes. +*/ + +/*! + \qmlmethod void QuotaRequest::accept() + + Accepts the quota request. + + \qml + WebEngineView { + onQuotaRequested: function(request) { + if (request.requestedSize <= 5 * 1024 * 1024) + request.accept(); + else + request.reject(); + } + } + \endqml +*/ + +/*! + \qmlmethod void QuotaRequest::reject() + Rejects the quota request. +*/ + diff --git a/src/webengine/doc/src/register_protocol_handler_request.qdoc b/src/webengine/doc/src/register_protocol_handler_request.qdoc new file mode 100644 index 000000000..b3ebcb31b --- /dev/null +++ b/src/webengine/doc/src/register_protocol_handler_request.qdoc @@ -0,0 +1,66 @@ +/**************************************************************************** +** +** Copyright (C) 2020 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 RegisterProtocolHandlerRequest + \instantiates QWebEngineRegisterProtocolHandlerRequest + \inqmlmodule QtWebEngine + \since QtWebEngine 1.7 + \brief The RegisterProtocolHandlerRequest type enables accepting + or rejecting requests from the \l registerProtocolHandler API. + + \sa WebEngineView::registerProtocolHandlerRequested() +*/ + +/*! + \qmlproperty url RegisterProtocolHandlerRequest::origin + \brief The URL template for the protocol handler. + + This is the second parameter from the \l registerProtocolHandler call. +*/ + +/*! + \qmlproperty string RegisterProtocolHandlerRequest::scheme + \brief The URL scheme for the protocol handler. + + This is the first parameter from the \l registerProtocolHandler call. +*/ + +/*! + \qmlmethod void RegisterProtocolHandlerRequest::accept() + \brief Accepts the request. + + Subsequent calls to accept() and reject() are ignored. +*/ + +/*! + \qmlmethod void RegisterProtocolHandlerRequest::reject() + \brief Accepts the request. + + Subsequent calls to accept() and reject() are ignored. +*/ + diff --git a/src/webengine/doc/src/webengineview_lgpl.qdoc b/src/webengine/doc/src/webengineview_lgpl.qdoc index 0cd8441cf..f55477fa2 100644 --- a/src/webengine/doc/src/webengineview_lgpl.qdoc +++ b/src/webengine/doc/src/webengineview_lgpl.qdoc @@ -1065,61 +1065,6 @@ */ /*! - \qmltype FullScreenRequest - \instantiates QQuickWebEngineFullScreenRequest - \inqmlmodule QtWebEngine - \since QtWebEngine 1.1 - - \brief A utility type for the WebEngineView::fullScreenRequested() signal. - - \sa WebEngineView::fullScreenRequested() -*/ - -/*! - \qmlproperty url FullScreenRequest::origin - \readonly - The URL of the web page that issued the fullscreen request. -*/ - -/*! - \qmlproperty bool FullScreenRequest::toggleOn - \readonly - - Returns \c{true} if the application should toggle fullscreen mode on, \c{false} otherwise. - - \sa accept() -*/ - -/*! - \qmlmethod void FullScreenRequest::accept() - - Call this method to accept the fullscreen request. It sets the WebEngineView::isFullScreen - property to be equal to toggleOn. - - \qml - ApplicationWindow { - id: window - WebEngineView { - onFullScreenRequested: function(request) { - if (request.toggleOn) - window.showFullScreen() - else - window.showNormal() - request.accept() - } - } - } - \endqml - - \sa toggleOn -*/ - -/*! - \qmlmethod void FullScreenRequest::reject() - Rejects a fullscreen request. -*/ - -/*! \qmlproperty bool WebEngineView::audioMuted \brief The state of whether the current page audio is muted. \since QtWebEngine 1.3 @@ -1332,53 +1277,6 @@ */ /*! - \qmltype QuotaRequest - \instantiates QWebEngineQuotaRequest - \inqmlmodule QtWebEngine - \since QtWebEngine 1.7 - - \brief A utility type for the WebEngineView::quotaRequested() signal. - - \sa WebEngineView::quotaRequested() -*/ - -/*! - \qmlproperty url QuotaRequest::origin - \readonly - - The URL of the web page that issued the quota request. -*/ - -/*! - \qmlproperty qint64 QuotaRequest::requestedSize - \readonly - - Contains the size of the requested disk space in bytes. -*/ - -/*! - \qmlmethod void QuotaRequest::accept() - - Accepts the quota request. - - \qml - WebEngineView { - onQuotaRequested: function(request) { - if (request.requestedSize <= 5 * 1024 * 1024) - request.accept(); - else - request.reject(); - } - } - \endqml -*/ - -/*! - \qmlmethod void QuotaRequest::reject() - Rejects the quota request. -*/ - -/*! \qmlsignal WebEngineView::registerProtocolHandlerRequested(RegisterProtocolHandlerRequest request) \since QtWebEngine 1.7 @@ -1389,45 +1287,6 @@ */ /*! - \qmltype RegisterProtocolHandlerRequest - \instantiates QWebEngineRegisterProtocolHandlerRequest - \inqmlmodule QtWebEngine - \since QtWebEngine 1.7 - \brief The RegisterProtocolHandlerRequest type enables accepting - or rejecting requests from the \l registerProtocolHandler API. - - \sa WebEngineView::registerProtocolHandlerRequested() -*/ - -/*! - \qmlproperty url RegisterProtocolHandlerRequest::origin - \brief The URL template for the protocol handler. - - This is the second parameter from the \l registerProtocolHandler call. -*/ - -/*! - \qmlproperty string RegisterProtocolHandlerRequest::scheme - \brief The URL scheme for the protocol handler. - - This is the first parameter from the \l registerProtocolHandler call. -*/ - -/*! - \qmlmethod void RegisterProtocolHandlerRequest::accept() - \brief Accepts the request. - - Subsequent calls to accept() and reject() are ignored. -*/ - -/*! - \qmlmethod void RegisterProtocolHandlerRequest::reject() - \brief Accepts the request. - - Subsequent calls to accept() and reject() are ignored. -*/ - -/*! \qmlsignal WebEngineView::geometryChangeRequested(rect geometry, rect frameGeometry) \since QtWebEngine 1.7 |