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

akonadi/contact

  • Akonadi
  • ContactGroupExpandJob
Public Member Functions
Akonadi::ContactGroupExpandJob Class Reference

#include <contactgroupexpandjob.h>

Inherits KJob.

List of all members.

Public Member Functions

 ContactGroupExpandJob (const KABC::ContactGroup &group, QObject *parent=0)
 ContactGroupExpandJob (const QString &name, QObject *parent=0)
 ~ContactGroupExpandJob ()
KABC::Addressee::List contacts () const
virtual void start ()

Detailed Description

Job that expands a ContactGroup to a list of contacts.

This job takes a KABC::ContactGroup object or a name of a contact group and expands it to a list of KABC::Addressee objects by creating temporary KABC::Addressee objects for the KABC::ContactGroup::Data objects of the group and fetching the complete contacts from the Akonadi storage for the KABC::ContactGroup::ContactReferences of the group.

 const KABC::ContactGroup group = ...;

 Akonadi::ContactGroupExpandJob *job = new Akonadi::ContactGroupExpandJob( group );
 connect( job, SIGNAL( result( KJob* ) ), this, SLOT( expandResult( KJob* ) ) );
 job->start();

 ...

 MyClass::expandResult( KJob *job )
 {
   Akonadi::ContactGroupExpandJob *expandJob = qobject_cast<Akonadi::ContactGroupExpandJob*>( job );
   const KABC::Addressee::List contacts = expandJob->contacts();
   // do something with the contacts
 }
Author:
Tobias Koenig <tokoe@kde.org>
Since:
4.4

Definition at line 64 of file contactgroupexpandjob.h.


Constructor & Destructor Documentation

ContactGroupExpandJob::ContactGroupExpandJob ( const KABC::ContactGroup &  group,
QObject *  parent = 0 
) [explicit]

Creates a new contact group expand job.

Parameters:
groupThe contact group to expand.
parentThe parent object.

Definition at line 125 of file contactgroupexpandjob.cpp.

ContactGroupExpandJob::ContactGroupExpandJob ( const QString &  name,
QObject *  parent = 0 
) [explicit]

Creates a new contact group expand job.

Parameters:
nameThe name of the contact group to expand.
parentThe parent object.
Since:
4.5

Definition at line 130 of file contactgroupexpandjob.cpp.

ContactGroupExpandJob::~ContactGroupExpandJob ( )

Destroys the contact group expand job.

Definition at line 135 of file contactgroupexpandjob.cpp.


Member Function Documentation

KABC::Addressee::List ContactGroupExpandJob::contacts ( ) const

Returns the list of contacts.

Definition at line 153 of file contactgroupexpandjob.cpp.

void ContactGroupExpandJob::start ( ) [virtual]

Starts the expand job.

Definition at line 140 of file contactgroupexpandjob.cpp.


The documentation for this class was generated from the following files:
  • contactgroupexpandjob.h
  • contactgroupexpandjob.cpp

akonadi/contact

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

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  •   contact
  •   kmime
  • kabc
  • kalarmcal
  • 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.6.1
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