• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdepim API Reference
  • KDE Home
  • Contact Us
 

messagelist

  • MessageList
  • Core
  • Model
Signals | Public Member Functions | List of all members
MessageList::Core::Model Class Reference

#include <model.h>

Inheritance diagram for MessageList::Core::Model:
Inheritance graph
[legend]

Signals

void statusMessage (const QString &message)
 

Public Member Functions

 Model (View *pParent)
 
 ~Model ()
 
virtual int columnCount (const QModelIndex &parent=QModelIndex()) const
 
MessageItemSetReference createPersistentSet (const QList< MessageItem * > &items)
 
virtual QVariant data (const QModelIndex &index, int role=Qt::DisplayRole) const
 
void deletePersistentSet (MessageItemSetReference ref)
 
virtual Qt::ItemFlags flags (const QModelIndex &index) const
 
virtual QVariant headerData (int section, Qt::Orientation orientation, int role) const
 
virtual QModelIndex index (int row, int column, const QModelIndex &parent=QModelIndex()) const
 
QModelIndex index (Item *item, int column) const
 
bool isLoading () const
 
MessageItem * messageItemByStorageRow (int row) const
 
virtual QMimeData * mimeData (const QModelIndexList &indexes) const
 
virtual QModelIndex parent (const QModelIndex &index) const
 
QList< MessageItem * > persistentSetCurrentMessageItemList (MessageItemSetReference ref)
 
Item * rootItem () const
 
virtual int rowCount (const QModelIndex &parent=QModelIndex()) const
 
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
 

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 77 of file model.h.

Constructor & Destructor Documentation

Model::Model ( View *  pParent)
explicit

Creates the mighty Model attached to the specified View.

Definition at line 265 of file model.cpp.

Model::~Model ( )

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

Definition at line 310 of file model.cpp.

Member Function Documentation

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

Definition at line 437 of file model.cpp.

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.

Definition at line 4547 of file model.cpp.

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

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

Definition at line 446 of file model.cpp.

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 4568 of file model.cpp.

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

Definition at line 4482 of file model.cpp.

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

Definition at line 494 of file model.cpp.

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

Definition at line 545 of file model.cpp.

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

Definition at line 522 of file model.cpp.

bool Model::isLoading ( ) const

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

Definition at line 4530 of file model.cpp.

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 4535 of file model.cpp.

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

Called when user initiates a drag from the messagelist.

Definition at line 4510 of file model.cpp.

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

Definition at line 574 of file model.cpp.

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.

Definition at line 4560 of file model.cpp.

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 4525 of file model.cpp.

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

Definition at line 590 of file model.cpp.

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 329 of file model.cpp.

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 351 of file model.cpp.

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 902 of file model.cpp.

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 341 of file model.cpp.

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 672 of file model.cpp.

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 336 of file model.cpp.

const SortOrder * Model::sortOrder ( ) const

Returns the sort order.

Definition at line 346 of file model.cpp.

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

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

StorageModel * Model::storageModel ( ) const

Returns the StorageModel currently set.

Definition at line 623 of file model.cpp.


The documentation for this class was generated from the following files:
  • model.h
  • model.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 22:55:32 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

messagelist

Skip menu "messagelist"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members

kdepim API Reference

Skip menu "kdepim API Reference"
  • akonadi_next
  • akregator
  • blogilo
  • calendarsupport
  • console
  •   kabcclient
  •   konsolekalendar
  • kaddressbook
  • kalarm
  •   lib
  • kdgantt2
  • kjots
  • kleopatra
  • kmail
  • knode
  • knotes
  • kontact
  • korgac
  • korganizer
  • ktimetracker
  • libkdepim
  • libkleo
  • libkpgp
  • mailcommon
  • messagelist
  • messageviewer

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal