address.h

/*
    This file is part of libtdeabc.
    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 <tqmap.h>
#include <tqstring.h>
#include <tqvaluelist.h>
 
#include <tdelibs_export.h>
 
// template tags for address formatting localization
#define KABC_FMTTAG_realname   TQString("%n")
#define KABC_FMTTAG_REALNAME   TQString("%N")
#define KABC_FMTTAG_company    TQString("%cm")
#define KABC_FMTTAG_COMPANY    TQString("%CM")
#define KABC_FMTTAG_pobox      TQString("%p")
#define KABC_FMTTAG_street     TQString("%s")
#define KABC_FMTTAG_STREET     TQString("%S")
#define KABC_FMTTAG_zipcode    TQString("%z")
#define KABC_FMTTAG_location   TQString("%l")
#define KABC_FMTTAG_LOCATION   TQString("%L")
#define KABC_FMTTAG_region     TQString("%r")
#define KABC_FMTTAG_REGION     TQString("%R")
#define KABC_FMTTAG_newline    TQString("\\n")
#define KABC_FMTTAG_condcomma  TQString("%,")
#define KABC_FMTTAG_condwhite  TQString("%w")
#define KABC_FMTTAG_purgeempty TQString("%0")
 
namespace TDEABC {
 
class KABC_EXPORT Address
{
    friend KABC_EXPORT TQDataStream &operator<<( TQDataStream &, const Address & );
    friend KABC_EXPORT TQDataStream &operator>>( TQDataStream &, Address & );
 
  public:
    typedef TQValueList<Address> List;
    typedef TQValueList<int> TypeList;
  
    enum Type { Dom = 1, Intl = 2, Postal = 4, Parcel = 8, Home = 16, Work = 32,
           Pref = 64 };
 
    Address();
  
    Address( int );
 
    bool operator==( const Address & ) const;
    bool operator!=( const Address & ) const;
  
    bool isEmpty() const;
 
    void clear();
 
    void setId( const TQString & );
 
    /*
      Returns the unique id.
    */
    TQString id() const;
 
    void setType( int type );
 
    int type() const;
 
    TQString typeLabel() const;
 
    void setPostOfficeBox( const TQString & );
 
    TQString postOfficeBox() const;
 
    static TQString postOfficeBoxLabel();
 
    void setExtended( const TQString & );
 
    TQString extended() const;
 
    static TQString extendedLabel();
    
    void setStreet( const TQString & );
 
    TQString street() const;
 
    static TQString streetLabel();
 
    void setLocality( const TQString & );
 
    TQString locality() const;
 
    static TQString localityLabel();
 
    void setRegion( const TQString & );
 
    TQString region() const;
 
    static TQString regionLabel();
 
    void setPostalCode( const TQString & );
 
    TQString postalCode() const;
 
    static TQString postalCodeLabel();
 
    void setCountry( const TQString & );
 
    TQString country() const;
 
    static TQString countryLabel();
 
    void setLabel( const TQString & );
 
    TQString label() const;
 
    static TQString labelLabel();
 
    static TypeList typeList();
 
    static TQString typeLabel( int type );
 
    void dump() const;
 
    TQString formattedAddress( const TQString &realName=TQString::null
                            , const TQString &orgaName=TQString::null ) const;
 
    static TQString countryToISO( const TQString &cname );
 
    static TQString ISOtoCountry( const TQString &ISOname );
 
  private:
    bool parseAddressTemplateSection( const TQString &tsection
                                    ,       TQString &result
                                    , const TQString &realName
                                    , const TQString &orgaName ) const;
 
    int  findBalancedBracket( const TQString &tsection, int pos ) const;
 
    bool mEmpty;
  
    TQString mId;
    int mType;
  
    TQString mPostOfficeBox;
    TQString mExtended;
    TQString mStreet;
    TQString mLocality;
    TQString mRegion;
    TQString mPostalCode;
    TQString mCountry;
    TQString mLabel;
 
    static TQMap<TQString, TQString> *mISOMap;
};
 
KABC_EXPORT TQDataStream &operator<<( TQDataStream &, const Address & );
KABC_EXPORT TQDataStream &operator>>( TQDataStream &, Address & );
 
}
 
#endif