LeechCraft  %{LEECHCRAFT_VERSION}
Modular cross-platform feature rich live environment.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
LeechCraft::Util::MergeModel Class Reference

#include "mergemodel.h"

+ Inheritance diagram for LeechCraft::Util::MergeModel:
+ Collaboration diagram for LeechCraft::Util::MergeModel:

Public Types

typedef models_t::iterator iterator
 
typedef models_t::const_iterator const_iterator
 

Public Slots

virtual void handleColumnsAboutToBeInserted (const QModelIndex &, int, int)
 
virtual void handleColumnsAboutToBeRemoved (const QModelIndex &, int, int)
 
virtual void handleColumnsInserted (const QModelIndex &, int, int)
 
virtual void handleColumnsRemoved (const QModelIndex &, int, int)
 
virtual void handleDataChanged (const QModelIndex &, const QModelIndex &)
 
virtual void handleRowsAboutToBeInserted (const QModelIndex &, int, int)
 
virtual void handleRowsAboutToBeRemoved (const QModelIndex &, int, int)
 
virtual void handleRowsInserted (const QModelIndex &, int, int)
 
virtual void handleRowsRemoved (const QModelIndex &, int, int)
 
virtual void handleModelAboutToBeReset ()
 
virtual void handleModelReset ()
 

Public Member Functions

 MergeModel (const QStringList &headers, QObject *parent=0)
 Constructs the merge model. More...
 
virtual int columnCount (const QModelIndex &=QModelIndex()) const
 
virtual QVariant headerData (int, Qt::Orientation, int=Qt::DisplayRole) const
 
virtual QVariant data (const QModelIndex &, int=Qt::DisplayRole) const
 
virtual Qt::ItemFlags flags (const QModelIndex &) const
 
virtual QModelIndex index (int, int, const QModelIndex &=QModelIndex()) const
 
virtual QModelIndex parent (const QModelIndex &) const
 
virtual int rowCount (const QModelIndex &=QModelIndex()) const
 
QStringList mimeTypes () const
 Returns the union of MIME types of the models. More...
 
QMimeData * mimeData (const QModelIndexList &indices) const
 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...
 
const_iterator GetModelForRow (int row, int *starting=0) const
 Returns the model for the given row. More...
 
iterator GetModelForRow (int row, int *starting=0)
 This is an overloaded function provided for convenience. More...
 
QList< QAbstractItemModel * > GetAllModels () const
 Returns all models intalled into this one. More...
 

Protected Types

typedef QList< QPointer
< QAbstractItemModel > > 
models_t
 

Protected Member Functions

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 56 of file mergemodel.h.

Member Typedef Documentation

typedef models_t::const_iterator LeechCraft::Util::MergeModel::const_iterator

Definition at line 70 of file mergemodel.h.

typedef models_t::iterator LeechCraft::Util::MergeModel::iterator

Definition at line 69 of file mergemodel.h.

typedef QList<QPointer<QAbstractItemModel> > LeechCraft::Util::MergeModel::models_t
protected

Definition at line 62 of file mergemodel.h.

Constructor & Destructor Documentation

LeechCraft::Util::MergeModel::MergeModel ( const QStringList &  headers,
QObject *  parent = 0 
)

Constructs the merge model.

Sets the given headers and parent object.

Parameters
[in]headersThe headers of the model.
[in]parentThe parent object of the model.

Definition at line 41 of file mergemodel.cpp.

Member Function Documentation

bool LeechCraft::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]modelThe source model the row belongs.
[in]rowThe row index in the source model.
Returns
Whether the given row should be displayed.

Definition at line 511 of file mergemodel.cpp.

void LeechCraft::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]modelThe model to append to the list.

Definition at line 230 of file mergemodel.cpp.

References handleColumnsAboutToBeInserted(), handleColumnsAboutToBeRemoved(), handleColumnsInserted(), handleColumnsRemoved(), handleDataChanged(), handleModelAboutToBeReset(), handleModelReset(), handleRowsAboutToBeInserted(), handleRowsAboutToBeRemoved(), handleRowsInserted(), handleRowsRemoved(), Models_, and rowCount().

+ Here is the call graph for this function:

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

Definition at line 49 of file mergemodel.cpp.

References mapToSource().

+ Here is the call graph for this function:

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

Definition at line 68 of file mergemodel.cpp.

References mapToSource().

+ Here is the call graph for this function:

MergeModel::const_iterator LeechCraft::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]modelThe model to find.
Returns
The iterator.

Definition at line 301 of file mergemodel.cpp.

References Models_.

Referenced by GetModelForRow(), handleModelAboutToBeReset(), handleModelReset(), handleRowsAboutToBeInserted(), handleRowsAboutToBeRemoved(), handleRowsInserted(), and RemoveModel().

+ Here is the caller graph for this function:

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

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

Parameters
[in]modelThe model to find.
Returns
The iterator.

Definition at line 306 of file mergemodel.cpp.

References Models_.

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

Definition at line 85 of file mergemodel.cpp.

References mapToSource().

+ Here is the call graph for this function:

QList< QAbstractItemModel * > LeechCraft::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 369 of file mergemodel.cpp.

References Models_.

Referenced by mimeTypes().

+ Here is the caller graph for this function:

MergeModel::const_iterator LeechCraft::Util::MergeModel::GetModelForRow ( int  row,
int *  starting = 0 
) 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]rowThe row that should be identified.
[in,out]startingThe pointer to variable that will store the starting row, if not null.
Returns
Iterator associated with the model.
Exceptions
std::runtime_errorThrows if there is no model for such row.

Definition at line 347 of file mergemodel.cpp.

References FindModel(), and GetStartingRow().

+ Here is the call graph for this function:

MergeModel::iterator LeechCraft::Util::MergeModel::GetModelForRow ( int  row,
int *  starting = 0 
)

This is an overloaded function provided for convenience.

Parameters
[in]rowThe row that should be identified.
[in,out]startingThe pointer to variable that will store the starting row, if not null.
Returns
Iterator associated with the model.
Exceptions
std::runtime_errorThrows if there is no model for such row.

Definition at line 358 of file mergemodel.cpp.

References FindModel(), and GetStartingRow().

+ Here is the call graph for this function:

int LeechCraft::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]itThe iterator corresponding to the model.
Returns
The starting row.

Definition at line 339 of file mergemodel.cpp.

References Models_.

Referenced by GetModelForRow(), handleModelAboutToBeReset(), handleModelReset(), handleRowsAboutToBeInserted(), handleRowsAboutToBeRemoved(), and handleRowsInserted().

+ Here is the caller graph for this function:

void LeechCraft::Util::MergeModel::handleColumnsAboutToBeInserted ( const QModelIndex &  ,
int  ,
int   
)
virtualslot

Definition at line 378 of file mergemodel.cpp.

Referenced by AddModel().

+ Here is the caller graph for this function:

void LeechCraft::Util::MergeModel::handleColumnsAboutToBeRemoved ( const QModelIndex &  ,
int  ,
int   
)
virtualslot

Definition at line 382 of file mergemodel.cpp.

Referenced by AddModel().

+ Here is the caller graph for this function:

void LeechCraft::Util::MergeModel::handleColumnsInserted ( const QModelIndex &  ,
int  ,
int   
)
virtualslot

Definition at line 388 of file mergemodel.cpp.

Referenced by AddModel().

+ Here is the caller graph for this function:

void LeechCraft::Util::MergeModel::handleColumnsRemoved ( const QModelIndex &  ,
int  ,
int   
)
virtualslot

Definition at line 392 of file mergemodel.cpp.

Referenced by AddModel().

+ Here is the caller graph for this function:

void LeechCraft::Util::MergeModel::handleDataChanged ( const QModelIndex &  topLeft,
const QModelIndex &  bottomRight 
)
virtualslot

Definition at line 398 of file mergemodel.cpp.

References mapFromSource().

Referenced by AddModel().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void LeechCraft::Util::MergeModel::handleModelAboutToBeReset ( )
virtualslot

Definition at line 483 of file mergemodel.cpp.

References FindModel(), and GetStartingRow().

Referenced by AddModel().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void LeechCraft::Util::MergeModel::handleModelReset ( )
virtualslot

Definition at line 495 of file mergemodel.cpp.

References FindModel(), and GetStartingRow().

Referenced by AddModel().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void LeechCraft::Util::MergeModel::handleRowsAboutToBeInserted ( const QModelIndex &  parent,
int  first,
int  last 
)
virtualslot

Definition at line 404 of file mergemodel.cpp.

References FindModel(), GetStartingRow(), and mapFromSource().

Referenced by AddModel().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void LeechCraft::Util::MergeModel::handleRowsAboutToBeRemoved ( const QModelIndex &  parent,
int  first,
int  last 
)
virtualslot

Definition at line 416 of file mergemodel.cpp.

References FindModel(), GetStartingRow(), and mapFromSource().

Referenced by AddModel().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void LeechCraft::Util::MergeModel::handleRowsInserted ( const QModelIndex &  parent,
int  first,
int  last 
)
virtualslot

Definition at line 444 of file mergemodel.cpp.

References FindModel(), GetStartingRow(), and mapFromSource().

Referenced by AddModel().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void LeechCraft::Util::MergeModel::handleRowsRemoved ( const QModelIndex &  ,
int  ,
int   
)
virtualslot

Definition at line 478 of file mergemodel.cpp.

Referenced by AddModel().

+ Here is the caller graph for this function:

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

Definition at line 60 of file mergemodel.cpp.

QModelIndex LeechCraft::Util::MergeModel::index ( int  row,
int  column,
const QModelIndex &  parent = QModelIndex () 
) const
virtual

Definition at line 99 of file mergemodel.cpp.

Referenced by mimeData().

+ Here is the caller graph for this function:

QModelIndex LeechCraft::Util::MergeModel::mapFromSource ( const QModelIndex &  index) const
virtual

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

Parameters
[in]indexSource index.
Returns
MergeModel's index.

Definition at line 180 of file mergemodel.cpp.

References parent().

Referenced by handleDataChanged(), handleRowsAboutToBeInserted(), handleRowsAboutToBeRemoved(), and handleRowsInserted().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

QModelIndex LeechCraft::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]indexMergeModel's index.
Returns
Source index.

Definition at line 210 of file mergemodel.cpp.

Referenced by columnCount(), data(), flags(), and mimeData().

+ Here is the caller graph for this function:

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

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]indicesThe indices for which to return the MIME data.
Returns
The MIME data.

Definition at line 155 of file mergemodel.cpp.

References index(), and mapToSource().

+ Here is the call graph for this function:

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

Returns the union of MIME types of the models.

Returns
The union of all the MIME types.

Definition at line 133 of file mergemodel.cpp.

References GetAllModels().

+ Here is the call graph for this function:

QModelIndex LeechCraft::Util::MergeModel::parent ( const QModelIndex &  index) const
virtual

Definition at line 111 of file mergemodel.cpp.

Referenced by mapFromSource().

+ Here is the caller graph for this function:

void LeechCraft::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]modelThe model to remove from the list.

Definition at line 311 of file mergemodel.cpp.

References FindModel(), and Models_.

+ Here is the call graph for this function:

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

Definition at line 124 of file mergemodel.cpp.

References LeechCraft::Util::ModelItem::GetModel().

Referenced by AddModel().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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

Sets the new headers for this model.

Parameters
[in]headersThe new headers.

Definition at line 225 of file mergemodel.cpp.

void LeechCraft::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_errorNo matter what, you'd get it.

Definition at line 220 of file mergemodel.cpp.

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

Returns the number of child models in the merger.

Returns
The number of child models.

Definition at line 334 of file mergemodel.cpp.

References Models_.

Member Data Documentation

models_t LeechCraft::Util::MergeModel::Models_
protected

Definition at line 63 of file mergemodel.h.

Referenced by AddModel(), FindModel(), GetAllModels(), GetStartingRow(), RemoveModel(), and Size().


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