qgroupingproxymodel.h

/******************************************************************************
** This file is part of qadvanceditemviews.
**
** Copyright (c) 2011-2012 Martin Hoppe martin@2x2hoppe.de
**
** qadvanceditemviews is free software: you can redistribute it
** and/or modify it under the terms of the GNU Lesser General
** Public License as published by the Free Software Foundation,
** either version 3 of the License, or (at your option) any
** later version.
**
** qadvanceditemviews is distributed in the hope that it will be
** useful, but WITHOUT ANY WARRANTY; without even the implied
** warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
** See the GNU General Public License for more details.
**
** You should have received a copy of the GNU Lesser General Public
** License along with qadvanceditemviews.
** If not, see <http://www.gnu.org/licenses/>.
******************************************************************************/
#ifndef QGROUPINGPROXYMODEL_H
#define QGROUPINGPROXYMODEL_H

#include <QAbstractProxyModel>
#include <qaivlib_global.h>

class QGroupingProxyModelGroup;
class QGroupingProxyModelPrivate;


class QAIVLIBSHARED_EXPORT QGroupingProxyModel : public QAbstractItemModel
{
    Q_OBJECT
        Q_PROPERTY(bool groupsSpanned READ groupsSpanned WRITE setGroupsSpanned)

    Q_PROPERTY(int modelColumn READ modelColumn WRITE setModelColumn)
public:
    explicit QGroupingProxyModel(QObject *parent = 0);
    ~QGroupingProxyModel();
    void addGroup(const QString & text, const QVariant & value = QVariant());
    void addGroup(const QIcon & icon, const QString & text, const QVariant & value = QVariant());
    int columnCount(const QModelIndex & parent = QModelIndex()) const;
    QVariant data(const QModelIndex & proxyIndex, int role) const;
    Qt::ItemFlags flags(const QModelIndex & index) const;
        bool groupsSpanned() const;
    QVariant headerData(int section, Qt::Orientation orientation, int role) const;
    QModelIndex index(int row, int column, const QModelIndex & parent = QModelIndex()) const;

    int findText(const QString & text) const;
    QModelIndex mapFromSource(const QModelIndex & sourceIndex) const;
    QModelIndex mapToSource(const QModelIndex & proxyIndex) const;
    int modelColumn() const;
    QModelIndex parent(const QModelIndex & child) const;
    bool removeGroup(int index);
    bool restoreGroups(const QByteArray & data);
    int rowCount(const QModelIndex & parent = QModelIndex()) const;
    QByteArray saveGroups() const;
    bool setData(const QModelIndex & index, const QVariant &value, int role);

        void setGroupSectionHeader(const QString & header);
        void setGroupsSpanned(bool on);
    void setModelColumn(int column);
    virtual void setSourceModel( QAbstractItemModel* sourceModel );
        void setUngroupedItemTitle(const QString & title);
        void setUngroupedItemTitle(const QString & title, const QIcon & icon);
        virtual QSize span(const QModelIndex & index) const;
private slots:
    void dataChangedHandler(const QModelIndex & topLeft, const QModelIndex & bottomRight);
        void sourceModelResetHandler();
    void rowsAboutToBeInsertedHandler( const QModelIndex & parent, int start, int end );
    void rowsInsertedHandler(const QModelIndex & parent, int first, int last);
private:
    void buildGroups();

    int groupAt(int sourceModelRow);
    void moveRows(int row, int count);
    void removeSourceModelRow(int sourceModelRow);

        QString m_groupSectionHeader;
        QGroupingProxyModelGroup* m_groupUngroupedItem;
    QGroupingProxyModelPrivate* d;
};

#endif // QGROUPINGPROXYMODEL_H