libkdepim

KPIM::DistributionList Class Reference

#include <distributionlist.h>

List of all members.


Detailed Description

Distribution list of email addresses.

This class represents a list of email addresses. Each email address is associated with an address book entry. If the address book entry changes, the entry in the distribution list is automatically updated.

This should go into kdelibs in KDE4.

Author:
David Faure <faure@kde.org>

Definition at line 43 of file distributionlist.h.


Public Types

typedef QValueList< DistributionListList

Public Member Functions

 DistributionList ()
 DistributionList (const KABC::Addressee &addr)
 ~DistributionList ()
void setName (const QString &name)
QString name () const
void insertEntry (const Addressee &, const QString &email=QString::null)
void removeEntry (const Addressee &, const QString &email=QString::null)
void insertEntry (const QString &uid, const QString &email=QString::null)
void removeEntry (const QString &uid, const QString &email=QString::null)
QStringList emails (KABC::AddressBook *book) const
Entry::List entries (KABC::AddressBook *book) const

Static Public Member Functions

static bool isDistributionList (const KABC::Addressee &addr)
static DistributionList findByName (KABC::AddressBook *book, const QString &name, bool caseSensitive=true)
static QValueList< DistributionListallDistributionLists (KABC::AddressBook *book)

Classes

struct  Entry
 Distribution List Entry. More...

Constructor & Destructor Documentation

KPIM::DistributionList::DistributionList (  ) 

Create a distribution list.

Definition at line 6 of file distributionlist.cpp.

KPIM::DistributionList::DistributionList ( const KABC::Addressee &  addr  ) 

Create a distribution list from an addressee object (this is a kind of down-cast).

Definition at line 12 of file distributionlist.cpp.

KPIM::DistributionList::~DistributionList (  )  [inline]

Destructor.

Definition at line 80 of file distributionlist.h.


Member Function Documentation

void KPIM::DistributionList::setName ( const QString &  name  ) 

HACK: reimplemented from Addressee, but it's NOT virtual there.

Definition at line 17 of file distributionlist.cpp.

QString KPIM::DistributionList::name (  )  const [inline]

HACK: reimplemented from Addressee, but it's NOT virtual there.

Definition at line 86 of file distributionlist.h.

void KPIM::DistributionList::insertEntry ( const Addressee &  ,
const QString &  email = QString::null 
)

Insert an entry into this distribution list.

If the entry already exists nothing happens.

Definition at line 54 of file distributionlist.cpp.

void KPIM::DistributionList::removeEntry ( const Addressee &  ,
const QString &  email = QString::null 
)

Remove an entry from this distribution list.

If the entry doesn't exist nothing happens.

Definition at line 71 of file distributionlist.cpp.

void KPIM::DistributionList::insertEntry ( const QString &  uid,
const QString &  email = QString::null 
)

Overload, used by resources to avoid looking up the addressee.

Definition at line 61 of file distributionlist.cpp.

void KPIM::DistributionList::removeEntry ( const QString &  uid,
const QString &  email = QString::null 
)

Overload, used by resources to avoid looking up the addressee.

Definition at line 78 of file distributionlist.cpp.

QStringList KPIM::DistributionList::emails ( KABC::AddressBook *  book  )  const

Return list of email addresses, which belong to this distributon list.

These addresses can be directly used by e.g. a mail client.

Parameters:
book necessary to look up entries

Definition at line 186 of file distributionlist.cpp.

KPIM::DistributionList::Entry::List KPIM::DistributionList::entries ( KABC::AddressBook *  book  )  const

Return list of entries belonging to this distribution list.

This function is mainly useful for a distribution list editor.

Parameters:
book necessary to look up entries

Definition at line 166 of file distributionlist.cpp.


The documentation for this class was generated from the following files:
KDE Home | KDE Accessibility Home | Description of Access Keys