.TH "KABC::PhoneNumber" kde3 "11 Jun 2005" "Version Version 3.4.1" "kabc Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KABC::PhoneNumber \- Phonenumber information.  

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

.in +1c
.ti -1c
.RI "typedef \fBQValueList\fP< \fBPhoneNumber\fP > \fBList\fP"
.br
.ti -1c
.RI "typedef \fBQValueList\fP< int > \fBTypeList\fP"
.br
.ti -1c
.RI "enum \fBTypes\fP { \fBHome\fP =  1, \fBWork\fP =  2, \fBMsg\fP =  4, \fBPref\fP =  8, \fBVoice\fP =  16, \fBFax\fP =  32, \fBCell\fP =  64, \fBVideo\fP =  128, \fBBbs\fP =  256, \fBModem\fP =  512, \fBCar\fP =  1024, \fBIsdn\fP =  2048, \fBPcs\fP =  4096, \fBPager\fP =  8192 }"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBPhoneNumber\fP ()"
.br
.ti -1c
.RI "\fBPhoneNumber\fP (const \fBQString\fP &number, int type=Home)"
.br
.ti -1c
.RI "\fB~PhoneNumber\fP ()"
.br
.ti -1c
.RI "bool \fBoperator==\fP (const \fBPhoneNumber\fP &) const "
.br
.ti -1c
.RI "bool \fBoperator!=\fP (const \fBPhoneNumber\fP &) const "
.br
.ti -1c
.RI "void \fBsetId\fP (const \fBQString\fP &id)"
.br
.ti -1c
.RI "\fBQString\fP \fBid\fP () const "
.br
.ti -1c
.RI "void \fBsetNumber\fP (const \fBQString\fP &)"
.br
.ti -1c
.RI "\fBQString\fP \fBnumber\fP () const "
.br
.ti -1c
.RI "void \fBsetType\fP (int)"
.br
.ti -1c
.RI "int \fBtype\fP () const "
.br
.ti -1c
.RI "\fBQString\fP \fBtypeLabel\fP () const "
.br
.ti -1c
.RI "\fBQString\fP \fBlabel\fP () const "
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "static \fBTypeList\fP \fBtypeList\fP ()"
.br
.ti -1c
.RI "static \fBQString\fP \fBtypeLabel\fP (int type)"
.br
.ti -1c
.RI "static \fBQString\fP \fBlabel\fP (int type)"
.br
.in -1c
.SS "Friends"

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

This class provides phone number information. A phone number is classified by a type. The following types are available, it's possible to use multiple types Types for a number by combining them through a logical or. 
.PP
Definition at line 38 of file phonenumber.h.
.SH "Member Enumeration Documentation"
.PP 
.SS "enum \fBKABC::PhoneNumber::Types\fP"
.PP
.PD 0
.IP "\(bu" 2
\fCHome\fP - Home number 
.IP "\(bu" 2
\fCWork\fP - Office number 
.IP "\(bu" 2
\fCMsg\fP - Messaging 
.IP "\(bu" 2
\fCPref\fP - Preferred number 
.IP "\(bu" 2
\fCVoice\fP - Voice 
.IP "\(bu" 2
\fCFax\fP - Fax machine 
.IP "\(bu" 2
\fCCell\fP - Cell phone 
.IP "\(bu" 2
\fCVideo\fP - Video phone 
.IP "\(bu" 2
\fCBbs\fP - Mailbox 
.IP "\(bu" 2
\fCModem\fP - Modem 
.IP "\(bu" 2
\fCCar\fP - Car phone 
.IP "\(bu" 2
\fCIsdn\fP - ISDN connection 
.IP "\(bu" 2
\fCPcs\fP - Personal Communication Service 
.IP "\(bu" 2
\fCPager\fP - Pager 
.PP

.PP
Definition at line 63 of file phonenumber.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "PhoneNumber::PhoneNumber ()"
.PP
Create an empty phone number object. 
.PP
Definition at line 28 of file phonenumber.cpp.
.SS "PhoneNumber::PhoneNumber (const \fBQString\fP & number, int type = \fCHome\fP)"
.PP
Create a phonenumber object. 
.PP
\fBParameters:\fP
.RS 4
\fInumber\fP Number 
.br
\fItype\fP Type as defined in enum. Multiple types can be specified by combining them by a logical or. 
.RE
.PP

.PP
Definition at line 34 of file phonenumber.cpp.
.PP
References number().
.SS "PhoneNumber::~\fBPhoneNumber\fP ()"
.PP
Destructor. 
.PP
Definition at line 42 of file phonenumber.cpp.
.SH "Member Function Documentation"
.PP 
.SS "void PhoneNumber::setId (const \fBQString\fP & id)"
.PP
Sets the unique identifier. 
.PP
Definition at line 73 of file phonenumber.cpp.
.PP
References id().
.SS "\fBQString\fP PhoneNumber::id () const"
.PP
Returns the unique identifier. 
.PP
Definition at line 78 of file phonenumber.cpp.
.PP
Referenced by setId().
.SS "void PhoneNumber::setNumber (const \fBQString\fP &)"
.PP
Sets the number. 
.PP
Definition at line 83 of file phonenumber.cpp.
.PP
References number().
.SS "\fBQString\fP PhoneNumber::number () const"
.PP
Returns the number. 
.PP
Definition at line 88 of file phonenumber.cpp.
.PP
Referenced by PhoneNumber(), and setNumber().
.SS "void PhoneNumber::setType (int)"
.PP
Sets the type. 
.PP
Multiple types can be specified by combining them by a logical or. 
.PP
Definition at line 93 of file phonenumber.cpp.
.SS "int PhoneNumber::type () const"
.PP
Returns the type. 
.PP
Can be a multiple types combined by a logical or. 
.PP
Definition at line 98 of file phonenumber.cpp.
.PP
Referenced by label(), and typeLabel().
.SS "\fBQString\fP PhoneNumber::typeLabel () const"
.PP
Returns a translated string of all types the address has. 
.PP
Definition at line 103 of file phonenumber.cpp.
.PP
References QString::append(), QValueList::begin(), QValueList::end(), label(), type(), and typeList().
.PP
Referenced by label().
.SS "\fBQString\fP PhoneNumber::label () const"
.PP
Returns the translated label for phone number depending on its type. 
.PP
Definition at line 122 of file phonenumber.cpp.
.PP
References type(), and typeLabel().
.PP
Referenced by typeLabel().
.SS "\fBPhoneNumber::TypeList\fP PhoneNumber::typeList ()\fC [static]\fP"
.PP
Returns a list of all available types. 
.PP
Definition at line 127 of file phonenumber.cpp.
.PP
References QValueList::isEmpty().
.PP
Referenced by typeLabel().
.SS "\fBQString\fP PhoneNumber::typeLabel (int type)\fC [static]\fP"
.PP
Returns the translated label for phone number type. 
.PP
Definition at line 144 of file phonenumber.cpp.
.SS "\fBQString\fP PhoneNumber::label (int type)\fC [static]\fP"
.PP
Returns the translated label for phone number type. 
.PP
\fBDeprecated\fP
.RS 4
.RE
.PP

.PP
Definition at line 139 of file phonenumber.cpp.
.PP
References typeLabel().

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