Akonadi::SelectionProxyModel

Search for usage in LXR

Public Member Functions | List of all members
Akonadi::SelectionProxyModel Class Reference

#include <selectionproxymodel.h>

Inheritance diagram for Akonadi::SelectionProxyModel:
Inheritance graph
[legend]

Public Member Functions

 SelectionProxyModel (QItemSelectionModel *selectionModel, QObject *parent=nullptr)
 
- Public Member Functions inherited from KSelectionProxyModel
 KSelectionProxyModel (QItemSelectionModel *selectionModel, QObject *parent=nullptr)
 
void setFilterBehavior (FilterBehavior behavior)
 
void setSourceModel (QAbstractItemModel *sourceModel) override
 
- Public Member Functions inherited from QAbstractProxyModel
 QAbstractProxyModel (QObject *parent)
 
QBindable< QAbstractItemModel * > bindableSourceModel ()
 
virtual QModelIndex buddy (const QModelIndex &index) const const override
 
virtual bool canDropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) const const override
 
virtual bool canFetchMore (const QModelIndex &parent) const const override
 
virtual bool clearItemData (const QModelIndex &index) override
 
virtual QVariant data (const QModelIndex &proxyIndex, int role) const const override
 
virtual bool dropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) override
 
virtual void fetchMore (const QModelIndex &parent) override
 
virtual Qt::ItemFlags flags (const QModelIndex &index) const const override
 
virtual bool hasChildren (const QModelIndex &parent) const const override
 
virtual QVariant headerData (int section, Qt::Orientation orientation, int role) const const override
 
virtual QMap< int, QVariant > itemData (const QModelIndex &proxyIndex) const const override
 
virtual QModelIndex mapFromSource (const QModelIndex &sourceIndex) const const=0
 
virtual QItemSelection mapSelectionFromSource (const QItemSelection &sourceSelection) const const
 
virtual QItemSelection mapSelectionToSource (const QItemSelection &proxySelection) const const
 
virtual QModelIndex mapToSource (const QModelIndex &proxyIndex) const const=0
 
virtual QMimeData * mimeData (const QModelIndexList &indexes) const const override
 
virtual QStringList mimeTypes () const const override
 
virtual void revert () override
 
virtual QHash< int, QByteArray > roleNames () const const override
 
virtual bool setData (const QModelIndex &index, const QVariant &value, int role) override
 
virtual bool setHeaderData (int section, Qt::Orientation orientation, const QVariant &value, int role) override
 
virtual bool setItemData (const QModelIndex &index, const QMap< int, QVariant > &roles) override
 
virtual QModelIndex sibling (int row, int column, const QModelIndex &idx) const const override
 
virtual void sort (int column, Qt::SortOrder order) override
 
QAbstractItemModel * sourceModel () const const
 
void sourceModelChanged ()
 
virtual QSize span (const QModelIndex &index) const const override
 
virtual bool submit () override
 
virtual Qt::DropActions supportedDragActions () const const override
 
virtual Qt::DropActions supportedDropActions () const const override
 
- Public Member Functions inherited from QAbstractItemModel
 QAbstractItemModel (QObject *parent)
 
bool checkIndex (const QModelIndex &index, CheckIndexOptions options) const const
 
virtual int columnCount (const QModelIndex &parent) const const=0
 
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)
 
virtual QModelIndex index (int row, int column, const QModelIndex &parent) const const=0
 
bool insertColumn (int column, const QModelIndex &parent)
 
virtual bool insertColumns (int column, int count, const QModelIndex &parent)
 
bool insertRow (int row, const QModelIndex &parent)
 
virtual bool insertRows (int row, int count, const QModelIndex &parent)
 
void layoutAboutToBeChanged (const QList< QPersistentModelIndex > &parents, QAbstractItemModel::LayoutChangeHint hint)
 
void layoutChanged (const QList< QPersistentModelIndex > &parents, QAbstractItemModel::LayoutChangeHint hint)
 
virtual QModelIndexList match (const QModelIndex &start, int role, const QVariant &value, int hits, Qt::MatchFlags flags) const const
 
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
 
virtual QModelIndex parent (const QModelIndex &index) const const=0
 
bool removeColumn (int column, const QModelIndex &parent)
 
virtual bool removeColumns (int column, int count, const QModelIndex &parent)
 
bool removeRow (int row, const QModelIndex &parent)
 
virtual bool removeRows (int row, int count, const QModelIndex &parent)
 
virtual int rowCount (const QModelIndex &parent) const const=0
 
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
 

Additional Inherited Members

- Public Types inherited from QAbstractItemModel
enum  CheckIndexOption
 
typedef  CheckIndexOptions
 
enum  LayoutChangeHint
 
- Public Types inherited from QObject
typedef  QObjectList
 
- Properties inherited from QAbstractProxyModel
 sourceModel
 
- Properties inherited from QObject
 objectName
 
- Signals inherited from KSelectionProxyModel
void rootIndexAboutToBeRemoved (const QModelIndex &removeRootIndex, QPrivateSignal)
 
void rootIndexAdded (const QModelIndex &newIndex, QPrivateSignal)
 
void rootSelectionAboutToBeRemoved (const QItemSelection &selection, QPrivateSignal)
 
void rootSelectionAdded (const QItemSelection &selection, QPrivateSignal)
 
- 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
 DoNotUseParent
 
 HorizontalSortHint
 
 IndexIsValid
 
 NoLayoutChangeHint
 
 NoOption
 
 ParentIsInvalid
 
 VerticalSortHint
 
- 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)
 

Detailed Description

A proxy model used to reference count selected Akonadi::Collection in a view.

Only selected Collections will be populated and monitored for changes. Unselected Collections will be ignored.

This model extends KSelectionProxyModel to implement reference counting on the Collections in an EntityTreeModel. The EntityTreeModel must use LazyPopulation to enable SelectionProxyModel to work.

By selecting a Collection, its reference count will be increased. A Collection in the EntityTreeModel which has a reference count of zero will ignore all signals from Monitor about items changed, inserted, removed etc, which can be expensive operations.

Example:

using namespace Akonadi;
// itemView
// ^
// |
// itemModel
// |
// flatModel
// |
// collectionView --> selectionModel
// ^ ^
// | |
// collectionFilter |
// \______________model
EntityTreeModel *model = new EntityTreeModel( ... );
// setup collection model
EntityMimeTypeFilterModel *collectionFilter = new EntityMimeTypeFilterModel( this );
collectionFilter->setSourceModel( model );
collectionFilter->addMimeTypeInclusionFilter( Collection::mimeType() );
collectionFilter->setHeaderGroup( EntityTreeModel::CollectionTreeHeaders );
// setup collection view
EntityTreeView *collectionView = new EntityTreeView( this );
collectionView->setModel( collectionFilter );
// setup selection model
SelectionProxyModel *selectionModel = new SelectionProxyModel( collectionView->selectionModel(), this );
selectionModel->setSourceModel( model );
// setup item model
KDescendantsProxyModel *flatModel = new KDescendantsProxyModel( this );
flatModel->setSourceModel( selectionModel );
EntityMimeTypeFilterModel *itemModel = new EntityMimeTypeFilterModel( this );
itemModel->setSourceModel( flatModel );
itemModel->setHeaderGroup( EntityTreeModel::ItemListHeaders );
itemModel->addMimeTypeExclusionFilter( Collection::mimeType() );
EntityListView *itemView = new EntityListView( this );
itemView->setModel( itemModel );
Akonadi::Collection::mimeType
static QString mimeType()
Returns the mimetype used for collections.
Definition collection.cpp:292
Akonadi::EntityListView
A view to show an item/collection list provided by an EntityTreeModel.
Definition entitylistview.h:64
Akonadi::EntityListView::setModel
void setModel(QAbstractItemModel *model) override
Definition entitylistview.cpp:147
Akonadi::EntityMimeTypeFilterModel
A proxy model that filters entities by mime type.
Definition entitymimetypefiltermodel.h:50
Akonadi::EntityMimeTypeFilterModel::setHeaderGroup
void setHeaderGroup(EntityTreeModel::HeaderGroup headerGroup)
Sets the header set of the filter model.
Definition entitymimetypefiltermodel.cpp:132
Akonadi::EntityMimeTypeFilterModel::addMimeTypeInclusionFilter
void addMimeTypeInclusionFilter(const QString &mimeType)
Add mime type to be shown by the filter.
Definition entitymimetypefiltermodel.cpp:65
Akonadi::EntityMimeTypeFilterModel::addMimeTypeExclusionFilter
void addMimeTypeExclusionFilter(const QString &mimeType)
Add mime type to be excluded by the filter.
Definition entitymimetypefiltermodel.cpp:72
Akonadi::EntityTreeModel
A model for collections and items together.
Definition entitytreemodel.h:306
Akonadi::EntityTreeModel::CollectionTreeHeaders
@ CollectionTreeHeaders
Header information for a collection-only tree.
Definition entitytreemodel.h:372
Akonadi::EntityTreeModel::ItemListHeaders
@ ItemListHeaders
Header information for a list of items.
Definition entitytreemodel.h:373
Akonadi::EntityTreeView
A view to show an item/collection tree provided by an EntityTreeModel.
Definition entitytreeview.h:60
Akonadi::EntityTreeView::setModel
void setModel(QAbstractItemModel *model) override
Definition entitytreeview.cpp:195
Akonadi::SelectionProxyModel
A proxy model used to reference count selected Akonadi::Collection in a view.
Definition selectionproxymodel.h:87
Akonadi::SelectionProxyModel::SelectionProxyModel
SelectionProxyModel(QItemSelectionModel *selectionModel, QObject *parent=nullptr)
Creates a new selection proxy model.
Definition selectionproxymodel.cpp:62
KDescendantsProxyModel::setSourceModel
void setSourceModel(QAbstractItemModel *model) override
KSelectionProxyModel::setSourceModel
void setSourceModel(QAbstractItemModel *sourceModel) override
Akonadi
Helper integration between Akonadi and Qt.
QAbstractItemView::selectionModel
QItemSelectionModel * selectionModel() const const
QSortFilterProxyModel::setSourceModel
virtual void setSourceModel(QAbstractItemModel *sourceModel) override

See Integration in your Application for further guidance on the use of this class.

Author
Stephen Kelly steve.nosp@m.ire@.nosp@m.gmail.nosp@m..com
Since
4.4

Definition at line 86 of file selectionproxymodel.h.

Constructor & Destructor Documentation

◆ SelectionProxyModel()

SelectionProxyModel::SelectionProxyModel ( QItemSelectionModel * selectionModel,
QObject * parent = nullptr )
explicit

Creates a new selection proxy model.

Parameters
selectionModelThe selection model of the source view.
parentThe parent object.

Definition at line 62 of file selectionproxymodel.cpp.

The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Mon Nov 4 2024 16:31:59 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.