Akonadi::ItemModel Class Reference

#include <itemmodel.h>

Inheritance diagram for Akonadi::ItemModel:

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() );

Author

Volker Krause vkrau.nosp@m.se@k.nosp@m.de.or.nosp@m.g

Deprecated:

Use Akonadi::EntityTreeModel instead

Definition at line 56 of file itemmodel.h.

Member Enumeration Documentation

enum Akonadi::ItemModel::Column

Describes the types of the columns in the model.

Enumerator
Id	The unique id.
RemoteId	The remote identifier.
MimeType	The item's mime type.

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

ItemModel::ItemModel ( QObject *  parent = 0 )

explicit

Creates a new item model.

Parameters

parent

The parent object.

Definition at line 248 of file itemmodel.cpp.

ItemModel::~ItemModel ( )

virtual

Destroys the item model.

Definition at line 254 of file itemmodel.cpp.

Member Function Documentation

Collection ItemModel::collection

(

)

const

Returns the collection being displayed in the model.

Definition at line 445 of file itemmodel.cpp.

void Akonadi::ItemModel::collectionChanged ( const Akonadi::Collection &  collection )

signal

This signal is emitted whenever setCollection is called.

Parameters

collection

The new collection.

ItemFetchScope & 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.

Definition at line 373 of file itemmodel.cpp.

QModelIndex 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.

Definition at line 430 of file itemmodel.cpp.

Item ItemModel::itemForIndex

(

const QModelIndex &

index

)

const

Returns the item at the given index.

Definition at line 378 of file itemmodel.cpp.

Session * ItemModel::session ( ) const

protected

Returns the Session object used for all operations by this model.

Definition at line 409 of file itemmodel.cpp.

void ItemModel::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 328 of file itemmodel.cpp.

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

Definition at line 368 of file itemmodel.cpp.

---

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

• itemmodel.h
• itemmodel.cpp