akonadi
#include <itemmodel.h>

Public Types | |
enum | Column { Id = 0, RemoteId, MimeType } |
enum | Roles { IdRole = Qt::UserRole + 1, ItemRole, MimeTypeRole, UserRole = Qt::UserRole + 42 } |
Public Slots | |
void | setCollection (const Akonadi::Collection &collection) |
Signals | |
void | collectionChanged (const Akonadi::Collection &collection) |
Public Member Functions | |
ItemModel (QObject *parent=0) | |
virtual | ~ItemModel () |
Collection | collection () const |
virtual int | columnCount (const QModelIndex &parent=QModelIndex()) const |
virtual QVariant | data (const QModelIndex &index, int role=Qt::DisplayRole) const |
bool | dropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) |
ItemFetchScope & | fetchScope () |
virtual Qt::ItemFlags | flags (const QModelIndex &index) const |
virtual QVariant | headerData (int section, Qt::Orientation orientation, int role=Qt::DisplayRole) const |
QModelIndex | indexForItem (const Akonadi::Item &item, const int column) const |
Item | itemForIndex (const QModelIndex &index) const |
virtual QMimeData * | mimeData (const QModelIndexList &indexes) const |
virtual QStringList | mimeTypes () const |
virtual int | rowCount (const QModelIndex &parent=QModelIndex()) const |
void | setFetchScope (const ItemFetchScope &fetchScope) |
virtual Qt::DropActions | supportedDropActions () const |
Protected Member Functions | |
Session * | session () const |
Detailed Description
A table model for items.
A self-updating table model that shows all items of a collection.
QTableView *view = new QTableView( this ); Akonadi::ItemModel *model = new Akonadi::ItemModel(); view->setModel( model ); model->setCollection( Akonadi::Collection::root() );
- Deprecated:
- Use Akonadi::EntityTreeModel instead
Member Enumeration Documentation
enum Akonadi::ItemModel::Column |
Describes the types of the columns in the model.
Reimplemented in Akonadi::MessageModel.
Definition at line 64 of file itemmodel.h.
enum Akonadi::ItemModel::Roles |
Describes the roles of the model.
- Enumerator:
IdRole The id of the item.
ItemRole The item object.
MimeTypeRole The mime type of the item.
UserRole Role for user extensions.
Definition at line 73 of file itemmodel.h.
Constructor & Destructor Documentation
Akonadi::ItemModel::ItemModel | ( | QObject * | parent = 0 | ) | [explicit] |
Creates a new item model.
- Parameters:
-
parent The parent object.
virtual Akonadi::ItemModel::~ItemModel | ( | ) | [virtual] |
Destroys the item model.
Member Function Documentation
Collection Akonadi::ItemModel::collection | ( | ) | const |
Returns the collection being displayed in the model.
void Akonadi::ItemModel::collectionChanged | ( | const Akonadi::Collection & | collection | ) | [signal] |
This signal is emitted whenever setCollection is called.
- Parameters:
-
collection The new collection.
ItemFetchScope& Akonadi::ItemModel::fetchScope | ( | ) |
Returns the item fetch scope.
Since this returns a reference it can be used to conveniently modify the current scope in-place, i.e. by calling a method on the returned reference without storing it in a local variable. See the ItemFetchScope documentation for an example.
- Returns:
- a reference to the current item fetch scope.
- See also:
- setFetchScope() for replacing the current item fetch scope.
QModelIndex Akonadi::ItemModel::indexForItem | ( | const Akonadi::Item & | item, |
const int | column | ||
) | const |
Returns the model index for the given item, with the given column.
- Parameters:
-
item The item to find. column The column for the returned index.
Item Akonadi::ItemModel::itemForIndex | ( | const QModelIndex & | index | ) | const |
Returns the item at the given index
.
Session* Akonadi::ItemModel::session | ( | ) | const [protected] |
Returns the Session object used for all operations by this model.
void ItemFetchJob::setCollection | ( | const Akonadi::Collection & | collection | ) | [slot] |
Sets the collection the model should display.
If the collection has changed, the model is reset and a new message listing is requested from the Akonadi storage.
- Parameters:
-
collection The collection.
Definition at line 234 of file itemfetchjob.cpp.
void Akonadi::ItemModel::setFetchScope | ( | const ItemFetchScope & | fetchScope | ) |
Sets the item fetch scope.
The ItemFetchScope controls how much of an item's data is fetched from the server, e.g. whether to fetch the full item payload or only meta data.
- Parameters:
-
fetchScope The new scope for item fetch operations.
- See also:
- fetchScope()
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2012 The KDE developers.
Generated on Thu Aug 2 2012 15:25:22 by doxygen 1.7.5 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.