QQuickContainer: 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 container, 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][Container] 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: I4af51157b196c273f923d99b949a9660e6e8df64
Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>

1 files changed, 42 insertions, 3 deletions

diff --git a/src/quicktemplates2/qquickcontainer.cpp b/src/quicktemplates2/qquickcontainer.cpp
index 42423ff3..9b8298c2 100644
--- a/src/quicktemplates2/qquickcontainer.cpp
+++ b/src/quicktemplates2/qquickcontainer.cpp
@@ -519,22 +519,61 @@ void QQuickContainer::moveItem(int from, int to)
 }
 
 /*!
+    \deprecated
     \qmlmethod void QtQuick.Controls::Container::removeItem(int index)
 
-    Removes an item at \a index.
+    Use Container::removeItem(Item) or Container::takeItem(int) instead.
+*/
+void QQuickContainer::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::Container::removeItem(Item item)
+
+    Removes and destroys the specified \a item.
+*/
+void QQuickContainer::removeItem(QQuickItem *item)
+{
+    Q_D(QQuickContainer);
+    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 Item QtQuick.Controls::Container::takeItem(int index)
+
+    Removes and returns the item at \a index.
 
     \note The ownership of the item is transferred to the caller.
 */
-void QQuickContainer::removeItem(int index)
+QQuickItem *QQuickContainer::takeItem(int index)
 {
     Q_D(QQuickContainer);
     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;
 }
 
 /*!