Container for a chain of proxy models based on QAbstractProxyModel. More...

#include <ProxyModelContainer.h>

Public Member Functions
	ProxyModelContainer ()=default
	Constructor.

void	setSourceModel (QAbstractItemModel *model)
	Set source model. More...

QAbstractItemModel *	sourceModel () const
	Get source model. More...

QAbstractItemModel *	modelForView () const
	Get model for the view. More...

void	appendProxyModel (QAbstractProxyModel *model)
	Add a proxy model to the end. More...

void	prependProxyModel (QAbstractProxyModel *model)
	Add a proxy model to the begin. More...

QAbstractProxyModel *	firstProxyModel () const
	Get first proxy model. More...

QAbstractProxyModel *	lastProxyModel () const
	Get last proxy model. More...

int	proxyModelCount () const
	Get count of proxy models.

QAbstractProxyModel *	proxyModelAt (int index) const
	Get proxy model at index. More...

int	indexOfProxyModel (QAbstractProxyModel *model) const
	Get the index of the proxy model. More...

template<typename T >
bool	containsProxyModelOfType () const
	Check if a proxy model of type T exists in this container.

template<typename T >
int	indexOfFirstProxyModelOfType () const
	Get the index of the first proxy model that is of type T. More...

template<typename T >
QAbstractProxyModel *	firstProxyModelOfType () const
	Get the first proxy model that is of type T. More...

void	removeProxyModel (QAbstractProxyModel *model)
	Remove a proxy model. More...

void	deleteProxyModel (QAbstractProxyModel *model)
	Delete a proxy model. More...

void	removeProxyModelAt (int index)
	Remove proxy model at index. More...

void	deleteProxyModelAt (int index)
	Delete proxy model at index. More...

template<typename T >
void	removeFirstProxyModelOfType ()
	Remove the first proxy model of type T. More...

template<typename T >
void	deleteFirstProxyModelOfType ()
	Delete the first proxy model of type T. More...

Detailed Description

Container for a chain of proxy models based on QAbstractProxyModel.

The common way to use a proxy model between a source model and a view looks like:

auto *view = new QTableView;
auto *sourceModel = new MyItemModel(this);
auto *filterModel = new FilterProxyModel(this);
filterModel->setSourceModel(sourceModel);
view->setModel(filterModel);

To insert a format model, we could do:

auto *formatModel = new FormatProxyModel(this);
filterModel->setSourceModel(sourceModel);
formatModel->setSourceModel(filterModel);
view->setModel(formatModel);

If we have to handle a chain of proxy models, and be able to insert or remove proxy models, ProxyModelContainer can be helpful.

Above example could look like:

ProxyModelContainer container;
auto *view = new QTableView;
container.setSourceModel( new MyItemModel(this) );
container.appendProxyModel( new FilterProxyModel(this) );
container.appendProxyModel( new FormatProxyModel(this) );
view->setModel( container.modelForView() );

If we have to access proxy models frquently, for example to change some setup, it can be helpful to create a custom container.

Here is a example how this could be done:

class MyModelContainer
{
 public:
  // Here, parent is used for lifetime management of the proxy models
  MyModelContainer(QObject *parent = nullptr)
  {
    mContainer.appendProxyModel( new FilterProxyModel(parent) );
    mContainer.appendProxyModel( new FormatProxyModel(parent) );
  }
  // Set source model
  void setSourceModel(QAbstractItemModel *model)
  {
    mContainer.setSourceModel(model);
  }
  // Get the model for the view
  QAbstractItemModel *modelForView() const
  {
    return mContainer.modelForView();
  }
  // Access the filter proxy model
  FilterProxyModel *filterModel() const
  {
    return reinterpret_cast<FilterProxyModel*>( mContainer.proxyModelAt(0) );
  }
  // Access the format proxy model
  FormatProxyModel *formatModel() const
  {
    return reinterpret_cast<FormatProxyModel*>( mContainer.proxyModelAt(1) );
  }
 private:
  ProxyModelContainer mContainer;
};

ProxyModelContainer does not own any model, source model and all proxy models will not be deleted when the container is destroyed. It is recommanded to use the QObject mechanism to handle lifetime of models (passing a parent to each one).

Definition at line 122 of file ProxyModelContainer.h.

Member Function Documentation

void Mdt::ItemModel::ProxyModelContainer::appendProxyModel ( QAbstractProxyModel * model )

Add a proxy model to the end.

Precondition: model must be a valid pointer

Definition at line 37 of file ProxyModelContainer.cpp.

template<typename T >

void Mdt::ItemModel::ProxyModelContainer::deleteFirstProxyModelOfType ( )

inline

Delete the first proxy model of type T.

Will remove and delete the proxy model.

Will do nothing if not proxy model of type T exists in this container.

Definition at line 330 of file ProxyModelContainer.h.

void Mdt::ItemModel::ProxyModelContainer::deleteProxyModel ( QAbstractProxyModel * model )

Delete a proxy model.

Will remove and delete proxy model referenced by model. Does nothing if model does not exists in this container.

Definition at line 73 of file ProxyModelContainer.cpp.

void Mdt::ItemModel::ProxyModelContainer::deleteProxyModelAt ( int index )

Delete proxy model at index.

Will remove and delete the proxy model at index.

Precondition: index must be in valid range ( 0 <= index < proxyModelCount() )

Definition at line 96 of file ProxyModelContainer.cpp.

QAbstractProxyModel* Mdt::ItemModel::ProxyModelContainer::firstProxyModel ( ) const

inline

Get first proxy model.

The first proxy model is the nearest of the source model.

Precondition: Cannot be called unless at least 1 proxy model was added the this container.

Definition at line 186 of file ProxyModelContainer.h.

template<typename T >

QAbstractProxyModel* Mdt::ItemModel::ProxyModelContainer::firstProxyModelOfType ( ) const

inline

Get the first proxy model that is of type T.

Returns: The proxy model if found, else a nullptr

Definition at line 266 of file ProxyModelContainer.h.

template<typename T >

int Mdt::ItemModel::ProxyModelContainer::indexOfFirstProxyModelOfType ( ) const

inline

Get the index of the first proxy model that is of type T.

Returns: The index of the proxy model if found, else -1

Definition at line 248 of file ProxyModelContainer.h.

int Mdt::ItemModel::ProxyModelContainer::indexOfProxyModel ( QAbstractProxyModel * model ) const

inline

Get the index of the proxy model.

Returns: The index of the proxy model that is referenced by model, or -1 if not found.

Definition at line 226 of file ProxyModelContainer.h.

QAbstractProxyModel* Mdt::ItemModel::ProxyModelContainer::lastProxyModel ( ) const

inline

Get last proxy model.

The last proxy model is the nearest of the view.

Precondition: Cannot be called unless at least 1 proxy model was added the this container.

Definition at line 198 of file ProxyModelContainer.h.

QAbstractItemModel* Mdt::ItemModel::ProxyModelContainer::modelForView ( ) const

inline

Get model for the view.

If at least 1 proxy model exists int this container, this method returns lastProxyModel(), else it returns sourceModel().

Definition at line 160 of file ProxyModelContainer.h.

void Mdt::ItemModel::ProxyModelContainer::prependProxyModel ( QAbstractProxyModel * model )

Add a proxy model to the begin.

Precondition: model must be a valid pointer

Definition at line 51 of file ProxyModelContainer.cpp.

QAbstractProxyModel* Mdt::ItemModel::ProxyModelContainer::proxyModelAt ( int index ) const

inline

Get proxy model at index.

Precondition: index must be in valid range ( 0 <= index < proxyModelCount() )

Definition at line 215 of file ProxyModelContainer.h.

template<typename T >

void Mdt::ItemModel::ProxyModelContainer::removeFirstProxyModelOfType ( )

inline

Remove the first proxy model of type T.

Note that the model is only removed from this container, but not deleted.

Will do nothing if not proxy model of type T exists in this container.

Definition at line 315 of file ProxyModelContainer.h.

void Mdt::ItemModel::ProxyModelContainer::removeProxyModel ( QAbstractProxyModel * model )

Remove a proxy model.

Will remove proxy model referenced by model. Does nothing if model does not exists in this container.

Definition at line 64 of file ProxyModelContainer.cpp.

void Mdt::ItemModel::ProxyModelContainer::removeProxyModelAt ( int index )

Remove proxy model at index.

Note that the model is only removed from this container, but not deleted.

Precondition: index must be in valid range ( 0 <= index < proxyModelCount() )

Definition at line 82 of file ProxyModelContainer.cpp.

void Mdt::ItemModel::ProxyModelContainer::setSourceModel ( QAbstractItemModel * model )

Set source model.

Precondition: model must be a valid pointer

Definition at line 27 of file ProxyModelContainer.cpp.

QAbstractItemModel* Mdt::ItemModel::ProxyModelContainer::sourceModel ( ) const

inline

Get source model.

Returns a nullptr until a model was set.

See also: setSourceModel()

Definition at line 149 of file ProxyModelContainer.h.

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

libs/ItemModel/src/Mdt/ItemModel/ProxyModelContainer.h
libs/ItemModel/src/Mdt/ItemModel/ProxyModelContainer.cpp

Public Member Functions

Detailed Description

Member Function Documentation