.TH "KABC::DistributionList" 3 "28 Jan 2004" "kabc Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KABC::DistributionList \- Distribution list of email addresses.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <distributionlist.h>\fP
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBDistributionList\fP (\fBDistributionListManager\fP *manager, const  \fBQString\fP &name)"
.br
.RI "\fICreate distribution list object. \fP"
.ti -1c
.RI "\fB~DistributionList\fP ()"
.br
.RI "\fIDestructor. \fP"
.ti -1c
.RI "void \fBsetName\fP (const  \fBQString\fP &)"
.br
.RI "\fISet name of this list. \fP"
.ti -1c
.RI "\fBQString\fP \fBname\fP () const "
.br
.RI "\fIGet name of this list. \fP"
.ti -1c
.RI "void \fBinsertEntry\fP (const  \fBAddressee\fP &, const  \fBQString\fP &email=QString::null)"
.br
.RI "\fIInsert an entry into this distribution list. \fP"
.ti -1c
.RI "void \fBremoveEntry\fP (const  \fBAddressee\fP &, const  \fBQString\fP &email=QString::null)"
.br
.RI "\fIRemove an entry from this distribution list. \fP"
.ti -1c
.RI "\fBQStringList\fP \fBemails\fP () const "
.br
.RI "\fIReturn list of email addresses, which belong to this distributon list. \fP"
.ti -1c
.RI "\fBEntry::List\fP \fBentries\fP () const "
.br
.RI "\fIReturn list of entries belonging to this distribution list. \fP"
.in -1c
.SH "Detailed Description"
.PP 
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. 
.PP
Definition at line 39 of file distributionlist.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "DistributionList::DistributionList (\fBDistributionListManager\fP * manager, const \fBQString\fP & name)"
.PP
Create distribution list object. \fBParameters:\fP
.RS 4
\fImanager\fP Managing object of this list. 
.br
\fIname\fP Name of this list. 
.RE
.PP
Definition at line 29 of file distributionlist.cpp.
.PP
References KABC::DistributionListManager::insert(), and KStdAccel::name().
.SS "DistributionList::~\fBDistributionList\fP ()"
.PP
Destructor. Definition at line 36 of file distributionlist.cpp.
.PP
References KABC::DistributionListManager::remove().
.SH "Member Function Documentation"
.PP 
.SS "void DistributionList::setName (const \fBQString\fP &)"
.PP
Set name of this list. The name is used as key by the DistributinListManager. Definition at line 41 of file distributionlist.cpp.
.PP
References KStdAccel::name().
.SS "\fBQString\fP DistributionList::name () const"
.PP
Get name of this list. Definition at line 46 of file distributionlist.cpp.
.PP
Referenced by KABC::DistributionListManager::insert(), KABC::DistributionListManager::list(), KABC::DistributionListManager::listNames(), KABC::DistributionListManager::remove(), and KABC::DistributionListManager::save().
.SS "void DistributionList::insertEntry (const \fBAddressee\fP &, const \fBQString\fP & email = QString::null)"
.PP
Insert an entry into this distribution list. If the entry already exists nothing happens. Definition at line 51 of file distributionlist.cpp.
.PP
References QValueList::append(), QValueList::begin(), QValueList::end(), QString::isEmpty(), QString::isNull(), and KABC::Addressee::uid().
.PP
Referenced by KABC::DistributionListManager::load().
.SS "void DistributionList::removeEntry (const \fBAddressee\fP &, const \fBQString\fP & email = QString::null)"
.PP
Remove an entry from this distribution list. If the entry doesn't exist nothing happens. Definition at line 73 of file distributionlist.cpp.
.PP
References QValueList::begin(), QValueList::end(), QValueList::remove(), and KABC::Addressee::uid().
.SS "\fBQStringList\fP DistributionList::emails () const"
.PP
Return list of email addresses, which belong to this distributon list. These addresses can be directly used by e.g. a mail client. Definition at line 84 of file distributionlist.cpp.
.PP
References QValueList::begin(), emails(), QValueList::end(), KABC::Addressee::fullEmail(), and QString::isEmpty().
.PP
Referenced by emails().
.SS "\fBDistributionList::Entry::List\fP DistributionList::entries () const"
.PP
Return list of entries belonging to this distribution list. This function is mainly useful for a distribution list editor. Definition at line 102 of file distributionlist.cpp.
.PP
Referenced by KABC::DistributionListManager::save().

.SH "Author"
.PP 
Generated automatically by Doxygen for kabc Library from the source code.
