.TH "KABC::DistributionList" kde3 "11 Jun 2005" "Version Version 3.4.1" "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
.ti -1c
.RI "\fB~DistributionList\fP ()"
.br
.ti -1c
.RI "void \fBsetName\fP (const \fBQString\fP &)"
.br
.ti -1c
.RI "\fBQString\fP \fBname\fP () const "
.br
.ti -1c
.RI "void \fBinsertEntry\fP (const \fBAddressee\fP &, const \fBQString\fP &email=QString::null)"
.br
.ti -1c
.RI "void \fBremoveEntry\fP (const \fBAddressee\fP &, const \fBQString\fP &email=QString::null)"
.br
.ti -1c
.RI "\fBQStringList\fP \fBemails\fP () const "
.br
.ti -1c
.RI "\fBEntry::List\fP \fBentries\fP () const "
.br
.in -1c
.SS "Classes"

.in +1c
.ti -1c
.RI "struct \fBEntry\fP"
.br
.RI "\fIDistribution List \fBEntry\fP. \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. 
.PP
\fBParameters:\fP
.RS 4
\fImanager\fP Managing object of this list. 
.br
\fIname\fP Name of this list. 
.RE
.PP

.PP
Definition at line 33 of file distributionlist.cpp.
.PP
References KABC::DistributionListManager::insert().
.SS "DistributionList::~\fBDistributionList\fP ()"
.PP
Destructor. 
.PP
Definition at line 40 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. 
.PP
The name is used as key by the DistributinListManager. 
.PP
Definition at line 45 of file distributionlist.cpp.
.PP
References name().
.SS "\fBQString\fP DistributionList::name () const"
.PP
Get name of this list. 
.PP
Definition at line 50 of file distributionlist.cpp.
.PP
Referenced by setName().
.SS "void DistributionList::insertEntry (const \fBAddressee\fP &, const \fBQString\fP & email = \fCQString::null\fP)"
.PP
Insert an entry into this distribution list. 
.PP
If the entry already exists nothing happens. 
.PP
Definition at line 55 of file distributionlist.cpp.
.PP
References QValueList::append(), QValueList::begin(), and QValueList::end().
.SS "void DistributionList::removeEntry (const \fBAddressee\fP &, const \fBQString\fP & email = \fCQString::null\fP)"
.PP
Remove an entry from this distribution list. 
.PP
If the entry doesn't exist nothing happens. 
.PP
Definition at line 77 of file distributionlist.cpp.
.PP
References QValueList::begin(), QValueList::end(), and QValueList::remove().
.SS "\fBQStringList\fP DistributionList::emails () const"
.PP
Return list of email addresses, which belong to this distributon list. 
.PP
These addresses can be directly used by e.g. a mail client. 
.PP
Definition at line 88 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. 
.PP
This function is mainly useful for a distribution list editor. 
.PP
Definition at line 106 of file distributionlist.cpp.

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