QMenu: hide when a QWidgetAction fires the trigged signal

QMenu hides regularly when the user interacts with it, and manages
the firing of signals based on that. It ignores if a QAction that is
added to it fires the triggered() signal programmatically.

With QWidgetActions added to the menu, the menu usually doesn't get
interacted with directly, as the widget gets the input events.
Since the action can be added to multiple menus, neither widget nor
action can interact with the menus programmatically. Instead, the
menu needs to hide when the widget action triggers.

Test included that covers the case where a QWidgetAction is added
to multiple menus that are visible. Documentation updated, and
removed a redudant paragraph as a drive-by change.

[ChangeLog][QtWidgets][QMenu] a popup menu hides when a QWidgetAction
added to it fires the triggered signal.

Change-Id: I69f378426a45c2e46cebdaa5e6f1b21c8fb03633
Fixes: QTBUG-10427
Reviewed-by: Richard Moe Gustavsen <richard.gustavsen@qt.io>

1 files changed, 5 insertions, 4 deletions

diff --git a/src/widgets/widgets/qmenu.cpp b/src/widgets/widgets/qmenu.cpp
index abe4e485c0..0233fa136d 100644
--- a/src/widgets/widgets/qmenu.cpp
+++ b/src/widgets/widgets/qmenu.cpp
@@ -1470,6 +1470,9 @@ void QMenuPrivate::_q_actionTriggered()
                 }
             }
             activateCausedStack(list, action, QAction::Trigger, false);
+            // if a widget action fires, we need to hide the menu explicitly
+            if (qobject_cast<QWidgetAction*>(action))
+                hideUpToMenuBar();
         }
     }
 }
@@ -1637,10 +1640,8 @@ void QMenu::initStyleOption(QStyleOptionMenuItem *option, const QAction *action)
 
     Widgets can be inserted into menus with the QWidgetAction class.
     Instances of this class are used to hold widgets, and are inserted
-    into menus with the addAction() overload that takes a QAction.
-
-    Conversely, actions can be added to widgets with the addAction(),
-    addActions() and insertAction() functions.
+    into menus with the addAction() overload that takes a QAction. If the
+    QWidgetAction fires the triggered() signal, the menu will close.
 
     \warning To make QMenu visible on the screen, exec() or popup() should be
     used instead of show().