Akonadi::ContactsTreeModel Class Reference

#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

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)
Protected Member Functions inherited from Akonadi::EntityTreeModel
void	clearAndReset ()
virtual int	entityColumnCount (HeaderGroup headerGroup) const
virtual QVariant	entityData (const Collection &collection, int column, int role=Qt::DisplayRole) const
virtual QVariant	entityData (const Item &item, int column, int role=Qt::DisplayRole) const
virtual QVariant	entityHeaderData (int section, Qt::Orientation orientation, int role, HeaderGroup headerGroup) const
virtual bool	entityMatch (const Collection &collection, const QVariant &value, Qt::MatchFlags flags) const
virtual bool	entityMatch (const Item &item, const QVariant &value, Qt::MatchFlags flags) const

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

Columns

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

Column

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.

Roles

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::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::~ContactsTreeModel ( )

virtual

Destroys the contacts tree model.

Definition at line 53 of file contactstreemodel.cpp.

Member Function Documentation

columns()

ContactsTreeModel::Columns ContactsTreeModel::columns

(

)

const

Returns the columns that the model currently shows.

Definition at line 65 of file contactstreemodel.cpp.

setColumns()

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:

• contactstreemodel.h
• contactstreemodel.cpp