KDChartDatasetProxyModel.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2001-2011 Klaralvdalens Datakonsult AB.  All rights reserved.
**
** This file is part of the KD Chart library.
**
** Licensees holding valid commercial KD Chart licenses may use this file in
** accordance with the KD Chart Commercial License Agreement provided with
** the Software.
**
**
** This file may be distributed and/or modified under the terms of the
** GNU General Public License version 2 and version 3 as published by the
** Free Software Foundation and appearing in the file LICENSE.GPL.txt included.
**
** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
**
** Contact info@kdab.com if any conditions of this licensing are not
** clear to you.
**
**********************************************************************/

#ifndef KDCHARTDATASETPROXYMODEL_H
#define KDCHARTDATASETPROXYMODEL_H

#include <QVector>
#include <QSortFilterProxyModel>

#include "kdchart_export.h"

namespace KDChart {

    class IndexOutOfBoundsException;

    typedef QVector<int> DatasetDescriptionVector;

    class KDCHART_EXPORT DatasetProxyModel : public QSortFilterProxyModel
    {
        Q_OBJECT
    public:
        explicit DatasetProxyModel ( QObject* parent = 0 );

        QModelIndex buddy( const QModelIndex& index ) const;

        Qt::ItemFlags flags( const QModelIndex& index ) const;

        QModelIndex index( int row, int column,
                           const QModelIndex &parent = QModelIndex() ) const;
        QModelIndex parent(const QModelIndex &child ) const;

        QModelIndex mapFromSource ( const QModelIndex & sourceIndex ) const;

        QModelIndex mapToSource ( const QModelIndex& proxyIndex ) const;

        QVariant data(const QModelIndex &index, int role) const;

        bool setData( const QModelIndex& index, const QVariant& value, int role );

        QVariant headerData ( int section, Qt::Orientation orientation, int role = Qt::DisplayRole ) const;

        void setSourceModel(QAbstractItemModel *sourceModel);

        void setSourceRootIndex(const QModelIndex& rootIdx);


    public Q_SLOTS:
        void resetDatasetDescriptions();

        void setDatasetColumnDescriptionVector ( const DatasetDescriptionVector& columnConfig );

        void setDatasetRowDescriptionVector ( const DatasetDescriptionVector& rowConfig );

        void setDatasetDescriptionVectors (
            const DatasetDescriptionVector& rowConfig,
            const DatasetDescriptionVector& columnConfig );

        // FIXME: add convenience methods to configure common dataset
        // selections (like rectangular areas etc)

    protected:
        bool filterAcceptsColumn ( int sourceColumn,
                                   const QModelIndex & ) const;


        bool filterAcceptsRow ( int source_row, const QModelIndex & source_parent ) const;

    private:

        int mapProxyColumnToSource ( const int& proxyColumn ) const;

        int mapSourceColumnToProxy ( const int& sourceColumn ) const;

        int mapProxyRowToSource ( const int& proxyRow ) const;

        int mapSourceRowToProxy ( const int& sourceRow ) const;

        void initializeDatasetDecriptors (
            const DatasetDescriptionVector& inConfiguration,
            int sourceCount,
            DatasetDescriptionVector& outSourceToProxyMap,
            DatasetDescriptionVector& outProxyToSourceMap );

        DatasetDescriptionVector mColSrcToProxyMap;
        DatasetDescriptionVector mColProxyToSrcMap;
        DatasetDescriptionVector mRowSrcToProxyMap;
        DatasetDescriptionVector mRowProxyToSrcMap;

        int mProxyRowCount;
        int mProxyColumnCount;
        QModelIndex mRootIndex;
    };

}


#endif