Fix the API for resetting QAbstractItemModels.

This commit deprecates the QAIM::reset() method, and adds beginResetModel()
and endResetModel() methods, addressing Qt issue 247023.

http://www.qtsoftware.com/developer/task-tracker/index_html?method=entry&id=247023

If models and proxies use QAIM::reset() alone, then proxies will
emit modelAboutToBeReset after its source model is reset. This means that mapToSource
will not behave as expected (Will always return an invalid index) in a slot connected
to modelAboutToBeReset.

The usecase for this is maintaining viewstate (which items are selected, expanded)
when the model is reset. See BrowserWidget::modelChanged here:
http://websvn.kde.org/trunk/KDE/kdepim/akonadi/akonadiconsole/browserwidget.cpp?view=markup

Task-number: 247023
Reviewed-by: Olivier Goffart <ogoffart@trolltech.com>
Merge-request: 1072

4 files changed, 56 insertions, 8 deletions

diff --git a/src/corelib/kernel/qabstractitemmodel.cpp b/src/corelib/kernel/qabstractitemmodel.cpp
index 1c9104a..2175542 100644
--- a/src/corelib/kernel/qabstractitemmodel.cpp
+++ b/src/corelib/kernel/qabstractitemmodel.cpp
@@ -1339,7 +1339,7 @@ void QAbstractItemModelPrivate::columnsRemoved(const QModelIndex &parent,
     \endlist
 
 
-    \sa layoutAboutToBeChanged(), dataChanged(), headerDataChanged(), reset(),
+    \sa layoutAboutToBeChanged(), dataChanged(), headerDataChanged(), modelReset(),
         changePersistentIndex()
 */
 
@@ -2769,7 +2769,25 @@ void QAbstractItemModel::endMoveColumns()
 /*!
     Resets the model to its original state in any attached views.
 
-    The view to which the model is attached to will be reset as well.
+    Use beginResetModel() and endResetModel() instead whenever possible. If usng this method, the modelAboutToBeReset signal will
+    not function as expected through proxy models.
+
+    Use this method only if there is no way to call beginResetModel() before invalidating the model.
+*/
+void QAbstractItemModel::reset()
+{
+    Q_D(QAbstractItemModel);
+    emit modelAboutToBeReset();
+    d->invalidatePersistentIndexes();
+    emit modelReset();
+}
+
+/*!
+    Begins a model reset operation.
+
+    A reset operation resets the model to its current state in any attached views.
+
+    \note Any views attached to this model will be reset as well.
 
     When a model is reset it means that any previous data reported from the
     model is now invalid and has to be queried for again. This also means that
@@ -2779,12 +2797,29 @@ void QAbstractItemModel::endMoveColumns()
     call this function rather than emit dataChanged() to inform other
     components when the underlying data source, or its structure, has changed.
 
-    \sa modelAboutToBeReset(), modelReset()
+    You must call this function before resetting any internal data structures in your model
+    or proxy model.
+
+    \sa modelAboutToBeReset(), modelReset(), endResetModel()
+    \since 4.6
 */
-void QAbstractItemModel::reset()
+void QAbstractItemModel::beginResetModel()
 {
-    Q_D(QAbstractItemModel);
     emit modelAboutToBeReset();
+}
+
+/*!
+    Completes a model reset operation.
+
+    You must call this function after resetting any internal data structure in your model
+    or proxy model.
+
+    \sa beginResetModel()
+    \since 4.6
+*/
+void QAbstractItemModel::endResetModel()
+{
+    Q_D(QAbstractItemModel);
     d->invalidatePersistentIndexes();
     emit modelReset();
 }
@@ -3256,7 +3291,7 @@ bool QAbstractListModel::dropMimeData(const QMimeData *data, Qt::DropAction acti
     This signal is emitted when reset() is called, before the model's internal
     state (e.g. persistent model indexes) has been invalidated.
 
-    \sa reset(), modelReset()
+    \sa beginResetModel(), modelReset()
 */
 
 /*!
@@ -3266,7 +3301,7 @@ bool QAbstractListModel::dropMimeData(const QMimeData *data, Qt::DropAction acti
     This signal is emitted when reset() is called, after the model's internal
     state (e.g. persistent model indexes) has been invalidated.
 
-    \sa reset(), modelAboutToBeReset()
+    \sa endResetModel(), modelAboutToBeReset()
 */
 
 /*!
diff --git a/src/corelib/kernel/qabstractitemmodel.h b/src/corelib/kernel/qabstractitemmodel.h
index b47e4cb..1ca6cbe 100644
--- a/src/corelib/kernel/qabstractitemmodel.h
+++ b/src/corelib/kernel/qabstractitemmodel.h
@@ -293,6 +293,9 @@ protected:
 
     void reset();
 
+    void beginResetModel();
+    void endResetModel();
+
     void changePersistentIndex(const QModelIndex &from, const QModelIndex &to);
     void changePersistentIndexList(const QModelIndexList &from, const QModelIndexList &to);
     QModelIndexList persistentIndexList() const;
diff --git a/src/gui/itemviews/qsortfilterproxymodel.cpp b/src/gui/itemviews/qsortfilterproxymodel.cpp
index d173efe..18fbf7b 100644
--- a/src/gui/itemviews/qsortfilterproxymodel.cpp
+++ b/src/gui/itemviews/qsortfilterproxymodel.cpp
@@ -174,6 +174,7 @@ public:
                            const QModelIndex &source_bottom_right);
     void _q_sourceHeaderDataChanged(Qt::Orientation orientation, int start, int end);
 
+    void _q_sourceAboutToBeReset();
     void _q_sourceReset();
 
     void _q_sourceLayoutAboutToBeChanged();
@@ -1148,11 +1149,17 @@ void QSortFilterProxyModelPrivate::_q_sourceHeaderDataChanged(Qt::Orientation or
     emit q->headerDataChanged(orientation, proxy_start, proxy_end);
 }
 
+void QSortFilterProxyModelPrivate::_q_sourceAboutToBeReset()
+{
+    Q_Q(QSortFilterProxyModel);
+    q->beginResetModel();
+}
+
 void QSortFilterProxyModelPrivate::_q_sourceReset()
 {
     Q_Q(QSortFilterProxyModel);
     // All internal structures are deleted in clear()
-    q->reset();
+    q->endResetModel();
     update_source_sort_column();
     if (dynamic_sortfilter)
         sort();
@@ -1499,6 +1506,7 @@ void QSortFilterProxyModel::setSourceModel(QAbstractItemModel *sourceModel)
     disconnect(d->model, SIGNAL(layoutChanged()),
                this, SLOT(_q_sourceLayoutChanged()));
 
+    disconnect(d->model, SIGNAL(modelAboutToBeReset()), this, SLOT(_q_sourceAboutToBeReset()));
     disconnect(d->model, SIGNAL(modelReset()), this, SLOT(_q_sourceReset()));
 
     QAbstractProxyModel::setSourceModel(sourceModel);
@@ -1539,6 +1547,7 @@ void QSortFilterProxyModel::setSourceModel(QAbstractItemModel *sourceModel)
     connect(d->model, SIGNAL(layoutChanged()),
             this, SLOT(_q_sourceLayoutChanged()));
 
+    connect(d->model, SIGNAL(modelAboutToBeReset()), this, SLOT(_q_sourceAboutToBeReset()));
     connect(d->model, SIGNAL(modelReset()), this, SLOT(_q_sourceReset()));
 
     d->clear_mapping();
diff --git a/src/gui/itemviews/qsortfilterproxymodel.h b/src/gui/itemviews/qsortfilterproxymodel.h
index 12baa19..0314aec 100644
--- a/src/gui/itemviews/qsortfilterproxymodel.h
+++ b/src/gui/itemviews/qsortfilterproxymodel.h
@@ -177,6 +177,7 @@ private:
 
     Q_PRIVATE_SLOT(d_func(), void _q_sourceDataChanged(const QModelIndex &source_top_left, const QModelIndex &source_bottom_right))
     Q_PRIVATE_SLOT(d_func(), void _q_sourceHeaderDataChanged(Qt::Orientation orientation, int start, int end))
+    Q_PRIVATE_SLOT(d_func(), void _q_sourceAboutToBeReset())
     Q_PRIVATE_SLOT(d_func(), void _q_sourceReset())
     Q_PRIVATE_SLOT(d_func(), void _q_sourceLayoutAboutToBeChanged())
     Q_PRIVATE_SLOT(d_func(), void _q_sourceLayoutChanged())