\section{KABC::Distribution\-List Class Reference}
\label{classKABC_1_1DistributionList}\index{KABC::DistributionList@{KABC::DistributionList}}
Distribution list of email addresses.  


{\tt \#include $<$distributionlist.h$>$}

Collaboration diagram for KABC::Distribution\-List:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=227pt]{classKABC_1_1DistributionList__coll__graph}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf Distribution\-List} ({\bf Distribution\-List\-Manager} $\ast$manager, const  {\bf QString} \&name)
\begin{CompactList}\small\item\em Create distribution list object. \item\end{CompactList}\item 
{\bf $\sim$Distribution\-List} ()
\begin{CompactList}\small\item\em Destructor. \item\end{CompactList}\item 
void {\bf set\-Name} (const  {\bf QString} \&)
\begin{CompactList}\small\item\em Set name of this list. \item\end{CompactList}\item 
{\bf QString} {\bf name} () const 
\begin{CompactList}\small\item\em Get name of this list. \item\end{CompactList}\item 
void {\bf insert\-Entry} (const  {\bf Addressee} \&, const  {\bf QString} \&email=QString::null)
\begin{CompactList}\small\item\em Insert an entry into this distribution list. \item\end{CompactList}\item 
void {\bf remove\-Entry} (const  {\bf Addressee} \&, const  {\bf QString} \&email=QString::null)
\begin{CompactList}\small\item\em Remove an entry from this distribution list. \item\end{CompactList}\item 
{\bf QString\-List} {\bf emails} () const 
\begin{CompactList}\small\item\em Return list of email addresses, which belong to this distributon list. \item\end{CompactList}\item 
{\bf Entry::List} {\bf entries} () const 
\begin{CompactList}\small\item\em Return list of entries belonging to this distribution list. \item\end{CompactList}\end{CompactItemize}


\subsection{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. 



Definition at line 39 of file distributionlist.h.

\subsection{Constructor \& Destructor Documentation}
\index{KABC::DistributionList@{KABC::Distribution\-List}!DistributionList@{DistributionList}}
\index{DistributionList@{DistributionList}!KABC::DistributionList@{KABC::Distribution\-List}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Distribution\-List::Distribution\-List ({\bf Distribution\-List\-Manager} $\ast$ {\em manager}, const {\bf QString} \& {\em name})}\label{classKABC_1_1DistributionList_a0}


Create distribution list object. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em manager}]Managing object of this list. \item[{\em name}]Name of this list. \end{description}
\end{Desc}


Definition at line 29 of file distributionlist.cpp.

References KABC::Distribution\-List\-Manager::insert(), and KStd\-Accel::name().\index{KABC::DistributionList@{KABC::Distribution\-List}!~DistributionList@{$\sim$DistributionList}}
\index{~DistributionList@{$\sim$DistributionList}!KABC::DistributionList@{KABC::Distribution\-List}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Distribution\-List::$\sim${\bf Distribution\-List} ()}\label{classKABC_1_1DistributionList_a1}


Destructor. 



Definition at line 36 of file distributionlist.cpp.

References KABC::Distribution\-List\-Manager::remove().

\subsection{Member Function Documentation}
\index{KABC::DistributionList@{KABC::Distribution\-List}!setName@{setName}}
\index{setName@{setName}!KABC::DistributionList@{KABC::Distribution\-List}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Distribution\-List::set\-Name (const {\bf QString} \&)}\label{classKABC_1_1DistributionList_a2}


Set name of this list. 

The name is used as key by the Distributin\-List\-Manager. 

Definition at line 41 of file distributionlist.cpp.

References KStd\-Accel::name().\index{KABC::DistributionList@{KABC::Distribution\-List}!name@{name}}
\index{name@{name}!KABC::DistributionList@{KABC::Distribution\-List}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} Distribution\-List::name () const}\label{classKABC_1_1DistributionList_a3}


Get name of this list. 



Definition at line 46 of file distributionlist.cpp.

Referenced by KABC::Distribution\-List\-Manager::insert(), KABC::Distribution\-List\-Manager::list(), KABC::Distribution\-List\-Manager::list\-Names(), KABC::Distribution\-List\-Manager::remove(), and KABC::Distribution\-List\-Manager::save().\index{KABC::DistributionList@{KABC::Distribution\-List}!insertEntry@{insertEntry}}
\index{insertEntry@{insertEntry}!KABC::DistributionList@{KABC::Distribution\-List}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Distribution\-List::insert\-Entry (const {\bf Addressee} \&, const {\bf QString} \& {\em email} = QString::null)}\label{classKABC_1_1DistributionList_a4}


Insert an entry into this distribution list. 

If the entry already exists nothing happens. 

Definition at line 51 of file distributionlist.cpp.

References QValue\-List::append(), QValue\-List::begin(), QValue\-List::end(), QString::is\-Empty(), QString::is\-Null(), and KABC::Addressee::uid().

Referenced by KABC::Distribution\-List\-Manager::load().\index{KABC::DistributionList@{KABC::Distribution\-List}!removeEntry@{removeEntry}}
\index{removeEntry@{removeEntry}!KABC::DistributionList@{KABC::Distribution\-List}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Distribution\-List::remove\-Entry (const {\bf Addressee} \&, const {\bf QString} \& {\em email} = QString::null)}\label{classKABC_1_1DistributionList_a5}


Remove an entry from this distribution list. 

If the entry doesn't exist nothing happens. 

Definition at line 73 of file distributionlist.cpp.

References QValue\-List::begin(), QValue\-List::end(), QValue\-List::remove(), and KABC::Addressee::uid().\index{KABC::DistributionList@{KABC::Distribution\-List}!emails@{emails}}
\index{emails@{emails}!KABC::DistributionList@{KABC::Distribution\-List}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString\-List} Distribution\-List::emails () const}\label{classKABC_1_1DistributionList_a6}


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.

References QValue\-List::begin(), emails(), QValue\-List::end(), KABC::Addressee::full\-Email(), and QString::is\-Empty().

Referenced by emails().\index{KABC::DistributionList@{KABC::Distribution\-List}!entries@{entries}}
\index{entries@{entries}!KABC::DistributionList@{KABC::Distribution\-List}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Distribution\-List::Entry::List} Distribution\-List::entries () const}\label{classKABC_1_1DistributionList_a7}


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.

Referenced by KABC::Distribution\-List\-Manager::save().

The documentation for this class was generated from the following files:\begin{CompactItemize}
\item 
distributionlist.h\item 
distributionlist.cpp\end{CompactItemize}
