summaryrefslogtreecommitdiffstats
path: root/src/webengine/doc/src/qquickwebengineview_lgpl.qdoc
diff options
context:
space:
mode:
authorSzabolcs David <davidsz@inf.u-szeged.hu>2014-12-01 04:34:04 -0800
committerJocelyn Turcotte <jocelyn.turcotte@digia.com>2015-01-23 12:10:54 +0100
commitfb612f3d2b181742730e18ca15c0944af0b743c5 (patch)
tree4706e39aca1d3e9908fba20c90a30dfffe3a4772 /src/webengine/doc/src/qquickwebengineview_lgpl.qdoc
parenta9cae7c25c67dfc21f63202a9fadba8ad20d24df (diff)
Move newViewRequested to the public API
This moves the API to public, with proper versioning, adds documentation and adjust the warning to also report an null parameter to openIn that would cause the load to fail. The experimental example code is copied from quicktestbrowser to quicknanobrowser. Change-Id: I23b06c7a5add0323d0540a783873584438d85ea8 Reviewed-by: Szabolcs David <davidsz@inf.u-szeged.hu> Reviewed-by: Andras Becsi <andras.becsi@theqtcompany.com>
Diffstat (limited to 'src/webengine/doc/src/qquickwebengineview_lgpl.qdoc')
-rw-r--r--src/webengine/doc/src/qquickwebengineview_lgpl.qdoc37
1 files changed, 37 insertions, 0 deletions
diff --git a/src/webengine/doc/src/qquickwebengineview_lgpl.qdoc b/src/webengine/doc/src/qquickwebengineview_lgpl.qdoc
index 379c45e1c..24341d745 100644
--- a/src/webengine/doc/src/qquickwebengineview_lgpl.qdoc
+++ b/src/webengine/doc/src/qquickwebengineview_lgpl.qdoc
@@ -258,6 +258,26 @@
*/
/*!
+ \qmlsignal WebEngineView::newViewRequested(request)
+
+ This signal is emitted when a page load is requested to happen in a separate
+ WebEngineView. This can either be because the current page requested it explicitly
+ through a JavaScript call to window.open, or because the user clicked on a link
+ while holding Shift, Ctrl or a built-in combination that triggers the page to open
+ in a new window.
+
+ If this signal isn't handled the requested load will fail.
+
+ An example implementation:
+
+ \snippet snippets/qtwebengine_webengineview_newviewrequested.qml 0
+
+ The corresponding handler is onNewViewRequested.
+
+ \sa WebEngineNewViewRequest, WebEngineView::NewViewDestination, {WebEngine Quick Nano Browser}
+*/
+
+/*!
\qmlproperty enumeration WebEngineView::ErrorDomain
This enumeration details various high-level error types.
@@ -328,3 +348,20 @@
\endtable
*/
+
+/*!
+ \qmlproperty enumeration WebEngineView::NewViewDestination
+
+ This enumeration details the format in which a new view request should be opened.
+
+ \value WebEngineView::NewViewInWindow
+ The page expects to be opened in a separate Window.
+ \value WebEngineView::NewViewInTab
+ The page expects to be opened in a tab of the same window.
+ \value WebEngineView::NewViewInDialog
+ The page expects to be opened in a Window without any tab, tool or URL bar.
+ \value WebEngineView::NewViewInBackgroundTab
+ The page expects to be opened in a tab of the same window, without hiding the currently visible WebEngineView.
+
+ \sa WebEngineNewViewRequest::destination
+*/