/****************************************************************************
**
** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
** Contact: Qt Software Information (qt-info@nokia.com)
**
** This file is part of the QtDeclarative module of the Qt Toolkit.
**
** $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 either Technology Preview License Agreement or the
** Beta Release License Agreement.
**
** 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.0, 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.
**
** If you are unsure which license is appropriate for your use, please
** contact the sales department at qt-sales@nokia.com.
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef QLISTMODELINTERFACE_H
#define QLISTMODELINTERFACE_H

#include <QHash>
#include <QVariant>
#include <qfxglobal.h>


QT_BEGIN_HEADER

QT_BEGIN_NAMESPACE

QT_MODULE(Declarative)

/*!
  \class QListModelInterface
  \brief The QListModelInterface class can be subclassed to provide C++ models to QFx Views

  This class is comprised primarily of pure virtual functions which you need to implement in a subclass. You can then use the subclass as a model for a QFx view, such as a QFxListView.
*/
class Q_DECLARATIVE_EXPORT QListModelInterface : public QObject
{
    Q_OBJECT
public:
    QListModelInterface(QObject *parent = 0) : QObject(parent) {}
    virtual ~QListModelInterface() {}

    // ### move these into the Qt namespace
    enum Roles {
        TextRole = Qt::DisplayRole,
        IconRole = Qt::DecorationRole
    };

    /*!
      Returns the number of data entries in the model.
      */
    virtual int count() const = 0;
    /*!
      Returns the data at the given \a index for the specifed \a roles.
      */
    virtual QHash<int,QVariant> data(int index, const QList<int> &roles = (QList<int>())) const = 0;
    /*!
      Sets the data at the given \a index.\a values is a mapping of QVariant values to roles.
      */
    virtual bool setData(int index, const QHash<int,QVariant> &values) { Q_UNUSED(index); Q_UNUSED(values); return false; }
    /*!
      This convinience function can be used to set the data for one specific role. It internally uses the other setData and does not need to be reimplemented.
      */
    inline bool setData(int index, const QVariant &value, int role)
    {
        QHash<int,QVariant> values;
        values.insert(role, value);
        return setData(index, values);
    }

    /*!
      Returns which roles the list provides data for.
      */
    virtual QList<int> roles() const = 0;
    /*!
      Returns a string description of the specified \a role.
      */
    virtual QString toString(int role) const = 0;

    //void bind(int index, int role, QObject *object, const char *propertyName, bool readOnly = true);

Q_SIGNALS:
    void itemsInserted(int index, int count);
    void itemsRemoved(int index, int count);
    void itemsMoved(int from, int to, int count);
    void itemsChanged(int index, int count, const QList<int> &roles);

protected:
    QListModelInterface(QObjectPrivate &dd, QObject *parent) : QObject(dd, parent) {}
};


QT_END_NAMESPACE

QT_END_HEADER
#endif //QTREEMODELINTERFACE_H