libkdepim Library API Documentation

KPIM::DistributionList Class Reference

Distribution list of email addresses. More...

#include <distributionlist.h>

List of all members.

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...


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 probably go into kdelibs at some point.

Definition at line 22 of file distributionlist.h.


Constructor & Destructor Documentation

KPIM::DistributionList::DistributionList  ) 
 

Create distribution list object.

Parameters:
manager Managing object of this list.
name Name of this list.

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

Destructor.

Definition at line 58 of file distributionlist.h.


Member Function Documentation

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

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

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.

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.

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

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

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

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

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

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


The documentation for this class was generated from the following file:
KDE Logo
This file is part of the documentation for libkdepim Library Version 3.3.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Thu Aug 2 09:53:44 2007 by doxygen 1.4.2 written by Dimitri van Heesch, © 1997-2003