/****************************************************************************

**

** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).

** All rights reserved.

** Contact: Nokia Corporation (qt-info@nokia.com)

**

** This file is part of the Qt Mobility Components.

**

** $QT_BEGIN_LICENSE:LGPL$

** No Commercial Usage

** This file contains pre-release code and may not be distributed.

** You may use this file in accordance with the terms and conditions

** contained in the Technology Preview License Agreement accompanying

** this package.

**

** GNU Lesser General Public License Usage

** Alternatively, this file may be used under the terms of the GNU Lesser

** General Public License version 2.1 as published by the Free Software

** Foundation and appearing in the file LICENSE.LGPL included in the

** packaging of this file.  Please review the following information to

** ensure the GNU Lesser General Public License version 2.1 requirements

** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

**

** In addition, as a special exception, Nokia gives you certain additional

** rights.  These rights are described in the Nokia Qt LGPL Exception

** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

**

** If you have questions regarding the use of this file, please contact

** Nokia at qt-info@nokia.com.

**

**

**

**

**

**

**

**

** $QT_END_LICENSE$

**

****************************************************************************/

#ifndef QCONTACTDETAIL_H

#define QCONTACTDETAIL_H

#include "qtcontactsglobal.h"

#include "qcontactactiondescriptor.h"

#include <QSharedDataPointer>

#include <QStringList>

#include <QVariant>

QTM_BEGIN_NAMESPACE

class QContactDetailPrivate;

class Q_CONTACTS_EXPORT QContactDetail

{

public:

    QContactDetail();

    explicit QContactDetail(const char* definitionName); // possibly internal

    explicit QContactDetail(const QString& definitionName);

    ~QContactDetail();

    QContactDetail(const QContactDetail& other);

    QContactDetail& operator=(const QContactDetail& other);

    enum AccessConstraint {

        NoConstraint = 0,

        ReadOnly = 0x01,

        Irremovable = 0x02

    };

    Q_DECLARE_FLAGS(AccessConstraints, AccessConstraint)

    AccessConstraints accessConstraints() const;

    // Predefined attribute names and values

#ifdef Q_QDOC

    static const QLatin1Constant FieldContext;

    static const QLatin1Constant ContextHome;

    static const QLatin1Constant ContextWork;

    static const QLatin1Constant ContextOther;

    static const QLatin1Constant FieldDetailUri;

    static const QLatin1Constant FieldLinkedDetailUris;

#else

    Q_DECLARE_LATIN1_CONSTANT(FieldContext, "Context");

    Q_DECLARE_LATIN1_CONSTANT(ContextHome, "Home");

    Q_DECLARE_LATIN1_CONSTANT(ContextWork, "Work");

    Q_DECLARE_LATIN1_CONSTANT(ContextOther, "Other");

    Q_DECLARE_LATIN1_CONSTANT(FieldDetailUri, "DetailUri");

    Q_DECLARE_LATIN1_CONSTANT(FieldLinkedDetailUris, "LinkedDetailUris");

#endif

    bool operator==(const QContactDetail& other) const;

    bool operator!=(const QContactDetail& other) const {return !(other == *this);}

    QString definitionName() const;

    bool isEmpty() const;

    int key() const;

    void resetKey();

    QString value(const QString& key) const;

    bool setValue(const QString& key, const QVariant& value);

    bool removeValue(const QString& key);

    bool hasValue(const QString& key) const;

    QVariantMap variantValues() const;

    QVariant variantValue(const QString& key) const;

    template <typename T> T value(const QString& key) const

    {

        return variantValue(key).value<T>();

    }

    /* These are probably internal */

    QString value(const char* key) const;

    bool setValue(const char* key, const QVariant& value);

    bool removeValue(const char* key);

    bool hasValue(const char* key) const;

    QVariant variantValue(const char *key) const;

    template<typename T> T value(const char *key) const

    {

        return variantValue(key).value<T>();

    }

#ifdef Q_QDOC

    QString value(const QLatin1Constant& key) const;

    bool setValue(const QLatin1Constant& key, const QVariant& value);

    bool removeValue(const QLatin1Constant& key);

    bool hasValue(const QLatin1Constant& key) const;

    QVariant variantValue(const QLatin1Constant& key) const;

    T value(const QLatin1Constant& key) const;

#else

    template<int N> QString value(const QLatin1Constant<N>& key) const

    {

        return value(key.latin1());

    }

    template<int N> bool setValue(const QLatin1Constant<N>& key, const QVariant& value)

    {

        return setValue(key.latin1(), value);

    }

    template<int N> bool removeValue(const QLatin1Constant<N>& key)

    {

        return removeValue(key.latin1());

    }

    template<int N> bool hasValue(const QLatin1Constant<N>& key) const

    {

        return hasValue(key.latin1());

    }

    template<int N> QVariant variantValue(const QLatin1Constant<N>& key) const

    {

        return variantValue(key.latin1());

    }

    template<typename T, int N> T value(const QLatin1Constant<N>& key) const

    {

        return value<T>(key.latin1());

    }

#endif

    void setContexts(const QStringList& contexts)

    {

        setValue(FieldContext, contexts);

    }

    void setContexts(const QString& context)

    {

        setValue(FieldContext, QStringList(context));

    }

    QStringList contexts() const

    {

        return value<QStringList>(FieldContext);

    }

    void setDetailUri(const QString& detailUri)

    {

        setValue(FieldDetailUri, detailUri);

    }

    QString detailUri() const

    {

        return value(FieldDetailUri);

    }

    void setLinkedDetailUris(const QStringList& linkedDetailUris)

    {

        setValue(FieldLinkedDetailUris, linkedDetailUris);

    }

    void setLinkedDetailUris(const QString& linkedDetailUri)

    {

        setValue(FieldLinkedDetailUris, QStringList(linkedDetailUri));

    }

    QStringList linkedDetailUris() const

    {

        return value<QStringList>(FieldLinkedDetailUris);

    }

protected:

    QContactDetail(const QContactDetail &other, const QString& expectedDefinitionId);

    QContactDetail& assign(const QContactDetail &other, const QString& expectedDefinitionId);

    QContactDetail(const QContactDetail &other, const char* expectedDefinitionId);

    QContactDetail& assign(const QContactDetail &other, const char* expectedDefinitionId);

private:

    friend class QContact;

    friend class QContactDetailPrivate;

    QSharedDataPointer<QContactDetailPrivate> d;

};

Q_CONTACTS_EXPORT uint qHash(const QContactDetail& key);

#ifndef QT_NO_DEBUG_STREAM

Q_CONTACTS_EXPORT QDebug operator<<(QDebug dbg, const QContactDetail& detail);

#endif

Q_DECLARE_OPERATORS_FOR_FLAGS(QContactDetail::AccessConstraints);

#define Q_DECLARE_CUSTOM_CONTACT_DETAIL(className, definitionNameString) \

    className() : QContactDetail(DefinitionName.latin1()) {} \

    className(const QContactDetail& field) : QContactDetail(field, DefinitionName.latin1()) {} \

    className& operator=(const QContactDetail& other) {assign(other, DefinitionName.latin1()); return *this;} \

    \

    Q_DECLARE_LATIN1_CONSTANT(DefinitionName, definitionNameString);

#define Q_IMPLEMENT_CUSTOM_CONTACT_DETAIL(className, definitionNameString) \

    Q_DEFINE_LATIN1_CONSTANT(className::DefinitionName, definitionNameString)

QTM_END_NAMESPACE

Q_DECLARE_TYPEINFO(QTM_PREPEND_NAMESPACE(QContactDetail), Q_MOVABLE_TYPE);

#endif