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

**

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

#include "hbsliderpopup_p.h"

#include <hbstyle.h>

#include <QDebug>

#include <QTimeLine>

#include <QGraphicsLinearLayout>

/*!   

    internal- HbSliderPopupContentWidget class 

    creates content widget for slider popup

*/

class HbSliderPopupContentWidget : public HbWidget

{

    Q_OBJECT

public:

    HbSliderPopupPrivate *d;

    HbSlider *slider;

    HbSliderPopupContentWidget(HbSliderPopupPrivate *priv,

        QGraphicsItem* parent =0) : HbWidget(parent),d(priv),slider(0)

    {

        d->createSlider();

        slider = d->slider;

        slider->setParentItem(this);

        HbStyle::setItemName( slider,"slider" );

    }

    enum { Type = HbPrivate::ItemType_SliderPopupContentWidget };

    int type() const { return Type; }

};

/*!   

    internal- HbSliderPopupPrivate class ctor

*/

HbSliderPopupPrivate::HbSliderPopupPrivate():slider(0)

{

}

/*!   

    internal- HbSliderPopupPrivate class dtor

*/

HbSliderPopupPrivate::~HbSliderPopupPrivate()

{

}

/*!  

    This is virtual function for creating slider

    derived class can over ride it and return required type of slider

    ex HbVolumeSlider or HbZoomSlider

*/

void HbSliderPopupPrivate::createSlider() 

{

    slider= new HbSlider();

}

/*!   

    This slot will be called when ever value change happens

    This will reset time out interval of popup

*/

void HbSliderPopupPrivate ::_q_valueChanged(int val)

{

    Q_Q(HbSliderPopup);

    startTimeout();

    emit q->valueChanged(val);

}

/*!

   create slider and delegate all signals of slider

*/

void HbSliderPopupPrivate::init()

{

    Q_Q( HbSliderPopup);

    mSliderPopupContentWidget = new HbSliderPopupContentWidget( this );

    q->setContentWidget( mSliderPopupContentWidget );

    q->setBackgroundItem(HbStyle::P_SliderPopup_background);

    HbStyle::setItemName(q->backgroundItem(),QLatin1String("sliderpopup_background"));

    q->connect(mSliderPopupContentWidget->slider,SIGNAL(valueChanged(int)),q,SLOT(_q_valueChanged(int)));

    q->connect(mSliderPopupContentWidget->slider,SIGNAL(sliderPressed()),q,SIGNAL(sliderPressed()));

    q->connect(mSliderPopupContentWidget->slider,SIGNAL(sliderReleased()),q,SIGNAL(sliderReleased()));

    q->connect(mSliderPopupContentWidget->slider,SIGNAL(rangeChanged(int , int  )),

        q,SIGNAL(rangeChanged(int , int  )));

    q->connect(mSliderPopupContentWidget->slider,SIGNAL(sliderMoved(int)),q,SIGNAL(sliderMoved(int)));

    q->connect(mSliderPopupContentWidget->slider,SIGNAL(iconPressed()),q,SIGNAL(iconPressed()));

    q->connect(mSliderPopupContentWidget->slider,SIGNAL(iconReleased()),q,SIGNAL(iconReleased()));

    q->connect(mSliderPopupContentWidget->slider,SIGNAL(iconClicked()),q,SIGNAL(iconClicked()));

    q->connect(mSliderPopupContentWidget->slider,SIGNAL(textClicked()),q,SIGNAL(textClicked()));

    q->setDismissPolicy(HbDialog::TapOutside);

    q->setBackgroundFaded(false);

    q->setModal(false);

    mainLayout->setContentsMargins(0,0,0,0);

    mSliderPopupContentWidget->slider->setFlags(QGraphicsItem::ItemIsFocusable);

}

/*!

    @beta

    @hbwidgets

    \class HbSliderPopup

    \brief HbSliderPopup widget provides a generic vertical or horizontal 

    slider embeeded in a popup.

    HbSliderPopup is a classic widget for controlling a bounded value.

    It lets the user move a slider handle along a horizontal or vertical

    track and translates the handle's position into an integer value

    within the legal range.

    The most important functions are setValue() to set the slider directly

    to some value; and setMinimum() and setMaximum() to define the range

    of the slider.

    HbSliderPopup consists of elements. The available slider elements are

    defined by the Hb::SliderElement enumeration. A set of elements

    can be set by setSliderElements() and currently existing elements can be

    queried by sliderElements().

    HbSliderPopup provides methods for controlling tickmarks.  You can use

    setTickPosition() to indicate where you want the tickmarks to be,

    setMajorTickInterval() and setMinorTickInterval() to indicate how

    many of them you want. The current set tick position and intervals

    can be queried using the tickPosition(), majorTickInterval() and

    minorTickInterval() functions, respectively.

    HbSliderPopup provides a comprehensive set of signals:

    \li valueChanged() Emitted when the slider's value has changed. The tracking()

       determines whether this signal is emitted during user

       interaction.

    \li sliderPressed() Emitted when the user starts to drag the slider.

    \li sliderMoved() Emitted when the user drags the slider.

    \li sliderReleased() Emitted when the user releases the slider.

    \li rangeChanged() Emitted when the range of the slider changes.

    \li iconPressed() Emitted when the user presses the associated slider icon.

    \li iconReleased() Emitted when the user releases the associated slider icon.

    \li iconClicked() Emitted when the user clicks the associated slider icon.

    HbSliderPopup provides only integer ranges. Note that although

    HbSliderPopup handles very large numbers, it becomes difficult for users

    to use a slider accurately for very large ranges.

    The slider handles keys in the following way:

    \li Left/Right moves a horizontal slider by one single step.

    \li Up/Down moves a vertical slider by one single step.

    Example usage:

    \code

    HbSliderPopup *slider = new HbSliderPopup();

    connect(slider, SIGNAL(valueChanged(int)), receiver, SLOT(volumeSliderChanged(int)));

    connect(slider, SIGNAL(iconToggled(bool)), receiver, SLOT(volumeMuted(bool)));

    \endcode

    \sa HbZoomSliderPopup, HbVolumeSliderPopup

*/

/*!

    \fn void HbSliderPopup::valueChanged(int value)

    This signal is emitted when the slider value has changed.

    \sa hasTracking()

*/

/*!

    \fn void HbSliderPopup::sliderPressed()

    This signal is emitted when the slider thumb has been pressed.

*/

/*!

    \fn void HbSliderPopup::sliderReleased()

    This signal is emitted when the slider thumb has been released.

*/

/*!

    \fn void HbSliderPopup::sliderMoved(int value)

    This signal is emitted when the slider position has changed.

    \sa hasTracking()

*/

/*!

    \fn void HbSliderPopup::rangeChanged(int min, int max)

    This signal is emitted when the slider range has changed.

*/

/*!

    \fn void HbSliderPopup::iconPressed()

    This signal is emitted when the slider icon has been pressed.

*/

/*!

    \fn void HbSliderPopup::iconReleased()

    This signal is emitted when the slider icon has been released.

*/

/*!

    \fn void HbSliderPopup::iconClicked()

    This signal is emitted when the slider icon has been clicked.

*/

/*!

    \reimp

    \fn int HbSliderPopup::type() const

 */

/*!

    \enum HbSliderPopup::SliderElement

    This enum defines available slider elements.

 */

/*!

    \var HbSliderPopup::IncreaseElement

    A button to increase the slider value. Usually a plus sign.

 */

/*!

    \var HbSliderPopup::TrackElement

    The slider track that consists of a groove, ticks and handle.

 */

/*!

    \var HbSliderPopup::DecreaseElement

    A button to decrease the slider value. Usually a minus sign.

 */

/*!

    \var HbSliderPopup::IconElement

    An icon element associated to the slider.

 */

/*!

    \var HbSliderPopup::TextElement

    A text element associated to the slider.

 */

/*!

    Constructs a slider embeeded in a popup with \a parent.

    The orientation is \b Qt::Vertical and the slider contains only track element by default.

    \sa setOrientation(), setElements()

*/

HbSliderPopup::HbSliderPopup(QGraphicsItem *parent) :

    HbDialog(*new HbSliderPopupPrivate, parent)

{

    Q_UNUSED( parent);

    Q_D(HbSliderPopup);

    d->q_ptr = this;

    d->init();

}

/*!

Constructs a sliderPopup with a \a orientation and \a parent.

The slider contains only track element by default.

\sa setElements()

*/

HbSliderPopup::HbSliderPopup(Qt::Orientation orientation, QGraphicsItem *parent) :

    HbDialog(*new HbSliderPopupPrivate, parent)

{

    Q_D(HbSliderPopup);

    d->q_ptr = this;

    d->init();

    setOrientation(orientation);

}

/*!

    \internal

 */

HbSliderPopup::HbSliderPopup(HbSliderPopupPrivate &dd, QGraphicsItem *parent) :

    HbDialog(dd, parent)

{

    Q_UNUSED( parent);

    Q_D(HbSliderPopup);

    d->q_ptr = this;

    d->init();

}

/*!

    Destructs the slider.

*/

HbSliderPopup::~HbSliderPopup()

{

}

/*!

    Returns the slider text.

    returns empty text if text element does not exist

    \sa setText()

*/

QString HbSliderPopup::text() const

{

    Q_D(const HbSliderPopup);

    return d->mSliderPopupContentWidget->slider->text();

}

/*!

    Sets the slider \a text for text element 

    Slider will not take care of localization.

    \warning Setting text to a non-existing text element has no effect.

    \sa text()

*/

void HbSliderPopup::setText(const QString &text)

{

    Q_D(HbSliderPopup);

    d->mSliderPopupContentWidget->slider->setText(text);

}

/*!

    Sets whether the tooltip is visible .

    \sa isToolTipVisible()

*/

void HbSliderPopup::setToolTipVisible(bool value)

{

    Q_D(const HbSliderPopup);

    d->mSliderPopupContentWidget->slider->setToolTipVisible(value);

}

/*!

    Returns \c true if tooltip is visible.

    The default value is \c false.

    \sa setToolTipVisible()

*/

bool HbSliderPopup::isToolTipVisible()

{

    Q_D(const HbSliderPopup);

    return d->mSliderPopupContentWidget->slider->isToolTipVisible();

}

/*!

   sets the toolTip Alignment with respect to the thumb.

    \sa toolTipAlignment()

*/

void HbSliderPopup::setToolTipAlignment(Qt::Alignment alignment)

{

    Q_D( HbSliderPopup);

    d->mSliderPopupContentWidget->slider->setToolTipAlignment(alignment);

}

/*!

    returns the tooltip Alignment with respect to the thumb

    \sa setToolTipAlignment()

*/

Qt::Alignment HbSliderPopup::toolTipAlignment() const

{

    Q_D(const HbSliderPopup);

    return d->mSliderPopupContentWidget->slider->toolTipAlignment();

}

/*!

    Returns the major ticklabels of the slider popup.

    \sa setMajorTickLabels()

*/

QStringList HbSliderPopup::majorTickLabels() const

{

    Q_D(const HbSliderPopup);

    return d->mSliderPopupContentWidget->slider->majorTickLabels();

}

/*!

    Sets the major ticklabels of the slider popup.

    Detailed description:

    Strings from the stringlist will be taken sequentially for drawing

    LabelItem,there exists a one-to-one mapping between tickmarkitem &

    tickmarklabelitem.

    case 1: if strings provided > tickmarks, labels are drawn for the

    strings which maps the tickmarkitems.If there are extra strings 

    available in the list beyond 1-1 mapping, those strings will be left out.

    case 2: if strings provided < tickmarks, labels are drawn only for strings

    provided.Rest of the tickmarkitems will be drawn without labelItem.

    case 3: If some tickmarkitems to be drawn without labelItem in the middle,

    specify empty string ("") for that item  in the string list.

    case 4: if both major & minor tickinterval are same,then only majortickLabel

    strings are taken into account for drawing the labelItem

    \sa majorTickLabels()

*/

void HbSliderPopup::setMajorTickLabels(const QStringList &majorTickLabels)

{

    Q_D(HbSliderPopup);

    return d->mSliderPopupContentWidget->slider->setMajorTickLabels(majorTickLabels);

}

/*!

    Returns the minor ticklabels of the slider popup.

    \sa setMajorTickLabels()

*/

QStringList HbSliderPopup::minorTickLabels() const

{

    Q_D(const HbSliderPopup);

    return d->mSliderPopupContentWidget->slider->minorTickLabels();

}

/*!

    Sets the minor ticklabels of the slider popup.

    see setMajorTickLabels for detailed description

    \sa minorTickLabels(),setMajorTickLabels()

*/

void HbSliderPopup::setMinorTickLabels(const QStringList &minorTickLabels)

{

    Q_D(HbSliderPopup);

    d->mSliderPopupContentWidget->slider->setMinorTickLabels(minorTickLabels);

}

/*!

    @beta

    Returns the icon of the \a element.

    returns NULL if element does not exist or icon was not set for this element

    \sa setElementIcon()

*/

HbIcon HbSliderPopup::elementIcon(HbSlider::SliderElement element) const

{

    Q_D(const HbSliderPopup);

}

/*!

    @beta

    Sets the \a icon if the \a element.

    Supported elements:

    \li HbSlider::IncreaseElement

    \li HbSlider::DecreaseElement

    \li HbSlider::IconElement

    \warning Setting icon to a non-existing element has no effect.

    \sa elementIcon() setElements()

*/

void HbSliderPopup::setElementIcon(HbSlider::SliderElement element, const HbIcon &icon)

{

    Q_D( HbSliderPopup);

}

/*!

    @proto

    Returns the map , which consist of element name as key and icon name  as value

    returns NULL map if none of the element has icon

    \sa setElementIcons()

*/

QMap<QString,QVariant> HbSliderPopup::elementIcons( )const

{

    Q_D(const HbSliderPopup);

    return(d->mSliderPopupContentWidget->slider->elementIcons());

}

/*!

    @proto

    Sets the icons for elements

    key of \a elements is element name  QString)  and value is icon

    name to set on given element

    Use following string for specifying elements

    "IncreaseElement" for increase element

    "DecreaseElement" for decrease element

    "IconElement" for icon element

    Eg Usage:

    HbSlider slider;