MessageList::Core::Model
#include <model.h>
Signals | |
void | statusMessage (const QString &message) |
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.
Constructor & Destructor Documentation
◆ Model()
|
explicit |
◆ ~Model()
|
override |
Member Function Documentation
◆ columnCount()
|
overridevirtual |
Implements QAbstractItemModel.
◆ createPersistentSet()
MessageItemSetReference Model::createPersistentSet | ( | const QList< MessageItem * > & | items | ) |
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.
◆ data()
|
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.
◆ deletePersistentSet()
void Model::deletePersistentSet | ( | MessageItemSetReference | ref | ) |
◆ flags()
|
overridevirtual |
Reimplemented from QAbstractItemModel.
◆ headerData()
|
overridevirtual |
Reimplemented from QAbstractItemModel.
◆ index() [1/2]
|
overridevirtual |
Implements QAbstractItemModel.
◆ index() [2/2]
QModelIndex Model::index | ( | Item * | item, |
int | column ) const |
◆ isLoading()
bool Model::isLoading | ( | ) | const |
Returns true if the view is currently loading, that is it's in the first (possibly lengthy) job batch after attaching to a StorageModel.
◆ 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.
◆ mimeData()
|
overridevirtual |
Called when user initiates a drag from the messagelist.
Reimplemented from QAbstractItemModel.
◆ parent()
|
overridevirtual |
Implements QAbstractItemModel.
◆ persistentSetCurrentMessageItemList()
QList< MessageItem * > Model::persistentSetCurrentMessageItemList | ( | MessageItemSetReference | ref | ) |
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.
◆ rootItem()
Item * Model::rootItem | ( | ) | const |
◆ rowCount()
|
overridevirtual |
Implements QAbstractItemModel.
◆ 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.
◆ setFilter()
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.
◆ setPreSelectionMode()
void Model::setPreSelectionMode | ( | PreSelectionMode | preSelect | ) |
◆ setSortOrder()
Sets the sort order.
As with setTheme() and setAggregation(), this does not reload the model in any way.
◆ 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.
◆ setTheme()
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.
◆ sortOrder()
◆ statusMessage
Notify the outside when updating the status bar with a message could be useful.
◆ storageModel()
StorageModel * Model::storageModel | ( | ) | const |
Returns the StorageModel currently set.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Tue Mar 26 2024 11:12:44 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.