address.h

/*
    This file is part of the KContacts framework.
    Copyright (c) 2001 Cornelius Schumacher <[email protected]>

    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 KCONTACTS_ADDRESS_H
#define KCONTACTS_ADDRESS_H

#include "kcontacts_export.h"
#include "geo.h"

#include <QMetaType>
#include <QSharedDataPointer>
#include <QString>
#include <QVector>

namespace KContacts {
class Geo;
class KCONTACTS_EXPORT Address
{
    friend KCONTACTS_EXPORT QDataStream &operator<<(QDataStream &s, const Address &addr);
    friend KCONTACTS_EXPORT QDataStream &operator>>(QDataStream &s, Address &addr);

    Q_GADGET
    Q_PROPERTY(QString id READ id WRITE setId)
    Q_PROPERTY(bool isEmpty READ isEmpty)
    Q_PROPERTY(Type type READ type WRITE setType)
    Q_PROPERTY(QString typeLabel READ typeLabel)
    Q_PROPERTY(QString postOfficeBox READ postOfficeBox WRITE setPostOfficeBox)
    Q_PROPERTY(QString extended READ extended WRITE setExtended)
    Q_PROPERTY(QString street READ street WRITE setStreet)
    Q_PROPERTY(QString locality READ locality WRITE setLocality)
    Q_PROPERTY(QString region READ region WRITE setRegion)
    Q_PROPERTY(QString postalCode READ postalCode WRITE setPostalCode)
    Q_PROPERTY(QString country READ country WRITE setCountry)
    Q_PROPERTY(QString label READ label WRITE setLabel)
    Q_PROPERTY(KContacts::Geo geo READ geo WRITE setGeo)
    Q_PROPERTY(QString formattedAddress READ formattedAddress)

public:
    typedef QVector<Address> List;

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

    Q_DECLARE_FLAGS(Type, TypeFlag)
    Q_FLAG(Type)

    typedef QList<TypeFlag> TypeList;

    Address();

    Address(Type type);

    Address(const Address &address);

    ~Address();

    Q_REQUIRED_RESULT bool operator==(const Address &other) const;

    Q_REQUIRED_RESULT bool operator!=(const Address &other) const;

    Address &operator=(const Address &other);

    Q_REQUIRED_RESULT bool isEmpty() const;

    void clear();

    void setId(const QString &identifier);

    Q_REQUIRED_RESULT QString id() const;

    void setType(Type type);

    Q_REQUIRED_RESULT Type type() const;

    Q_REQUIRED_RESULT QString typeLabel() const;

    void setPostOfficeBox(const QString &postOfficeBox);

    Q_REQUIRED_RESULT QString postOfficeBox() const;

    static QString postOfficeBoxLabel();

    void setExtended(const QString &extended);

    Q_REQUIRED_RESULT QString extended() const;

    static QString extendedLabel();

    void setStreet(const QString &street);

    Q_REQUIRED_RESULT QString street() const;

    static QString streetLabel();

    void setLocality(const QString &locality);

    Q_REQUIRED_RESULT QString locality() const;

    static QString localityLabel();

    void setRegion(const QString &region);

    Q_REQUIRED_RESULT QString region() const;

    static QString regionLabel();

    void setPostalCode(const QString &code);

    Q_REQUIRED_RESULT QString postalCode() const;

    static QString postalCodeLabel();

    void setCountry(const QString &country);

    Q_REQUIRED_RESULT QString country() const;

    static QString countryLabel();

    void setLabel(const QString &label);

    Q_REQUIRED_RESULT QString label() const;

    static QString labelLabel();

    static TypeList typeList();

    static QString typeLabel(Type type);

    Q_REQUIRED_RESULT QString toString() const;

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

    static QString countryToISO(const QString &cname);

    static QString ISOtoCountry(const QString &ISOname);

    static QString typeFlagLabel(TypeFlag type);

    void setGeo(const Geo &geo);

    Q_REQUIRED_RESULT Geo geo() const;

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

Q_DECLARE_OPERATORS_FOR_FLAGS(Address::Type)

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

KCONTACTS_EXPORT QDataStream &operator>>(QDataStream &stream, Address &address);
}

Q_DECLARE_METATYPE(KContacts::Address)

#endif