Main Page   Modules   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   Related Pages  

KABC::Address Class Reference

Postal address information. More...

#include <address.h>

List of all members.

Public Types

typedef QValueList< Address > List
enum  Type

Public Methods

 Address ()
 Address (int)
bool isEmpty () const
void clear ()
void setId (const QString &)
void setType (int type)
int type () const
QString typeLabel () const
void setPostOfficeBox (const QString &)
QString postOfficeBox () const
void setExtended (const QString &)
QString extended () const
void setStreet (const QString &)
QString street () const
void setLocality (const QString &)
QString locality () const
void setRegion (const QString &)
QString region () const
void setPostalCode (const QString &)
QString postalCode () const
void setCountry (const QString &)
QString country () const
void setLabel (const QString &)
QString label () const
void dump () const

Static Public Methods

QString postOfficeBoxLabel ()
QString extendedLabel ()
QString streetLabel ()
QString localityLabel ()
QString regionLabel ()
QString postalCodeLabel ()
QString countryLabel ()
QString labelLabel ()
TypeList typeList ()
QString typeLabel (int type)


Detailed Description

Postal address information.

This class represents information about a postal address.

Definition at line 34 of file address.h.


Member Typedef Documentation

typedef QValueList<Address> KABC::Address::List
 

List of addresses.

Definition at line 43 of file address.h.


Member Enumeration Documentation

enum KABC::Address::Type
 

Address types:

  • Dom - domestic
  • Intl - international
  • Postal - postal
  • Parcel - parcel
  • Home - home address
  • Work - address at work
  • Pref - preferred address

Definition at line 57 of file address.h.


Constructor & Destructor Documentation

KABC::Address::Address  
 

Constructor that creates an empty Address, which is initialized with a unique id (see id()).

KABC::Address::Address int   
 

This is like Address() just above, with the difference that you can specify the type.


Member Function Documentation

void KABC::Address::clear  
 

Clears all entries of the address.

QString KABC::Address::country  
 

Returns the country.

QString KABC::Address::countryLabel   [static]
 

Returns the translated label for country field.

void KABC::Address::dump  
 

Used for debug output.

QString KABC::Address::extended  
 

Returns the extended address information.

QString KABC::Address::extendedLabel   [static]
 

Returns the translated label for extended field.

bool KABC::Address::isEmpty  
 

Returns true, if the address is empty.

QString KABC::Address::label  
 

Returns the delivery label.

QString KABC::Address::labelLabel   [static]
 

Returns the translated label for delivery label field.

QString KABC::Address::locality  
 

Returns the locality.

QString KABC::Address::localityLabel   [static]
 

Returns the translated label for locality field.

QString KABC::Address::postalCode  
 

Returns the postal code.

QString KABC::Address::postalCodeLabel   [static]
 

Returns the translated label for postal code field.

QString KABC::Address::postOfficeBox  
 

Returns the post office box.

QString KABC::Address::postOfficeBoxLabel   [static]
 

Returns the translated label for post office box field.

QString KABC::Address::region  
 

Returns the region.

QString KABC::Address::regionLabel   [static]
 

Returns the translated label for region field.

void KABC::Address::setCountry const QString &   
 

Sets the country.

void KABC::Address::setExtended const QString &   
 

Sets the extended address information.

void KABC::Address::setId const QString &   
 

Sets the unique id.

void KABC::Address::setLabel const QString &   
 

Sets the delivery label. This is the literal text to be used as label.

void KABC::Address::setLocality const QString &   
 

Sets the locality, e.g. city.

void KABC::Address::setPostalCode const QString &   
 

Sets the postal code.

void KABC::Address::setPostOfficeBox const QString &   
 

Sets the post office box.

void KABC::Address::setRegion const QString &   
 

Sets the region, e.g. state.

void KABC::Address::setStreet const QString &   
 

Sets the street (including number).

void KABC::Address::setType int    type
 

Sets the type of address. See enum for definiton of types.

Parameters:
type  type, can be a bitwise or of multiple types.

QString KABC::Address::street  
 

Returns the street.

QString KABC::Address::streetLabel   [static]
 

Returns the translated label for street field.

int KABC::Address::type  
 

Returns the type of address. Can be a bitwise or of multiple types.

QString KABC::Address::typeLabel int    type [static]
 

Returns the translated label for a special type.

QString KABC::Address::typeLabel  
 

Returns a translated string of all types the address has.

TypeList KABC::Address::typeList   [static]
 

Returns the list of available types.


The documentation for this class was generated from the following file:
Generated on Wed Aug 13 23:30:30 2003 for kdelibs by doxygen1.2.18