address.h

/*
    This file is part of libkabc.
    Copyright (c) 2001 Cornelius Schumacher <schumacher@kde.org>

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/

#ifndef KABC_ADDRESS_H
#define KABC_ADDRESS_H

#include <QtCore/QSharedDataPointer>
#include <QtCore/QString>

#include "kabc_export.h"

namespace KABC {

class KABC_EXPORT Address
{
    friend KABC_EXPORT QDataStream &operator<<( QDataStream &s, const Address &addr );
    friend KABC_EXPORT QDataStream &operator>>( QDataStream &s, Address &addr );

  public:
    typedef QList<Address> List;

    enum TypeFlag {
      Dom = 1,     
      Intl = 2,    
      Postal = 4,  
      Parcel = 8,  
      Home = 16,   
      Work = 32,   
      Pref = 64    
    };

    Q_DECLARE_FLAGS( Type, TypeFlag )

    
    typedef QList<TypeFlag> TypeList;

    Address();

    Address( Type type );

    Address( const Address &address );

    ~Address();

    bool operator==( const Address &addr ) const;

    bool operator!=( const Address &addr ) const;

    Address &operator=( const Address &addr );

    bool isEmpty() const;

    void clear();

    void setId( const QString &identifier );

    QString id() const;

    void setType( Type type );

    Type type() const;

    QString typeLabel() const;

    void setPostOfficeBox( const QString &postOfficeBox );

    QString postOfficeBox() const;

    static QString postOfficeBoxLabel();

    void setExtended( const QString &extended );

    QString extended() const;

    static QString extendedLabel();

    void setStreet( const QString &street );

    QString street() const;

    static QString streetLabel();

    void setLocality( const QString &locality );

    QString locality() const;

    static QString localityLabel();

    void setRegion( const QString &region );

    QString region() const;

    static QString regionLabel();

    void setPostalCode( const QString &code );

    QString postalCode() const;

    static QString postalCodeLabel();

    void setCountry( const QString &country );

    QString country() const;

    static QString countryLabel();

    void setLabel( const QString &label );

    QString label() const;

    static QString labelLabel();

    static TypeList typeList();

    static QString typeLabel( Type type );

    QString toString() const;

    QString formattedAddress( const QString &realName = QString(),
                              const QString &orgaName = QString() ) const;

    static QString countryToISO( const QString &cname );

    static QString ISOtoCountry( const QString &ISOname );

  private:
    class Private;
    QSharedDataPointer<Private> d;
};

Q_DECLARE_OPERATORS_FOR_FLAGS( Address::Type )

KABC_EXPORT QDataStream &operator<<( QDataStream &stream, const Address &address );

KABC_EXPORT QDataStream &operator>>( QDataStream &stream, Address &address );

}

#endif