src/gui/itemviews/qabstractproxymodel.cpp
changeset 0 1918ee327afb
child 4 3b1da2848fc7
child 7 f7bc934e204c
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/gui/itemviews/qabstractproxymodel.cpp	Mon Jan 11 14:00:40 2010 +0000
@@ -0,0 +1,282 @@
+/****************************************************************************
+**
+** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the QtGui module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** No Commercial Usage
+** This file contains pre-release code and may not be distributed.
+** You may use this file in accordance with the terms and conditions
+** contained in the Technology Preview License Agreement accompanying
+** this package.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Nokia gives you certain additional
+** rights.  These rights are described in the Nokia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** If you have questions regarding the use of this file, please contact
+** Nokia at qt-info@nokia.com.
+**
+**
+**
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include "qabstractproxymodel.h"
+
+#ifndef QT_NO_PROXYMODEL
+
+#include "qitemselectionmodel.h"
+#include <private/qabstractproxymodel_p.h>
+
+QT_BEGIN_NAMESPACE
+
+/*!
+    \since 4.1
+    \class QAbstractProxyModel
+    \brief The QAbstractProxyModel class provides a base class for proxy item
+    models that can do sorting, filtering or other data processing tasks.
+    \ingroup model-view
+
+    This class defines the standard interface that proxy models must use to be
+    able to interoperate correctly with other model/view components. It is not
+    supposed to be instantiated directly.
+
+    All standard proxy models are derived from the QAbstractProxyModel class.
+    If you need to create a new proxy model class, it is usually better to
+    subclass an existing class that provides the closest behavior to the one
+    you want to provide.
+
+    Proxy models that filter or sort items of data from a source model should
+    be created by using or subclassing QSortFilterProxyModel.
+
+    To subclass QAbstractProxyModel, you need to implement mapFromSource() and
+    mapToSource(). The mapSelectionFromSource() and mapSelectionToSource()
+    functions only need to be reimplemented if you need a behavior different
+    from the default behavior.
+
+    \note If the source model is deleted or no source model is specified, the
+    proxy model operates on a empty placeholder model.
+
+    \sa QSortFilterProxyModel, QAbstractItemModel, {Model/View Programming}
+*/
+
+//detects the deletion of the source model
+void QAbstractProxyModelPrivate::_q_sourceModelDestroyed()
+{
+    model = QAbstractItemModelPrivate::staticEmptyModel();
+}
+
+/*!
+    Constructs a proxy model with the given \a parent.
+*/
+
+QAbstractProxyModel::QAbstractProxyModel(QObject *parent)
+    :QAbstractItemModel(*new QAbstractProxyModelPrivate, parent)
+{
+    setSourceModel(QAbstractItemModelPrivate::staticEmptyModel());
+}
+
+/*!
+    \internal
+*/
+
+QAbstractProxyModel::QAbstractProxyModel(QAbstractProxyModelPrivate &dd, QObject *parent)
+    : QAbstractItemModel(dd, parent)
+{
+    setSourceModel(QAbstractItemModelPrivate::staticEmptyModel());
+}
+
+/*!
+    Destroys the proxy model.
+*/
+QAbstractProxyModel::~QAbstractProxyModel()
+{
+
+}
+
+/*!
+    Sets the given \a sourceModel to be processed by the proxy model.
+*/
+void QAbstractProxyModel::setSourceModel(QAbstractItemModel *sourceModel)
+{
+    Q_D(QAbstractProxyModel);
+    if (d->model)
+        disconnect(d->model, SIGNAL(destroyed()), this, SLOT(_q_sourceModelDestroyed()));
+
+    if (sourceModel) {
+        d->model = sourceModel;
+        connect(d->model, SIGNAL(destroyed()), this, SLOT(_q_sourceModelDestroyed()));
+    } else {
+        d->model = QAbstractItemModelPrivate::staticEmptyModel();
+    }
+}
+
+/*!
+    Returns the model that contains the data that is available through the proxy model.
+*/
+QAbstractItemModel *QAbstractProxyModel::sourceModel() const
+{
+    Q_D(const QAbstractProxyModel);
+    if (d->model == QAbstractItemModelPrivate::staticEmptyModel())
+        return 0;
+    return d->model;
+}
+
+/*!
+    \reimp
+ */
+bool QAbstractProxyModel::submit()
+{
+    Q_D(QAbstractProxyModel);
+    return d->model->submit();
+}
+
+/*!
+    \reimp
+ */
+void QAbstractProxyModel::revert()
+{
+    Q_D(QAbstractProxyModel);
+    d->model->revert();
+}
+
+
+/*!
+  \fn QModelIndex QAbstractProxyModel::mapToSource(const QModelIndex &proxyIndex) const
+
+  Reimplement this function to return the model index in the source model that
+  corresponds to the \a proxyIndex in the proxy model.
+
+  \sa mapFromSource()
+*/
+
+/*!
+  \fn QModelIndex QAbstractProxyModel::mapFromSource(const QModelIndex &sourceIndex) const
+
+  Reimplement this function to return the model index in the proxy model that
+  corresponds to the \a sourceIndex from the source model.
+
+  \sa mapToSource()
+*/
+
+/*!
+  Returns a source selection mapped from the specified \a proxySelection.
+
+  Reimplement this method to map proxy selections to source selections.
+ */
+QItemSelection QAbstractProxyModel::mapSelectionToSource(const QItemSelection &proxySelection) const
+{
+    QModelIndexList proxyIndexes = proxySelection.indexes();
+    QItemSelection sourceSelection;
+    for (int i = 0; i < proxyIndexes.size(); ++i)
+        sourceSelection << QItemSelectionRange(mapToSource(proxyIndexes.at(i)));
+    return sourceSelection;
+}
+
+/*!
+  Returns a proxy selection mapped from the specified \a sourceSelection.
+
+  Reimplement this method to map source selections to proxy selections.
+*/
+QItemSelection QAbstractProxyModel::mapSelectionFromSource(const QItemSelection &sourceSelection) const
+{
+    QModelIndexList sourceIndexes = sourceSelection.indexes();
+    QItemSelection proxySelection;
+    for (int i = 0; i < sourceIndexes.size(); ++i)
+        proxySelection << QItemSelectionRange(mapFromSource(sourceIndexes.at(i)));
+    return proxySelection;
+}
+
+/*!
+    \reimp
+ */
+QVariant QAbstractProxyModel::data(const QModelIndex &proxyIndex, int role) const
+{
+    Q_D(const QAbstractProxyModel);
+    return d->model->data(mapToSource(proxyIndex), role);
+}
+
+/*!
+    \reimp
+ */
+QVariant QAbstractProxyModel::headerData(int section, Qt::Orientation orientation, int role) const
+{
+    Q_D(const QAbstractProxyModel);
+    int sourceSection;
+    if (orientation == Qt::Horizontal) {
+        const QModelIndex proxyIndex = index(0, section);
+        sourceSection = mapToSource(proxyIndex).column();
+    } else {
+        const QModelIndex proxyIndex = index(section, 0);
+        sourceSection = mapToSource(proxyIndex).row();
+    }
+    return d->model->headerData(sourceSection, orientation, role);
+}
+
+/*!
+    \reimp
+ */
+QMap<int, QVariant> QAbstractProxyModel::itemData(const QModelIndex &proxyIndex) const
+{
+    Q_D(const QAbstractProxyModel);
+    return d->model->itemData(mapToSource(proxyIndex));
+}
+
+/*!
+    \reimp
+ */
+Qt::ItemFlags QAbstractProxyModel::flags(const QModelIndex &index) const
+{
+    Q_D(const QAbstractProxyModel);
+    return d->model->flags(mapToSource(index));
+}
+
+/*!
+    \reimp
+ */
+bool QAbstractProxyModel::setData(const QModelIndex &index, const QVariant &value, int role)
+{
+    Q_D(QAbstractProxyModel);
+    return d->model->setData(mapToSource(index), value, role);
+}
+
+/*!
+    \reimp
+ */
+bool QAbstractProxyModel::setHeaderData(int section, Qt::Orientation orientation, const QVariant &value, int role)
+{
+    Q_D(QAbstractProxyModel);
+    int sourceSection;
+    if (orientation == Qt::Horizontal) {
+        const QModelIndex proxyIndex = index(0, section);
+        sourceSection = mapToSource(proxyIndex).column();
+    } else {
+        const QModelIndex proxyIndex = index(section, 0);
+        sourceSection = mapToSource(proxyIndex).row();
+    }
+    return d->model->setHeaderData(sourceSection, orientation, value, role);
+}
+
+QT_END_NAMESPACE
+
+#include "moc_qabstractproxymodel.cpp"
+
+#endif // QT_NO_PROXYMODEL