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
Public Member Functions inherited from QAbstractTableModel
	QAbstractTableModel (QObject *parent)
virtual QModelIndex	index (int row, int column, const QModelIndex &parent) const
Public Member Functions inherited from QAbstractItemModel
	QAbstractItemModel (QObject *parent)
virtual QModelIndex	buddy (const QModelIndex &index) const
virtual bool	canFetchMore (const QModelIndex &parent) const
virtual int	columnCount (const QModelIndex &parent) const =0
void	columnsAboutToBeInserted (const QModelIndex &parent, int start, int end)
void	columnsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn)
void	columnsAboutToBeRemoved (const QModelIndex &parent, int start, int end)
void	columnsInserted (const QModelIndex &parent, int start, int end)
void	columnsMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn)
void	columnsRemoved (const QModelIndex &parent, int start, int end)
virtual QVariant	data (const QModelIndex &index, int role) const =0
void	dataChanged (const QModelIndex &topLeft, const QModelIndex &bottomRight)
virtual void	fetchMore (const QModelIndex &parent)
virtual bool	hasChildren (const QModelIndex &parent) const
bool	hasIndex (int row, int column, const QModelIndex &parent) const
void	headerDataChanged (Qt::Orientation orientation, int first, int last)
virtual QModelIndex	index (int row, int column, const QModelIndex &parent) const =0
bool	insertColumn (int column, const QModelIndex &parent)
virtual bool	insertColumns (int column, int count, const QModelIndex &parent)
bool	insertRow (int row, const QModelIndex &parent)
virtual bool	insertRows (int row, int count, const QModelIndex &parent)
virtual QMap< int, QVariant >	itemData (const QModelIndex &index) const
void	layoutAboutToBeChanged ()
void	layoutChanged ()
virtual QModelIndexList	match (const QModelIndex &start, int role, const QVariant &value, int hits, QFlags< Qt::MatchFlag > flags) const
void	modelAboutToBeReset ()
void	modelReset ()
virtual QModelIndex	parent (const QModelIndex &index) const =0
bool	removeColumn (int column, const QModelIndex &parent)
virtual bool	removeColumns (int column, int count, const QModelIndex &parent)
bool	removeRow (int row, const QModelIndex &parent)
virtual bool	removeRows (int row, int count, const QModelIndex &parent)
virtual void	revert ()
const QHash< int, QByteArray > &	roleNames () const
virtual int	rowCount (const QModelIndex &parent) const =0
void	rowsAboutToBeInserted (const QModelIndex &parent, int start, int end)
void	rowsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow)
void	rowsAboutToBeRemoved (const QModelIndex &parent, int start, int end)
void	rowsInserted (const QModelIndex &parent, int start, int end)
void	rowsMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow)
void	rowsRemoved (const QModelIndex &parent, int start, int end)
virtual bool	setData (const QModelIndex &index, const QVariant &value, int role)
virtual bool	setHeaderData (int section, Qt::Orientation orientation, const QVariant &value, int role)
virtual bool	setItemData (const QModelIndex &index, const QMap< int, QVariant > &roles)
void	setSupportedDragActions (QFlags< Qt::DropAction > actions)
QModelIndex	sibling (int row, int column, const QModelIndex &index) const
virtual void	sort (int column, Qt::SortOrder order)
virtual QSize	span (const QModelIndex &index) const
virtual bool	submit ()
Qt::DropActions	supportedDragActions () const
Public Member Functions inherited from QObject
	QObject (QObject *parent)
	QObject (QObject *parent, const char *name)
bool	blockSignals (bool block)
QObject *	child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
const QObjectList &	children () const
const char *	className () const
bool	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const QObject *receiver, const char *method)
bool	disconnect (const char *signal, const QObject *receiver, const char *method)
void	dumpObjectInfo ()
void	dumpObjectTree ()
QList< QByteArray >	dynamicPropertyNames () const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name) const
QList< T >	findChildren (const QRegExp &regExp) const
QList< T >	findChildren (const QString &name) const
bool	inherits (const char *className) const
void	insertChild (QObject *object)
void	installEventFilter (QObject *filterObj)
bool	isA (const char *className) const
bool	isWidgetType () const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const
void	moveToThread (QThread *targetThread)
const char *	name () const
const char *	name (const char *defaultName) const
QString	objectName () const
QObject *	parent () const
QVariant	property (const char *name) const
void	removeChild (QObject *object)
void	removeEventFilter (QObject *obj)
void	setName (const char *name)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const
int	startTimer (int interval)
QThread *	thread () const

Protected Member Functions
Session *	session () const
Protected Member Functions inherited from QAbstractItemModel
void	beginInsertColumns (const QModelIndex &parent, int first, int last)
void	beginInsertRows (const QModelIndex &parent, int first, int last)
bool	beginMoveColumns (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationChild)
bool	beginMoveRows (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationChild)
void	beginRemoveColumns (const QModelIndex &parent, int first, int last)
void	beginRemoveRows (const QModelIndex &parent, int first, int last)
void	beginResetModel ()
void	changePersistentIndex (const QModelIndex &from, const QModelIndex &to)
void	changePersistentIndexList (const QModelIndexList &from, const QModelIndexList &to)
QModelIndex	createIndex (int row, int column, void *ptr) const
QModelIndex	createIndex (int row, int column, int id) const
QModelIndex	createIndex (int row, int column, quint32 id) const
void	endInsertColumns ()
void	endInsertRows ()
void	endMoveColumns ()
void	endMoveRows ()
void	endRemoveColumns ()
void	endRemoveRows ()
void	endResetModel ()
QModelIndexList	persistentIndexList () const
void	reset ()
void	resetInternalData ()
void	setRoleNames (const QHash< int, QByteArray > &roleNames)
Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char *signal, const QObject *object, const char *method)
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const char *signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const char *signal)
int	receivers (const char *signal) const
QObject *	sender () const
int	senderSignalIndex () const
virtual void	timerEvent (QTimerEvent *event)

Additional Inherited Members
Static Public Member Functions inherited from QObject
bool	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
bool	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)
Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)
Properties inherited from QObject
	objectName

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 254 of file itemmodel.cpp.

ItemModel::~ItemModel ( )

virtual

Destroys the item model.

Definition at line 260 of file itemmodel.cpp.

Member Function Documentation

Collection ItemModel::collection

(

)

const

Returns the collection being displayed in the model.

Definition at line 462 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 386 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 447 of file itemmodel.cpp.

Item ItemModel::itemForIndex

(

const QModelIndex &

index

)

const

Returns the item at the given index.

Definition at line 391 of file itemmodel.cpp.

Session * ItemModel::session ( ) const

protected

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

Definition at line 425 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 341 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 381 of file itemmodel.cpp.

---

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

• itemmodel.h
• itemmodel.cpp