.TH "KABC::Address" 3 "28 Jan 2004" "kabc Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KABC::Address \- Postal address information.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <address.h>\fP
.PP
.SS "Public Types"

.in +1c
.ti -1c
.RI "typedef \fBQValueList\fP< \fBAddress\fP > \fBList\fP"
.br
.RI "\fIList of addresses. \fP"
.ti -1c
.RI "typedef \fBQValueList\fP< int > \fBTypeList\fP"
.br
.ti -1c
.RI "enum \fBType\fP { \fBDom\fP =  1, \fBIntl\fP =  2, \fBPostal\fP =  4, \fBParcel\fP =  8, \fBHome\fP =  16, \fBWork\fP =  32, \fBPref\fP =  64 }"
.br
.RI "\fI\fBAddress\fP types:. \fP"
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBAddress\fP ()"
.br
.RI "\fIConstructor that creates an empty \fBAddress\fP, which is initialized with a unique id (see \fBid\fP()). \fP"
.ti -1c
.RI "\fBAddress\fP (int)"
.br
.RI "\fIThis is like \fBAddress\fP() just above, with the difference that you can specify the type. \fP"
.ti -1c
.RI "bool \fBoperator==\fP (const  \fBAddress\fP &) const "
.br
.ti -1c
.RI "bool \fBoperator!=\fP (const  \fBAddress\fP &) const "
.br
.ti -1c
.RI "bool \fBisEmpty\fP () const "
.br
.RI "\fIReturns true, if the address is empty. \fP"
.ti -1c
.RI "void \fBclear\fP ()"
.br
.RI "\fIClears all entries of the address. \fP"
.ti -1c
.RI "void \fBsetId\fP (const  \fBQString\fP &)"
.br
.RI "\fISets the unique id. \fP"
.ti -1c
.RI "\fBQString\fP \fBid\fP () const "
.br
.ti -1c
.RI "void \fBsetType\fP (int type)"
.br
.RI "\fISets the type of address. \fP"
.ti -1c
.RI "int \fBtype\fP () const "
.br
.RI "\fIReturns the type of address. \fP"
.ti -1c
.RI "\fBQString\fP \fBtypeLabel\fP () const "
.br
.RI "\fIReturns a translated string of all types the address has. \fP"
.ti -1c
.RI "void \fBsetPostOfficeBox\fP (const  \fBQString\fP &)"
.br
.RI "\fISets the post office box. \fP"
.ti -1c
.RI "\fBQString\fP \fBpostOfficeBox\fP () const "
.br
.RI "\fIReturns the post office box. \fP"
.ti -1c
.RI "void \fBsetExtended\fP (const  \fBQString\fP &)"
.br
.RI "\fISets the extended address information. \fP"
.ti -1c
.RI "\fBQString\fP \fBextended\fP () const "
.br
.RI "\fIReturns the extended address information. \fP"
.ti -1c
.RI "void \fBsetStreet\fP (const  \fBQString\fP &)"
.br
.RI "\fISets the street (including number). \fP"
.ti -1c
.RI "\fBQString\fP \fBstreet\fP () const "
.br
.RI "\fIReturns the street. \fP"
.ti -1c
.RI "void \fBsetLocality\fP (const  \fBQString\fP &)"
.br
.RI "\fISets the locality, e.g. \fP"
.ti -1c
.RI "\fBQString\fP \fBlocality\fP () const "
.br
.RI "\fIReturns the locality. \fP"
.ti -1c
.RI "void \fBsetRegion\fP (const  \fBQString\fP &)"
.br
.RI "\fISets the region, e.g. \fP"
.ti -1c
.RI "\fBQString\fP \fBregion\fP () const "
.br
.RI "\fIReturns the region. \fP"
.ti -1c
.RI "void \fBsetPostalCode\fP (const  \fBQString\fP &)"
.br
.RI "\fISets the postal code. \fP"
.ti -1c
.RI "\fBQString\fP \fBpostalCode\fP () const "
.br
.RI "\fIReturns the postal code. \fP"
.ti -1c
.RI "void \fBsetCountry\fP (const  \fBQString\fP &)"
.br
.RI "\fISets the country. \fP"
.ti -1c
.RI "\fBQString\fP \fBcountry\fP () const "
.br
.RI "\fIReturns the country. \fP"
.ti -1c
.RI "void \fBsetLabel\fP (const  \fBQString\fP &)"
.br
.RI "\fISets the delivery label. \fP"
.ti -1c
.RI "\fBQString\fP \fBlabel\fP () const "
.br
.RI "\fIReturns the delivery label. \fP"
.ti -1c
.RI "void \fBdump\fP () const "
.br
.RI "\fIUsed for debug output. \fP"
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "\fBQString\fP \fBpostOfficeBoxLabel\fP ()"
.br
.RI "\fIReturns the translated label for post office box field. \fP"
.ti -1c
.RI "\fBQString\fP \fBextendedLabel\fP ()"
.br
.RI "\fIReturns the translated label for extended field. \fP"
.ti -1c
.RI "\fBQString\fP \fBstreetLabel\fP ()"
.br
.RI "\fIReturns the translated label for street field. \fP"
.ti -1c
.RI "\fBQString\fP \fBlocalityLabel\fP ()"
.br
.RI "\fIReturns the translated label for locality field. \fP"
.ti -1c
.RI "\fBQString\fP \fBregionLabel\fP ()"
.br
.RI "\fIReturns the translated label for region field. \fP"
.ti -1c
.RI "\fBQString\fP \fBpostalCodeLabel\fP ()"
.br
.RI "\fIReturns the translated label for postal code field. \fP"
.ti -1c
.RI "\fBQString\fP \fBcountryLabel\fP ()"
.br
.RI "\fIReturns the translated label for country field. \fP"
.ti -1c
.RI "\fBQString\fP \fBlabelLabel\fP ()"
.br
.RI "\fIReturns the translated label for delivery label field. \fP"
.ti -1c
.RI "\fBTypeList\fP \fBtypeList\fP ()"
.br
.RI "\fIReturns the list of available types. \fP"
.ti -1c
.RI "\fBQString\fP \fBtypeLabel\fP (int type)"
.br
.RI "\fIReturns the translated label for a special type. \fP"
.in -1c
.SS "Friends"

.in +1c
.ti -1c
.RI "\fBQDataStream\fP & \fBoperator<<\fP (\fBQDataStream\fP &, const  \fBAddress\fP &)"
.br
.ti -1c
.RI "\fBQDataStream\fP & \fBoperator>>\fP (\fBQDataStream\fP &, \fBAddress\fP &)"
.br
.in -1c
.SH "Detailed Description"
.PP 
Postal address information. 

This class represents information about a postal address. 
.PP
Definition at line 34 of file address.h.
.SH "Member Typedef Documentation"
.PP 
.SS "typedef \fBQValueList\fP<\fBAddress\fP> \fBKABC::Address::List\fP"
.PP
List of addresses. Definition at line 43 of file address.h.
.SH "Member Enumeration Documentation"
.PP 
.SS "enum \fBKABC::Address::Type\fP"
.PP
\fBAddress\fP types:. .IP "\(bu" 2
\fCDom\fP - domestic 
.IP "\(bu" 2
\fCIntl\fP - international 
.IP "\(bu" 2
\fCPostal\fP - postal 
.IP "\(bu" 2
\fCParcel\fP - parcel 
.IP "\(bu" 2
\fCHome\fP - home address 
.IP "\(bu" 2
\fCWork\fP - address at work 
.IP "\(bu" 2
\fCPref\fP - preferred address 
.PP
Definition at line 57 of file address.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "Address::Address ()"
.PP
Constructor that creates an empty \fBAddress\fP, which is initialized with a unique id (see \fBid\fP()). Definition at line 29 of file address.cpp.
.PP
References KApplication::randomString().
.PP
Referenced by clear().
.SS "Address::Address (int)"
.PP
This is like \fBAddress\fP() just above, with the difference that you can specify the type. Definition at line 35 of file address.cpp.
.PP
References KApplication::randomString().
.SH "Member Function Documentation"
.PP 
.SS "bool Address::isEmpty () const"
.PP
Returns true, if the address is empty. Definition at line 60 of file address.cpp.
.PP
References QString::isEmpty().
.SS "void Address::clear ()"
.PP
Clears all entries of the address. Definition at line 75 of file address.cpp.
.PP
References Address().
.SS "void Address::setId (const \fBQString\fP &)"
.PP
Sets the unique id. Definition at line 80 of file address.cpp.
.SS "void Address::setType (int type)"
.PP
Sets the type of address. See enum for definiton of types.
.PP
\fBParameters:\fP
.RS 4
\fItype\fP type, can be a bitwise or of multiple types. 
.RE
.PP
Definition at line 92 of file address.cpp.
.SS "int Address::type () const"
.PP
Returns the type of address. Can be a bitwise or of multiple types. Definition at line 99 of file address.cpp.
.PP
Referenced by typeLabel().
.SS "\fBQString\fP Address::typeLabel () const"
.PP
Returns a translated string of all types the address has. Definition at line 104 of file address.cpp.
.PP
References QString::append(), QValueList< int >::begin(), QValueList< int >::end(), KStdAccel::label(), label(), type(), and typeList().
.SS "void Address::setPostOfficeBox (const \fBQString\fP &)"
.PP
Sets the post office box. Definition at line 123 of file address.cpp.
.SS "\fBQString\fP Address::postOfficeBox () const"
.PP
Returns the post office box. Definition at line 130 of file address.cpp.
.SS "\fBQString\fP Address::postOfficeBoxLabel ()\fC [static]\fP"
.PP
Returns the translated label for post office box field. Definition at line 135 of file address.cpp.
.SS "void Address::setExtended (const \fBQString\fP &)"
.PP
Sets the extended address information. Definition at line 141 of file address.cpp.
.SS "\fBQString\fP Address::extended () const"
.PP
Returns the extended address information. Definition at line 148 of file address.cpp.
.PP
Referenced by dump().
.SS "\fBQString\fP Address::extendedLabel ()\fC [static]\fP"
.PP
Returns the translated label for extended field. Definition at line 153 of file address.cpp.
.SS "void Address::setStreet (const \fBQString\fP &)"
.PP
Sets the street (including number). Definition at line 159 of file address.cpp.
.SS "\fBQString\fP Address::street () const"
.PP
Returns the street. Definition at line 166 of file address.cpp.
.PP
Referenced by dump().
.SS "\fBQString\fP Address::streetLabel ()\fC [static]\fP"
.PP
Returns the translated label for street field. Definition at line 171 of file address.cpp.
.SS "void Address::setLocality (const \fBQString\fP &)"
.PP
Sets the locality, e.g. city. Definition at line 177 of file address.cpp.
.SS "\fBQString\fP Address::locality () const"
.PP
Returns the locality. Definition at line 184 of file address.cpp.
.PP
Referenced by dump().
.SS "\fBQString\fP Address::localityLabel ()\fC [static]\fP"
.PP
Returns the translated label for locality field. Definition at line 189 of file address.cpp.
.SS "void Address::setRegion (const \fBQString\fP &)"
.PP
Sets the region, e.g. state. Definition at line 195 of file address.cpp.
.SS "\fBQString\fP Address::region () const"
.PP
Returns the region. Definition at line 202 of file address.cpp.
.SS "\fBQString\fP Address::regionLabel ()\fC [static]\fP"
.PP
Returns the translated label for region field. Definition at line 207 of file address.cpp.
.SS "void Address::setPostalCode (const \fBQString\fP &)"
.PP
Sets the postal code. Definition at line 213 of file address.cpp.
.SS "\fBQString\fP Address::postalCode () const"
.PP
Returns the postal code. Definition at line 220 of file address.cpp.
.PP
Referenced by dump().
.SS "\fBQString\fP Address::postalCodeLabel ()\fC [static]\fP"
.PP
Returns the translated label for postal code field. Definition at line 225 of file address.cpp.
.SS "void Address::setCountry (const \fBQString\fP &)"
.PP
Sets the country. Definition at line 231 of file address.cpp.
.SS "\fBQString\fP Address::country () const"
.PP
Returns the country. Definition at line 238 of file address.cpp.
.SS "\fBQString\fP Address::countryLabel ()\fC [static]\fP"
.PP
Returns the translated label for country field. Definition at line 243 of file address.cpp.
.SS "void Address::setLabel (const \fBQString\fP &)"
.PP
Sets the delivery label. This is the literal text to be used as label. Definition at line 249 of file address.cpp.
.SS "\fBQString\fP Address::label () const"
.PP
Returns the delivery label. Definition at line 256 of file address.cpp.
.PP
Referenced by typeLabel().
.SS "\fBQString\fP Address::labelLabel ()\fC [static]\fP"
.PP
Returns the translated label for delivery label field. Definition at line 261 of file address.cpp.
.SS "\fBAddress::TypeList\fP Address::typeList ()\fC [static]\fP"
.PP
Returns the list of available types. Definition at line 266 of file address.cpp.
.PP
Referenced by typeLabel().
.SS "\fBQString\fP Address::typeLabel (int type)\fC [static]\fP"
.PP
Returns the translated label for a special type. Definition at line 275 of file address.cpp.
.SS "void Address::dump () const"
.PP
Used for debug output. Definition at line 305 of file address.cpp.
.PP
References extended(), locality(), postalCode(), and street().

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