phonenumber.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_PHONENUMBER_H
#define KABC_PHONENUMBER_H

#include "kabc_export.h"

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

namespace KABC {

class KABC_EXPORT PhoneNumber
{
    friend KABC_EXPORT QDataStream &operator<<( QDataStream &, const PhoneNumber & );
    friend KABC_EXPORT QDataStream &operator>>( QDataStream &, PhoneNumber & );

  public:
    enum TypeFlag {
      Home = 1,     
      Work = 2,     
      Msg = 4,      
      Pref = 8,     
      Voice = 16,   
      Fax = 32,     
      Cell = 64,    
      Video = 128,  
      Bbs = 256,    
      Modem = 512,  
      Car = 1024,   
      Isdn = 2048,  
      Pcs = 4096,   
      Pager = 8192  
    };

    Q_DECLARE_FLAGS( Type, TypeFlag )

    
    typedef QList<TypeFlag> TypeList;

    typedef QList<PhoneNumber> List;

    PhoneNumber();

    PhoneNumber( const QString &number, Type type = Home ); //krazy:exclude=explicit

    PhoneNumber( const PhoneNumber &other );

    ~PhoneNumber();

    bool operator==( const PhoneNumber & ) const;

    bool operator!=( const PhoneNumber & ) const;

    PhoneNumber &operator=( const PhoneNumber &other );

    bool isEmpty() const;

    void setId( const QString &identifier );

    QString id() const;

    void setNumber( const QString &number );

    QString number() const;

    void setType( Type type );

    Type type() const;

    QString typeLabel() const;

    static TypeList typeList();

    static QString typeLabel( Type type );

    static QString typeFlagLabel( TypeFlag type );

    QString toString() const;

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

Q_DECLARE_OPERATORS_FOR_FLAGS( PhoneNumber::Type )

KABC_EXPORT QDataStream &operator<<( QDataStream &stream, const PhoneNumber &number );

KABC_EXPORT QDataStream &operator>>( QDataStream &stream, const PhoneNumber &number );

}

#endif