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>

3 files changed, 112 insertions, 1 deletions

diff --git a/src/webengine/doc/qtwebengine.qdocconf b/src/webengine/doc/qtwebengine.qdocconf
index e5abeafd6..ad6898440 100644
--- a/src/webengine/doc/qtwebengine.qdocconf
+++ b/src/webengine/doc/qtwebengine.qdocconf
@@ -33,7 +33,7 @@ depends += qtcore qtgui qtquick qtquickcontrols qtdoc
 
 headerdirs  += . ../api
 sourcedirs  += . ../api
-exampledirs +=  ../../../examples/webengine
+exampledirs +=  ../../../examples/webengine .
 
 navigation.landingpage = "Qt WebEngine"
 navigation.qmltypespage = "Qt WebEngine QML Types"
diff --git a/src/webengine/doc/snippets/qtwebengine_webengineview_newviewrequested.qml b/src/webengine/doc/snippets/qtwebengine_webengineview_newviewrequested.qml
new file mode 100644
index 000000000..6c5497145
--- /dev/null
+++ b/src/webengine/doc/snippets/qtwebengine_webengineview_newviewrequested.qml
@@ -0,0 +1,74 @@
+/****************************************************************************
+**
+** Copyright (C) 2015 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the QtWebEngine module 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 Digia Plc and its Subsidiary(-ies) 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$
+**
+****************************************************************************/
+
+import QtQuick 2.0
+import QtQuick.Window 2.1
+import QtWebEngine 1.1
+
+//! [0]
+QtObject {
+    id: windowParent
+    // Create the initial browsing windows and open the startup page.
+    Component.onCompleted: {
+        var firstWindow = windowComponent.createObject(windowParent)
+        firstWindow.webView.loadHtml('<input type="button" value="Click!" onclick="window.open(&quot;http://qt.io&quot;)">')
+    }
+
+    property Component windowComponent: Window {
+        // Destroy on close to release the Window's QML resources.
+        // Because it was created with a parent, it won't be garbage-collected.
+        onClosing: destroy()
+        visible: true
+
+        property WebEngineView webView: webView_
+        WebEngineView {
+            id: webView_
+            anchors.fill: parent
+
+            // Handle the signal. Dynamically create the window and
+            // use its WebEngineView as the destination of our request.
+            onNewViewRequested: {
+                var newWindow = windowComponent.createObject(windowParent)
+                request.openIn(newWindow.webView)
+            }
+        }
+    }
+}
+//! [0]
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
+*/