\section{KABC::Address Class Reference}
\label{classKABC_1_1Address}\index{KABC::Address@{KABC::Address}}
Postal address information.  


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

Collaboration diagram for KABC::Address:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=86pt]{classKABC_1_1Address__coll__graph}
\end{center}
\end{figure}
\subsection*{Public Types}
\begin{CompactItemize}
\item 
typedef {\bf QValue\-List}$<$ {\bf Address} $>$ {\bf List}
\begin{CompactList}\small\item\em List of addresses. \item\end{CompactList}\item 
typedef {\bf QValue\-List}$<$ int $>$ {\bf Type\-List}\label{classKABC_1_1Address_w1}

\item 
enum {\bf Type} \{ \par
{\bf Dom} =  1, 
{\bf Intl} =  2, 
{\bf Postal} =  4, 
{\bf Parcel} =  8, 
\par
{\bf Home} =  16, 
{\bf Work} =  32, 
{\bf Pref} =  64
 \}
\begin{CompactList}\small\item\em {\bf Address}{\rm (p.\,\pageref{classKABC_1_1Address})} types:. \item\end{CompactList}\end{CompactItemize}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf Address} ()
\begin{CompactList}\small\item\em Constructor that creates an empty {\bf Address}{\rm (p.\,\pageref{classKABC_1_1Address})}, which is initialized with a unique id (see id()). \item\end{CompactList}\item 
{\bf Address} (int)
\begin{CompactList}\small\item\em This is like {\bf Address}{\rm (p.\,\pageref{classKABC_1_1Address})}() just above, with the difference that you can specify the type. \item\end{CompactList}\item 
bool {\bf operator==} (const  {\bf Address} \&) const \label{classKABC_1_1Address_a2}

\item 
bool {\bf operator!=} (const  {\bf Address} \&) const \label{classKABC_1_1Address_a3}

\item 
bool {\bf is\-Empty} () const 
\begin{CompactList}\small\item\em Returns true, if the address is empty. \item\end{CompactList}\item 
void {\bf clear} ()
\begin{CompactList}\small\item\em Clears all entries of the address. \item\end{CompactList}\item 
void {\bf set\-Id} (const  {\bf QString} \&)
\begin{CompactList}\small\item\em Sets the unique id. \item\end{CompactList}\item 
{\bf QString} {\bf id} () const \label{classKABC_1_1Address_a7}

\item 
void {\bf set\-Type} (int type)
\begin{CompactList}\small\item\em Sets the type of address. \item\end{CompactList}\item 
int {\bf type} () const 
\begin{CompactList}\small\item\em Returns the type of address. \item\end{CompactList}\item 
{\bf QString} {\bf type\-Label} () const 
\begin{CompactList}\small\item\em Returns a translated string of all types the address has. \item\end{CompactList}\item 
void {\bf set\-Post\-Office\-Box} (const  {\bf QString} \&)
\begin{CompactList}\small\item\em Sets the post office box. \item\end{CompactList}\item 
{\bf QString} {\bf post\-Office\-Box} () const 
\begin{CompactList}\small\item\em Returns the post office box. \item\end{CompactList}\item 
void {\bf set\-Extended} (const  {\bf QString} \&)
\begin{CompactList}\small\item\em Sets the extended address information. \item\end{CompactList}\item 
{\bf QString} {\bf extended} () const 
\begin{CompactList}\small\item\em Returns the extended address information. \item\end{CompactList}\item 
void {\bf set\-Street} (const  {\bf QString} \&)
\begin{CompactList}\small\item\em Sets the street (including number). \item\end{CompactList}\item 
{\bf QString} {\bf street} () const 
\begin{CompactList}\small\item\em Returns the street. \item\end{CompactList}\item 
void {\bf set\-Locality} (const  {\bf QString} \&)
\begin{CompactList}\small\item\em Sets the locality, e.g. \item\end{CompactList}\item 
{\bf QString} {\bf locality} () const 
\begin{CompactList}\small\item\em Returns the locality. \item\end{CompactList}\item 
void {\bf set\-Region} (const  {\bf QString} \&)
\begin{CompactList}\small\item\em Sets the region, e.g. \item\end{CompactList}\item 
{\bf QString} {\bf region} () const 
\begin{CompactList}\small\item\em Returns the region. \item\end{CompactList}\item 
void {\bf set\-Postal\-Code} (const  {\bf QString} \&)
\begin{CompactList}\small\item\em Sets the postal code. \item\end{CompactList}\item 
{\bf QString} {\bf postal\-Code} () const 
\begin{CompactList}\small\item\em Returns the postal code. \item\end{CompactList}\item 
void {\bf set\-Country} (const  {\bf QString} \&)
\begin{CompactList}\small\item\em Sets the country. \item\end{CompactList}\item 
{\bf QString} {\bf country} () const 
\begin{CompactList}\small\item\em Returns the country. \item\end{CompactList}\item 
void {\bf set\-Label} (const  {\bf QString} \&)
\begin{CompactList}\small\item\em Sets the delivery label. \item\end{CompactList}\item 
{\bf QString} {\bf label} () const 
\begin{CompactList}\small\item\em Returns the delivery label. \item\end{CompactList}\item 
void {\bf dump} () const 
\begin{CompactList}\small\item\em Used for debug output. \item\end{CompactList}\end{CompactItemize}
\subsection*{Static Public Member Functions}
\begin{CompactItemize}
\item 
{\bf QString} {\bf post\-Office\-Box\-Label} ()
\begin{CompactList}\small\item\em Returns the translated label for post office box field. \item\end{CompactList}\item 
{\bf QString} {\bf extended\-Label} ()
\begin{CompactList}\small\item\em Returns the translated label for extended field. \item\end{CompactList}\item 
{\bf QString} {\bf street\-Label} ()
\begin{CompactList}\small\item\em Returns the translated label for street field. \item\end{CompactList}\item 
{\bf QString} {\bf locality\-Label} ()
\begin{CompactList}\small\item\em Returns the translated label for locality field. \item\end{CompactList}\item 
{\bf QString} {\bf region\-Label} ()
\begin{CompactList}\small\item\em Returns the translated label for region field. \item\end{CompactList}\item 
{\bf QString} {\bf postal\-Code\-Label} ()
\begin{CompactList}\small\item\em Returns the translated label for postal code field. \item\end{CompactList}\item 
{\bf QString} {\bf country\-Label} ()
\begin{CompactList}\small\item\em Returns the translated label for country field. \item\end{CompactList}\item 
{\bf QString} {\bf label\-Label} ()
\begin{CompactList}\small\item\em Returns the translated label for delivery label field. \item\end{CompactList}\item 
{\bf Type\-List} {\bf type\-List} ()
\begin{CompactList}\small\item\em Returns the list of available types. \item\end{CompactList}\item 
{\bf QString} {\bf type\-Label} (int type)
\begin{CompactList}\small\item\em Returns the translated label for a special type. \item\end{CompactList}\end{CompactItemize}
\subsection*{Friends}
\begin{CompactItemize}
\item 
{\bf QData\-Stream} \& {\bf operator$<$$<$} ({\bf QData\-Stream} \&, const  {\bf Address} \&)\label{classKABC_1_1Address_n0}

\item 
{\bf QData\-Stream} \& {\bf operator$>$$>$} ({\bf QData\-Stream} \&, {\bf Address} \&)\label{classKABC_1_1Address_n1}

\end{CompactItemize}


\subsection{Detailed Description}
Postal address information. 

This class represents information about a postal address. 



Definition at line 34 of file address.h.

\subsection{Member Typedef Documentation}
\index{KABC::Address@{KABC::Address}!List@{List}}
\index{List@{List}!KABC::Address@{KABC::Address}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}typedef {\bf QValue\-List}$<${\bf Address}$>$ {\bf KABC::Address::List}}\label{classKABC_1_1Address_w0}


List of addresses. 



Definition at line 43 of file address.h.

\subsection{Member Enumeration Documentation}
\index{KABC::Address@{KABC::Address}!Type@{Type}}
\index{Type@{Type}!KABC::Address@{KABC::Address}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}enum {\bf KABC::Address::Type}}\label{classKABC_1_1Address_w9}


{\bf Address}{\rm (p.\,\pageref{classKABC_1_1Address})} types:. 

\begin{itemize}
\item {\tt Dom} - domestic \item {\tt Intl} - international \item {\tt Postal} - postal \item {\tt Parcel} - parcel \item {\tt Home} - home address \item {\tt Work} - address at work \item {\tt Pref} - preferred address \end{itemize}


Definition at line 57 of file address.h.

\subsection{Constructor \& Destructor Documentation}
\index{KABC::Address@{KABC::Address}!Address@{Address}}
\index{Address@{Address}!KABC::Address@{KABC::Address}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Address::Address ()}\label{classKABC_1_1Address_a0}


Constructor that creates an empty {\bf Address}{\rm (p.\,\pageref{classKABC_1_1Address})}, which is initialized with a unique id (see id()). 



Definition at line 29 of file address.cpp.

References KApplication::random\-String().

Referenced by clear().\index{KABC::Address@{KABC::Address}!Address@{Address}}
\index{Address@{Address}!KABC::Address@{KABC::Address}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Address::Address (int)}\label{classKABC_1_1Address_a1}


This is like {\bf Address}{\rm (p.\,\pageref{classKABC_1_1Address})}() just above, with the difference that you can specify the type. 



Definition at line 35 of file address.cpp.

References KApplication::random\-String().

\subsection{Member Function Documentation}
\index{KABC::Address@{KABC::Address}!isEmpty@{isEmpty}}
\index{isEmpty@{isEmpty}!KABC::Address@{KABC::Address}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool Address::is\-Empty () const}\label{classKABC_1_1Address_a4}


Returns true, if the address is empty. 



Definition at line 60 of file address.cpp.

References QString::is\-Empty().\index{KABC::Address@{KABC::Address}!clear@{clear}}
\index{clear@{clear}!KABC::Address@{KABC::Address}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Address::clear ()}\label{classKABC_1_1Address_a5}


Clears all entries of the address. 



Definition at line 75 of file address.cpp.

References Address().\index{KABC::Address@{KABC::Address}!setId@{setId}}
\index{setId@{setId}!KABC::Address@{KABC::Address}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Address::set\-Id (const {\bf QString} \&)}\label{classKABC_1_1Address_a6}


Sets the unique id. 



Definition at line 80 of file address.cpp.\index{KABC::Address@{KABC::Address}!setType@{setType}}
\index{setType@{setType}!KABC::Address@{KABC::Address}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Address::set\-Type (int {\em type})}\label{classKABC_1_1Address_a8}


Sets the type of address. 

See enum for definiton of types.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em type}]type, can be a bitwise or of multiple types. \end{description}
\end{Desc}


Definition at line 92 of file address.cpp.\index{KABC::Address@{KABC::Address}!type@{type}}
\index{type@{type}!KABC::Address@{KABC::Address}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int Address::type () const}\label{classKABC_1_1Address_a9}


Returns the type of address. 

Can be a bitwise or of multiple types. 

Definition at line 99 of file address.cpp.

Referenced by type\-Label().\index{KABC::Address@{KABC::Address}!typeLabel@{typeLabel}}
\index{typeLabel@{typeLabel}!KABC::Address@{KABC::Address}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} Address::type\-Label () const}\label{classKABC_1_1Address_a10}


Returns a translated string of all types the address has. 



Definition at line 104 of file address.cpp.

References QString::append(), QValue\-List$<$ int $>$::begin(), QValue\-List$<$ int $>$::end(), KStd\-Accel::label(), label(), type(), and type\-List().\index{KABC::Address@{KABC::Address}!setPostOfficeBox@{setPostOfficeBox}}
\index{setPostOfficeBox@{setPostOfficeBox}!KABC::Address@{KABC::Address}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Address::set\-Post\-Office\-Box (const {\bf QString} \&)}\label{classKABC_1_1Address_a11}


Sets the post office box. 



Definition at line 123 of file address.cpp.\index{KABC::Address@{KABC::Address}!postOfficeBox@{postOfficeBox}}
\index{postOfficeBox@{postOfficeBox}!KABC::Address@{KABC::Address}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} Address::post\-Office\-Box () const}\label{classKABC_1_1Address_a12}


Returns the post office box. 



Definition at line 130 of file address.cpp.\index{KABC::Address@{KABC::Address}!postOfficeBoxLabel@{postOfficeBoxLabel}}
\index{postOfficeBoxLabel@{postOfficeBoxLabel}!KABC::Address@{KABC::Address}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} Address::post\-Office\-Box\-Label ()\hspace{0.3cm}{\tt  [static]}}\label{classKABC_1_1Address_e0}


Returns the translated label for post office box field. 



Definition at line 135 of file address.cpp.\index{KABC::Address@{KABC::Address}!setExtended@{setExtended}}
\index{setExtended@{setExtended}!KABC::Address@{KABC::Address}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Address::set\-Extended (const {\bf QString} \&)}\label{classKABC_1_1Address_a13}


Sets the extended address information. 



Definition at line 141 of file address.cpp.\index{KABC::Address@{KABC::Address}!extended@{extended}}
\index{extended@{extended}!KABC::Address@{KABC::Address}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} Address::extended () const}\label{classKABC_1_1Address_a14}


Returns the extended address information. 



Definition at line 148 of file address.cpp.

Referenced by dump().\index{KABC::Address@{KABC::Address}!extendedLabel@{extendedLabel}}
\index{extendedLabel@{extendedLabel}!KABC::Address@{KABC::Address}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} Address::extended\-Label ()\hspace{0.3cm}{\tt  [static]}}\label{classKABC_1_1Address_e1}


Returns the translated label for extended field. 



Definition at line 153 of file address.cpp.\index{KABC::Address@{KABC::Address}!setStreet@{setStreet}}
\index{setStreet@{setStreet}!KABC::Address@{KABC::Address}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Address::set\-Street (const {\bf QString} \&)}\label{classKABC_1_1Address_a15}


Sets the street (including number). 



Definition at line 159 of file address.cpp.\index{KABC::Address@{KABC::Address}!street@{street}}
\index{street@{street}!KABC::Address@{KABC::Address}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} Address::street () const}\label{classKABC_1_1Address_a16}


Returns the street. 



Definition at line 166 of file address.cpp.

Referenced by dump().\index{KABC::Address@{KABC::Address}!streetLabel@{streetLabel}}
\index{streetLabel@{streetLabel}!KABC::Address@{KABC::Address}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} Address::street\-Label ()\hspace{0.3cm}{\tt  [static]}}\label{classKABC_1_1Address_e2}


Returns the translated label for street field. 



Definition at line 171 of file address.cpp.\index{KABC::Address@{KABC::Address}!setLocality@{setLocality}}
\index{setLocality@{setLocality}!KABC::Address@{KABC::Address}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Address::set\-Locality (const {\bf QString} \&)}\label{classKABC_1_1Address_a17}


Sets the locality, e.g. 

city. 

Definition at line 177 of file address.cpp.\index{KABC::Address@{KABC::Address}!locality@{locality}}
\index{locality@{locality}!KABC::Address@{KABC::Address}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} Address::locality () const}\label{classKABC_1_1Address_a18}


Returns the locality. 



Definition at line 184 of file address.cpp.

Referenced by dump().\index{KABC::Address@{KABC::Address}!localityLabel@{localityLabel}}
\index{localityLabel@{localityLabel}!KABC::Address@{KABC::Address}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} Address::locality\-Label ()\hspace{0.3cm}{\tt  [static]}}\label{classKABC_1_1Address_e3}


Returns the translated label for locality field. 



Definition at line 189 of file address.cpp.\index{KABC::Address@{KABC::Address}!setRegion@{setRegion}}
\index{setRegion@{setRegion}!KABC::Address@{KABC::Address}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Address::set\-Region (const {\bf QString} \&)}\label{classKABC_1_1Address_a19}


Sets the region, e.g. 

state. 

Definition at line 195 of file address.cpp.\index{KABC::Address@{KABC::Address}!region@{region}}
\index{region@{region}!KABC::Address@{KABC::Address}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} Address::region () const}\label{classKABC_1_1Address_a20}


Returns the region. 



Definition at line 202 of file address.cpp.\index{KABC::Address@{KABC::Address}!regionLabel@{regionLabel}}
\index{regionLabel@{regionLabel}!KABC::Address@{KABC::Address}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} Address::region\-Label ()\hspace{0.3cm}{\tt  [static]}}\label{classKABC_1_1Address_e4}


Returns the translated label for region field. 



Definition at line 207 of file address.cpp.\index{KABC::Address@{KABC::Address}!setPostalCode@{setPostalCode}}
\index{setPostalCode@{setPostalCode}!KABC::Address@{KABC::Address}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Address::set\-Postal\-Code (const {\bf QString} \&)}\label{classKABC_1_1Address_a21}


Sets the postal code. 



Definition at line 213 of file address.cpp.\index{KABC::Address@{KABC::Address}!postalCode@{postalCode}}
\index{postalCode@{postalCode}!KABC::Address@{KABC::Address}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} Address::postal\-Code () const}\label{classKABC_1_1Address_a22}


Returns the postal code. 



Definition at line 220 of file address.cpp.

Referenced by dump().\index{KABC::Address@{KABC::Address}!postalCodeLabel@{postalCodeLabel}}
\index{postalCodeLabel@{postalCodeLabel}!KABC::Address@{KABC::Address}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} Address::postal\-Code\-Label ()\hspace{0.3cm}{\tt  [static]}}\label{classKABC_1_1Address_e5}


Returns the translated label for postal code field. 



Definition at line 225 of file address.cpp.\index{KABC::Address@{KABC::Address}!setCountry@{setCountry}}
\index{setCountry@{setCountry}!KABC::Address@{KABC::Address}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Address::set\-Country (const {\bf QString} \&)}\label{classKABC_1_1Address_a23}


Sets the country. 



Definition at line 231 of file address.cpp.\index{KABC::Address@{KABC::Address}!country@{country}}
\index{country@{country}!KABC::Address@{KABC::Address}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} Address::country () const}\label{classKABC_1_1Address_a24}


Returns the country. 



Definition at line 238 of file address.cpp.\index{KABC::Address@{KABC::Address}!countryLabel@{countryLabel}}
\index{countryLabel@{countryLabel}!KABC::Address@{KABC::Address}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} Address::country\-Label ()\hspace{0.3cm}{\tt  [static]}}\label{classKABC_1_1Address_e6}


Returns the translated label for country field. 



Definition at line 243 of file address.cpp.\index{KABC::Address@{KABC::Address}!setLabel@{setLabel}}
\index{setLabel@{setLabel}!KABC::Address@{KABC::Address}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Address::set\-Label (const {\bf QString} \&)}\label{classKABC_1_1Address_a25}


Sets the delivery label. 

This is the literal text to be used as label. 

Definition at line 249 of file address.cpp.\index{KABC::Address@{KABC::Address}!label@{label}}
\index{label@{label}!KABC::Address@{KABC::Address}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} Address::label () const}\label{classKABC_1_1Address_a26}


Returns the delivery label. 



Definition at line 256 of file address.cpp.

Referenced by type\-Label().\index{KABC::Address@{KABC::Address}!labelLabel@{labelLabel}}
\index{labelLabel@{labelLabel}!KABC::Address@{KABC::Address}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} Address::label\-Label ()\hspace{0.3cm}{\tt  [static]}}\label{classKABC_1_1Address_e7}


Returns the translated label for delivery label field. 



Definition at line 261 of file address.cpp.\index{KABC::Address@{KABC::Address}!typeList@{typeList}}
\index{typeList@{typeList}!KABC::Address@{KABC::Address}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Address::Type\-List} Address::type\-List ()\hspace{0.3cm}{\tt  [static]}}\label{classKABC_1_1Address_e8}


Returns the list of available types. 



Definition at line 266 of file address.cpp.

Referenced by type\-Label().\index{KABC::Address@{KABC::Address}!typeLabel@{typeLabel}}
\index{typeLabel@{typeLabel}!KABC::Address@{KABC::Address}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} Address::type\-Label (int {\em type})\hspace{0.3cm}{\tt  [static]}}\label{classKABC_1_1Address_e9}


Returns the translated label for a special type. 



Definition at line 275 of file address.cpp.\index{KABC::Address@{KABC::Address}!dump@{dump}}
\index{dump@{dump}!KABC::Address@{KABC::Address}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Address::dump () const}\label{classKABC_1_1Address_a27}


Used for debug output. 



Definition at line 305 of file address.cpp.

References extended(), locality(), postal\-Code(), and street().

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