From ef75047a6330b592ce14c7ff8d9b75ad11dc2460 Mon Sep 17 00:00:00 2001
From: Volker Hilsheimer <volker.hilsheimer@qt.io>
Date: Wed, 15 Jun 2022 12:32:23 +0200
Subject: [PATCH] Accessibility: don't emit focus change when reason is window
 activation
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

If a window becomes active, then the accessibility system gets informed
about that already. Qt puts focus on the focus child of the activated
window afterwards, and if this emits another accessibility event, then
accessibility clients like Windows Narrator will stop reading the
activated window, and instead read about the focused widget.

This makes dialogs like message boxes poorly accessible.

Accessibility clients already know that a window became active, and can
query Qt about the focused child within that window.

Amend test case.

Fixes: QTBUG-101585
Change-Id: I2d6bff7c415a6f29c4a4f7f4e4be38079fb976ca
Reviewed-by: Jan Arve Sæther <jan-arve.saether@qt.io>
(cherry picked from commit 79a11470f3c4c61951906223f97001a77ce36500)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
---
 src/widgets/kernel/qwidget.cpp                     | 14 +++++++++-----
 .../other/qaccessibility/tst_qaccessibility.cpp    | 10 ++++++++++
 2 files changed, 19 insertions(+), 5 deletions(-)

diff --git a/src/widgets/kernel/qwidget.cpp b/src/widgets/kernel/qwidget.cpp
index ebbb2dffb88..cf32ff6c93e 100644
--- a/src/widgets/kernel/qwidget.cpp
+++ b/src/widgets/kernel/qwidget.cpp
@@ -6513,11 +6513,15 @@ void QWidget::setFocus(Qt::FocusReason reason)
 
         QApplicationPrivate::setFocusWidget(f, reason);
 #if QT_CONFIG(accessibility)
-        // menus update the focus manually and this would create bogus events
-        if (!(f->inherits("QMenuBar") || f->inherits("QMenu") || f->inherits("QMenuItem")))
-        {
-            QAccessibleEvent event(f, QAccessible::Focus);
-            QAccessible::updateAccessibility(&event);
+        // If the widget gets focus because its window becomes active, then the accessibility
+        // subsystem is already informed about the window opening, and also knows which child
+        // within the window has focus. Don't interrupt it by emitting another focus event.
+        if (reason != Qt::ActiveWindowFocusReason) {
+            // menus update the focus manually and this would create bogus events
+            if (!(f->inherits("QMenuBar") || f->inherits("QMenu") || f->inherits("QMenuItem"))) {
+                QAccessibleEvent event(f, QAccessible::Focus);
+                QAccessible::updateAccessibility(&event);
+            }
         }
 #endif
 #if QT_CONFIG(graphicsview)
diff --git a/tests/auto/other/qaccessibility/tst_qaccessibility.cpp b/tests/auto/other/qaccessibility/tst_qaccessibility.cpp
index de0942ba085..fa9f2a58664 100644
--- a/tests/auto/other/qaccessibility/tst_qaccessibility.cpp
+++ b/tests/auto/other/qaccessibility/tst_qaccessibility.cpp
@@ -4288,10 +4288,20 @@ void tst_QAccessibility::messageBoxTest()
     if (!boxPrivate->canBeNativeDialog()) {
         // platforms that use a native message box will not emit accessibility events
         box.show();
+        QVERIFY(QTest::qWaitForWindowActive(&box));
 
         QAccessibleEvent showEvent(&box, QAccessible::DialogStart);
         QVERIFY(QTestAccessibility::containsEvent(&showEvent));
 
+        // on some platforms, like macOS, not all widgets get key board focus; we
+        // only care about a push button getting focus
+        if (QTest::qWaitFor([&box]{ return qobject_cast<QPushButton *>(box.focusWidget()); }, 1000)) {
+            // a widget that gets focus through window activation should not emit an accessibility
+            // notification
+            QAccessibleEvent focusEvent(box.focusWidget(), QAccessible::Focus);
+            QVERIFY(!QTestAccessibility::containsEvent(&focusEvent));
+        }
+
         box.hide();
 
         QAccessibleEvent hideEvent(&box, QAccessible::DialogEnd);