#include <contactstreemodel.h>

Inheritance diagram for Akonadi::ContactsTreeModel:

Public Types
enum	Column { FullName, FamilyName, GivenName, Birthday, HomeAddress, BusinessAddress, PhoneNumbers, PreferredEmail, AllEmails, Organization, Role, Homepage, Note }

typedef QList< Column >	Columns

enum	Roles { DateRole = EntityTreeModel::UserRole + 1, UserRole = DateRole + 42 }

Public Types inherited from Akonadi::EntityTreeModel
enum	CollectionFetchStrategy { FetchNoCollections, FetchFirstLevelChildCollections, FetchCollectionsRecursive, InvisibleCollectionFetch }

enum	FetchState { IdleState, FetchingState }

enum	HeaderGroup { EntityTreeHeaders, CollectionTreeHeaders, ItemListHeaders, UserHeaders = 10, EndHeaderGroup = 32 }

enum	ItemPopulationStrategy { NoItemPopulation, ImmediatePopulation, LazyPopulation }

enum	Roles { ItemIdRole = Qt::UserRole + 1, ItemRole = Qt::UserRole + 2, MimeTypeRole = Qt::UserRole + 3, CollectionIdRole = Qt::UserRole + 10, CollectionRole = Qt::UserRole + 11, RemoteIdRole, CollectionChildOrderRole, AmazingCompletionRole, ParentCollectionRole, ColumnCountRole, LoadedPartsRole, AvailablePartsRole, SessionRole, CollectionRefRole, CollectionDerefRole, PendingCutRole, EntityUrlRole, UnreadCountRole, FetchStateRole, CollectionSyncProgressRole, IsPopulatedRole, OriginalCollectionNameRole, UserRole = Qt::UserRole + 500, TerminalUserRole = 2000, EndRole = 65535 }

Public Member Functions
	ContactsTreeModel (ChangeRecorder monitor, QObject parent=0)

virtual	~ContactsTreeModel ()

Columns	columns () const

void	setColumns (const Columns &columns)

Public Member Functions inherited from Akonadi::EntityTreeModel
	EntityTreeModel (ChangeRecorder monitor, QObject parent=0)

virtual	~EntityTreeModel ()

virtual bool	canFetchMore (const QModelIndex &parent) const

CollectionFetchStrategy	collectionFetchStrategy () const

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)

virtual void	fetchMore (const QModelIndex &parent)

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

virtual bool	hasChildren (const QModelIndex &parent=QModelIndex()) const

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

bool	includeRootCollection () const

AKONADI_DEPRECATED bool	includeUnsubscribed () const

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

bool	isCollectionPopulated (Akonadi::Collection::Id) const

bool	isCollectionTreeFetched () const

bool	isFullyPopulated () const

ItemPopulationStrategy	itemPopulationStrategy () const

Akonadi::CollectionFetchScope::ListFilter	listFilter () const

virtual QModelIndexList	match (const QModelIndex &start, int role, const QVariant &value, int hits=1, Qt::MatchFlags flags=Qt::MatchFlags(Qt::MatchStartsWith\|Qt::MatchWrap)) const

virtual QMimeData *	mimeData (const QModelIndexList &indexes) const

virtual QStringList	mimeTypes () const

virtual QModelIndex	parent (const QModelIndex &index) const

QString	rootCollectionDisplayName () const

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

void	setCollectionFetchStrategy (CollectionFetchStrategy strategy)

void	setCollectionMonitored (const Akonadi::Collection &col, bool monitored=true)

void	setCollectionReferenced (const Akonadi::Collection &col, bool referenced=true)

void	setCollectionsMonitored (const Akonadi::Collection::List &collections)

virtual bool	setData (const QModelIndex &index, const QVariant &value, int role=Qt::EditRole)

void	setIncludeRootCollection (bool include)

AKONADI_DEPRECATED void	setIncludeUnsubscribed (bool show)

void	setItemPopulationStrategy (ItemPopulationStrategy strategy)

void	setListFilter (Akonadi::CollectionFetchScope::ListFilter filter)

void	setRootCollectionDisplayName (const QString &name)

void	setShowSystemEntities (bool show)

virtual Qt::DropActions	supportedDropActions () const

bool	systemEntitiesShown () const

Public Member Functions inherited from QAbstractItemModel
	QAbstractItemModel (QObject *parent)

virtual QModelIndex	buddy (const QModelIndex &index) 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)

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

Additional Inherited Members
Signals inherited from Akonadi::EntityTreeModel
void	collectionFetched (int collectionId)

void	collectionPopulated (Akonadi::Collection::Id collectionId)

void	collectionTreeFetched (const Akonadi::Collection::List &collections)

Static Public Member Functions inherited from Akonadi::EntityTreeModel
static QModelIndexList	modelIndexesForItem (const QAbstractItemModel *model, const Item &item)

static QModelIndex	modelIndexForCollection (const QAbstractItemModel *model, const Collection &collection)

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)

Protected Member Functions inherited from Akonadi::EntityTreeModel
void	clearAndReset ()

virtual int	entityColumnCount (HeaderGroup headerGroup) const

virtual QVariant	entityData (const Item &item, int column, int role=Qt::DisplayRole) const

virtual QVariant	entityData (const Collection &collection, int column, int role=Qt::DisplayRole) const

virtual QVariant	entityHeaderData (int section, Qt::Orientation orientation, int role, HeaderGroup headerGroup) const

virtual bool	entityMatch (const Item &item, const QVariant &value, Qt::MatchFlags flags) const

virtual bool	entityMatch (const Collection &collection, const QVariant &value, Qt::MatchFlags flags) 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)

Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)

Properties inherited from QObject
	objectName

Detailed Description

A model for contacts and contact groups as available in Akonadi.

This class provides a model for displaying the contacts and contact groups which are available from Akonadi.

Example:

// use a separated session for this model
Akonadi::Session *session = new Akonadi::Session( "MySession" );
Akonadi::ItemFetchScope scope;
// fetch all content of the contacts, including images
scope.fetchFullPayload( true );
// fetch the EntityDisplayAttribute, which contains custom names and icons
scope.fetchAttribute<Akonadi::EntityDisplayAttribute>();
Akonadi::ChangeRecorder *changeRecorder = new Akonadi::ChangeRecorder;
changeRecorder->setSession( session );
// include fetching the collection tree
changeRecorder->fetchCollection( true );
// set the fetch scope that shall be used
changeRecorder->setItemFetchScope( scope );
// monitor all collections below the root collection for changes
changeRecorder->setCollectionMonitored( Akonadi::Collection::root() );
// list only contacts and contact groups
changeRecorder->setMimeTypeMonitored( KABC::Addressee::mimeType(), true );
changeRecorder->setMimeTypeMonitored( KABC::ContactGroup::mimeType(), true );
Akonadi::ContactsTreeModel *model = new Akonadi::ContactsTreeModel( changeRecorder );
Akonadi::ContactsTreeModel::Columns columns;
columns << Akonadi::ContactsTreeModel::FullName;
columns << Akonadi::ContactsTreeModel::AllEmails;
model->setColumns( columns );
Akonadi::EntityTreeView *view = new Akonadi::EntityTreeView;
view->setModel( model );

Author: Tobias Koenig tokoe.nosp@m.@kde.nosp@m..org

Since: 4.5

Definition at line 78 of file contactstreemodel.h.

Member Typedef Documentation

typedef QList<Column> Akonadi::ContactsTreeModel::Columns

Describes a list of columns of the contacts tree model.

Definition at line 156 of file contactstreemodel.h.

Member Enumeration Documentation

enum Akonadi::ContactsTreeModel::Column

Describes the columns that can be shown by the model.

Enumerator
FullName	Shows the formatted name or, if empty, the assembled name.
FamilyName	Shows the family name.
GivenName	Shows the given name.
Birthday	Shows the birthday.
HomeAddress	Shows the formatted home address.
BusinessAddress	Shows the formatted business address.
PhoneNumbers	Shows the phone numbers.
PreferredEmail	Shows the preferred email address.
AllEmails	Shows all email address.
Organization	Shows organization name.
Role	Shows the role of a contact.
Homepage	Shows homepage url.
Note	Shows the note.

Definition at line 86 of file contactstreemodel.h.

enum Akonadi::ContactsTreeModel::Roles

Describes the role for contacts and contact groups.

Enumerator
DateRole	The QDate object for the current index.

Definition at line 161 of file contactstreemodel.h.

Constructor & Destructor Documentation

ContactsTreeModel::ContactsTreeModel	(	ChangeRecorder *	monitor,
		QObject *	parent = `0`
	)

explicit

Creates a new contacts tree model.

Parameters

monitor	The ChangeRecorder whose entities should be represented in the model.
parent	The parent object.

Definition at line 48 of file contactstreemodel.cpp.

ContactsTreeModel::~ContactsTreeModel ( )

virtual

Destroys the contacts tree model.

Definition at line 53 of file contactstreemodel.cpp.

Member Function Documentation

ContactsTreeModel::Columns ContactsTreeModel::columns ( ) const

Returns the columns that the model currently shows.

Definition at line 65 of file contactstreemodel.cpp.

void ContactsTreeModel::setColumns ( const Columns & columns )

Sets the columns that the model should show.

Definition at line 58 of file contactstreemodel.cpp.

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

akonadi

Public Types

Public Member Functions

Additional Inherited Members