/****************************************************************************
**
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the Qt Mobility Components.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** 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, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef QORGANIZERCOLLECTION_H
#define QORGANIZERCOLLECTION_H

#include <QVariantMap>
#include <QVariant>
#include <QString>
#include <QList>
#include <QSharedDataPointer>

#include "qorganizeritemid.h"
#include "qorganizercollectionid.h"

QTM_BEGIN_NAMESPACE

class QOrganizerManagerEngine;
class QOrganizerCollectionData;
class Q_ORGANIZER_EXPORT QOrganizerCollection
{
public:
    QOrganizerCollection();

    ~QOrganizerCollection();

    QOrganizerCollection(const QOrganizerCollection& other);
    QOrganizerCollection& operator=(const QOrganizerCollection& other);

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

    /* Every collection has an id */
    QOrganizerCollectionId id() const;
    void setId(const QOrganizerCollectionId& id);

    void setMetaData(const QVariantMap& metaData);
    QVariantMap metaData() const;

    void setMetaData(const QString& key, const QVariant& value);
    QVariant metaData(const QString& key) const;

    /* Default meta data keys */
#ifdef Q_QDOC
    static const QLatin1Constant KeyName;
    static const QLatin1Constant KeyDescription;
    static const QLatin1Constant KeyColor;
    static const QLatin1Constant KeyImage;
#else
    Q_DECLARE_LATIN1_CONSTANT(KeyName, "Name");
    Q_DECLARE_LATIN1_CONSTANT(KeyDescription, "Description");
    Q_DECLARE_LATIN1_CONSTANT(KeyColor, "Color");
    Q_DECLARE_LATIN1_CONSTANT(KeyImage, "Image");
#endif


private:
    friend class QOrganizerManagerEngine;
    QSharedDataPointer<QOrganizerCollectionData> d;
};

Q_ORGANIZER_EXPORT uint qHash(const QOrganizerCollection& key);
#ifndef QT_NO_DEBUG_STREAM
Q_ORGANIZER_EXPORT QDebug operator<<(QDebug dbg, const QOrganizerCollection& collection);
#endif

#ifndef QT_NO_DATASTREAM
Q_ORGANIZER_EXPORT QDataStream& operator<<(QDataStream& out, const QOrganizerCollection& collection);
Q_ORGANIZER_EXPORT QDataStream& operator>>(QDataStream& in, QOrganizerCollection& collection);
#endif

QTM_END_NAMESPACE

Q_DECLARE_TYPEINFO(QTM_PREPEND_NAMESPACE(QOrganizerCollection), Q_MOVABLE_TYPE);

#endif

