• Skip to content
  • Skip to link menu
KDE 4.7 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • KDE Home
  • Contact Us
 

akonadi

  • Akonadi
  • ContactsTreeModel
Public Types | Public Member Functions
Akonadi::ContactsTreeModel Class Reference

#include <contactstreemodel.h>

Inheritance diagram for Akonadi::ContactsTreeModel:
Inheritance graph
[legend]

List of all members.

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

 ContactsTreeModel (ChangeRecorder *monitor, QObject *parent=0)
virtual ~ContactsTreeModel ()
Columns columns () const
void setColumns (const Columns &columns)

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@kde.org>
Since:
4.5

Member Typedef Documentation

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

Describes a list of columns of the contacts tree model.

Definition at line 157 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.

UserRole 

First role for user extensions.

Reimplemented from Akonadi::EntityTreeModel.

Definition at line 162 of file contactstreemodel.h.


Constructor & Destructor Documentation

Akonadi::ContactsTreeModel::ContactsTreeModel ( ChangeRecorder *  monitor,
QObject *  parent = 0 
) [explicit]

Creates a new contacts tree model.

Parameters:
monitorThe ChangeRecorder whose entities should be represented in the model.
parentThe parent object.
virtual Akonadi::ContactsTreeModel::~ContactsTreeModel ( ) [virtual]

Destroys the contacts tree model.


Member Function Documentation

Columns Akonadi::ContactsTreeModel::columns ( ) const

Returns the columns that the model currently shows.

void Akonadi::ContactsTreeModel::setColumns ( const Columns &  columns)

Sets the columns that the model should show.


The documentation for this class was generated from the following file:
  • contactstreemodel.h

akonadi

Skip menu "akonadi"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • Modules
  • Related Pages

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  •   contact
  •   kmime
  • kabc
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.7.5
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal