Akonadi::CollectionModel Class Reference

#include <collectionmodel.h>

Inheritance diagram for Akonadi::CollectionModel:

Public Types
enum	Roles {   OldCollectionIdRole = Qt::UserRole + 1, OldCollectionRole = Qt::UserRole + 2, CollectionIdRole = Qt::UserRole + 10, CollectionRole = Qt::UserRole + 11,   UserRole = Qt::UserRole + 42 }

Public Member Functions
	CollectionModel (QObject *parent=0)
virtual	~CollectionModel ()
virtual int	columnCount (const QModelIndex &parent=QModelIndex()) const
virtual QVariant	data (const QModelIndex &index, int role=Qt::DisplayRole) const
virtual bool	dropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent)
void	fetchCollectionStatistics (bool enable)
virtual Qt::ItemFlags	flags (const QModelIndex &index) const
virtual QVariant	headerData (int section, Qt::Orientation orientation, int role=Qt::DisplayRole) const
void	includeUnsubscribed (bool include=true)
virtual QModelIndex	index (int row, int column, const QModelIndex &parent=QModelIndex()) const
virtual QMimeData *	mimeData (const QModelIndexList &indexes) const
virtual QStringList	mimeTypes () const
virtual QModelIndex	parent (const QModelIndex &index) const
virtual int	rowCount (const QModelIndex &parent=QModelIndex()) const
virtual bool	setData (const QModelIndex &index, const QVariant &value, int role=Qt::EditRole)
virtual bool	setHeaderData (int section, Qt::Orientation orientation, const QVariant &value, int role=Qt::EditRole)
virtual Qt::DropActions	supportedDropActions () const

Protected Member Functions
Collection	collectionForId (Collection::Id id) const

Detailed Description

A model for collections.

This class provides the interface of QAbstractItemModel for the collection tree of the Akonadi storage.

Akonadi::CollectionModel *model = new Akonadi::CollectionModel( this );

QTreeView *view = new QTreeView( this );
view->setModel( model );

If you want to list only collections of a special mime type, use CollectionFilterProxyModel on top of this model.

Author

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

Deprecated:

Use Akonadi::EntityTreeModel instead

Definition at line 54 of file collectionmodel.h.

Member Enumeration Documentation

enum Akonadi::CollectionModel::Roles

Describes the roles for collections.

Enumerator
OldCollectionIdRole	The collection identifier. For binary compatibility to <4.3.
OldCollectionRole	The actual collection object. For binary compatibility to <4.3.
CollectionIdRole	The collection identifier.
CollectionRole	The actual collection object.
UserRole	Role for user extensions.

Definition at line 62 of file collectionmodel.h.

Constructor & Destructor Documentation

CollectionModel::CollectionModel ( QObject *  parent = 0 )

explicit

Creates a new collection model.

Parameters

parent

The parent object.

Definition at line 39 of file collectionmodel.cpp.

CollectionModel::~CollectionModel ( )

virtual

Destroys the collection model.

Definition at line 57 of file collectionmodel.cpp.

Member Function Documentation

Collection CollectionModel::collectionForId ( Collection::Id  id ) const

protected

Returns the collection for a given collection id.

Definition at line 309 of file collectionmodel.cpp.

void CollectionModel::fetchCollectionStatistics

(

bool

enable

)

Sets whether collection statistics information shall be provided by the model.

See also

CollectionStatistics.

Parameters

enable

whether to fetch collecton statistics

Definition at line 315 of file collectionmodel.cpp.

void CollectionModel::includeUnsubscribed

(

bool

include = true

)

Sets whether unsubscribed collections shall be listed in the model.

Definition at line 322 of file collectionmodel.cpp.

---

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

• collectionmodel.h
• collectionmodel.cpp