Menu: ensure the correct delegates are used when created via Component

Don't add items until we're complete, as the delegate could change in
the meantime. Instead, add them to contentData and create them when
we're complete.

Task-number: QTBUG-67559
Change-Id: I5f42129f49de861ff5f15d0069daeda0b4e5017c
Reviewed-by: Frederik Gladhorn <frederik.gladhorn@qt.io>

7 files changed, 278 insertions, 0 deletions

diff --git a/tests/auto/qquickmenu/data/delegateFromSeparateComponent.qml b/tests/auto/qquickmenu/data/delegateFromSeparateComponent.qml
new file mode 100644
index 00000000..48176d37
--- /dev/null
+++ b/tests/auto/qquickmenu/data/delegateFromSeparateComponent.qml
@@ -0,0 +1,107 @@
+/****************************************************************************
+**
+** Copyright (C) 2018 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the test suite of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:BSD$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** BSD License Usage
+** Alternatively, 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 The Qt Company Ltd 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.10
+import QtQuick.Controls 2.3
+
+ApplicationWindow {
+    width: 800
+    height: 800
+
+    property alias menu: menu
+
+    Component {
+        id: menuItemComponent
+
+        MenuItem {
+            contentItem: Text {
+                text: parent.text
+                color: "blue"
+            }
+            background: Rectangle {
+                color: "#00ff00"
+            }
+        }
+    }
+
+    Menu {
+        id: menu
+        title: "Root Menu"
+
+        Action {
+            text: "Action Item 1"
+        }
+        Menu {
+            title: "Sub-menu"
+            delegate: menuItemComponent
+
+            Action {
+                text: "Sub-menu Action Item 1"
+            }
+            Menu {
+                title: "Sub-sub-menu"
+                delegate: menuItemComponent
+
+                Action {
+                    text: "Sub-sub-menu Action Item 1"
+                }
+            }
+            Action {
+                text: "Sub-menu Action Item 2"
+            }
+        }
+        Action {
+            text: "Action Item 2"
+        }
+
+        delegate: menuItemComponent
+        visible: true
+    }
+}
diff --git a/tests/auto/qquickmenu/qquickmenu.pro b/tests/auto/qquickmenu/qquickmenu.pro
index ee539842..7e1080b9 100644
--- a/tests/auto/qquickmenu/qquickmenu.pro
+++ b/tests/auto/qquickmenu/qquickmenu.pro
@@ -1,5 +1,6 @@
 CONFIG += testcase
 TARGET = tst_qquickmenu
+HEADERS += ../shared/menuutil.h
 SOURCES += tst_qquickmenu.cpp
 
 macos:CONFIG -= app_bundle
diff --git a/tests/auto/qquickmenu/tst_qquickmenu.cpp b/tests/auto/qquickmenu/tst_qquickmenu.cpp
index 5a676c03..adb3d7aa 100644
--- a/tests/auto/qquickmenu/tst_qquickmenu.cpp
+++ b/tests/auto/qquickmenu/tst_qquickmenu.cpp
@@ -43,6 +43,8 @@
 #include <QtQml/qqmlcontext.h>
 #include <QtQuick/qquickview.h>
 #include <QtQuick/private/qquickitem_p.h>
+#include <QtQuick/private/qquicklistview_p.h>
+#include "../shared/menuutil.h"
 #include "../shared/util.h"
 #include "../shared/visualtestutil.h"
 
@@ -86,6 +88,7 @@ private slots:
     void addRemoveSubMenus();
     void scrollable_data();
     void scrollable();
+    void delegateFromSeparateComponent();
 };
 
 void tst_QQuickMenu::defaults()
@@ -145,6 +148,7 @@ void tst_QQuickMenu::mouse()
     menu->open();
     QVERIFY(menu->isVisible());
     QVERIFY(window->overlay()->childItems().contains(menu->contentItem()->parentItem()));
+    waitForMenuListViewPolish(menu);
 
     QQuickItem *firstItem = menu->itemAt(0);
     QSignalSpy clickedSpy(firstItem, SIGNAL(clicked()));
@@ -268,6 +272,8 @@ void tst_QQuickMenu::contextMenuKeyboard()
     QCOMPARE(visibleSpy.count(), 1);
     QVERIFY(menu->isVisible());
     QVERIFY(window->overlay()->childItems().contains(menu->contentItem()->parentItem()));
+    waitForMenuListViewPolish(menu);
+
     QVERIFY(!firstItem->hasActiveFocus());
     QVERIFY(!firstItem->property("highlighted").toBool());
     QCOMPARE(menu->currentIndex(), -1);
@@ -934,6 +940,7 @@ void tst_QQuickMenu::subMenuMouse()
     QVERIFY(!subMenu1->isVisible());
     QVERIFY(!subMenu2->isVisible());
     QVERIFY(!subSubMenu1->isVisible());
+    waitForMenuListViewPolish(mainMenu);
 
     // open the sub-menu with mouse click
     QQuickMenuItem *subMenu1Item = qobject_cast<QQuickMenuItem *>(mainMenu->itemAt(1));
@@ -944,6 +951,7 @@ void tst_QQuickMenu::subMenuMouse()
     QVERIFY(subMenu1->isVisible());
     QVERIFY(!subMenu2->isVisible());
     QVERIFY(!subSubMenu1->isVisible());
+    waitForMenuListViewPolish(subMenu1);
 
     // open the cascading sub-sub-menu with mouse hover
     QQuickMenuItem *subSubMenu1Item = qobject_cast<QQuickMenuItem *>(subMenu1->itemAt(2));
@@ -954,6 +962,7 @@ void tst_QQuickMenu::subMenuMouse()
     QVERIFY(subMenu1->isVisible());
     QVERIFY(!subMenu2->isVisible());
     QVERIFY(!subSubMenu1->isVisible());
+    QVERIFY(subSubMenu1Item->isHovered());
     if (cascade)
         QTRY_VERIFY(subSubMenu1->isVisible());
 
@@ -973,6 +982,7 @@ void tst_QQuickMenu::subMenuMouse()
     QVERIFY(subMenu1->isVisible());
     QVERIFY(!subMenu2->isVisible());
     QVERIFY(!subSubMenu1->isVisible());
+    QVERIFY(subSubMenu1Item->isHovered());
     if (cascade)
         QTRY_VERIFY(subSubMenu1->isVisible());
 
@@ -1199,6 +1209,7 @@ void tst_QQuickMenu::subMenuPosition()
     QVERIFY(!subMenu1->isVisible());
     QVERIFY(!subMenu2->isVisible());
     QVERIFY(!subSubMenu1->isVisible());
+    waitForMenuListViewPolish(mainMenu);
 
     // open the sub-menu (never flips)
     QQuickMenuItem *subMenu1Item = qobject_cast<QQuickMenuItem *>(mainMenu->itemAt(1));
@@ -1333,9 +1344,96 @@ void tst_QQuickMenu::scrollable()
     QVERIFY(menu->isVisible());
 
     QQuickItem *contentItem = menu->contentItem();
+    // Can only be scrollable if it exceeds the height of the window.
+    QTRY_VERIFY(contentItem->property("contentHeight").toReal() > window->height());
     QCOMPARE(contentItem->property("interactive").toBool(), true);
 }
 
+// QTBUG-67559
+// Test that Actions and MenuItems declared as children of a Menu have the
+// correct delegate when it is declared outside of the Menu as a Component.
+void tst_QQuickMenu::delegateFromSeparateComponent()
+{
+    QQuickApplicationHelper helper(this, QLatin1String("delegateFromSeparateComponent.qml"));
+    QQuickWindow *window = helper.window;
+    window->show();
+    QVERIFY(QTest::qWaitForWindowActive(window));
+
+    const QColor green = QColor::fromRgb(0x00ff00);
+
+    QQuickMenu *menu = window->property("menu").value<QQuickMenu*>();
+    QVERIFY(menu);
+
+    // "Action Item 1"
+    QQuickMenuItem *actionItem1 = qobject_cast<QQuickMenuItem*>(menu->itemAt(0));
+    QVERIFY(actionItem1);
+    QCOMPARE(actionItem1->text(), QLatin1String("Action Item 1"));
+
+    QQuickItem *actionItem1Bg = actionItem1->property("background").value<QQuickItem*>();
+    QVERIFY(actionItem1Bg);
+    QCOMPARE(actionItem1Bg->property("color").value<QColor>(), green);
+
+    // "Sub-menu"
+    QQuickMenuItem *subMenuItem = qobject_cast<QQuickMenuItem*>(menu->itemAt(1));
+    QVERIFY(subMenuItem);
+    QCOMPARE(subMenuItem->text(), QLatin1String("Sub-menu"));
+
+    QQuickItem *subMenuItemBg = subMenuItem->property("background").value<QQuickItem*>();
+    QVERIFY(subMenuItemBg);
+    QCOMPARE(subMenuItemBg->property("color").value<QColor>(), green);
+
+    QQuickMenu *subMenu = subMenuItem->subMenu();
+    QVERIFY(subMenu);
+
+    // "Sub-menu Action Item 1"
+    QQuickMenuItem *subMenuActionItem1 = qobject_cast<QQuickMenuItem*>(subMenu->itemAt(0));
+    QVERIFY(subMenuActionItem1);
+    QCOMPARE(subMenuActionItem1->text(), QLatin1String("Sub-menu Action Item 1"));
+
+    QQuickItem *subMenuActionItem1Bg = subMenuActionItem1->property("background").value<QQuickItem*>();
+    QVERIFY(subMenuActionItem1Bg);
+    QCOMPARE(subMenuActionItem1Bg->property("color").value<QColor>(), green);
+
+    // "Sub-sub-menu"
+    QQuickMenuItem *subSubMenuItem = qobject_cast<QQuickMenuItem*>(subMenu->itemAt(1));
+    QVERIFY(subSubMenuItem);
+    QCOMPARE(subSubMenuItem->text(), QLatin1String("Sub-sub-menu"));
+
+    QQuickItem *subSubMenuItemBg = subSubMenuItem->property("background").value<QQuickItem*>();
+    QVERIFY(subSubMenuItemBg);
+    QCOMPARE(subSubMenuItemBg->property("color").value<QColor>(), green);
+
+    QQuickMenu *subSubMenu = subSubMenuItem->subMenu();
+    QVERIFY(subSubMenu);
+
+    // "Sub-sub-menu Action Item 1"
+    QQuickMenuItem *subSubMenuActionItem1 = qobject_cast<QQuickMenuItem*>(subSubMenu->itemAt(0));
+    QVERIFY(subSubMenuActionItem1);
+    QCOMPARE(subSubMenuActionItem1->text(), QLatin1String("Sub-sub-menu Action Item 1"));
+
+    QQuickItem *subSubMenuActionItem1Bg = subSubMenuActionItem1->property("background").value<QQuickItem*>();
+    QVERIFY(subSubMenuActionItem1Bg);
+    QCOMPARE(subSubMenuActionItem1Bg->property("color").value<QColor>(), green);
+
+    // "Sub-menu Action Item 2"
+    QQuickMenuItem *subMenuActionItem2 = qobject_cast<QQuickMenuItem*>(subMenu->itemAt(2));
+    QVERIFY(subMenuActionItem2);
+    QCOMPARE(subMenuActionItem2->text(), QLatin1String("Sub-menu Action Item 2"));
+
+    QQuickItem *subMenuActionItem2Bg = subMenuActionItem2->property("background").value<QQuickItem*>();
+    QVERIFY(subMenuActionItem2Bg);
+    QCOMPARE(subMenuActionItem2Bg->property("color").value<QColor>(), green);
+
+    // "Action Item 2"
+    QQuickMenuItem *actionItem2 = qobject_cast<QQuickMenuItem*>(menu->itemAt(2));
+    QVERIFY(actionItem2);
+    QCOMPARE(actionItem2->text(), QLatin1String("Action Item 2"));
+
+    QQuickItem *actionItem2Bg = actionItem2->property("background").value<QQuickItem*>();
+    QVERIFY(actionItem2Bg);
+    QCOMPARE(actionItem2Bg->property("color").value<QColor>(), green);
+}
+
 QTEST_MAIN(tst_QQuickMenu)
 
 #include "tst_qquickmenu.moc"
diff --git a/tests/auto/qquickmenubar/qquickmenubar.pro b/tests/auto/qquickmenubar/qquickmenubar.pro
index b7d41f0f..d2f28e47 100644
--- a/tests/auto/qquickmenubar/qquickmenubar.pro
+++ b/tests/auto/qquickmenubar/qquickmenubar.pro
@@ -1,5 +1,6 @@
 CONFIG += testcase
 TARGET = tst_qquickmenubar
+HEADERS += ../shared/menuutil.h
 SOURCES += tst_qquickmenubar.cpp
 
 macos:CONFIG -= app_bundle
diff --git a/tests/auto/qquickmenubar/tst_qquickmenubar.cpp b/tests/auto/qquickmenubar/tst_qquickmenubar.cpp
index 19d67eac..754e915b 100644
--- a/tests/auto/qquickmenubar/tst_qquickmenubar.cpp
+++ b/tests/auto/qquickmenubar/tst_qquickmenubar.cpp
@@ -36,6 +36,8 @@
 
 #include <QtTest>
 #include <QtQml>
+#include <QtQuick/private/qquicklistview_p.h>
+#include "../shared/menuutil.h"
 #include "../shared/util.h"
 #include "../shared/visualtestutil.h"
 #include "../shared/qtest_quickcontrols.h"
@@ -146,6 +148,7 @@ void tst_qquickmenubar::mouse()
     QVERIFY(helpMenuBarMenu->isVisible());
     QTRY_VERIFY(!editMenuBarMenu->isVisible());
     QTRY_VERIFY(helpMenuBarMenu->isOpened());
+    waitForMenuListViewPolish(helpMenuBarMenu);
 
     // trigger a menu item to close the menu
     QQuickMenuItem *aboutMenuItem = qobject_cast<QQuickMenuItem *>(helpMenuBarMenu->itemAt(0));
@@ -167,6 +170,7 @@ void tst_qquickmenubar::mouse()
     QVERIFY(viewMenuBarItem->isHighlighted());
     QVERIFY(viewMenuBarMenu->isVisible());
     QTRY_VERIFY(viewMenuBarMenu->isOpened());
+    waitForMenuListViewPolish(viewMenuBarMenu);
 
     // trigger a menu item to open a sub-menu
     QQuickMenuItem *alignmentSubMenuItem = qobject_cast<QQuickMenuItem *>(viewMenuBarMenu->itemAt(0));
@@ -177,6 +181,7 @@ void tst_qquickmenubar::mouse()
     QVERIFY(viewMenuBarMenu->isVisible());
     QVERIFY(alignmentSubMenu->isVisible());
     QTRY_VERIFY(alignmentSubMenu->isOpened());
+    waitForMenuListViewPolish(alignmentSubMenu);
 
     // trigger a menu item to open a sub-sub-menu
     QQuickMenuItem *verticalSubMenuItem = qobject_cast<QQuickMenuItem *>(alignmentSubMenu->itemAt(1));
@@ -188,6 +193,7 @@ void tst_qquickmenubar::mouse()
     QVERIFY(alignmentSubMenu->isVisible());
     QVERIFY(verticalSubMenu->isVisible());
     QTRY_VERIFY(verticalSubMenu->isOpened());
+    waitForMenuListViewPolish(verticalSubMenu);
 
     // trigger a menu item to close the whole chain of menus
     QQuickMenuItem *centerMenuItem = qobject_cast<QQuickMenuItem *>(verticalSubMenu->itemAt(1));
diff --git a/tests/auto/qquickpopup/tst_qquickpopup.cpp b/tests/auto/qquickpopup/tst_qquickpopup.cpp
index 9230116b..6c860d6e 100644
--- a/tests/auto/qquickpopup/tst_qquickpopup.cpp
+++ b/tests/auto/qquickpopup/tst_qquickpopup.cpp
@@ -36,6 +36,7 @@
 
 #include <QtTest/qtest.h>
 #include <QtTest/qsignalspy.h>
+#include "../shared/menuutil.h"
 #include "../shared/util.h"
 #include "../shared/visualtestutil.h"
 #include "../shared/qtest_quickcontrols.h"
@@ -858,6 +859,7 @@ void tst_QQuickPopup::grabber()
 
     menu->open();
     QTRY_COMPARE(menu->isOpened(), true);
+    waitForMenuListViewPolish(menu);
     QCOMPARE(popup->isVisible(), false);
     QCOMPARE(combo->isVisible(), false);
 
@@ -880,6 +882,7 @@ void tst_QQuickPopup::grabber()
 
     menu->open();
     QTRY_COMPARE(menu->isOpened(), true);
+    waitForMenuListViewPolish(menu);
     QCOMPARE(popup->isVisible(), false);
     QCOMPARE(combo->isVisible(), false);
 
@@ -971,6 +974,7 @@ void tst_QQuickPopup::closeOnEscapeWithNestedPopups()
     QQuickPopup *optionsMenu = window->findChild<QQuickPopup*>("optionsMenu");
     QVERIFY(optionsMenu);
     QTRY_VERIFY(optionsMenu->isVisible());
+    waitForMenuListViewPolish(optionsMenu);
 
     QQuickItem *settingsMenuItem = window->findChild<QQuickItem*>("settingsMenuItem");
     QVERIFY(settingsMenuItem);
diff --git a/tests/auto/shared/menuutil.h b/tests/auto/shared/menuutil.h
new file mode 100644
index 00000000..067b7e55
--- /dev/null
+++ b/tests/auto/shared/menuutil.h
@@ -0,0 +1,61 @@
+/****************************************************************************
+**
+** Copyright (C) 2018 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing/
+**
+** This file is part of the test suite of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL3$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see http://www.qt.io/terms-conditions. For further
+** information use the contact form at http://www.qt.io/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 3 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPLv3 included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 3 requirements
+** will be met: https://www.gnu.org/licenses/lgpl.html.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 2.0 or later as published by the Free
+** Software Foundation and appearing in the file LICENSE.GPL included in
+** the packaging of this file. Please review the following information to
+** ensure the GNU General Public License version 2.0 requirements will be
+** met: http://www.gnu.org/licenses/gpl-2.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#ifndef QQUICKMENUTUTIL_H
+#define QQUICKMENUTUTIL_H
+
+#include <QtQuick/private/qquickitem_p.h>
+#include <QtQuick/private/qquicklistview_p.h>
+
+/*
+    QQuickMenuPrivate::insertItem() culls newly added items to ensure
+    that they don't show up when they shouldn't, but now that QQuickMenu
+    postpones item creation until after component completion (QTBUG-67559),
+    the culled flag being set means that mouse events don't get delivered
+    to menu items (see the culled check in QQuickWindowPrivate::pointerTargets()).
+
+    ListView unculls the items in FxViewItem::setVisible(), and waiting until
+    polishes are finished is a reliable way of ensuring that that happens
+    before we send mouse events.
+*/
+#define waitForMenuListViewPolish(menu) \
+{ \
+    const auto listView = qobject_cast<QQuickListView*>((menu)->contentItem()); \
+    Q_ASSERT(listView); \
+    QTRY_COMPARE(QQuickItemPrivate::get(listView)->polishScheduled, false); \
+}
+
+#endif // QQUICKMENUTUTIL_H