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

#include "kcontacts_export.h"

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

namespace KContacts {
class KCONTACTS_EXPORT PhoneNumber
{
    friend KCONTACTS_EXPORT QDataStream &operator<<(QDataStream &, const PhoneNumber &);
    friend KCONTACTS_EXPORT QDataStream &operator>>(QDataStream &, PhoneNumber &);

    Q_GADGET
    Q_PROPERTY(QString id READ id WRITE setId)
    Q_PROPERTY(QString number READ number WRITE setNumber)
    Q_PROPERTY(QString normalizedNumber READ normalizedNumber)
    Q_PROPERTY(Type type READ type WRITE setType)
    Q_PROPERTY(QString typeLabel READ typeLabel)
    Q_PROPERTY(bool isEmpty READ isEmpty)
    Q_PROPERTY(bool isPreferred READ isPreferred)
    Q_PROPERTY(bool supportsSms READ supportsSms)

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,  
        //TODO add Text and textphone support vcard4
        Undefined = 16384 
    };

    Q_DECLARE_FLAGS(Type, TypeFlag)
    Q_FLAG(Type)

    typedef QVector<TypeFlag> TypeList;

    typedef QVector<PhoneNumber> List;

    PhoneNumber();

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

    PhoneNumber(const PhoneNumber &other);

    ~PhoneNumber();

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

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

    PhoneNumber &operator=(const PhoneNumber &other);

    Q_REQUIRED_RESULT bool isEmpty() const;

    void setId(const QString &identifier);

    Q_REQUIRED_RESULT QString id() const;

    void setNumber(const QString &number);

    Q_REQUIRED_RESULT QString number() const;

    Q_REQUIRED_RESULT QString normalizedNumber() const;

    void setType(Type type);

    Q_REQUIRED_RESULT Type type() const;

    Q_REQUIRED_RESULT QString typeLabel() const;

    Q_REQUIRED_RESULT static TypeList typeList();

    Q_REQUIRED_RESULT bool isPreferred() const;
    Q_REQUIRED_RESULT bool supportsSms() const;

    static QString typeLabel(Type type);

    Q_REQUIRED_RESULT static QString typeFlagLabel(TypeFlag type);

    QString toString() const;

    void setParameters(const QMap<QString, QStringList> &params);
    Q_REQUIRED_RESULT QMap<QString, QStringList> parameters() const;

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

Q_DECLARE_OPERATORS_FOR_FLAGS(PhoneNumber::Type)

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

KCONTACTS_EXPORT QDataStream &operator>>(QDataStream &stream, PhoneNumber &number);
}
Q_DECLARE_METATYPE(KContacts::PhoneNumber)
Q_DECLARE_TYPEINFO(KContacts::PhoneNumber, Q_MOVABLE_TYPE);
#endif