• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.14.10 API Reference
  • KDE Home
  • Contact Us
 

akonadi/contact

  • Akonadi
  • ContactsTreeModel
Public Types | Public Member Functions | List of all members
Akonadi::ContactsTreeModel Class Reference

#include <contactstreemodel.h>

Inherits EntityTreeModel.

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 );
Akonadi::ContactsTreeModel
A model for contacts and contact groups as available in Akonadi.
Definition: contactstreemodel.h:79
Akonadi::ContactsTreeModel::setColumns
void setColumns(const Columns &columns)
Sets the columns that the model should show.
Definition: contactstreemodel.cpp:58
Akonadi::ContactsTreeModel::columns
Columns columns() const
Returns the columns that the model currently shows.
Definition: contactstreemodel.cpp:65
Akonadi::ContactsTreeModel::Columns
QList< Column > Columns
Describes a list of columns of the contacts tree model.
Definition: contactstreemodel.h:156
Akonadi::ContactsTreeModel::AllEmails
@ AllEmails
Shows all email address.
Definition: contactstreemodel.h:130
Akonadi::ContactsTreeModel::FullName
@ FullName
Shows the formatted name or, if empty, the assembled name.
Definition: contactstreemodel.h:90
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
monitorThe ChangeRecorder whose entities should be represented in the model.
parentThe 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
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Thu Jul 21 2022 00:00:00 by doxygen 1.9.5 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

akonadi/contact

Skip menu "akonadi/contact"
  • Main Page
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • Related Pages

kdepimlibs-4.14.10 API Reference

Skip menu "kdepimlibs-4.14.10 API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal