diff options
Diffstat (limited to 'src/webenginewidgets/doc')
8 files changed, 150 insertions, 79 deletions
diff --git a/src/webenginewidgets/doc/snippets/qtwebengine_qwebenginepage_snippet.cpp b/src/webenginewidgets/doc/snippets/qtwebengine_qwebenginepage_snippet.cpp index ba9aec8fe..b948fa597 100644 --- a/src/webenginewidgets/doc/snippets/qtwebengine_qwebenginepage_snippet.cpp +++ b/src/webenginewidgets/doc/snippets/qtwebengine_qwebenginepage_snippet.cpp @@ -1,7 +1,7 @@ /**************************************************************************** ** -** Copyright (C) 2015 The Qt Company Ltd. -** Contact: http://www.qt.io/licensing/ +** Copyright (C) 2016 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ ** ** This file is part of the documentation of the Qt Toolkit. ** @@ -11,8 +11,8 @@ ** 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 http://www.qt.io/terms-conditions. For further -** information use the contact form at http://www.qt.io/contact-us. +** 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 @@ -20,7 +20,7 @@ ** 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: http://www.gnu.org/copyleft/fdl.html. +** will be met: https://www.gnu.org/licenses/fdl-1.3.html. ** $QT_END_LICENSE$ ** ****************************************************************************/ diff --git a/src/webenginewidgets/doc/snippets/simple/main.cpp b/src/webenginewidgets/doc/snippets/simple/main.cpp index bebdeff11..666ef3f65 100644 --- a/src/webenginewidgets/doc/snippets/simple/main.cpp +++ b/src/webenginewidgets/doc/snippets/simple/main.cpp @@ -1,21 +1,42 @@ -/* - Copyright (C) 2014 Nokia Corporation and/or its subsidiary(-ies) - - This library is free software; you can redistribute it and/or - modify it under the terms of the GNU Library General Public - License as published by the Free Software Foundation; either - version 2 of the License, or (at your option) any later version. - - This library is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Library General Public License for more details. - - You should have received a copy of the GNU Library General Public License - along with this library; see the file COPYING.LIB. If not, write to - the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, - Boston, MA 02110-1301, USA. -*/ +/**************************************************************************** +** +** Copyright (C) 2016 The Qt Company Ltd. +** Contact: http://www.qt.io/licensing/ +** +** This file is part of the examples of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:BSD$ +** You may use this file under the terms of the BSD license as follows: +** +** "Redistribution and use in source and binary forms, with or without +** modification, are permitted provided that the following conditions are +** met: +** * Redistributions of source code must retain the above copyright +** notice, this list of conditions and the following disclaimer. +** * Redistributions in binary form must reproduce the above copyright +** notice, this list of conditions and the following disclaimer in +** the documentation and/or other materials provided with the +** distribution. +** * Neither the name of The Qt Company Ltd nor the names of its +** contributors may be used to endorse or promote products derived +** from this software without specific prior written permission. +** +** +** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." +** +** $QT_END_LICENSE$ +** +****************************************************************************/ #include <QApplication> #include <QUrl> diff --git a/src/webenginewidgets/doc/src/qtwebenginewidgets-index.qdoc b/src/webenginewidgets/doc/src/qtwebenginewidgets-index.qdoc index 77596a370..59d7bc5d1 100644 --- a/src/webenginewidgets/doc/src/qtwebenginewidgets-index.qdoc +++ b/src/webenginewidgets/doc/src/qtwebenginewidgets-index.qdoc @@ -1,7 +1,7 @@ /**************************************************************************** ** -** Copyright (C) 2015 The Qt Company Ltd. -** Contact: http://www.qt.io/licensing/ +** Copyright (C) 2016 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ ** ** This file is part of the documentation of the Qt Toolkit. ** @@ -11,8 +11,8 @@ ** 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 http://www.qt.io/terms-conditions. For further -** information use the contact form at http://www.qt.io/contact-us. +** 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 @@ -20,7 +20,7 @@ ** 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: http://www.gnu.org/copyleft/fdl.html. +** will be met: https://www.gnu.org/licenses/fdl-1.3.html. ** $QT_END_LICENSE$ ** ****************************************************************************/ diff --git a/src/webenginewidgets/doc/src/qtwebenginewidgets-module.qdoc b/src/webenginewidgets/doc/src/qtwebenginewidgets-module.qdoc index a9ef6ad8c..d0f2fd930 100644 --- a/src/webenginewidgets/doc/src/qtwebenginewidgets-module.qdoc +++ b/src/webenginewidgets/doc/src/qtwebenginewidgets-module.qdoc @@ -1,7 +1,7 @@ /**************************************************************************** ** -** Copyright (C) 2015 The Qt Company Ltd. -** Contact: http://www.qt.io/licensing/ +** Copyright (C) 2016 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ ** ** This file is part of the documentation of the Qt Toolkit. ** @@ -11,8 +11,8 @@ ** 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 http://www.qt.io/terms-conditions. For further -** information use the contact form at http://www.qt.io/contact-us. +** 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 @@ -20,7 +20,7 @@ ** 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: http://www.gnu.org/copyleft/fdl.html. +** will be met: https://www.gnu.org/licenses/fdl-1.3.html. ** $QT_END_LICENSE$ ** ****************************************************************************/ diff --git a/src/webenginewidgets/doc/src/qtwebkitportingguide.qdoc b/src/webenginewidgets/doc/src/qtwebkitportingguide.qdoc index 5822f41b7..7bc7ff48d 100644 --- a/src/webenginewidgets/doc/src/qtwebkitportingguide.qdoc +++ b/src/webenginewidgets/doc/src/qtwebkitportingguide.qdoc @@ -1,7 +1,7 @@ /**************************************************************************** ** -** Copyright (C) 2015 The Qt Company Ltd. -** Contact: http://www.qt.io/licensing/ +** Copyright (C) 2016 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ ** ** This file is part of the documentation of the Qt Toolkit. ** @@ -11,8 +11,8 @@ ** 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 http://www.qt.io/terms-conditions. For further -** information use the contact form at http://www.qt.io/contact-us. +** 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 @@ -20,7 +20,7 @@ ** 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: http://www.gnu.org/copyleft/fdl.html. +** will be met: https://www.gnu.org/licenses/fdl-1.3.html. ** $QT_END_LICENSE$ ** ****************************************************************************/ diff --git a/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc b/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc index 0900765fc..539e809d4 100644 --- a/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc +++ b/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc @@ -51,8 +51,9 @@ The title of an HTML page can be accessed with the title() property. Additionally, a page may also specify an icon, which can be accessed - using the iconUrl() property. If the title or the icon changes, the - corresponding titleChanged() and iconUrlChanged() signals will be emitted. + using the icon() or its URL using the iconUrl() property. + If the title or the icon changes, the corresponding titleChanged(), iconChanged() + and iconUrlChanged() signals will be emitted. The zoomFactor() property enables zooming the contents of the web page by a scale factor. @@ -78,6 +79,14 @@ security origin, and can access each other's resources. Local resources are by default restricted from accessing remote content, which means that \c file:// will not be able to access \c http://domain.com/foo.html. + + Scripts can be executed on the web page by using runJavaScript(), either in the main + JavaScript \e world, along with the rest of the JavaScript coming from the web contents, or in + their own isolated world. While the DOM of the page can be accessed from any world, JavaScript + variables of a function defined in one world are not accessible from a different one. + QWebEngineScript::ScriptWorldId provides some predefined IDs for this purpose. Using the + \c runJavaScript() version without the world ID is the same as running the script in the + \c MainWorld. */ /*! @@ -117,6 +126,7 @@ \value OpenLinkInThisWindow Open the current link in the current window. (Added in Qt 5.6) \value OpenLinkInNewWindow Open the current link in a new window. (Added in Qt 5.6) \value OpenLinkInNewTab Open the current link in a new tab. (Added in Qt 5.6) + \value OpenLinkInNewBackgroundTab Open the current link in a new background tab. (Added in Qt 5.7) \value CopyLinkToClipboard Copy the current link to the clipboard. (Added in Qt 5.6) \value CopyImageToClipboard Copy the clicked image to the clipboard. (Added in Qt 5.6) @@ -139,6 +149,9 @@ \value RequestClose Request to close the web page. If defined, the \c{window.onbeforeunload} handler is run, and the user can confirm or reject to close the page. If the close request is confirmed, \c windowCloseRequested is emitted. (Added in Qt 5.6) + \value Unselect Clear the current selection. (Added in Qt 5.7) + \value SavePage Save the current page to disk. MHTML is the default format that is used to store + the web page on disk. (Added in Qt 5.7) \omitvalue WebActionCount @@ -155,6 +168,8 @@ A web browser tab. \value WebDialog A window without decoration. + \value WebBrowserBackgroundTab + A web browser tab without hiding the current visible WebEngineView. (Added in Qt 5.7) */ /*! @@ -266,6 +281,9 @@ the user clicks on the web page with the right mouse button. It is called from the default \l{QWidget::}{contextMenuEvent()} handler. The popup menu's ownership is transferred to the caller. + + Returns \c nullptr if the context menu data is not initialized, for example when it + is called when there is actually no context menu requested. */ /*! @@ -396,14 +414,14 @@ \fn void QWebEnginePage::findText(const QString &subString, FindFlags options) Finds the specified string, \a subString, in the page, using the given \a options. - To clear the selection, just pass an empty string. + To clear the search highlight, just pass an empty string. */ /*! \fn void QWebEnginePage::findText(const QString &subString, FindFlags options, FunctorOrLambda resultCallback) Finds the specified string, \a subString, in the page, using the given \a options. - To clear the selection, just pass an empty string. + To clear the search highlight, just pass an empty string. The \a resultCallback must take a boolean parameter. It will be called with a value of \c true if the \a subString was found; otherwise the callback value will be \c false. @@ -558,13 +576,6 @@ */ /*! - \property QWebEnginePage::iconUrl - \brief the URL of the icon associated with the page currently viewed. - - \sa iconUrlChanged() -*/ - -/*! \property QWebEnginePage::requestedUrl \brief the URL that was originally requested to be loaded by the page that is currently viewed @@ -641,31 +652,61 @@ */ /*! + \fn void QWebEnginePage::runJavaScript(const QString& scriptSource, quint32 worldId, FunctorOrLambda resultCallback) + \since 5.7 + + Runs the JavaScript code contained in \a scriptSource in the world specified by \a worldId. + The world ID values are the same as provided by QWebEngineScript::ScriptWorldId. Using the + \e runJavaScript() versions without the world ID is the same as running the script in the + \c MainWorld. + + When the script has been executed, \a resultCallback is called with the result of the last + executed statement. \c resultCallback can be any of a function pointer, a functor or a lambda, + and it is expected to take a QVariant parameter. For example: + + \code + page.runJavaScript("document.title", [](const QVariant &v) { qDebug() << v.toString(); }); + \endcode + + \warning Do not execute lengthy routines in the callback function, because it might block the + rendering of the web engine page. + + See scripts() for an alternative API to inject scripts. + + \sa QWebEngineScript::ScriptWorldId +*/ + +/*! + \fn void QWebEnginePage::runJavaScript(const QString &scriptSource, quint32 worldId) + \since 5.7 + \overload runJavaScript() + + This convenience function runs the JavaScript code contained in \a scriptSource in the world + specified by \a worldId. +*/ + +/*! \fn void QWebEnginePage::runJavaScript(const QString& scriptSource) \overload runJavaScript() - This convenience function runs the JavaScript code contained in \a scriptSource. + This convenience function runs the JavaScript code contained in \a scriptSource in the same + world as other scripts that are part of the loaded site. + + \sa QWebEngineScript::MainWorld */ /*! \fn void QWebEnginePage::runJavaScript(const QString& scriptSource, FunctorOrLambda resultCallback) + \overload runJavaScript() Runs the JavaScript code contained in \a scriptSource. - The script will run in the same \e world as other scripts that are part of the loaded site. - - When the script has been executed, \a resultCallback is called with the result of the last executed statement. - \a resultCallback can be any of a function pointer, a functor or a lambda, and it is expected to take a - QVariant parameter. For example: + The script will run in the same world as other scripts that are part of the loaded site. - \code - page.runJavaScript("document.title", [](const QVariant &v) { qDebug() << v.toString(); }); - \endcode + When the script has been executed, \a resultCallback is called with the result of the last + executed statement. - \warning Do not execute lengthy routines in the callback function, because it might block the - rendering of the web engine page. - - See scripts() for an alternative API to inject scripts. + \sa QWebEngineScript::MainWorld */ /*! @@ -716,13 +757,3 @@ \sa url() */ - -/*! - \fn void QWebEnginePage::iconUrlChanged(const QUrl &url) - - This signal is emitted when the icon ("favicon") associated with the page is - found or changed. The new URL is specified by \a url. - - - \sa iconUrl() -*/ diff --git a/src/webenginewidgets/doc/src/qwebenginesettings_lgpl.qdoc b/src/webenginewidgets/doc/src/qwebenginesettings_lgpl.qdoc index fde034c6a..558aa1f50 100644 --- a/src/webenginewidgets/doc/src/qwebenginesettings_lgpl.qdoc +++ b/src/webenginewidgets/doc/src/qwebenginesettings_lgpl.qdoc @@ -66,6 +66,8 @@ \value SansSerifFont \value CursiveFont \value FantasyFont + \value PictographFont + (added in Qt 5.7) */ /*! @@ -132,6 +134,18 @@ See also \l{Pepper Plugin API}. (Added in Qt 5.6) \value FullScreenSupportEnabled Enables fullscreen support in an application. Disabled by default. (Added in Qt 5.6) + \value ScreenCaptureEnabled + Enables screen capture in an application. Disabled by default. (Added in Qt 5.7) + \value WebGLEnabled + Enables support for HTML 5 WebGL. Enabled by default if available. (Added in Qt 5.7) + \value Accelerated2dCanvasEnabled + Specifies whether the HTML5 2D canvas should be a OpenGL framebuffer. + This makes many painting operations faster, but slows down pixel access. Enabled by default if available. (Added in Qt 5.7) + \value AutoLoadIconsForPage + Automatically downloads icons for web pages. Enabled by default. (Added in Qt 5.7) + \value TouchIconsEnabled + Enables support for touch icons and precomposed touch icons + Disabled by default. (Added in Qt 5.7) */ /*! diff --git a/src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc b/src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc index d03d64a1c..5a4c1b52b 100644 --- a/src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc +++ b/src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc @@ -59,9 +59,11 @@ The title of an HTML document can be accessed with the title() property. Additionally, a web site may specify an icon, which can be accessed - using the iconUrl() property. If the title or the icon changes, the corresponding - titleChanged() and iconUrlChanged() signals will be emitted. The - zoomFactor() property enables zooming the contents of the web page by a scale factor. + using the icon() or its URL using the iconUrl() property. + If the title or the icon changes, the corresponding titleChanged(), iconChanged() + and iconUrlChanged() signals will be emitted. + The zoomFactor() property enables zooming the contents of the web page by a + scale factor. If you require a custom context menu, you can implement it by reimplementing \l{QWidget::}{contextMenuEvent()} and populating your QMenu with the actions @@ -189,9 +191,11 @@ /*! \property QWebEngineView::iconUrl - \brief the URL of the icon associated with the web page currently viewed + \brief the URL of the icon associated with the page currently viewed - \sa iconUrlChanged() + By default, this property contains an empty URL. + + \sa iconUrlChanged(), icon(), iconChanged() */ /*! @@ -331,9 +335,10 @@ /*! \fn void QWebEngineView::iconUrlChanged(const QUrl &url) - This signal is emitted whenever the icon \a url of the view changes. + This signal is emitted when the URL of the icon ("favicon") associated with the + view is changed. The new URL is specified by \a url. - \sa iconUrl() + \sa iconUrl(), icon(), iconChanged() */ /*! |