QQuickMenu: removeItem(Item) and takeItem(int)

Deprecate removeItem(int) in favor of removeItem(Item) and
takeItem(int) with clearer semantics.

If one already has access to an item, one can pass it to removeItem()
to get rid of it for good, instead of having to call destroy() by hand.
If one knows the index instead, we provide a way to take the respective
item out of the menu, and let the user decide what to do with it. This
way we provide convenient ways to remove & destroy items in one go, and
to take items out without destroying them.

This nice pattern was once upon time planned for the QQC1 containers
such as SplitView, and should have been used for the QQC2 containers,
but was simply forgotten during the development...

[ChangeLog][Controls][Menu] Deprecated removeItem(int) in favor of
removeItem(Item) and takeItem(int) with clearer semantics. The former
destroys the item, whereas the latter transfers ownership to the
caller.

Change-Id: Id2a07fb65019b2904a013c8bcc3154089d36a0ea
Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>

4 files changed, 186 insertions, 4 deletions

diff --git a/src/quicktemplates2/qquickmenu.cpp b/src/quicktemplates2/qquickmenu.cpp
index 67725160..c7dd0ea5 100644
--- a/src/quicktemplates2/qquickmenu.cpp
+++ b/src/quicktemplates2/qquickmenu.cpp
@@ -443,22 +443,61 @@ void QQuickMenu::moveItem(int from, int to)
 }
 
 /*!
+    \deprecated
     \qmlmethod void QtQuick.Controls::Menu::removeItem(int index)
 
-    Removes the item at \a index.
+    Use Menu::removeItem(Item) or Menu::takeItem(int) instead.
+*/
+void QQuickMenu::removeItem(const QVariant &var)
+{
+    if (var.userType() == QMetaType::Nullptr)
+        return;
+
+    if (QQuickItem *item = var.value<QQuickItem *>())
+        removeItem(item);
+    else
+        takeItem(var.toInt());
+}
+
+/*!
+    \since QtQuick.Controls 2.3 (Qt 5.10)
+    \qmlmethod void QtQuick.Controls::Menu::removeItem(Item item)
+
+    Removes and destroys the specified \a item.
+*/
+void QQuickMenu::removeItem(QQuickItem *item)
+{
+    Q_D(QQuickMenu);
+    if (!item)
+        return;
+
+    const int index = d->contentModel->indexOf(item, nullptr);
+    if (index == -1)
+        return;
+
+    d->removeItem(index, item);
+    item->deleteLater();
+}
+
+/*!
+    \since QtQuick.Controls 2.3 (Qt 5.10)
+    \qmlmethod MenuItem QtQuick.Controls::Menu::takeItem(int index)
+
+    Removes and returns the item at \a index.
 
     \note The ownership of the item is transferred to the caller.
 */
-void QQuickMenu::removeItem(int index)
+QQuickItem *QQuickMenu::takeItem(int index)
 {
     Q_D(QQuickMenu);
     const int count = d->contentModel->count();
     if (index < 0 || index >= count)
-        return;
+        return nullptr;
 
     QQuickItem *item = itemAt(index);
     if (item)
         d->removeItem(index, item);
+    return item;
 }
 
 /*!
diff --git a/src/quicktemplates2/qquickmenu_p.h b/src/quicktemplates2/qquickmenu_p.h
index 25630c0c..4f05a7c9 100644
--- a/src/quicktemplates2/qquickmenu_p.h
+++ b/src/quicktemplates2/qquickmenu_p.h
@@ -75,7 +75,9 @@ public:
     Q_INVOKABLE void addItem(QQuickItem *item);
     Q_INVOKABLE void insertItem(int index, QQuickItem *item);
     Q_INVOKABLE void moveItem(int from, int to);
-    Q_INVOKABLE void removeItem(int index);
+    Q_INVOKABLE void removeItem(const QVariant &item); // ### Qt 6: remove
+    void removeItem(QQuickItem *item); // ### Qt 6: Q_INVOKABLE
+    Q_INVOKABLE QQuickItem *takeItem(int index);
 
     QVariant contentModel() const;
     QQmlListProperty<QObject> contentData();
diff --git a/tests/auto/menu/data/removeTakeItem.qml b/tests/auto/menu/data/removeTakeItem.qml
new file mode 100644
index 00000000..9a2914ed
--- /dev/null
+++ b/tests/auto/menu/data/removeTakeItem.qml
@@ -0,0 +1,91 @@
+/****************************************************************************
+**
+** Copyright (C) 2017 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.9
+import QtQuick.Controls 2.3
+
+ApplicationWindow {
+    width: 200
+    height: 200
+
+    property alias menu: menu
+    property alias menuItem1: menuItem1
+    property alias menuItem2: menuItem2
+    property alias menuItem3: menuItem3
+
+    function takeSecondItem() {
+        return menu.takeItem(1)
+    }
+
+    function removeFirstItem() {
+        menu.removeItem(menuItem1)
+    }
+
+    function removeNullItem() {
+        menu.removeItem(null)
+    }
+
+    function removeFirstIndex() {
+        menu.removeItem(0)
+    }
+
+    Menu {
+        id: menu
+        MenuItem {
+            id: menuItem1
+        }
+        MenuItem {
+            id: menuItem2
+        }
+        MenuItem {
+            id: menuItem3
+        }
+    }
+}
diff --git a/tests/auto/menu/tst_menu.cpp b/tests/auto/menu/tst_menu.cpp
index 739488ec..8f4792ae 100644
--- a/tests/auto/menu/tst_menu.cpp
+++ b/tests/auto/menu/tst_menu.cpp
@@ -72,6 +72,7 @@ private slots:
     void order();
     void popup();
     void actions();
+    void removeTakeItem();
 };
 
 void tst_menu::defaults()
@@ -481,6 +482,55 @@ void tst_menu::actions()
     QCOMPARE(menuItem4->text(), "menuitem4");
 }
 
+void tst_menu::removeTakeItem()
+{
+    QQuickApplicationHelper helper(this, QLatin1String("removeTakeItem.qml"));
+    QQuickWindow *window = helper.window;
+    window->show();
+    QVERIFY(QTest::qWaitForWindowActive(window));
+
+    QQuickMenu *menu = window->property("menu").value<QQuickMenu *>();
+    QVERIFY(menu);
+
+    QPointer<QQuickMenuItem> menuItem1 = window->property("menuItem1").value<QQuickMenuItem *>();
+    QVERIFY(!menuItem1.isNull());
+    QCOMPARE(menuItem1->menu(), menu);
+
+    QPointer<QQuickMenuItem> menuItem2 = window->property("menuItem2").value<QQuickMenuItem *>();
+    QVERIFY(!menuItem2.isNull());
+    QCOMPARE(menuItem2->menu(), menu);
+
+    QPointer<QQuickMenuItem> menuItem3 = window->property("menuItem3").value<QQuickMenuItem *>();
+    QVERIFY(!menuItem3.isNull());
+    QCOMPARE(menuItem3->menu(), menu);
+
+    // takeItem(int) does not destroy
+    QVariant ret;
+    QVERIFY(QMetaObject::invokeMethod(window, "takeSecondItem", Q_RETURN_ARG(QVariant, ret)));
+    QCOMPARE(ret.value<QQuickMenuItem *>(), menuItem2);
+    QVERIFY(!menuItem2->menu());
+    QCoreApplication::sendPostedEvents(menuItem2, QEvent::DeferredDelete);
+    QVERIFY(!menuItem2.isNull());
+
+    // removeItem(Item) destroys
+    QVERIFY(QMetaObject::invokeMethod(window, "removeFirstItem"));
+    QVERIFY(!menuItem1->menu());
+    QCoreApplication::sendPostedEvents(menuItem1, QEvent::DeferredDelete);
+    QVERIFY(menuItem1.isNull());
+
+    // removeItem(null) must not call removeItem(0)
+    QVERIFY(QMetaObject::invokeMethod(window, "removeNullItem"));
+    QCOMPARE(menuItem3->menu(), menu);
+    QCoreApplication::sendPostedEvents(menuItem3, QEvent::DeferredDelete);
+    QVERIFY(!menuItem3.isNull());
+
+    // deprecated removeItem(int) does not destroy
+    QVERIFY(QMetaObject::invokeMethod(window, "removeFirstIndex"));
+    QVERIFY(!menuItem3->menu());
+    QCoreApplication::sendPostedEvents(menuItem3, QEvent::DeferredDelete);
+    QVERIFY(!menuItem3.isNull());
+}
+
 QTEST_MAIN(tst_menu)
 
 #include "tst_menu.moc"