/****************************************************************************
**
** Copyright (C) 2008-2010 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (developer.feedback@nokia.com)
**
** This file is part of the HbWidgets module of the UI Extensions for Mobile.
**
** GNU Lesser General Public License Usage
** 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 developer.feedback@nokia.com.
**
****************************************************************************/
#ifndef HBABSTRACTVIEWITEM_H
#define HBABSTRACTVIEWITEM_H

#include <hbwidget.h>
#include <hbglobal.h>
#include <hbnamespace.h>
#include <hbeffect.h>

#include <QHash>

class HbAbstractViewItemPrivate;
class HbAbstractViewItemShared;
class HbAbstractItemView;
class HbStyleParameters;
class HbFrameBackground;
class HbStylePrimitiveData;

class QGraphicsObject;
class QModelIndex;

class HB_WIDGETS_EXPORT HbAbstractViewItem : public HbWidget
{
    Q_OBJECT

    Q_PROPERTY(Hb::ModelItemType modelItemType READ modelItemType)
    Q_PROPERTY(Qt::CheckState checkState READ checkState WRITE setCheckState)

public:

    enum SelectionAreaType
    {
        SingleSelection,
        MultiSelection,
        ContiguousSelection
    };
   
    explicit HbAbstractViewItem(QGraphicsItem *parent=0);
    virtual ~HbAbstractViewItem();

    virtual HbAbstractViewItem *createItem() = 0;
    virtual void updateChildItems();

    QModelIndex modelIndex() const;
    virtual bool canSetModelIndex(const QModelIndex &index) const;
    virtual void setModelIndex(const QModelIndex &index);

    HbAbstractViewItem *prototype() const;

    HbAbstractItemView *itemView() const;
    void setItemView(HbAbstractItemView *itemView);

    virtual QHash<QString, QVariant> transientState() const;
    virtual void setTransientState(const QHash<QString, QVariant> &state);

    virtual bool selectionAreaContains(const QPointF &position, SelectionAreaType selectionAreaType) const;

    void setCheckState(Qt::CheckState state);
    Qt::CheckState checkState() const;

    void setDefaultFrame(const HbFrameBackground &frame);
    HbFrameBackground defaultFrame() const;

    Hb::ModelItemType modelItemType() const;

    virtual void paint(QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget = 0);

public slots:
    void updatePrimitives();

signals:
    void pressed(const QPointF &position);
    void released(const QPointF &position);
    void activated(const QPointF &position);
    void longPressed(const QPointF &position);

protected:

    HbAbstractViewItem(const HbAbstractViewItem &source);
    HbAbstractViewItem &operator=(const HbAbstractViewItem &source);

    HbAbstractViewItem( HbAbstractViewItemPrivate &dd, QGraphicsItem *parent );
    void initPrimitiveData( HbStylePrimitiveData     *primitiveData, 
                            const QGraphicsObject    *primitive);
    virtual void polish(HbStyleParameters& params);

    virtual QVariant itemChange(GraphicsItemChange change, const QVariant &value);
    virtual bool event(QEvent *e);

    virtual QSizeF sizeHint(Qt::SizeHint which, const QSizeF &constraint = QSizeF()) const;

    virtual void pressStateChanged(bool value, bool animate);

    virtual void gestureEvent(QGestureEvent *event);

    virtual void changeEvent(QEvent *event);

protected slots:
    
    void updatePixmapCache();

private:
    Q_DECLARE_PRIVATE_D( d_ptr, HbAbstractViewItem )
    Q_PRIVATE_SLOT(d_func(), void _q_animationFinished(const HbEffect::EffectStatus &status))
    Q_PRIVATE_SLOT(d_func(), void _q_childrenChanged())

    friend class HbAbstractViewItemShared;
};

#endif /*HBABSTRACTVIEWITEM_H*/
