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

**

** 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.

**

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

#include "hbabstractviewitem_p.h"

#include <hbabstractviewitem.h>

#include <hbabstractitemview.h>

#include <hbnamespace.h>

#include <hbstyleoptionabstractviewitem.h>

#include <hbstyle.h>

#include <hbiconitem.h>

#include <hbframebackground.h>

#include <hbtextitem.h>

#include <QPersistentModelIndex>

#include <QGraphicsSceneMouseEvent>

#include <QGraphicsLinearLayout>

#include <QVariant>

#include <QCoreApplication>

#include <QEvent>

#include <QDebug>

const QString KDefaultLayoutOption = "default";

const int HbAbstractViewItemShared::ViewItemDeferredDeleteEvent = QEvent::registerEventType();

/*!

    @alpha

    @hbwidgets

    \class HbAbstractViewItem

    \brief The HbAbstractViewItem class represents a single item in a AbstractItemView.  

    The HbAbstractViewItem class provides an item that is used by HbAbstractItemView class to

    visualize content within single model index. By default HbAbstractViewItem supports QString

    that is stored into Qt::DisplayRole role and QIcon or HbIcon that is stored into

    Qt::DecoratorRole role within the index. 

    This class is provided mainly for customization purposes but it also acts as a default

    item prototype inside HbAbstractItemView. See HbAbstractItemView how to set customized class as a item prototype.

    \b Subclassing

    When subclassing HbAbstractViewItem, childclass must provide implementations of createItem() and updateChildItems() functions.

    To support multiple Abstractview items within single AbstractItemview, you must also provide an implementation of canSetModelIndex().

    If derived abstract view item has transient state information that is not meaningful to store within model index (child item cursor 

    position selection areas etc.) view item can use abstract views internal state model to store this information. This feature can

    be taken into use by implementing state() and setState() functions in derived class.

*/

/*!

    \enum HbAbstractViewItem::StateKey

    HbAbstractViewItem's predefined set of state keys.

    This enum describes state keys for HbAbstractViewItem state values. State value can be accessed using this key.

*/

/*!

    \var HbAbstractViewItem::FocusKey

         Predefined key for focus state value.

*/

/*!

    \var HbAbstractViewItem::UserKey

         First key that can be used by the derived class for it's own purposes.

*/

/*!

    \fn HbAbstractViewItem::createItem 

    Creates a new item. 

    In most subclasses, createItem should be implemented like this:

    \snippet{ultimatecodesnippet/customlistviewitem.cpp,1}

*/

void HbAbstractViewItemPrivate::init()

{

    Q_Q(HbAbstractViewItem);

    q->setProperty("state", "normal");

    if (isPrototype()) {

        q->setFocusPolicy(Qt::ClickFocus);

    } else {

        QGraphicsItem::GraphicsItemFlags itemFlags = q->flags();

        itemFlags |= QGraphicsItem::ItemIsFocusable;

        q->setFlags(itemFlags);

        q->setFocusPolicy(mSharedData->mPrototype->focusPolicy());

        mSharedData->mCloneItems.append(q);

    }

}

int HbAbstractViewItemPrivate::modelItemType() const

{

    return mIndex.data(Hb::ItemTypeRole).toInt();

}

void HbAbstractViewItemPrivate::_q_animationFinished(const HbEffect::EffectStatus &status)

{

    Q_UNUSED(status);

    Q_Q(HbAbstractViewItem);

    if (mFocusItem) {

        QCoreApplication::postEvent(q, new QEvent((QEvent::Type)HbAbstractViewItemShared::ViewItemDeferredDeleteEvent));

    }

}

void HbAbstractViewItemPrivate::repolishCloneItems()

{

    int count(mSharedData->mCloneItems.count());

    for (int i = 0; i < count; ++i) {

        mSharedData->mCloneItems.at(i)->repolish();

    }

}

void HbAbstractViewItemPrivate::updateCloneItems()

{

    int count(mSharedData->mCloneItems.count());

    for (int i = 0; i < count; ++i) {

        mSharedData->mCloneItems.at(i)->updatePrimitives();

    }

}

void HbAbstractViewItemPrivate::setInsidePopup(bool insidePopup)

{

    Q_Q(HbAbstractViewItem);

    HbWidgetPrivate::setInsidePopup(insidePopup);

    if (q) {

        themingPending = true;

        q->updatePrimitives();

        q->repolish();

    }

}

/*!

    Constructs an abstract view item with the given parent.

*/

HbAbstractViewItem::HbAbstractViewItem(QGraphicsItem *parent) : 

    HbWidget( *new HbAbstractViewItemPrivate( this ), parent )

{

    Q_D( HbAbstractViewItem );

    d->q_ptr = this;

    d->init();

}

/*!

    Creates a separate graphics widget with same Abstract view item state as \a source.

*/

HbAbstractViewItem::HbAbstractViewItem( HbAbstractViewItemPrivate &dd, QGraphicsItem *parent):

                    HbWidget( dd, parent )

{

    Q_D( HbAbstractViewItem );

    d->q_ptr = this;

    d->init();

}

/*!

    Creates a separate graphics widget with same abstract view item state as \a source.

*/

HbAbstractViewItem::HbAbstractViewItem(const HbAbstractViewItem &source) :

    HbWidget(*new HbAbstractViewItemPrivate(*source.d_func()), 0)

{

    Q_D( HbAbstractViewItem );

    d->q_ptr = this;

    d->init();

}

/*!

    Assigns the \a source abstract view item to this abstract view item and returns a reference to this item.

*/

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

{

    Q_D( HbAbstractViewItem );

    *d = *source.d_func();

    return *this;

}

/*!

    Destructor.

*/

HbAbstractViewItem::~HbAbstractViewItem()

{

    HB_SDD(HbAbstractViewItem);

    if (d && !d->isPrototype()) {

        sd->mCloneItems.removeOne(this);

    }

}

/*!

    Returns true if \a model index is supported by Abstract view item, otherwise returns false.

    This function is called for every item on the prototype list (, if several prototypes exist)

    until item is found, which can create item for \a index. The prototype list is gone 

    through from end to the beginning. 

    Thus specialized prototypes should be in the end of the list and 

    'default' prototype first one. The specialized prototypes usually can create only

    certain types of list view items. The default prototype usually return always true,

    meaning that it can create any type of list view item. 

    \sa HbAbstractItemView::setItemPrototype(HbAbstractViewItem *prototype), HbAbstractItemView::setItemPrototype(const QList<HbAbstractViewItem *> &prototypes)

*/

bool HbAbstractViewItem::canSetModelIndex(const QModelIndex &index) const

{

    Q_UNUSED(index);

    return true;

}

/*!

    Returns model index tied into this Abstract view item.

*/

QModelIndex HbAbstractViewItem::modelIndex() const

{

    Q_D( const HbAbstractViewItem );

    return d->mIndex;

}

/*!

    \deprecated HbAbstractViewItem::type() const

        is deprecated.

    \reimp

*/

int HbAbstractViewItem::type() const

{

    qWarning("HbAbstractViewItem::type() const is deprecated");

    return Hb::ItemType_AbstractViewItem;

}

/*!

    Sets model \a index where this Abstract view item should retrieve it's content.

*/

void HbAbstractViewItem::setModelIndex(const QModelIndex &index)

{

    Q_D( HbAbstractViewItem );

    if (d->mIndex != index) {

        d->mIndex = index;

        updateChildItems();

    }

}

/*!

    \deprecated HbAbstractViewItem::receivedFocus()

        is deprecated.

    Called when item has received focus.

*/

void HbAbstractViewItem::receivedFocus()

{

    qWarning("HbAbstractViewItem::receivedFocus() is deprecated!");

    Q_D( HbAbstractViewItem );

    d->mFocused = true;

}

/*!

    \deprecated HbAbstractViewItem::lostFocus()

        is deprecated.

    Called when item has lost focus.

*/

void HbAbstractViewItem::lostFocus()

{

    qWarning("HbAbstractViewItem::lostFocus() is deprecated!");

    Q_D( HbAbstractViewItem );

    d->mFocused = false;

}

/*!

    \deprecated HbAbstractViewItem::isFocused() const

        is deprecated.

    Retuns true if item is currently focused, otherwise return false.

*/

bool HbAbstractViewItem::isFocused() const

{

    qWarning("HbAbstractViewItem::isFocused() is deprecated!");

    Q_D( const HbAbstractViewItem );

    return d->mFocused;

}

/*!

    Returns the saved item's transient state. Transient state can be seen as a state data that is 

    wanted to be preserved but it not meaningful to be stored inside model index because of it's

    momentary nature. States will be saved inside AbstractItemview and restored when current model index is

    assigned to certain Abstract view item.

*/

QMap<int,QVariant> HbAbstractViewItem::state() const

{

    Q_D( const HbAbstractViewItem );

    QMap<int,QVariant> state;

    state.insert(FocusKey, d->mFocused);

    state.insert(CheckStateKey, d->mCheckState);

    return state;

}

/*!

    Restores the item's transient state using given \a state data.

*/

void HbAbstractViewItem::setState(const QMap<int,QVariant> &state)

{

    Q_D( HbAbstractViewItem );

    if (state.contains(FocusKey)) {

        d->mFocused = state.value(FocusKey).toBool();

    } else {

        d->mFocused = false; 

    }

    if (state.contains(CheckStateKey)) {

        d->mCheckState = (Qt::CheckState)state.value(CheckStateKey).toInt();

    } else {

        d->mCheckState = Qt::Unchecked;

    }

}

/*!

    Returns a pointer to HbAbstractViewItem prototype that was used to create this

    view item.

*/

HbAbstractViewItem *HbAbstractViewItem::prototype() const

{

    HB_SDD( const HbAbstractViewItem );

    return sd->mPrototype;

}

/*!

    Sets \a AbstractItemView that contains the Abstract view item.

*/

void HbAbstractViewItem::setItemView( HbAbstractItemView *itemView )

{

    HB_SDD( HbAbstractViewItem );

    sd->mItemView = itemView;

}

/*!

    Returns item view that contains the item view item.

*/

HbAbstractItemView *HbAbstractViewItem::itemView() const

{

    HB_SDD( const HbAbstractViewItem );

    return sd->mItemView;

}

/*!

    Populates a style option object for this widget based on its current state, and stores the output in \a option.

*/

void HbAbstractViewItem::initStyleOption(HbStyleOptionAbstractViewItem *option) const

{

    HB_SDD( const HbAbstractViewItem );

    HbWidget::initStyleOption(option);

    option->modelItemType = d->mModelItemType;

    option->index = d->mIndex;

    option->viewItemType = type();

    option->checkState = d->mCheckState;

    option->background = d->mBackground;

    if (!option->background.isValid()) {

        if (option->modelItemType == Hb::StandardItem 

            && !sd->mDefaultFrame.isNull()) {

            option->background = sd->mDefaultFrame;

        }

    }

    if (d->mPressed) {

        option->state |= QStyle::State_Sunken;

    }

    if (    sd->mItemView

        &&  sd->mItemView->selectionMode() == HbAbstractItemView::SingleSelection){

        option->singleSelectionMode = true;

    }

    option->insidePopup = testAttribute(Hb::InsidePopup);

}

/*!

    Check whether \a scenePosition of pressed down is inside selection area of view item in current selection mode.

    Default selection areas are for

    \li HbAbstractItemView::SingleSelection mode: whole item

    \li HbAbstractItemView::MultiSelection mode: touch area of selection icon. 

        Touch are is represented by primitive HbStyle::P_ItemViewItem_touchmultiselection.

    \li HbAbstractItemView::ContiguousSelection mode: touch area of selection icon. 

        Touch are is represented by primitive HbStyle::P_ItemViewItem_touchmultiselection.

    \li HbAbstractItemView::NoSelection mode: none

*/

bool HbAbstractViewItem::selectionAreaContains(const QPointF &scenePosition) const

{

    HB_SDD(const HbAbstractViewItem);

    bool contains = false;

    if (sd->mItemView) {

        switch (sd->mItemView->selectionMode()) {

            case HbAbstractItemView::SingleSelection: 

                contains = true;

                break;

            case HbAbstractItemView::MultiSelection: 

                // fall through

            case HbAbstractItemView::ContiguousSelection: {

                // TODO: put assert back in action, when official layouts in use

                /*Q_ASSERT_X(     d->mMultiSelectionTouchArea 

                            &&  d->mMultiSelectionTouchArea->boundingRect().size().width() > 0 

                            &&  d->mMultiSelectionTouchArea->boundingRect().size().height() > 0, "", "HbAbstractViewItem::selectionAreaContains(): d->mMultiSelectionTouchArea should exist");

                */

                if(     d->mMultiSelectionTouchArea 

                    &&  d->mMultiSelectionTouchArea->boundingRect().size().width() > 0 

                    &&  d->mMultiSelectionTouchArea->boundingRect().size().height() > 0) {

                    contains = d->mMultiSelectionTouchArea->boundingRect().contains(

                                    d->mMultiSelectionTouchArea->mapFromScene(scenePosition));

                } else {

                    contains = d->mSelectionItem->boundingRect().contains(

                                    d->mSelectionItem->mapFromScene(scenePosition));

                }

                break;

            }

            default:

                break;

        }

    }

    return contains;

}

/*!

    \reimp

*/

bool HbAbstractViewItem::event(QEvent *e)

{

    if (e) {

        switch (e->type()) {

            case QEvent::GraphicsSceneResize: {

                Q_D(HbAbstractViewItem );

                if (d->mBackgroundItem || d->mFrame || d->mFocusItem) {

                    HbStyleOptionAbstractViewItem styleOption;

                    initStyleOption(&styleOption);

                    if (d->mFocusItem) {

                        style()->updatePrimitive(d->mFocusItem, HbStyle::P_ItemViewItem_focus, &styleOption);

                    }

                }

                break;

            }

            case QEvent::LayoutDirectionChange: {

                repolish();

                break;

            }

            default: {

                if (e->type() == HbAbstractViewItemShared::ViewItemDeferredDeleteEvent) {

                    // cannot handle ViewItemDeferredDeleteEvent in the case statement!

                    Q_D(HbAbstractViewItem);

                    delete d->mFocusItem;

                    d->mFocusItem = 0;

               }

                break;

            }

        }

        return HbWidget::event(e);

    }

    return false;

}

/*!

  Provides access to primitives of HbAbstractViewItem.

  \param primitive is the type of the requested primitive. The available primitives are 

  \c P_ItemViewItem_background

  \c P_ItemViewItem_frame

  \c P_ItemViewItem_selection

  \c P_ItemViewItem_focus

  \c P_ItemViewItem_touchmultiselection.

 */

QGraphicsItem *HbAbstractViewItem::primitive(HbStyle::Primitive primitive) const

{

    Q_D(const HbAbstractViewItem);

    if (primitive == HbStyle::P_ItemViewItem_background) {

        return d->mBackgroundItem;

    } else if (primitive == HbStyle::P_ItemViewItem_frame) {

        return d->mFrame;

    } else if (primitive == HbStyle::P_ItemViewItem_selection) {

        return d->mSelectionItem;

    } else if (primitive == HbStyle::P_ItemViewItem_focus) {

        return d->mFocusItem;

    } else if (primitive == HbStyle::P_ItemViewItem_touchmultiselection) {

        return d->mMultiSelectionTouchArea;

    }

    return HbWidget::primitive(primitive);

}