KChart::DatasetProxyModel

#include <KChartDatasetProxyModel.h>

Inheritance diagram for KChart::DatasetProxyModel:

[legend]

Public Slots
void	resetDatasetDescriptions ()

void	setDatasetColumnDescriptionVector (const KChart::DatasetDescriptionVector &columnConfig)

void	setDatasetDescriptionVectors (const KChart::DatasetDescriptionVector &rowConfig, const KChart::DatasetDescriptionVector &columnConfig)

void	setDatasetRowDescriptionVector (const KChart::DatasetDescriptionVector &rowConfig)

Public Member Functions
	DatasetProxyModel (QObject *parent=nullptr)

QModelIndex	buddy (const QModelIndex &index) const override

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

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

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

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

QModelIndex	mapFromSource (const QModelIndex &sourceIndex) const override

QModelIndex	mapToSource (const QModelIndex &proxyIndex) const override

QModelIndex	parent (const QModelIndex &child) const override

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

void	setSourceModel (QAbstractItemModel *sourceModel) override

void	setSourceRootIndex (const QModelIndex &rootIdx)

Public Member Functions inherited from QSortFilterProxyModel
	QSortFilterProxyModel (QObject *parent)

bool	autoAcceptChildRows () const const

void	autoAcceptChildRowsChanged (bool autoAcceptChildRows)

QBindable< bool >	bindableAutoAcceptChildRows ()

QBindable< bool >	bindableDynamicSortFilter ()

QBindable< Qt::CaseSensitivity >	bindableFilterCaseSensitivity ()

QBindable< int >	bindableFilterKeyColumn ()

QBindable< QRegularExpression >	bindableFilterRegularExpression ()

QBindable< int >	bindableFilterRole ()

QBindable< bool >	bindableIsSortLocaleAware ()

QBindable< bool >	bindableRecursiveFilteringEnabled ()

QBindable< Qt::CaseSensitivity >	bindableSortCaseSensitivity ()

QBindable< int >	bindableSortRole ()

virtual bool	canFetchMore (const QModelIndex &parent) const const override

virtual int	columnCount (const QModelIndex &parent) const const override

virtual bool	dropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) override

bool	dynamicSortFilter () const const

virtual void	fetchMore (const QModelIndex &parent) override

Qt::CaseSensitivity	filterCaseSensitivity () const const

void	filterCaseSensitivityChanged (Qt::CaseSensitivity filterCaseSensitivity)

int	filterKeyColumn () const const

QRegularExpression	filterRegularExpression () const const

int	filterRole () const const

void	filterRoleChanged (int filterRole)

virtual bool	hasChildren (const QModelIndex &parent) const const override

virtual bool	insertColumns (int column, int count, const QModelIndex &parent) override

virtual bool	insertRows (int row, int count, const QModelIndex &parent) override

void	invalidate ()

bool	isRecursiveFilteringEnabled () const const

bool	isSortLocaleAware () const const

virtual QItemSelection	mapSelectionFromSource (const QItemSelection &sourceSelection) const const override

virtual QItemSelection	mapSelectionToSource (const QItemSelection &proxySelection) const const override

virtual QModelIndexList	match (const QModelIndex &start, int role, const QVariant &value, int hits, Qt::MatchFlags flags) const const override

virtual QMimeData *	mimeData (const QModelIndexList &indexes) const const override

virtual QStringList	mimeTypes () const const override

void	recursiveFilteringEnabledChanged (bool recursiveFilteringEnabled)

virtual bool	removeColumns (int column, int count, const QModelIndex &parent) override

virtual bool	removeRows (int row, int count, const QModelIndex &parent) override

virtual int	rowCount (const QModelIndex &parent) const const override

void	setAutoAcceptChildRows (bool accept)

void	setDynamicSortFilter (bool enable)

void	setFilterCaseSensitivity (Qt::CaseSensitivity cs)

void	setFilterFixedString (const QString &pattern)

void	setFilterKeyColumn (int column)

void	setFilterRegularExpression (const QRegularExpression &regularExpression)

void	setFilterRegularExpression (const QString &pattern)

void	setFilterRole (int role)

void	setFilterWildcard (const QString &pattern)

virtual bool	setHeaderData (int section, Qt::Orientation orientation, const QVariant &value, int role) override

void	setRecursiveFilteringEnabled (bool recursive)

void	setSortCaseSensitivity (Qt::CaseSensitivity cs)

void	setSortLocaleAware (bool on)

void	setSortRole (int role)

virtual QModelIndex	sibling (int row, int column, const QModelIndex &idx) const const override

virtual void	sort (int column, Qt::SortOrder order) override

Qt::CaseSensitivity	sortCaseSensitivity () const const

void	sortCaseSensitivityChanged (Qt::CaseSensitivity sortCaseSensitivity)

int	sortColumn () const const

void	sortLocaleAwareChanged (bool sortLocaleAware)

Qt::SortOrder	sortOrder () const const

int	sortRole () const const

void	sortRoleChanged (int sortRole)

virtual QSize	span (const QModelIndex &index) const const override

virtual Qt::DropActions	supportedDropActions () const const override

Public Member Functions inherited from QAbstractProxyModel
	QAbstractProxyModel (QObject *parent)

QBindable< QAbstractItemModel * >	bindableSourceModel ()

virtual bool	canDropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) const const override

virtual bool	clearItemData (const QModelIndex &index) override

virtual QMap< int, QVariant >	itemData (const QModelIndex &proxyIndex) const const override

virtual void	revert () override

virtual QHash< int, QByteArray >	roleNames () const const override

virtual bool	setItemData (const QModelIndex &index, const QMap< int, QVariant > &roles) override

QAbstractItemModel *	sourceModel () const const

void	sourceModelChanged ()

virtual bool	submit () override

virtual Qt::DropActions	supportedDragActions () const const override

Public Member Functions inherited from QAbstractItemModel
	QAbstractItemModel (QObject *parent)

bool	checkIndex (const QModelIndex &index, CheckIndexOptions options) const const

void	columnsAboutToBeInserted (const QModelIndex &parent, int first, int last)

void	columnsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn)

void	columnsAboutToBeRemoved (const QModelIndex &parent, int first, int last)

void	columnsInserted (const QModelIndex &parent, int first, int last)

void	columnsMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn)

void	columnsRemoved (const QModelIndex &parent, int first, int last)

void	dataChanged (const QModelIndex &topLeft, const QModelIndex &bottomRight, const QList< int > &roles)

bool	hasIndex (int row, int column, const QModelIndex &parent) const const

void	headerDataChanged (Qt::Orientation orientation, int first, int last)

bool	insertColumn (int column, const QModelIndex &parent)

bool	insertRow (int row, const QModelIndex &parent)

void	layoutAboutToBeChanged (const QList< QPersistentModelIndex > &parents, QAbstractItemModel::LayoutChangeHint hint)

void	layoutChanged (const QList< QPersistentModelIndex > &parents, QAbstractItemModel::LayoutChangeHint hint)

void	modelAboutToBeReset ()

void	modelReset ()

bool	moveColumn (const QModelIndex &sourceParent, int sourceColumn, const QModelIndex &destinationParent, int destinationChild)

virtual bool	moveColumns (const QModelIndex &sourceParent, int sourceColumn, int count, const QModelIndex &destinationParent, int destinationChild)

bool	moveRow (const QModelIndex &sourceParent, int sourceRow, const QModelIndex &destinationParent, int destinationChild)

virtual bool	moveRows (const QModelIndex &sourceParent, int sourceRow, int count, const QModelIndex &destinationParent, int destinationChild)

virtual void	multiData (const QModelIndex &index, QModelRoleDataSpan roleDataSpan) const const

bool	removeColumn (int column, const QModelIndex &parent)

bool	removeRow (int row, const QModelIndex &parent)

void	rowsAboutToBeInserted (const QModelIndex &parent, int start, int end)

void	rowsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow)

void	rowsAboutToBeRemoved (const QModelIndex &parent, int first, int last)

void	rowsInserted (const QModelIndex &parent, int first, int last)

void	rowsMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow)

void	rowsRemoved (const QModelIndex &parent, int first, int last)

Public Member Functions inherited from QObject
	QObject (QObject *parent)

QBindable< QString >	bindableObjectName ()

bool	blockSignals (bool block)

const QObjectList &	children () const const

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method) const const

bool	disconnect (const QObject receiver, const char method) const const

void	dumpObjectInfo () const const

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (Qt::FindChildOptions options) const const

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

bool	isQuickItemType () const const

bool	isWidgetType () const const

bool	isWindowType () const const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const const

void	moveToThread (QThread *targetThread)

QString	objectName () const const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

QVariant	property (const char *name) const const

	Q_CLASSINFO (Name, Value)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_GADGET_EXPORT (EXPORT_MACRO)

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	Q_MOC_INCLUDE Q_MOC_INCLUDE

	Q_NAMESPACE Q_NAMESPACE

	Q_NAMESPACE_EXPORT (EXPORT_MACRO)

	Q_OBJECT Q_OBJECT

	Q_PROPERTY (...)

	Q_REVISION Q_REVISION

	Q_SET_OBJECT_NAME (Object)

	Q_SIGNAL Q_SIGNAL

	Q_SIGNALS Q_SIGNALS

	Q_SLOT Q_SLOT

	Q_SLOTS Q_SLOTS

T	qobject_cast (const QObject *object)

T	qobject_cast (QObject *object)

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setObjectName (QAnyStringView name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	setProperty (const char *name, QVariant &&value)

bool	signalsBlocked () const const

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)

QThread *	thread () const const

Protected Member Functions
bool	filterAcceptsColumn (int sourceColumn, const QModelIndex &) const override

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

Protected Member Functions inherited from QSortFilterProxyModel
void	invalidateColumnsFilter ()

void	invalidateFilter ()

void	invalidateRowsFilter ()

virtual bool	lessThan (const QModelIndex &source_left, const QModelIndex &source_right) const const

Protected Member Functions inherited from QAbstractProxyModel
QModelIndex	createSourceIndex (int row, int col, void *internalPtr) const const

Protected Member Functions inherited from QAbstractItemModel
void	beginInsertColumns (const QModelIndex &parent, int first, int last)

void	beginInsertRows (const QModelIndex &parent, int first, int last)

bool	beginMoveColumns (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationChild)

bool	beginMoveRows (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationChild)

void	beginRemoveColumns (const QModelIndex &parent, int first, int last)

void	beginRemoveRows (const QModelIndex &parent, int first, int last)

void	beginResetModel ()

void	changePersistentIndex (const QModelIndex &from, const QModelIndex &to)

void	changePersistentIndexList (const QModelIndexList &from, const QModelIndexList &to)

QModelIndex	createIndex (int row, int column, const void *ptr) const const

QModelIndex	createIndex (int row, int column, quintptr id) const const

void	endInsertColumns ()

void	endInsertRows ()

void	endMoveColumns ()

void	endMoveRows ()

void	endRemoveColumns ()

void	endRemoveRows ()

void	endResetModel ()

QModelIndexList	persistentIndexList () const const

virtual void	resetInternalData ()

Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const QMetaMethod &signal)

bool	isSignalConnected (const QMetaMethod &signal) const const

int	receivers (const char *signal) const const

QObject *	sender () const const

int	senderSignalIndex () const const

virtual void	timerEvent (QTimerEvent *event)

Additional Inherited Members
Public Types inherited from QAbstractItemModel
enum	CheckIndexOption

enum	LayoutChangeHint

Properties inherited from QSortFilterProxyModel
	autoAcceptChildRows

	dynamicSortFilter

	filterCaseSensitivity

	filterKeyColumn

	filterRegularExpression

	filterRole

	isSortLocaleAware

	recursiveFilteringEnabled

	sortCaseSensitivity

	sortRole

Properties inherited from QAbstractProxyModel
	sourceModel

Properties inherited from QObject
	objectName

Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

QString	tr (const char sourceText, const char disambiguation, int n)

Public Attributes inherited from QAbstractItemModel
typedef	CheckIndexOptions

	DoNotUseParent

	HorizontalSortHint

	IndexIsValid

	NoLayoutChangeHint

	NoOption

	ParentIsInvalid

	VerticalSortHint

Public Attributes inherited from QObject
typedef	QObjectList

Detailed Description

DatasetProxyModel takes a KChart 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 41 of file KChartDatasetProxyModel.h.

Constructor & Destructor Documentation

◆ DatasetProxyModel()

DatasetProxyModel::DatasetProxyModel ( QObject * parent = nullptr )

explicit

Create a DatasetProxyModel.

Without further configuration, this model is invalid.

See also: setDatasetDescriptionVector

Definition at line 18 of file KChartDatasetProxyModel.cpp.

Member Function Documentation

◆ buddy()

QModelIndex DatasetProxyModel::buddy ( const QModelIndex & index ) const

overridevirtual

Reimplemented from QSortFilterProxyModel.

Definition at line 23 of file KChartDatasetProxyModel.cpp.

◆ data()

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

overridevirtual

Overloaded from base class.

Reimplemented from QSortFilterProxyModel.

Definition at line 202 of file KChartDatasetProxyModel.cpp.

◆ filterAcceptsColumn()

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

overrideprotectedvirtual

Decide whether the column is accepted.

Reimplemented from QSortFilterProxyModel.

Definition at line 129 of file KChartDatasetProxyModel.cpp.

◆ filterAcceptsRow()

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

overrideprotectedvirtual

Decide whether the row is accepted.

Reimplemented from QSortFilterProxyModel.

Definition at line 109 of file KChartDatasetProxyModel.cpp.

◆ flags()

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

overridevirtual

Reimplemented from QSortFilterProxyModel.

Definition at line 28 of file KChartDatasetProxyModel.cpp.

◆ headerData()

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

overridevirtual

Overloaded from base class.

Reimplemented from QSortFilterProxyModel.

Definition at line 212 of file KChartDatasetProxyModel.cpp.

◆ index()

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

overridevirtual

Reimplemented from QSortFilterProxyModel.

Definition at line 61 of file KChartDatasetProxyModel.cpp.

◆ mapFromSource()

QModelIndex DatasetProxyModel::mapFromSource ( const QModelIndex & sourceIndex ) const

overridevirtual

Implements the mapping from the source to the proxy indexes.

Reimplemented from QSortFilterProxyModel.

Definition at line 75 of file KChartDatasetProxyModel.cpp.

◆ mapToSource()

QModelIndex DatasetProxyModel::mapToSource ( const QModelIndex & proxyIndex ) const

overridevirtual

Implements the mapping from the proxy to the source indexes.

Reimplemented from QSortFilterProxyModel.

Definition at line 93 of file KChartDatasetProxyModel.cpp.

◆ parent()

QModelIndex DatasetProxyModel::parent ( const QModelIndex & child ) const

overridevirtual

Reimplemented from QSortFilterProxyModel.

Definition at line 69 of file KChartDatasetProxyModel.cpp.

◆ resetDatasetDescriptions

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 193 of file KChartDatasetProxyModel.cpp.

◆ setData()

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

overridevirtual

Overloaded from base class.

Reimplemented from QSortFilterProxyModel.

Definition at line 207 of file KChartDatasetProxyModel.cpp.

◆ setDatasetColumnDescriptionVector

void DatasetProxyModel::setDatasetColumnDescriptionVector ( const KChart::DatasetDescriptionVector & columnConfig )

slot

Configure the dataset selection for the columns.

Every call to this method resets the previous dataset description.

Definition at line 43 of file KChartDatasetProxyModel.cpp.

◆ setDatasetDescriptionVectors

void DatasetProxyModel::setDatasetDescriptionVectors	(	const KChart::DatasetDescriptionVector &	rowConfig,
		const KChart::DatasetDescriptionVector &	columnConfig )

slot

Convenience method to configure rows and columns in one step.

Definition at line 53 of file KChartDatasetProxyModel.cpp.

◆ setDatasetRowDescriptionVector

void DatasetProxyModel::setDatasetRowDescriptionVector ( const KChart::DatasetDescriptionVector & rowConfig )

slot

Configure the dataset selection for the rows.

Every call to this method resets the previous dataset description.

Definition at line 33 of file KChartDatasetProxyModel.cpp.

◆ setSourceModel()

void DatasetProxyModel::setSourceModel ( QAbstractItemModel * sourceModel )

overridevirtual

Overloaded from base class.

Reimplemented from QSortFilterProxyModel.

Definition at line 262 of file KChartDatasetProxyModel.cpp.

◆ setSourceRootIndex()

void DatasetProxyModel::setSourceRootIndex ( const QModelIndex & rootIdx )

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

Definition at line 278 of file KChartDatasetProxyModel.cpp.

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

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About KChart

KChart::DatasetProxyModel

Public Slots

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DatasetProxyModel()

Member Function Documentation

◆ buddy()

◆ data()

◆ filterAcceptsColumn()

◆ filterAcceptsRow()

◆ flags()

◆ headerData()

◆ index()

◆ mapFromSource()

◆ mapToSource()

◆ parent()

◆ resetDatasetDescriptions

◆ setData()

◆ setDatasetColumnDescriptionVector

◆ setDatasetDescriptionVectors

◆ setDatasetRowDescriptionVector

◆ setSourceModel()

◆ setSourceRootIndex()