MessageList::Core::Model

MessageList
Core
Model

#include <model.h>

Inheritance diagram for MessageList::Core::Model:

[legend]

Signals
void	statusMessage (const QString &message)

Public Member Functions
	Model (View *pParent)

	~Model () override

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

MessageItemSetReference	createPersistentSet (const QList< MessageItem * > &items)

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

void	deletePersistentSet (MessageItemSetReference ref)

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

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

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

QModelIndex	index (Item *item, int column) const

bool	isLoading () const

MessageItem *	messageItemByStorageRow (int row) const

QMimeData *	mimeData (const QModelIndexList &indexes) const override

QModelIndex	parent (const QModelIndex &index) const override

QList< MessageItem * >	persistentSetCurrentMessageItemList (MessageItemSetReference ref)

Item *	rootItem () const

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

void	setAggregation (const Aggregation *aggregation)

void	setFilter (const Filter *filter)

void	setPreSelectionMode (PreSelectionMode preSelect)

void	setSortOrder (const SortOrder *sortOrder)

void	setStorageModel (StorageModel *storageModel, PreSelectionMode preSelectionMode=PreSelectLastSelected)

void	setTheme (const Theme *theme)

const SortOrder *	sortOrder () const

StorageModel *	storageModel () const

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

virtual QModelIndex	buddy (const QModelIndex &index) const const

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

virtual bool	canFetchMore (const QModelIndex &parent) const const

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

virtual bool	clearItemData (const QModelIndex &index)

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)

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

virtual void	fetchMore (const QModelIndex &parent)

virtual bool	hasChildren (const QModelIndex &parent) const const

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)

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)

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

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

virtual QStringList	mimeTypes () 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

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 void	revert ()

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

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)

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

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

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

virtual QModelIndex	sibling (int row, int column, const QModelIndex &index) const const

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

virtual QSize	span (const QModelIndex &index) const const

virtual bool	submit ()

virtual Qt::DropActions	supportedDragActions () const const

virtual Qt::DropActions	supportedDropActions () const const

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 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
	DoNotUseParent

	HorizontalSortHint

	IndexIsValid

	NoLayoutChangeHint

	NoOption

	ParentIsInvalid

	VerticalSortHint

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

This class manages the huge tree of displayable objects: GroupHeaderItems and MessageItems.

The tree is exposed via a 'hacked' QAbstractItemModel interface to a QTreeView subclass (which is MessageList::View).

The keypoint in this class is that it has to be non-blocking in manipulating the tree: fill, cleanup and update operations are performed in timed chunks. Perfect non-blocking behaviour is not possible since there are some small operations that basically can't be split in chunks. However, these exceptions apply to a minority of tasks and in the average case the user will not notice.

The data for building the tree is obtained from a subclass of StorageModel. The StorageModel must offer a consistent rappresentation of a "flat" folder containing messages.

Definition at line 53 of file model.h.

Constructor & Destructor Documentation

◆ Model()

Model::Model ( View * pParent )

explicit

Creates the mighty Model attached to the specified View.

Definition at line 306 of file model.cpp.

◆ ~Model()

Model::~Model ( )

override

Destroys the mighty model along with the tree of items it manages.

Definition at line 352 of file model.cpp.

Member Function Documentation

◆ columnCount()

int Model::columnCount ( const QModelIndex & parent = QModelIndex() ) const

overridevirtual

Implements QAbstractItemModel.

Definition at line 476 of file model.cpp.

◆ createPersistentSet()

MessageItemSetReference Model::createPersistentSet ( const QList< MessageItem * > & items )

nodiscard

Creates a persistent set for the specified MessageItems and returns its reference.

Later you can use this reference to retrieve the list of MessageItems that are still valid. See persistentSetActualMessageList() for that.

Persistent sets consume resources (both memory and CPU time while manipulating the view) so be sure to call deletePersistentSet() when you no longer need it.

Definition at line 4547 of file model.cpp.

◆ data()

QVariant Model::data	(	const QModelIndex &	index,
		int	role = Qt::DisplayRole ) const

overridevirtual

this is called only when Akonadi is using the selectionmodel for item actions. since akonadi uses the ETM ItemRoles, and the messagelist uses its own internal roles, here we respond to the ETM ones.

taken from entitytreemodel.h

Implements QAbstractItemModel.

Definition at line 487 of file model.cpp.

◆ deletePersistentSet()

void Model::deletePersistentSet ( MessageItemSetReference ref )

Deletes the persistent set pointed by the specified reference.

If the set does not exist anymore, nothing happens.

Definition at line 4569 of file model.cpp.

◆ flags()

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

overridevirtual

Reimplemented from QAbstractItemModel.

Definition at line 4477 of file model.cpp.

◆ headerData()

QVariant Model::headerData	(	int	section,
		Qt::Orientation	orientation,
		int	role ) const

overridevirtual

Reimplemented from QAbstractItemModel.

Definition at line 539 of file model.cpp.

◆ index() [1/2]

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

overridevirtual

Implements QAbstractItemModel.

Definition at line 594 of file model.cpp.

◆ index() [2/2]

QModelIndex Model::index	(	Item *	item,
		int	column ) const

Definition at line 569 of file model.cpp.

◆ isLoading()

bool Model::isLoading ( ) const

nodiscard

Returns true if the view is currently loading, that is it's in the first (possibly lengthy) job batch after attaching to a StorageModel.

Definition at line 4529 of file model.cpp.

◆ messageItemByStorageRow()

MessageItem * Model::messageItemByStorageRow ( int row ) const

Returns the message item that is at the current storage row index or zero if no such storage item is found.

Please note that this may return 0 also if the specified storage row hasn't been actually read yet. This may happen if isLoading() returns true. In this case the only thing you can do is to retry in a while.

Definition at line 4534 of file model.cpp.

◆ mimeData()

QMimeData * MessageList::Core::Model::mimeData ( const QModelIndexList & indexes ) const

overridevirtual

Called when user initiates a drag from the messagelist.

Reimplemented from QAbstractItemModel.

Definition at line 4510 of file model.cpp.

◆ parent()

QModelIndex Model::parent ( const QModelIndex & index ) const

overridevirtual

Implements QAbstractItemModel.

Definition at line 627 of file model.cpp.

◆ persistentSetCurrentMessageItemList()

QList< MessageItem * > Model::persistentSetCurrentMessageItemList ( MessageItemSetReference ref )

nodiscard

Returns the list of MessageItems that are still existing in the set pointed by the specified reference.

This list will contain at most the messages that you have passed to createPersistentSet() but may contain less (even 0) if these MessageItem object were removed from the view for some reason.

Definition at line 4561 of file model.cpp.

◆ rootItem()

Item * Model::rootItem ( ) const

Returns the hidden root item that all the messages are (or will be) attached to.

The returned value is never 0.

Definition at line 4524 of file model.cpp.

◆ rowCount()

int Model::rowCount ( const QModelIndex & parent = QModelIndex() ) const

overridevirtual

Implements QAbstractItemModel.

Definition at line 646 of file model.cpp.

◆ setAggregation()

void Model::setAggregation ( const Aggregation * aggregation )

Sets the Aggregation mode.

Does not reload the model in any way: you need to call setStorageModel( storageModel() ) for this to happen. The pointer ownership remains of the caller which must ensure its validity until the next call to setAggretation() or until this Model dies. The caller, in fact, is Widget which takes care of meeting the above conditions. The aggregation pointer must not be null.

Definition at line 370 of file model.cpp.

◆ setFilter()

void Model::setFilter ( const Filter * filter )

Sets the Filter to be applied on messages.

filter may be null (no filter is applied). The pointer ownership remains of the caller which must ensure its validity until the next call to setFilter() or until this Model dies. The caller, in fact, is Widget which takes care of meeting the above conditions. The Filter pointer may be null.

Definition at line 391 of file model.cpp.

◆ setPreSelectionMode()

void Model::setPreSelectionMode ( PreSelectionMode preSelect )

Sets the pre-selection mode.

Called with PreSelectNone to abort any pending message pre-selection. This may be done if the user starts navigating the view and selecting items before we actually could apply the pre-selection.

Definition at line 1004 of file model.cpp.

◆ setSortOrder()

void Model::setSortOrder ( const SortOrder * sortOrder )

Sets the sort order.

As with setTheme() and setAggregation(), this does not reload the model in any way.

Definition at line 381 of file model.cpp.

◆ setStorageModel()

void Model::setStorageModel	(	StorageModel *	storageModel,
		PreSelectionMode	preSelectionMode = PreSelectLastSelected )

Sets the storage model from that the messages to be displayed should be fetched.

The model is then reset and a new fill operation is started. The fill operation may or may not complete before setStorageModel() returns. This depends on the fill strategy and the size of the folder. You can check if the fill operation has completed by looking at the return value of isLoading().

Pre-selection is the action of automatically selecting a message just after the folder has finished loading. We may want to select the message that was selected the last time this folder has been open, or we may want to select the first unread message. We also may want to do no pre-selection at all (for example, when the user starts navigating the view before the pre-selection could actually be made and pre-selecting would confuse him). The pre-selection is applied once loading is complete.

Definition at line 742 of file model.cpp.

◆ setTheme()

void Model::setTheme ( const Theme * theme )

Sets the Theme.

Does not reload the model in any way: you need to call setStorageModel( storageModel() ) for this to happen. The pointer ownership remains of the caller which must ensure its validity until the next call to setTheme() or until this Model dies. The caller, in fact, is Widget which takes care of meeting the above conditions. The theme pointer must not be null.

Definition at line 376 of file model.cpp.

◆ sortOrder()

const SortOrder * Model::sortOrder ( ) const

Returns the sort order.

Definition at line 386 of file model.cpp.

◆ statusMessage

void MessageList::Core::Model::statusMessage ( const QString & message )

signal

Notify the outside when updating the status bar with a message could be useful.

◆ storageModel()

StorageModel * Model::storageModel ( ) const

Returns the StorageModel currently set.

Definition at line 692 of file model.cpp.

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

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About Messagelib

MessageList::Core::Model

Signals

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Model()

◆ ~Model()

Member Function Documentation

◆ columnCount()

◆ createPersistentSet()

◆ data()

◆ deletePersistentSet()

◆ flags()

◆ headerData()

◆ index() [1/2]

◆ index() [2/2]

◆ isLoading()

◆ messageItemByStorageRow()

◆ mimeData()

◆ parent()

◆ persistentSetCurrentMessageItemList()

◆ rootItem()

◆ rowCount()

◆ setAggregation()

◆ setFilter()

◆ setPreSelectionMode()

◆ setSortOrder()

◆ setStorageModel()

◆ setTheme()

◆ sortOrder()

◆ statusMessage

◆ storageModel()