KDChart::DatasetProxyModel Class Reference

#include <KDChartDatasetProxyModel.h>

Inheritance diagram for KDChart::DatasetProxyModel:

[legend]

Collaboration diagram for KDChart::DatasetProxyModel:

[legend]

List of all members.

---

Detailed Description

DatasetProxyModel takes a KDChart dataset configuration and translates it into a filtering proxy model.

The resulting model will only contain the part of the model that is selected by the dataset, and the according row and column header data.

Currently, this model is implemented for table models only. The way it would work with models representing a tree is to be decided.

The column selection is configured by passing a dataset description vector to the model. This vector (of integers) is supposed to have one value for each column of the original model. If the value at position x is -1, column x of the original model is not included in the dataset. If it is between 0 and (columnCount() -1), it is the column the source column is mapped to in the resulting model. Any other value is an error.

Definition at line 58 of file KDChartDatasetProxyModel.h.

Public Slots
void	resetDatasetDescriptions ()
	Reset all dataset description.
void	setDatasetColumnDescriptionVector (const DatasetDescriptionVector &columnConfig)
	Configure the dataset selection for the columns.
void	setDatasetDescriptionVectors (const DatasetDescriptionVector &rowConfig, const DatasetDescriptionVector &columnConfig)
	Convenience method to configure rows and columns in one step.
void	setDatasetRowDescriptionVector (const DatasetDescriptionVector &rowConfig)
	Configure the dataset selection for the rows.
Public Member Functions
QModelIndex	buddy (const QModelIndex &index) const
QVariant	data (const QModelIndex &index, int role) const
	Overloaded from base class.
	DatasetProxyModel (QObject *parent=0)
	Create a DatasetProxyModel.
Qt::ItemFlags	flags (const QModelIndex &index) const
QVariant	headerData (int section, Qt::Orientation orientation, int role=Qt::DisplayRole) const
	Overloaded from base class.
QModelIndex	index (int row, int column, const QModelIndex &parent=QModelIndex()) const
QModelIndex	mapFromSource (const QModelIndex &sourceIndex) const
	Implements the mapping from the source to the proxy indexes.
QModelIndex	mapToSource (const QModelIndex &proxyIndex) const
	Implements the mapping from the proxy to the source indexes.
QModelIndex	parent (const QModelIndex &child) const
bool	setData (const QModelIndex &index, const QVariant &value, int role)
	Overloaded from base class.
void	setSourceModel (QAbstractItemModel *sourceModel)
	Overloaded from base class.
void	setSourceRootIndex (const QModelIndex &rootIdx)
	Set the root index of the table in the source model.
Protected Member Functions
bool	filterAcceptsColumn (int sourceColumn, const QModelIndex &) const
	Decide whether the column is accepted.
bool	filterAcceptsRow (int source_row, const QModelIndex &source_parent) const
	Decide whether the row is accepted.

---

Constructor & Destructor Documentation

DatasetProxyModel::DatasetProxyModel

(

QObject *

parent = 0

)

[explicit]

Create a DatasetProxyModel.

Without further configuration, this model is invalid.

See also:

setDatasetDescriptionVector

Definition at line 35 of file KDChartDatasetProxyModel.cpp.

    : QSortFilterProxyModel ( parent )
{
}

---

Member Function Documentation

QModelIndex DatasetProxyModel::buddy

(

const QModelIndex &

index

)

const

Definition at line 40 of file KDChartDatasetProxyModel.cpp.

{
    return index;
}

QVariant DatasetProxyModel::data	(	const QModelIndex &	index,
		int	role
	)			const

Overloaded from base class.

Definition at line 219 of file KDChartDatasetProxyModel.cpp.

References mapToSource().

{
   return sourceModel()->data( mapToSource ( index ), role );
}

bool DatasetProxyModel::filterAcceptsColumn	(	int	sourceColumn,
		const QModelIndex &
	)			const [protected]

Decide whether the column is accepted.

Definition at line 146 of file KDChartDatasetProxyModel.cpp.

{
    if ( mColSrcToProxyMap.isEmpty() )
    {   // no column mapping set up yet, all columns are passed down:
        return true;
    } else {
        Q_ASSERT ( sourceModel() );
        Q_ASSERT ( mColSrcToProxyMap.size() == sourceModel()->columnCount(mRootIndex) );
        if ( mColSrcToProxyMap[sourceColumn] == -1 )
        {   // this column is explicitly not accepted:
            return false;
        } else {
            Q_ASSERT ( mColSrcToProxyMap[sourceColumn] >= 0
                       && mColSrcToProxyMap[sourceColumn] < mColSrcToProxyMap.size() );
            return true;
        }
    }
}

bool DatasetProxyModel::filterAcceptsRow	(	int	source_row,
		const QModelIndex &	source_parent
	)			const [protected]

Decide whether the row is accepted.

Definition at line 126 of file KDChartDatasetProxyModel.cpp.

{
    if ( mRowSrcToProxyMap.isEmpty() )
    {   // no row mapping set, all rows are passed down:
        return true;
    } else {
        Q_ASSERT ( sourceModel() );
        Q_ASSERT ( mRowSrcToProxyMap.size() == sourceModel()->rowCount(mRootIndex) );
        if ( mRowSrcToProxyMap[sourceRow] == -1 )
        {   // this row is explicitly not accepted:
            return false;
        } else {
            Q_ASSERT ( mRowSrcToProxyMap[sourceRow] >= 0
                       && mRowSrcToProxyMap[sourceRow] < mRowSrcToProxyMap.size() );
            return true;
        }
    }
}

Qt::ItemFlags DatasetProxyModel::flags

(

const QModelIndex &

index

)

const

Definition at line 45 of file KDChartDatasetProxyModel.cpp.

References mapToSource().

{
    return sourceModel()->flags( mapToSource( index ) );
}

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

Overloaded from base class.

Definition at line 229 of file KDChartDatasetProxyModel.cpp.

{
    if ( orientation == Qt::Horizontal )
    {
        if ( mapProxyColumnToSource ( section ) == -1 )
        {
            return QVariant();
        } else {
            return sourceModel()->headerData ( mapProxyColumnToSource ( section ),
                                                       orientation,  role );
        }
    } else {
        if ( mapProxyRowToSource ( section ) == -1 )
        {
            return QVariant();
        } else {
            return sourceModel()->headerData ( mapProxyRowToSource ( section ),
                                                       orientation, role );
        }
    }
}

QModelIndex DatasetProxyModel::index	(	int	row,
		int	column,
		const QModelIndex &	parent = QModelIndex()
	)			const

Definition at line 78 of file KDChartDatasetProxyModel.cpp.

References mapFromSource().

{
    return mapFromSource( sourceModel()->index( mapProxyRowToSource(row),
                                                mapProxyColumnToSource(column),
                                                parent ) );
}

QModelIndex DatasetProxyModel::mapFromSource

(

const QModelIndex &

sourceIndex

)

const

Implements the mapping from the source to the proxy indexes.

Definition at line 92 of file KDChartDatasetProxyModel.cpp.

Referenced by index(), and parent().

{
    Q_ASSERT_X ( sourceModel(), "DatasetProxyModel::mapFromSource", "A source "
                 "model must be set before the selection can be configured." );

    if ( !sourceIndex.isValid() ) return sourceIndex;

    if ( mRowSrcToProxyMap.isEmpty() && mColSrcToProxyMap.isEmpty() )
    {
        return createIndex ( sourceIndex.row(), sourceIndex.column(),
                             sourceIndex.internalPointer() );
    } else {
        int row = mapSourceRowToProxy ( sourceIndex.row() );
        int column = mapSourceColumnToProxy ( sourceIndex.column() );
        return createIndex ( row, column, sourceIndex.internalPointer() );
    }
}

QModelIndex DatasetProxyModel::mapToSource

(

const QModelIndex &

proxyIndex

)

const

Implements the mapping from the proxy to the source indexes.

Definition at line 110 of file KDChartDatasetProxyModel.cpp.

Referenced by data(), flags(), parent(), and setData().

{
    Q_ASSERT_X ( sourceModel(), "DatasetProxyModel::mapToSource", "A source "
                 "model must be set before the selection can be configured." );

    if ( !proxyIndex.isValid() ) return proxyIndex;
    if ( mRowSrcToProxyMap.isEmpty() && mColSrcToProxyMap.isEmpty() )
    {
        return sourceModel()->index( proxyIndex.row(),  proxyIndex.column(), mRootIndex );
    } else {
        int row = mapProxyRowToSource ( proxyIndex.row() );
        int column = mapProxyColumnToSource ( proxyIndex.column() );
        return sourceModel()->index( row, column, mRootIndex );
    }
}

QModelIndex DatasetProxyModel::parent

(

const QModelIndex &

child

)

const

Definition at line 86 of file KDChartDatasetProxyModel.cpp.

References mapFromSource(), and mapToSource().

{
//    return mapFromSource( sourceModel()->parent( child ) );
    return mapFromSource( sourceModel()->parent( mapToSource( child ) ) );
}

void DatasetProxyModel::resetDatasetDescriptions

(

)

[slot]

Reset all dataset description.

After that, the result of the proxying is an empty model (a new dataset description needs to be set to achieve a non-empty result).

Definition at line 210 of file KDChartDatasetProxyModel.cpp.

Referenced by setSourceModel(), and setSourceRootIndex().

{
    mRowSrcToProxyMap.clear();
    mRowProxyToSrcMap.clear();
    mColSrcToProxyMap.clear();
    mColProxyToSrcMap.clear();
    clear();
}

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

Overloaded from base class.

Definition at line 224 of file KDChartDatasetProxyModel.cpp.

References mapToSource().

{
    return sourceModel()->setData( mapToSource( index ), value, role );
}

void DatasetProxyModel::setDatasetColumnDescriptionVector

(

const DatasetDescriptionVector &

columnConfig

)

[slot]

Configure the dataset selection for the columns.

Every call to this method resets the previous dataset description.

Definition at line 60 of file KDChartDatasetProxyModel.cpp.

Referenced by setDatasetDescriptionVectors().

{
    Q_ASSERT_X ( sourceModel(), "DatasetProxyModel::setDatasetColumnDescriptionVector",
                 "A source model must be set before the selection can be configured." );
    initializeDatasetDecriptors ( configuration, sourceModel()->columnCount(mRootIndex),
                                  mColSrcToProxyMap, mColProxyToSrcMap );
    clear(); // clear emits layoutChanged()
}

void DatasetProxyModel::setDatasetDescriptionVectors	(	const DatasetDescriptionVector &	rowConfig,
		const DatasetDescriptionVector &	columnConfig
	)			[slot]

Convenience method to configure rows and columns in one step.

Definition at line 70 of file KDChartDatasetProxyModel.cpp.

References setDatasetColumnDescriptionVector(), and setDatasetRowDescriptionVector().

{
    setDatasetRowDescriptionVector( rowConfig );
    setDatasetColumnDescriptionVector ( columnConfig );
}

void DatasetProxyModel::setDatasetRowDescriptionVector

(

const DatasetDescriptionVector &

rowConfig

)

[slot]

Configure the dataset selection for the rows.

Every call to this method resets the previous dataset description.

Definition at line 50 of file KDChartDatasetProxyModel.cpp.

Referenced by setDatasetDescriptionVectors().

{
    Q_ASSERT_X ( sourceModel(), "DatasetProxyModel::setDatasetRowDescriptionVector",
                 "A source model must be set before the selection can be configured." );
    initializeDatasetDecriptors ( configuration, sourceModel()->rowCount(mRootIndex),
                                  mRowSrcToProxyMap,  mRowProxyToSrcMap );
    clear(); // clear emits layoutChanged()
}

void DatasetProxyModel::setSourceModel

(

QAbstractItemModel *

sourceModel

)

Overloaded from base class.

Definition at line 283 of file KDChartDatasetProxyModel.cpp.

References resetDatasetDescriptions().

{
    QSortFilterProxyModel::setSourceModel ( sourceModel );
    mRootIndex = QModelIndex();
    connect ( sourceModel,  SIGNAL ( layoutChanged() ),
              SLOT( resetDatasetDescriptions() ) );

    resetDatasetDescriptions();
}

void DatasetProxyModel::setSourceRootIndex

(

const QModelIndex &

rootIdx

)

Set the root index of the table in the source model.

Definition at line 293 of file KDChartDatasetProxyModel.cpp.

References resetDatasetDescriptions().

{
    mRootIndex = rootIdx;
    resetDatasetDescriptions();
}

---

The documentation for this class was generated from the following files:

• KDChartDatasetProxyModel.h
• KDChartDatasetProxyModel.cpp

---