Fix Instantiator-created MenuItems disappearing

When d5cb26bc fixed a bug in Menu, it also broke the use case
of having an Instantiator create menu items. Using an Instantiator
like this allows users to create a "Recent Files" menu, for example.
The issue was that we would indiscriminately recreate items, even
those owned by an Instantiator.

This patch avoids recreating items owned by Instantiators.
It also adds a logging category for Menu, to aid debugging.

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

1 files changed, 71 insertions, 0 deletions

diff --git a/tests/auto/qquickmenu/tst_qquickmenu.cpp b/tests/auto/qquickmenu/tst_qquickmenu.cpp
index 27cd8aaa..2ba9363b 100644
--- a/tests/auto/qquickmenu/tst_qquickmenu.cpp
+++ b/tests/auto/qquickmenu/tst_qquickmenu.cpp
@@ -89,6 +89,8 @@ private slots:
     void scrollable_data();
     void scrollable();
     void delegateFromSeparateComponent();
+    void instantiator();
+    void instantiatorWithItemsBeforeAndAfter();
 };
 
 void tst_QQuickMenu::defaults()
@@ -1434,6 +1436,75 @@ void tst_QQuickMenu::delegateFromSeparateComponent()
     QCOMPARE(actionItem2Bg->property("color").value<QColor>(), green);
 }
 
+void tst_QQuickMenu::instantiator()
+{
+    if (QGuiApplication::styleHints()->tabFocusBehavior() != Qt::TabFocusAllControls)
+        QSKIP("This platform only allows tab focus for text controls");
+
+    QQuickApplicationHelper helper(this, QLatin1String("instantiator.qml"));
+
+    QQuickApplicationWindow *window = helper.appWindow;
+    window->show();
+    window->requestActivate();
+    QVERIFY(QTest::qWaitForWindowActive(window));
+    QVERIFY(QGuiApplication::focusWindow() == window);
+    centerOnScreen(window);
+    moveMouseAway(window);
+
+    QQuickMenu *menu = window->property("menu").value<QQuickMenu*>();
+    menu->open();
+    QVERIFY(menu->isVisible());
+    waitForMenuListViewPolish(menu);
+    menu->setFocus(true);
+
+    // Highlight the first item.
+    QQuickMenuItem *firstItem = qobject_cast<QQuickMenuItem *>(menu->itemAt(0));
+    QVERIFY(firstItem);
+    QTest::keyClick(window, Qt::Key_Tab);
+    QVERIFY(firstItem->hasActiveFocus());
+    QVERIFY(firstItem->hasVisualFocus());
+    QVERIFY(firstItem->isHighlighted());
+    QTRY_VERIFY(!QQuickItemPrivate::get(firstItem)->culled);
+
+    // Highlight the second item.
+    QQuickMenuItem *secondItem = qobject_cast<QQuickMenuItem *>(menu->itemAt(1));
+    QVERIFY(secondItem);
+    QTest::keyClick(window, Qt::Key_Down);
+    QVERIFY(secondItem->hasActiveFocus());
+    QVERIFY(secondItem->hasVisualFocus());
+    QVERIFY(secondItem->isHighlighted());
+    QVERIFY(!QQuickItemPrivate::get(secondItem)->culled);
+}
+
+void tst_QQuickMenu::instantiatorWithItemsBeforeAndAfter()
+{
+    QQuickApplicationHelper helper(this, QLatin1String("instantiatorWithItemsBeforeAndAfter.qml"));
+
+    QQuickApplicationWindow *window = helper.appWindow;
+    window->show();
+    window->requestActivate();
+    QVERIFY(QTest::qWaitForWindowActive(window));
+    QVERIFY(QGuiApplication::focusWindow() == window);
+    centerOnScreen(window);
+    moveMouseAway(window);
+
+    QQuickMenu *menu = window->property("menu").value<QQuickMenu*>();
+    menu->open();
+    QVERIFY(menu->isVisible());
+    waitForMenuListViewPolish(menu);
+
+    QStringList expectedItemTexts;
+    expectedItemTexts << QLatin1String("Before") << QLatin1String("Instantiated #1")
+        << QLatin1String("Instantiated #2") << QLatin1String("After");
+
+    for (int i = 0; i < expectedItemTexts.size(); ++i) {
+        const QString expectedText = expectedItemTexts.at(i);
+        QQuickMenuItem *menuItem = qobject_cast<QQuickMenuItem*>(menu->itemAt(i));
+        QVERIFY(menuItem);
+        QCOMPARE(menuItem->text(), expectedText);
+    }
+}
+
 QTEST_MAIN(tst_QQuickMenu)
 
 #include "tst_qquickmenu.moc"