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

**

** 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 HbCore 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 "hbscrollarea.h"

#include "hbscrollarea_p.h"

#include "hbscrollbar.h"

#include "hbdeviceprofile.h"

#include "hbinstance.h"

#include <hbwidgetfeedback.h>

#include <hbevent.h>

#include "hbglobal_p.h"

#include <QGesture>

#include <QDebug>

/*!

 */

/*!

 Here are the main properties of the class:

 \li HbScrollArea::scrollDirections     : 

 \li HbScrollArea::clampingStyle        : 

 \li HbScrollArea::scrollingStyle       : 

 \li HbScrollArea::showScrollBars       : 

 \li HbScrollArea::scrollBarWidth       :  

 \li HbScrollArea::scrollBarMargin      : 

 \li HbScrollArea::frictionEnabled      :

 \li HbScrollArea::handleLongPress      :  

 */

/*!

    \property HbScrollArea::showScrollBars

    \brief

*/

/*!

    \property HbScrollArea::scrollBarWidth

    \brief

*/

/*!

    \property HbScrollArea::scrollBarMargin

    \brief

*/

/*!

    \property HbScrollArea::scrollDirections

    \brief 

*/

/*!

    \property HbScrollArea::clampingStyle

    \brief 

*/

/*!

    \property HbScrollArea::scrollingStyle

    \brief 

*/

/*!

    \property HbScrollArea::frictionEnabled

    \brief

*/

/*!

    \property HbScrollArea::handleLongPress

    \brief 

*/

/*!

    \property HbScrollArea::verticalScrollBarPolicy

    \brief

*/

/*!

    \property HbScrollArea::horizontalScrollBarPolicy

    \brief

*/

/*!

    \fn void HbScrollArea::scrollDirectionsChanged(Qt::Orientations newValue)

    This signal is emitted when scrolling direction is changed.

*/

/*!

    \fn void HbScrollArea::scrollingStarted()

    This signal is emitted whenever a scrolling action begins.

*/

/*!

    \fn void HbScrollArea::scrollingEnded()

    This signal is emitted whenever a scrolling action ends.

*/

/*!

    \fn void HbScrollArea::scrollPositionChanged(QPointF newposition)

    This signal is emitted when scroll position is changed.

*/

/*!

    \enum HbScrollArea::ClampingStyle

    Clamping styles supported by HbScrollArea.

    This enum describes how scrolling is behaving when reaching boundaries of the content item.

*/

/*!

    \var HbScrollArea::StrictClamping

    Scrolling is limited to the bounding rectangle of the content item.

*/

/*!

    \var HbScrollArea::BounceBackClamping

    Scrolling can go beyond the bounding rectangle of the content item, but bounces back to the

    limits of the bounding rectangle when released or when inertia scrolling stops.

*/

/*!

    \var HbScrollArea::NoClamping

    Scrolling is completely unclamped (this is usually used when the subclass implements its own).

*/

/*!

    \enum HbScrollArea::ScrollingStyle

    Different scrolling styles supported by HbScrollArea.

    This enum describes how scroll area can be scrolled.

*/

/*!

    \var HbScrollArea::Pan

    Dragging motion pans the view with no follow-on scrolling animation.

*/

/*!

    \var HbScrollArea::PanOrFlick

    Dragging motion pans the view with no follow-on scrolling animation,

    quick flicking motion triggers scrolling animation.

*/

/*!

    \var HbScrollArea::PanWithFollowOn

    Dragging motion pans the view, velocity at end of drag motion triggers follow-on animated scrolling.

*/

/*!

    \enum HbScrollArea::ScrollBarPolicy

    This enum type describes the various visibility modes of HbScrollArea's scroll bars.

*/

/*!

    \var HbScrollArea::ScrollBarAsNeeded

    HbScrollArea shows a scroll bar when the content is too large to fit and not otherwise.

*/

/*!

    \var HbScrollArea::ScrollBarAlwaysOff

    HbScrollArea never shows a scroll bar.

*/

/*!

    \var HbScrollArea::ScrollBarAlwaysOn

    HbScrollArea always shows a scroll bar.

*/

/*!

    \var HbScrollArea::ScrollBarAutoHide

    HbScrollArea shows scroll bar for short period of time when the content is displayed or scrolled. Scroll bar is not shown if not needed.

    This is the default behavior.

*/

/*!

 */

HbScrollArea::HbScrollArea(QGraphicsItem* parent) : 

        HbWidget( *new HbScrollAreaPrivate, parent )

{

    Q_D( HbScrollArea );

    d->q_ptr = this;

    d->init();

}

HbScrollArea::HbScrollArea(HbScrollAreaPrivate &dd, QGraphicsItem *parent):

        HbWidget( dd, parent  )

{

    Q_D( HbScrollArea );

    d->q_ptr = this;

    d->init();

}

/*!

 */

HbScrollArea::~HbScrollArea()

{

    Q_D( HbScrollArea );

    if (d && d->mContents) {

        d->mContents->setParentLayoutItem(0);

    }

}

/*!

 */

QGraphicsWidget* HbScrollArea::contentWidget() const

{

    Q_D( const HbScrollArea );

    return d->mContents;

}

/*!

 */

void HbScrollArea::setContentWidget(QGraphicsWidget* contents)

{

    Q_D( HbScrollArea );

    if ( contents == d->mContents ) {

        return;

    }

    d->stopAnimating();

    if (0 != d->mContents) {

        d->mContents->setParentLayoutItem(0);

        delete d->mContents;

    }

    d->mContents = contents;

    updateGeometry();

    if (0 != contents) {

        contents->setParentLayoutItem(this);

        contents->setParentItem(this);

        contents->installEventFilter(this);

        d->mResetAlignment = true;

        d->adjustContent();

        setContinuationIndicators(d->mContinuationIndicators);

    } else {

        d->hideChildComponents();

    }

}

/*!

Removes the content widget, which is set to the scrollarea and returns it.

The ownership of the \a QGraphicsWidget is transferred to the caller.

\note This function is particularly useful if one wants to switch between

different contents without deleting previous content.

    \sa setContentWidget()

*/

QGraphicsWidget *HbScrollArea::takeContentWidget()

{

    Q_D(HbScrollArea);

    QGraphicsWidget* content = d->mContents;

    d->mContents = 0;

    // Reset the ownership

    if (content) {

        content->setParentLayoutItem(0);

        content->setParentItem(0);

        content->removeEventFilter(this);

    }

    d->hideChildComponents();

    return content;

}

/*!

 */

HbScrollArea::ClampingStyle HbScrollArea::clampingStyle() const

{

    Q_D( const HbScrollArea );

    return d->mClampingStyle;

}

/*!

 */

void HbScrollArea::setClampingStyle(ClampingStyle value)

{

    Q_D( HbScrollArea );

    d->mClampingStyle = value;

}

/*!

 */

HbScrollArea::ScrollingStyle HbScrollArea::scrollingStyle() const

{

    Q_D( const HbScrollArea );

    return d->mScrollingStyle;

}

/*!

  Sets the scrollingStyle property that controls how the style of scrolling interaction

  provided by the widget

  Possible values for the clamping style include:

 		Pan - dragging motion pans the view with no follow-on scrolling animation

                    is deprecated.

 		PanWithFollowOn - dragging motion pans the view, velocity at end of drag motion triggers follow-on animated scrolling

  The default value is PanWithFollowOn.

  \sa HbScrollArea::scrollingStyle()

 */

void HbScrollArea::setScrollingStyle(ScrollingStyle value)

{

    Q_D( HbScrollArea );

    if (value == HbScrollArea::PanOrFlick) {

        d->mScrollingStyle = HbScrollArea::PanWithFollowOn;

        HB_DEPRECATED("HbScrollArea::PanOrFlick is deprecated");

    } else {

        d->mScrollingStyle = value;

    }

}

/*!

 */

Qt::Orientations HbScrollArea::scrollDirections() const

{

    Q_D( const HbScrollArea );

    return d->mScrollDirections;

}

/*!

 */

void HbScrollArea::setScrollDirections(Qt::Orientations value)

{

    Q_D( HbScrollArea );

    bool isChanged = (d->mScrollDirections != value);

    d->mScrollDirections = value;

    if (isChanged) {

        emit scrollDirectionsChanged( value );

    }

}

/*!

 */

bool HbScrollArea::frictionEnabled() const

{

    Q_D( const HbScrollArea );

    return d->mFrictionEnabled;

}

/*!

 */

void HbScrollArea::setFrictionEnabled(bool value)

{

    Q_D( HbScrollArea );

    d->mFrictionEnabled = value;

}

/*!

  Returns true if the scroll area handles

  long press gestures, false otherwise

  \deprecated HbScrollArea::longPressEnabled()

      is deprecated.

  \sa HbScrollArea::setHandleLongPress()

 */

bool HbScrollArea::longPressEnabled() const

{

    HB_DEPRECATED("HbScrollArea::longPressEnabled() is deprecated");    

    return false;

}

/*!

  Sets the value of the handleLongPress property.  This value is set

  to true if the widget is to respond to long press gestures, false otherwise.

  The default value is false.

  \deprecated HbScrollArea::setLongPressEnabled(bool)

        is deprecated.

  \sa HbScrollArea::handleLongPress()

 */

void HbScrollArea::setLongPressEnabled (bool value)

{

    HB_DEPRECATED("HbScrollArea::setLongPressEnabled(bool) is deprecated");

    Q_UNUSED(value);

}

/*

 */

QVariant HbScrollArea::itemChange(GraphicsItemChange change, const QVariant &value)

{

    Q_D( HbScrollArea );

    if (change == QGraphicsItem::ItemVisibleHasChanged && d->mContents) {

        if (value.toBool() == true)

            d->adjustContent();

        else

            d->_q_hideScrollBars();

    }

    return HbWidget::itemChange(change, value);

}

/*! @beta

  upGesture() is a virtual slot function that is called whenever an

  up flick gesture is detected, if the scrollDirection is set to