#include "mergemodel.h"

Inheritance diagram for LC::Util::MergeModel:

Collaboration diagram for LC::Util::MergeModel:

Public Types
using	iterator = models_t::iterator

using	const_iterator = models_t::const_iterator

Public Member Functions
	MergeModel (QStringList headers, QObject *parent=nullptr)
	Constructs the merge model. More...

int	columnCount (const QModelIndex &=QModelIndex()) const override

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

QVariant	data (const QModelIndex &, int=Qt::DisplayRole) const override

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

QModelIndex	index (int, int, const QModelIndex &=QModelIndex()) const override

QModelIndex	parent (const QModelIndex &) const override

int	rowCount (const QModelIndex &=QModelIndex()) const override

QStringList	mimeTypes () const override
	Returns the union of MIME types of the models. More...

QMimeData *	mimeData (const QModelIndexList &indices) const override
	Returns the MIME data for the given indices. More...

virtual QModelIndex	mapFromSource (const QModelIndex &index) const
	Returns the model index in the MergeModel given the index from the source model. More...

virtual QModelIndex	mapToSource (const QModelIndex &index) const
	Returns the source model index corresponding to the given index from the sorting filter model. More...

virtual void	setSourceModel (QAbstractItemModel *)

void	SetHeaders (const QStringList &headers)
	Sets the new headers for this model. More...

void	AddModel (QAbstractItemModel *model)
	Adds a model to the list of source models. More...

void	RemoveModel (QAbstractItemModel *model)
	Removes a model from the list of source models. More...

size_t	Size () const
	Returns the number of child models in the merger. More...

const_iterator	FindModel (const QAbstractItemModel *model) const
	Returns a const_iterator corresponding to the passed model, or one-past-end if no such model is found. More...

iterator	FindModel (const QAbstractItemModel *model)
	This is an overloaded function provided for convenience. Non-const and returns a non-const iterator. More...

int	GetStartingRow (const_iterator it) const
	Finds starting row for the model pointed by it. More...

int	GetStartingRow (iterator it)
	Finds starting row for the model pointed by it. More...

const_iterator	GetModelForRow (int row, int *starting=nullptr) const
	Returns the model for the given row. More...

iterator	GetModelForRow (int row, int *starting=nullptr)
	This is an overloaded function provided for convenience. More...

QList< QAbstractItemModel * >	GetAllModels () const
	Returns all models intalled into this one. More...

Protected Types
using	models_t = QList< QPointer< QAbstractItemModel > >

Protected Member Functions
virtual void	HandleRowsAboutToBeInserted (QAbstractItemModel *, const QModelIndex &, int, int)

virtual void	HandleRowsAboutToBeRemoved (QAbstractItemModel *, const QModelIndex &, int, int)

virtual void	HandleRowsInserted (QAbstractItemModel *, const QModelIndex &, int, int)

virtual void	HandleRowsRemoved (QAbstractItemModel *, const QModelIndex &, int, int)

virtual void	HandleModelAboutToBeReset (QAbstractItemModel *)

virtual void	HandleModelReset (QAbstractItemModel *)

virtual bool	AcceptsRow (QAbstractItemModel *model, int row) const
	Allows to filter rows from the resulting model. More...

Protected Attributes
models_t	Models_

Detailed Description

Merges data from multiple source models into one resulting model and provides means to lookup models by row, get starting rows for a model etc.

To add a new source model, one should use AddModel() as setSourceModel() throws an std::runtime_error exception.

Currently it doesn't support hierarchical source models. Seems like it would never support it at least someone would try to implement it.

Definition at line 40 of file mergemodel.h.

Member Typedef Documentation

◆ const_iterator

using LC::Util::MergeModel::const_iterator = models_t::const_iterator

Definition at line 60 of file mergemodel.h.

◆ iterator

using LC::Util::MergeModel::iterator = models_t::iterator

Definition at line 59 of file mergemodel.h.

◆ models_t

using LC::Util::MergeModel::models_t = QList<QPointer<QAbstractItemModel> >

protected

Definition at line 50 of file mergemodel.h.

Constructor & Destructor Documentation

◆ MergeModel()

LC::Util::MergeModel::MergeModel	(	QStringList	headers,
		QObject *	parent = `nullptr`
	)

explicit

Constructs the merge model.

Sets the given headers and parent object.

Parameters

[in]	headers	The headers of the model.
[in]	parent	The parent object of the model.

Definition at line 25 of file mergemodel.cpp.

References index(), and mapToSource().

Here is the call graph for this function:

Member Function Documentation

◆ AcceptsRow()

bool LC::Util::MergeModel::AcceptsRow	(	QAbstractItemModel *	model,
		int	row
	)		const

protectedvirtual

Allows to filter rows from the resulting model.

This virtual function could be overridden to provide custom filtering facilities. If the row in the model should be merged into the resulting model, this function should return true, otherwise if it returns false the row would be filtered out.

Parameters

[in]	model	The source model the row belongs.
[in]	row	The row index in the source model.

Returns: Whether the given row should be displayed.

Definition at line 452 of file mergemodel.cpp.

◆ AddModel()

void LC::Util::MergeModel::AddModel ( QAbstractItemModel * model )

Adds a model to the list of source models.

The newly added model is appended to the end.

If the model already exists in the list, it is added again, and bad things would happen, as all the signals and slots would be connected and called twice. So it's your duty to ensure that you don't add the same model more than once.

Parameters

[in] model The model to append to the list.

Definition at line 206 of file mergemodel.cpp.

◆ columnCount()

int LC::Util::MergeModel::columnCount ( const QModelIndex & index = QModelIndex () ) const

override

Definition at line 32 of file mergemodel.cpp.

◆ data()

QVariant LC::Util::MergeModel::data	(	const QModelIndex &	index,
		int	role = `Qt::DisplayRole`
	)		const

override

Definition at line 48 of file mergemodel.cpp.

References index(), and mapToSource().

Here is the call graph for this function:

◆ FindModel() [1/2]

MergeModel::iterator LC::Util::MergeModel::FindModel ( const QAbstractItemModel * model )

This is an overloaded function provided for convenience. Non-const and returns a non-const iterator.

Parameters

[in] model The model to find.

Returns: The iterator.

Definition at line 274 of file mergemodel.cpp.

References FindModel(), and Models_.

Here is the call graph for this function:

◆ FindModel() [2/2]

MergeModel::const_iterator LC::Util::MergeModel::FindModel ( const QAbstractItemModel * model ) const

Returns a const_iterator corresponding to the passed model, or one-past-end if no such model is found.

Parameters

[in] model The model to find.

Returns: The iterator.

Definition at line 269 of file mergemodel.cpp.

References Models_.

Referenced by FindModel(), and HandleRowsRemoved().

Here is the caller graph for this function:

◆ flags()

Qt::ItemFlags LC::Util::MergeModel::flags ( const QModelIndex & index ) const

override

Definition at line 65 of file mergemodel.cpp.

◆ GetAllModels()

QList< QAbstractItemModel * > LC::Util::MergeModel::GetAllModels ( ) const

Returns all models intalled into this one.

Only those models that are not null (and, thus, haven't been destroyed) are returned in the list. This list is guaranteed to contain only valid objects.

Returns: The list of models.

Definition at line 347 of file mergemodel.cpp.

◆ GetModelForRow() [1/2]

MergeModel::iterator LC::Util::MergeModel::GetModelForRow	(	int	row,
		int *	starting = `nullptr`
	)

This is an overloaded function provided for convenience.

Parameters

[in]	row	The row that should be identified.
[in,out]	starting	The pointer to variable that will store the starting row, if not null.

Returns: Iterator associated with the model.

Exceptions

std::runtime_error Throws if there is no model for such row.

Definition at line 336 of file mergemodel.cpp.

◆ GetModelForRow() [2/2]

MergeModel::const_iterator LC::Util::MergeModel::GetModelForRow	(	int	row,
		int *	starting = `nullptr`
	)		const

Returns the model for the given row.

Returns the model that corresponds to the given row. If there is no such model, throws std::runtime_error. If starting is not null, it also calculates and returns the starting row for the returned model. This allows one to avoid calling GetStartingRow() after this function and thus speed things up.

Parameters

[in]	row	The row that should be identified.
[in,out]	starting	The pointer to variable that will store the starting row, if not null.

Returns: Iterator associated with the model.

Exceptions

std::runtime_error Throws if there is no model for such row.

Definition at line 325 of file mergemodel.cpp.

◆ GetStartingRow() [1/2]

int LC::Util::MergeModel::GetStartingRow ( MergeModel::const_iterator it ) const

Finds starting row for the model pointed by it.

Returns the row in the resulting MergeModel from which do begin rows which belong to the model corresponding to the given const_iterator.

Parameters

[in] it The iterator corresponding to the model.

Returns: The starting row.

Definition at line 309 of file mergemodel.cpp.

Referenced by HandleRowsRemoved().

Here is the caller graph for this function:

◆ GetStartingRow() [2/2]

int LC::Util::MergeModel::GetStartingRow ( MergeModel::iterator it )

Finds starting row for the model pointed by it.

Returns the row in the resulting MergeModel from which do begin rows which belong to the model corresponding to the given const_iterator.

Parameters

[in] it The iterator corresponding to the model.

Returns: The starting row.

Definition at line 317 of file mergemodel.cpp.

◆ HandleModelAboutToBeReset()

void LC::Util::MergeModel::HandleModelAboutToBeReset ( QAbstractItemModel * model )

protectedvirtual

Definition at line 426 of file mergemodel.cpp.

◆ HandleModelReset()

void LC::Util::MergeModel::HandleModelReset ( QAbstractItemModel * model )

protectedvirtual

Definition at line 437 of file mergemodel.cpp.

◆ HandleRowsAboutToBeInserted()

void LC::Util::MergeModel::HandleRowsAboutToBeInserted	(	QAbstractItemModel *	model,
		const QModelIndex &	parent,
		int	first,
		int	last
	)

protectedvirtual

Definition at line 356 of file mergemodel.cpp.

◆ HandleRowsAboutToBeRemoved()

void LC::Util::MergeModel::HandleRowsAboutToBeRemoved	(	QAbstractItemModel *	model,
		const QModelIndex &	parent,
		int	first,
		int	last
	)

protectedvirtual

Definition at line 365 of file mergemodel.cpp.

◆ HandleRowsInserted()

void LC::Util::MergeModel::HandleRowsInserted	(	QAbstractItemModel *	model,
		const QModelIndex &	parent,
		int	first,
		int	last
	)

protectedvirtual

Definition at line 388 of file mergemodel.cpp.

References parent().

Here is the call graph for this function:

◆ HandleRowsRemoved()

void LC::Util::MergeModel::HandleRowsRemoved	(	QAbstractItemModel *	,
		const QModelIndex &	,
		int	,
		int
	)

protectedvirtual

Definition at line 420 of file mergemodel.cpp.

References FindModel(), and GetStartingRow().

Here is the call graph for this function:

◆ headerData()

QVariant LC::Util::MergeModel::headerData	(	int	column,
		Qt::Orientation	orient,
		int	role = `Qt::DisplayRole`
	)		const

override

Definition at line 40 of file mergemodel.cpp.

◆ index()

QModelIndex LC::Util::MergeModel::index	(	int	row,
		int	column,
		const QModelIndex &	parent = `QModelIndex ()`
	)		const

override

Definition at line 79 of file mergemodel.cpp.

Referenced by data(), and MergeModel().

Here is the caller graph for this function:

◆ mapFromSource()

QModelIndex LC::Util::MergeModel::mapFromSource ( const QModelIndex & index ) const

virtual

Returns the model index in the MergeModel given the index from the source model.

Parameters

[in] index Source index.

Returns: MergeModel's index.

Definition at line 156 of file mergemodel.cpp.

References parent().

Here is the call graph for this function:

◆ mapToSource()

QModelIndex LC::Util::MergeModel::mapToSource ( const QModelIndex & index ) const

virtual

Returns the source model index corresponding to the given index from the sorting filter model.

Parameters

[in] index MergeModel's index.

Returns: Source index.

Definition at line 186 of file mergemodel.cpp.

Referenced by data(), and MergeModel().

Here is the caller graph for this function:

◆ mimeData()

QMimeData * LC::Util::MergeModel::mimeData ( const QModelIndexList & indices ) const

override

Returns the MIME data for the given indices.

This function queries the corresponding source model for each index of the indices, merging the URL list (if any) and using first obtained data of any other format.

Parameters

[in] indices The indices for which to return the MIME data.

Returns: The MIME data.

Definition at line 135 of file mergemodel.cpp.

◆ mimeTypes()

QStringList LC::Util::MergeModel::mimeTypes ( ) const

override

Returns the union of MIME types of the models.

Returns: The union of all the MIME types.

Definition at line 113 of file mergemodel.cpp.

◆ parent()

QModelIndex LC::Util::MergeModel::parent ( const QModelIndex & index ) const

override

Definition at line 91 of file mergemodel.cpp.

Referenced by HandleRowsInserted(), and mapFromSource().

Here is the caller graph for this function:

◆ RemoveModel()

void LC::Util::MergeModel::RemoveModel ( QAbstractItemModel * model )

Removes a model from the list of source models.

If there is no such model, this function does nothing.

Parameters

[in] model The model to remove from the list.

Definition at line 279 of file mergemodel.cpp.

◆ rowCount()

int LC::Util::MergeModel::rowCount ( const QModelIndex & parent = QModelIndex () ) const

override

Definition at line 104 of file mergemodel.cpp.

◆ SetHeaders()

void LC::Util::MergeModel::SetHeaders ( const QStringList & headers )

Sets the new headers for this model.

Parameters

[in] headers The new headers.

Definition at line 201 of file mergemodel.cpp.

References Models_.

◆ setSourceModel()

void LC::Util::MergeModel::setSourceModel ( QAbstractItemModel * )

virtual

You shouldn't use this function because its semantics in the context of multiple source models aren't clearly defined. Calling this function results in std::runtime_error.

Exceptions

std::runtime_error No matter what, you'd get it.

Definition at line 196 of file mergemodel.cpp.

◆ Size()

size_t LC::Util::MergeModel::Size ( ) const

Returns the number of child models in the merger.

Returns: The number of child models.

Definition at line 304 of file mergemodel.cpp.

References Models_.

Member Data Documentation

◆ Models_

models_t LC::Util::MergeModel::Models_

protected

Definition at line 51 of file mergemodel.h.

Referenced by FindModel(), SetHeaders(), and Size().

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

/home/d34df00d/leechcraft/src/util/models/mergemodel.h
/home/d34df00d/leechcraft/src/util/models/mergemodel.cpp

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ const_iterator

◆ iterator

◆ models_t

Constructor & Destructor Documentation

◆ MergeModel()

Member Function Documentation

◆ AcceptsRow()

◆ AddModel()

◆ columnCount()

◆ data()

◆ FindModel() [1/2]

◆ FindModel() [2/2]

◆ flags()

◆ GetAllModels()

◆ GetModelForRow() [1/2]

◆ GetModelForRow() [2/2]

◆ GetStartingRow() [1/2]

◆ GetStartingRow() [2/2]

◆ HandleModelAboutToBeReset()

◆ HandleModelReset()

◆ HandleRowsAboutToBeInserted()

◆ HandleRowsAboutToBeRemoved()

◆ HandleRowsInserted()

◆ HandleRowsRemoved()

◆ headerData()

◆ index()

◆ mapFromSource()

◆ mapToSource()

◆ mimeData()

◆ mimeTypes()

◆ parent()

◆ RemoveModel()

◆ rowCount()

◆ SetHeaders()

◆ setSourceModel()

◆ Size()

Member Data Documentation

◆ Models_