Add focusOnNavigationEnabled setting

The focusOnNavigationEnabled setting allows changing the behavior of
whether a WebEngine view (widget or quick) will automatically get
focus, whenever a navigation action happens (load, reload, previous
history entry, etc).
The default behavior before this patch was to always grab the focus.

[ChangeLog][QtWebEngine][General] Add focusOnNavigationEnabled setting
which allows controlling whether a web view will receive focus on a
navigation request. Previously the view always received the focus.

Task-number: QTBUG-52999
Change-Id: I6d30d973a41b53011131f21dcecbf6ec4d652759
Reviewed-by: Kai Koehne <kai.koehne@qt.io>

14 files changed, 69 insertions, 11 deletions

diff --git a/src/core/web_contents_adapter.cpp b/src/core/web_contents_adapter.cpp
index b0aae6ca9..a7799544b 100644
--- a/src/core/web_contents_adapter.cpp
+++ b/src/core/web_contents_adapter.cpp
@@ -470,21 +470,21 @@ void WebContentsAdapter::stop()
         controller.RemoveEntryAtIndex(index);
 
     d->webContents->Stop();
-    d->webContents->Focus();
+    focusIfNecessary();
 }
 
 void WebContentsAdapter::reload()
 {
     Q_D(WebContentsAdapter);
     d->webContents->GetController().Reload(/*checkRepost = */false);
-    d->webContents->Focus();
+    focusIfNecessary();
 }
 
 void WebContentsAdapter::reloadAndBypassCache()
 {
     Q_D(WebContentsAdapter);
     d->webContents->GetController().ReloadBypassingCache(/*checkRepost = */false);
-    d->webContents->Focus();
+    focusIfNecessary();
 }
 
 void WebContentsAdapter::load(const QUrl &url)
@@ -507,7 +507,7 @@ void WebContentsAdapter::load(const QUrl &url)
     params.transition_type = ui::PageTransitionFromInt(ui::PAGE_TRANSITION_TYPED | ui::PAGE_TRANSITION_FROM_ADDRESS_BAR);
     params.override_user_agent = content::NavigationController::UA_OVERRIDE_TRUE;
     d->webContents->GetController().LoadURLWithParams(params);
-    d->webContents->Focus();
+    focusIfNecessary();
 }
 
 void WebContentsAdapter::setContent(const QByteArray &data, const QString &mimeType, const QUrl &baseUrl)
@@ -532,7 +532,7 @@ void WebContentsAdapter::setContent(const QByteArray &data, const QString &mimeT
     params.transition_type = ui::PageTransitionFromInt(ui::PAGE_TRANSITION_TYPED | ui::PAGE_TRANSITION_FROM_API);
     params.override_user_agent = content::NavigationController::UA_OVERRIDE_TRUE;
     d->webContents->GetController().LoadURLWithParams(params);
-    d->webContents->Focus();
+    focusIfNecessary();
     d->webContents->Unselect();
 }
 
@@ -646,14 +646,14 @@ void WebContentsAdapter::navigateToIndex(int offset)
 {
     Q_D(WebContentsAdapter);
     d->webContents->GetController().GoToIndex(offset);
-    d->webContents->Focus();
+    focusIfNecessary();
 }
 
 void WebContentsAdapter::navigateToOffset(int offset)
 {
     Q_D(WebContentsAdapter);
     d->webContents->GetController().GoToOffset(offset);
-    d->webContents->Focus();
+    focusIfNecessary();
 }
 
 int WebContentsAdapter::navigationEntryCount()
@@ -1246,6 +1246,15 @@ void WebContentsAdapter::replaceMisspelling(const QString &word)
 #endif
 }
 
+void WebContentsAdapter::focusIfNecessary()
+{
+    Q_D(WebContentsAdapter);
+    const WebEngineSettings *settings = d->adapterClient->webEngineSettings();
+    bool focusOnNavigation = settings->testAttribute(WebEngineSettings::FocusOnNavigationEnabled);
+    if (focusOnNavigation)
+        d->webContents->Focus();
+}
+
 WebContentsAdapterClient::RenderProcessTerminationStatus
 WebContentsAdapterClient::renderProcessExitStatus(int terminationStatus) {
     auto status = WebContentsAdapterClient::RenderProcessTerminationStatus(-1);
diff --git a/src/core/web_contents_adapter.h b/src/core/web_contents_adapter.h
index a29778a7e..08f68e76b 100644
--- a/src/core/web_contents_adapter.h
+++ b/src/core/web_contents_adapter.h
@@ -180,6 +180,8 @@ public:
 
     void viewSource();
     bool canViewSource();
+    void focusIfNecessary();
+
 
 private:
     Q_DISABLE_COPY(WebContentsAdapter)
diff --git a/src/core/web_engine_settings.cpp b/src/core/web_engine_settings.cpp
index 6c17c3ce9..a706b860e 100644
--- a/src/core/web_engine_settings.cpp
+++ b/src/core/web_engine_settings.cpp
@@ -237,6 +237,7 @@ void WebEngineSettings::initDefaults(bool offTheRecord)
         s_defaultAttributes.insert(Accelerated2dCanvasEnabled, accelerated2dCanvas);
         s_defaultAttributes.insert(AutoLoadIconsForPage, true);
         s_defaultAttributes.insert(TouchIconsEnabled, false);
+        s_defaultAttributes.insert(FocusOnNavigationEnabled, true);
     }
     if (offTheRecord)
         m_attributes.insert(LocalStorageEnabled, false);
diff --git a/src/core/web_engine_settings.h b/src/core/web_engine_settings.h
index e21eee8a9..55e659b53 100644
--- a/src/core/web_engine_settings.h
+++ b/src/core/web_engine_settings.h
@@ -79,7 +79,8 @@ public:
         WebGLEnabled,
         Accelerated2dCanvasEnabled,
         AutoLoadIconsForPage,
-        TouchIconsEnabled
+        TouchIconsEnabled,
+        FocusOnNavigationEnabled
     };
 
     // Must match the values from the public API in qwebenginesettings.h.
diff --git a/src/webengine/api/qquickwebenginesettings.cpp b/src/webengine/api/qquickwebenginesettings.cpp
index 3fea83166..a69db0554 100644
--- a/src/webengine/api/qquickwebenginesettings.cpp
+++ b/src/webengine/api/qquickwebenginesettings.cpp
@@ -304,6 +304,20 @@ bool QQuickWebEngineSettings::touchIconsEnabled() const
 }
 
 /*!
+  \qmlproperty bool WebEngineSettings::focusOnNavigationEnabled
+  \since QtWebEngine 1.4
+
+  Focus is given to the view whenever a navigation operation occurs
+  (load, stop, reload, reload and bypass cache, forward, backward, set content, and so on).
+
+  Enabled by default.
+*/
+bool QQuickWebEngineSettings::focusOnNavigationEnabled() const
+{
+    return d_ptr->testAttribute(WebEngineSettings::FocusOnNavigationEnabled);
+}
+
+/*!
     \qmlproperty QString WebEngineSettings::defaultTextEncoding
     \since QtWebEngine 1.2
 
@@ -472,6 +486,14 @@ void QQuickWebEngineSettings::setDefaultTextEncoding(QString encoding)
         Q_EMIT defaultTextEncodingChanged();
 }
 
+void QQuickWebEngineSettings::setFocusOnNavigationEnabled(bool on)
+{
+    bool wasOn = d_ptr->testAttribute(WebEngineSettings::FocusOnNavigationEnabled);
+    d_ptr->setAttribute(WebEngineSettings::FocusOnNavigationEnabled, on);
+    if (wasOn != on)
+        Q_EMIT focusOnNavigationEnabledChanged();
+}
+
 void QQuickWebEngineSettings::setParentSettings(QQuickWebEngineSettings *parentSettings)
 {
     d_ptr->setParentSettings(parentSettings->d_ptr.data());
diff --git a/src/webengine/api/qquickwebenginesettings_p.h b/src/webengine/api/qquickwebenginesettings_p.h
index 584027260..2675630f8 100644
--- a/src/webengine/api/qquickwebenginesettings_p.h
+++ b/src/webengine/api/qquickwebenginesettings_p.h
@@ -82,6 +82,7 @@ class Q_WEBENGINE_PRIVATE_EXPORT QQuickWebEngineSettings : public QObject {
     Q_PROPERTY(bool accelerated2dCanvasEnabled READ accelerated2dCanvasEnabled WRITE setAccelerated2dCanvasEnabled NOTIFY accelerated2dCanvasEnabledChanged REVISION 2)
     Q_PROPERTY(bool autoLoadIconsForPage READ autoLoadIconsForPage WRITE setAutoLoadIconsForPage NOTIFY autoLoadIconsForPageChanged REVISION 2)
     Q_PROPERTY(bool touchIconsEnabled READ touchIconsEnabled WRITE setTouchIconsEnabled NOTIFY touchIconsEnabledChanged REVISION 2)
+    Q_PROPERTY(bool focusOnNavigationEnabled READ focusOnNavigationEnabled WRITE setFocusOnNavigationEnabled NOTIFY focusOnNavigationEnabledChanged REVISION 3)
 
 public:
     ~QQuickWebEngineSettings();
@@ -105,6 +106,7 @@ public:
     bool accelerated2dCanvasEnabled() const;
     bool autoLoadIconsForPage() const;
     bool touchIconsEnabled() const;
+    bool focusOnNavigationEnabled() const;
 
     void setAutoLoadImages(bool on);
     void setJavascriptEnabled(bool on);
@@ -125,6 +127,7 @@ public:
     void setAccelerated2dCanvasEnabled(bool on);
     void setAutoLoadIconsForPage(bool on);
     void setTouchIconsEnabled(bool on);
+    void setFocusOnNavigationEnabled(bool on);
 
 signals:
     void autoLoadImagesChanged();
@@ -146,6 +149,7 @@ signals:
     Q_REVISION(2) void accelerated2dCanvasEnabledChanged();
     Q_REVISION(2) void autoLoadIconsForPageChanged();
     Q_REVISION(2) void touchIconsEnabledChanged();
+    Q_REVISION(3) void focusOnNavigationEnabledChanged();
 
 private:
     explicit QQuickWebEngineSettings(QQuickWebEngineSettings *parentSettings = 0);
diff --git a/src/webengine/api/qquickwebengineview_p_p.h b/src/webengine/api/qquickwebengineview_p_p.h
index 66952ca6e..98efb822c 100644
--- a/src/webengine/api/qquickwebengineview_p_p.h
+++ b/src/webengine/api/qquickwebengineview_p_p.h
@@ -226,6 +226,7 @@ public:
     bool m_fullscreenMode;
     bool isLoading;
     bool m_activeFocusOnPress;
+    bool m_navigationActionTriggered;
     qreal devicePixelRatio;
     QMap<quint64, QJSValue> m_callbacks;
     QList<QSharedPointer<CertificateErrorController> > m_certificateErrorControllers;
diff --git a/src/webengine/doc/src/webengineview.qdoc b/src/webengine/doc/src/webengineview.qdoc
index 6fd9ba45b..938545d79 100644
--- a/src/webengine/doc/src/webengineview.qdoc
+++ b/src/webengine/doc/src/webengineview.qdoc
@@ -82,7 +82,11 @@
     described by \l FindFlags.
 
     The \l setActiveFocusOnPress() method can be used to create a UI element that should not get
-    focus. This can be useful in a hybrid UI.
+    focus on press. This can be useful in a hybrid UI.
+
+    The \l {WebEngineSettings::focusOnNavigationEnabled} {focusOnNavigationEnabled} setting can be
+    used to stop the view from automatically receiving focus when a navigation operation occurs
+    (like loading or reloading a page or navigating through history).
 
     The \l linkHovered() signal is emitted when a mouse pointer passes over a link and thus
     corresponds to the \c{mouseover} DOM event.
@@ -481,7 +485,7 @@
     a web engine view can be used to create a UI element that should not get focus. This can be
     useful in a hybrid UI.
 
-    \sa activeFocusOnPressChanged()
+    \sa activeFocusOnPressChanged, WebEngineSettings::focusOnNavigationEnabled
 */
 
 /*!
diff --git a/src/webengine/plugin/plugin.cpp b/src/webengine/plugin/plugin.cpp
index 2f7d2c2c4..5c33086c0 100644
--- a/src/webengine/plugin/plugin.cpp
+++ b/src/webengine/plugin/plugin.cpp
@@ -100,6 +100,7 @@ public:
         qmlRegisterUncreatableType<QQuickWebEngineSettings>(uri, 1, 1, "WebEngineSettings", tr("Cannot create a separate instance of WebEngineSettings"));
         qmlRegisterUncreatableType<QQuickWebEngineSettings, 1>(uri, 1, 2, "WebEngineSettings", tr("Cannot create a separate instance of WebEngineSettings"));
         qmlRegisterUncreatableType<QQuickWebEngineSettings, 2>(uri, 1, 3, "WebEngineSettings", tr("Cannot create a separate instance of WebEngineSettings"));
+        qmlRegisterUncreatableType<QQuickWebEngineSettings, 3>(uri, 1, 4, "WebEngineSettings", tr("Cannot create a separate instance of WebEngineSettings"));
         qmlRegisterSingletonType<QQuickWebEngineSingleton>(uri, 1, 1, "WebEngine", webEngineSingletonProvider);
         qmlRegisterUncreatableType<QQuickWebEngineHistory>(uri, 1, 1, "NavigationHistory",
             tr("Cannot create a separate instance of NavigationHistory"));
diff --git a/src/webenginewidgets/api/qwebenginepage_p.h b/src/webenginewidgets/api/qwebenginepage_p.h
index 03883bb44..8d2a86350 100644
--- a/src/webenginewidgets/api/qwebenginepage_p.h
+++ b/src/webenginewidgets/api/qwebenginepage_p.h
@@ -174,6 +174,7 @@ public:
     QWebChannel *webChannel;
     unsigned int webChannelWorldId;
     QUrl iconUrl;
+    bool m_navigationActionTriggered;
 
     mutable QtWebEngineCore::CallbackDirectory m_callbacks;
     mutable QAction *actions[QWebEnginePage::WebActionCount];
diff --git a/src/webenginewidgets/api/qwebenginesettings.cpp b/src/webenginewidgets/api/qwebenginesettings.cpp
index dfca16287..dbc6a0e9b 100644
--- a/src/webenginewidgets/api/qwebenginesettings.cpp
+++ b/src/webenginewidgets/api/qwebenginesettings.cpp
@@ -89,6 +89,8 @@ static WebEngineSettings::Attribute toWebEngineAttribute(QWebEngineSettings::Web
         return WebEngineSettings::AutoLoadIconsForPage;
     case QWebEngineSettings::TouchIconsEnabled:
         return WebEngineSettings::TouchIconsEnabled;
+    case QWebEngineSettings::FocusOnNavigationEnabled:
+        return WebEngineSettings::FocusOnNavigationEnabled;
     default:
         return WebEngineSettings::UnsupportedInCoreSettings;
     }
diff --git a/src/webenginewidgets/api/qwebenginesettings.h b/src/webenginewidgets/api/qwebenginesettings.h
index 8eda50ee2..fb7fcfee5 100644
--- a/src/webenginewidgets/api/qwebenginesettings.h
+++ b/src/webenginewidgets/api/qwebenginesettings.h
@@ -85,7 +85,8 @@ public:
         WebGLEnabled,
         Accelerated2dCanvasEnabled,
         AutoLoadIconsForPage,
-        TouchIconsEnabled
+        TouchIconsEnabled,
+        FocusOnNavigationEnabled
     };
 
     enum FontSize {
diff --git a/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc b/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc
index a0dc49d0a..560d4a2e4 100644
--- a/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc
+++ b/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc
@@ -87,6 +87,10 @@
     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.
+
+    The \l {QWebEngineSettings::FocusOnNavigationEnabled} {FocusOnNavigationEnabled} setting can be
+    used to stop the view associated with the page from automatically receiving focus when a
+    navigation operation occurs (like loading or reloading a page or navigating through history).
 */
 
 /*!
diff --git a/src/webenginewidgets/doc/src/qwebenginesettings_lgpl.qdoc b/src/webenginewidgets/doc/src/qwebenginesettings_lgpl.qdoc
index 558aa1f50..5bea28f55 100644
--- a/src/webenginewidgets/doc/src/qwebenginesettings_lgpl.qdoc
+++ b/src/webenginewidgets/doc/src/qwebenginesettings_lgpl.qdoc
@@ -146,6 +146,11 @@
     \value  TouchIconsEnabled
             Enables support for touch icons and precomposed touch icons
             Disabled by default. (Added in Qt 5.7)
+    \value  FocusOnNavigationEnabled
+            Gives focus to the view associated with the page, whenever a navigation operation occurs
+            (load, stop, reload, reload and bypass cache, forward, backward, set content, and so
+            on).
+            Enabled by default. (Added in Qt 5.8)
 */
 
 /*!