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

**

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

#include <hbstyleoptionprogressbar_p.h>

#include "hbglobal_p.h"

#ifdef HB_EFFECTS

#include <hbeffect.h>

#include "hbeffectinternal_p.h"

#define HB_PRGRESSBAR_ITEM_TYPE "HB_PROGRESSBAR"

#endif

/*!

    @beta

    @hbwidgets

    \class HbProgressBar

    \brief HbProgressBar widget provides a vertical and horizontal progress bar.

    \image html progressbar.png  "A Progress Bar with Min-Max text at bottom"

    \image html infiniteprogressbar.png  "An infinite progres bar"

    The HbProgressBar widget provides a horizontal or vertical progress bar.

    A progress bar is used to give the user an indication of the progress of an operation and to reassure them that 

    the application is still running. The progress bar uses the concept of steps. You set it up by specifying the 

    minimum and maximum possible step values, and it will display the percentage of steps that have been completed 

    when you later give it the current step value. The percentage is calculated by dividing the 

    progress (value() - minimum()) divided by maximum() - minimum().

    By default the min value is 0 and max value is 100.If minimum and maximum both are set to 0, the bar shows a busy indicator 

    instead of a percentage of steps.The ProgressBar is always non interactive.

    ProgressBar also supports adding text . Min-Max text pair is also supported which is commonly 

    used for progress indication for music. 

    Progress bar provides below signal.

    \li valueChanged(int value) Emitted when the value of the progressbar is changed.

    Example code for creating normal ProgressBar:

    \code

    HbProgressBar *pb = new HbProgressBar();

    pb->setMinimum(0);

    pb->setMaximum(500);

    pb->setProgressValue(175);

    \endcode

    Example code for creating infinite ProgressBar:

    \code

    HbProgressBar *pb = new HbProgressBar();

    pb->setMinimum(0);

    pb->setMaximum(0);

    \endcode

    Example code for creating normal ProgressBar with Min-Max text at Top:

    \code

    HbProgressBar *pb = new HbProgressBar();

    pb->setMinimum(0);

    pb->setMaximum(500);

    pb->setProgressValue(175);

    pb->setMinMaxTextVisible(true);

    pb->setMinMaxTextAlignment(Qt::AlignTop);// The possible options are Qt::AlignTop ,Qt::AlignBottom ,Qt::AlignCenter

    pb->setminText("0");

    pb->setmaxText("500");

    \endcode

    Example code for creating vertical normal ProgressBar:

    \code

    HbProgressBar *pb = new HbProgressBar();

    pb->setOrientation(Qt::Vertical);

    pb->setMinimum(0);

    pb->setMaximum(500);

    pb->setProgressValue(175);

    \endcode

*/

/*

    HbProgressBarPrivate

    private class constructor     

*/

HbProgressBarPrivate::HbProgressBarPrivate() :

    mFrame(0),

    mTrack(0),

    mWaitTrack(0),

    mMinTextItem(0),

    mMaxTextItem(0),

    mMinMaxTextVisible(false),

    mMaximum(100),

    mMinimum(0),

    mProgressValue(0),

    mInvertedAppearance(false),

    mMinMaxTextAlignment(Qt::AlignBottom),

    mMinText(QString()),

    mMaxText(QString()),

    mOrientation(Qt::Horizontal),

    mDelayHideInProgress(true),

    mShowEffectInProgress(false)

{

}

/*

    HbProgressBarPrivate

    destructor     

*/

HbProgressBarPrivate::~HbProgressBarPrivate() 

{

}

/*

    \internal

    initialises progressbar

*/

void HbProgressBarPrivate::init() 

{

    Q_Q(HbProgressBar);

    HbStyle *style = qobject_cast<HbStyle*>(q->style());

    Q_ASSERT(style);

    mFrame = style->createPrimitive(HbStyle::P_ProgressBar_frame,q);

    mTrack = style->createPrimitive(HbStyle::P_ProgressBar_track,mFrame);

    mWaitTrack = style->createPrimitive(HbStyle::P_ProgressBar_waittrack,mFrame);    

    mWaitTrack->setVisible(false);

    if(q->layoutDirection() == Qt::RightToLeft) {

        q->setInvertedAppearance(true);

    }

#ifdef HB_EFFECTS

    HbEffectInternal::add(HB_PRGRESSBAR_ITEM_TYPE,"progressbar_appear", "progressbar_appear");

    HbEffectInternal::add(HB_PRGRESSBAR_ITEM_TYPE,"progressbar_disappear", "progressbar_disappear");

    HbEffectInternal::add(HB_PRGRESSBAR_ITEM_TYPE,"progressbar_progress_complete", "progressbar_progress_complete");

#endif

}

/*

    createTextPrimitives

*/

void HbProgressBarPrivate::createTextPrimitives()

{

    Q_Q(HbProgressBar);

    mMinTextItem = q->style()->createPrimitive(HbStyle::P_ProgressBar_mintext,q);

    mMaxTextItem = q->style()->createPrimitive(HbStyle::P_ProgressBar_maxtext,q);

}

void HbProgressBarPrivate::setProgressValue(int value)

{

   Q_Q(HbProgressBar);

   if (mProgressValue == value) {

        return;

    }

    if (value >= mMaximum) {

        value = mMaximum;

#ifdef HB_EFFECTS

        HbEffect::start(mTrack, HB_PRGRESSBAR_ITEM_TYPE, "progressbar_progress_complete");

#endif

    }

    else if (value < mMinimum) {

        value = mMinimum;

    }

    mProgressValue=value;

    //redraw track

    HbStyleOptionProgressBar progressBarOption;

    q->initStyleOption(&progressBarOption);

    if(mTrack) {

        q->style()->updatePrimitive(mTrack, HbStyle::P_ProgressBar_track, &progressBarOption);

    }

    emit q->valueChanged(value);

}

/*

    \internal

    Sets the progressbar enabling/disabling

*/

void HbProgressBarPrivate::setEnableFlag(bool flag)

{

    Q_Q(HbProgressBar);

    if(!flag) {

        q->setProgressValue(q->minimum());

    }

}

/*

    \internal

    Sets the progressbar range

*/

void HbProgressBarPrivate::setRange(int minimum, int maximum)

{

    Q_Q(HbProgressBar);

    if( minimum > maximum ){

        maximum = minimum ;

    }

    mMinimum = minimum;

    mMaximum = maximum;

    if ( mProgressValue < mMinimum){

        mProgressValue = mMinimum;

    }

    if(mProgressValue > mMaximum){

        mProgressValue = mMaximum;

    }

    if( (mMinimum == 0) && (mMaximum == 0) ) {

        mWaitTrack->setVisible(true);

        mTrack->setVisible(false);

    } else {

        mWaitTrack->setVisible(false);

        mTrack->setVisible(true);

    }

} 

/*!

    \internal

    Sets the progressbar orientation.

    Can be either vertical or Horizontal.

*/

void HbProgressBarPrivate::setOrientation(Qt::Orientation orientation)

{

    Q_Q(HbProgressBar);

    if (mOrientation != orientation) {

        mOrientation = orientation;

        q->repolish();

        q->updatePrimitives();

    }

}

/*!

    \internal

    Private slot which delays the hiding effect.

*/

#ifdef HB_EFFECTS

void HbProgressBarPrivate::_q_delayedHide(HbEffect::EffectStatus status)

{

    Q_Q(HbProgressBar);

    if (status.reason != Hb::EffectNotStarted) {

        q->setVisible(false);

    } 

}

/*!

    \internal

    Private slot which delays the show effect.

*/

void HbProgressBarPrivate::_q_delayedShow(HbEffect::EffectStatus status)

{

    Q_UNUSED(status);

    mShowEffectInProgress = false;

}

#endif

/*!

    @beta

   Constructs a progress bar with the given parent.

   By default, the minimum step value is set to 0, and the maximum to 100.

   \param parent The parent of ProgressBar

*/

HbProgressBar::HbProgressBar(QGraphicsItem *parent) : 

    HbWidget(*new HbProgressBarPrivate, parent)

{    

    Q_D( HbProgressBar );

    d->q_ptr = this;

    d->init();

}

HbProgressBar::HbProgressBar(HbProgressBarPrivate &dd, QGraphicsItem *parent) : 

    HbWidget( dd, parent)

{   

    Q_D( HbProgressBar );

    d->init();

}

/*!

    @beta

    Destructor for the progressbar.

*/

HbProgressBar::~HbProgressBar() 

{    

}

/*!

    @beta

    \sa setInvertedAppearance()

*/

bool HbProgressBar::invertedAppearance() const 

{

    Q_D( const HbProgressBar );

    return d->mInvertedAppearance;

}

/*!

    @beta

    Sets the inverted appearence. If this is true progress grows from right to 

    left otherwise left to right.

    \param inverted true or false.

    \sa invertedAppearance()

*/

void HbProgressBar::setInvertedAppearance(bool inverted)

{

    Q_D( HbProgressBar );

    d->mInvertedAppearance=inverted;

    updatePrimitives();

}

/*!

    @beta

    Returns the maximum value of the progressbar. By default it is 100. 

    \sa setMaximum()

*/

int HbProgressBar::maximum() const

{   

    Q_D( const HbProgressBar );

    return d->mMaximum;

}

/*!

    @beta

    Sets the maximum value of the progressbar. By default it is 100. 

    \param maximum the maximum value

    \sa maximum()

*/

void HbProgressBar::setMaximum(int maximum)

{

    Q_D( HbProgressBar );

    d->setRange(qMin(d->mMinimum,maximum),maximum);

}

/*!

    @beta

    Returns the minimum value of the progressbar. By default it is 0. 

    \sa setMinimum()

*/

int HbProgressBar::minimum() const

{

    Q_D( const HbProgressBar );

    return d->mMinimum;

}

/*!

    @beta

    Sets the minimum value of the progressbar. By default it is 0. 

    \param minimum the minimum value

    \sa minimum()

*/

void HbProgressBar::setMinimum(int minimum)

{

    Q_D( HbProgressBar );

    d->setRange(minimum,qMax(d->mMaximum,minimum));

}

/*!

    @beta

    Returns the current value of the progress bar.

    \sa setProgressValue()

*/

int HbProgressBar::progressValue() const

{

    Q_D( const HbProgressBar );

    return d->mProgressValue;

}

/*!

    @beta

    Sets the progress value of the progressbar. 

    \param value the progress value

    \sa progressValue()

*/

void HbProgressBar::setProgressValue(int value)

{

    Q_D( HbProgressBar );

    d->setProgressValue(value);

}

/*!

    @beta

    This function is provided for convenience.

    Sets the progress bar's minimum and its maximum.

    If  maximum is smaller than minimum, minimum becomes the only valid legal

    value.

    \param minimum the minimum value

    \param maximum the maximum value

*/

void HbProgressBar::setRange(int minimum, int maximum) 

{

    Q_D( HbProgressBar );

    d->setRange(minimum , maximum);

}

/*!

    @beta

    A text can be shown at top,bottom or left-right of the progressbar near minimum and maximum.

    This will set the text near the minimum point.

    \param text mintext string

    \sa minText()

*/

void HbProgressBar::setMinText(const QString &text)

{

    Q_D(HbProgressBar);

    if (d->mMinText != text) {

        d->mMinText = text;

        HbStyleOptionProgressBar progressBarOption;

        progressBarOption.minText = d->mMinText;

        style()->updatePrimitive(d->mMinTextItem,HbStyle::P_ProgressBar_mintext,&progressBarOption);

     }

}

/*!

    @beta

    Returns the Min Text of the progress bar.

    \sa setMinText()

*/

QString HbProgressBar::minText() const

{

    Q_D( const HbProgressBar );

    return d->mMinText;

}

/*!

    @beta

    A text can be shown at top,bottom or left-right of the progressbar near minimum and maximum.

    This will set the text near the minimum point.

    \param text max text string

    \sa maxText()

*/

void HbProgressBar::setMaxText(const QString &text)

{

    Q_D(HbProgressBar);

    if (d->mMaxText != text) {

        d->mMaxText = text;

        HbStyleOptionProgressBar progressBarOption;

        progressBarOption.maxText = d->mMaxText;

        style()->updatePrimitive(d->mMaxTextItem,HbStyle::P_ProgressBar_maxtext,&progressBarOption);

    }

}

/*!

    @beta

    Returns the Max Text of the progress bar.

    \sa setMaxText()

*/

QString HbProgressBar::maxText() const

{

    Q_D( const HbProgressBar );

    return d->mMaxText;

}

/*!

    @beta