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

**

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

#include "hbabstractslidercontrol_p.h"

#include <qevent.h>

#include <limits.h>

#include <hbwidgetfeedback.h>

#ifdef HB_EFFECTS

#define HB_SLIDERCONTROL_TYPE "HB_SLIDERCONTROL"

#endif

/*!

    \class HbAbstractSliderControl

    \brief The HbAbstractSliderControl class provides an integer value within a range.

    The class is designed as a common super class for all slider like widgets.

    Here are the main properties of the class:

    \li HbAbstractSliderControl::value: The bounded integer that HbAbstractSliderControl maintains.

    \li HbAbstractSliderControl::minimum: The lowest possible value.

    \li HbAbstractSliderControl::maximum: The highest possible value.

    \li HbAbstractSliderControl::singleStep: The smaller of two natural steps that an

    abstract sliders provides and typically corresponds to the user

    pressing an arrow key.

    \li HbAbstractSliderControl::pageStep: The larger of two natural steps that an abstract

    slider provides and typically corresponds to the user pressing

    PageUp or PageDown.

    \li HbAbstractSliderControl::hasTracking: Whether slider tracking is enabled.

    \li HbAbstractSliderControl::sliderPosition: The current position of the slider. If \l

    tracking is enabled (the default), this is identical to \l value.

    Unity (1) may be viewed as a third step size. setValue() lets you

    set the current value to any integer in the allowed range, not

    just minimum() + \e n * singleStep() for integer values of \e n.

    Some widgets may allow the user to set any value at all; others

    may just provide multiples of singleStep() or pageStep().

    HbAbstractSliderControl emits a comprehensive set of signals:

    \li HbAbstractSliderControl::valueChanged() Emitted when the value has changed. The \l tracking

            determines whether this signal is emitted during user interaction.

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

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

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

    \li HbAbstractSliderControl::actionTriggered(): Emitted when a slider action was triggerd.

    \li HbAbstractSliderControl::rangeChanged(): Emitted when the range has changed.

    HbAbstractSliderControl provides a virtual sliderChange() function that is

    well suited for updating the on-screen representation of

    sliders. By calling triggerAction(), subclasses trigger slider

    actions. Two helper functions \b QStyle::sliderPositionFromValue() and

    \b QStyle::sliderValueFromPosition() help subclasses and styles to map

    screen coordinates to logical range values.

*/

/*!

    \enum HbAbstractSliderControl::SliderAction

    This enum defines available slider actions.

 */

/*!

    \var HbAbstractSliderControl::SliderNoAction

    No action.

 */

/*!

    \var HbAbstractSliderControl::SliderSingleStepAdd

    Add a single step.

 */

/*!

    \var HbAbstractSliderControl::SliderSingleStepSub

    Substract a single step.

 */

/*!

    \var HbAbstractSliderControl::SliderPageStepAdd

    Add a page step.

 */

/*!

    \var HbAbstractSliderControl::SliderPageStepSub

    Substract a page step.

 */

/*!

    \var HbAbstractSliderControl::SliderToMinimum

    Move the slider to its minimum.

 */

/*!

    \var HbAbstractSliderControl::SliderToMaximum

    Move the slider to its maximum.

 */

/*!

    \var HbAbstractSliderControl::SliderMove

    Move the slider to its position.

 */

/*!

    \fn void HbAbstractSliderControl::valueChanged(int value)

    This signal is emitted when the slider value has changed, with the

    new slider \a value as argument.

*/

/*!

    \fn void HbAbstractSliderControl::sliderPressed()

    This signal is emitted when the user presses the slider with the

    mouse, or programmatically when setSliderDown(true) is called.

    \sa sliderReleased(), sliderMoved(), isSliderDown()

*/

/*!

    \fn void HbAbstractSliderControl::sliderMoved(int value)

    This signal is emitted when sliderDown is true and the slider moves. This

    usually happens when the user is dragging the slider. The \a value

    is the new slider position.

    This signal is emitted even when tracking is turned off.

    \sa setTracking(), valueChanged(), isSliderDown(),

    sliderPressed(), sliderReleased()

*/

/*!

    \fn void HbAbstractSliderControl::sliderReleased()

    This signal is emitted when the user releases the slider with the

    mouse, or programmatically when setSliderDown(false) is called.

    \sa sliderPressed() sliderMoved() sliderDown

*/

/*!

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

    This signal is emitted when the slider range has changed, with \a

    min being the new minimum, and \a max being the new maximum.

    \sa minimum, maximum

*/

/*!

    \fn void HbAbstractSliderControl::actionTriggered(int action)

    This signal is emitted when the slider action \a action is

    triggered. Actions are \l SliderSingleStepAdd, \l

    SliderSingleStepSub, \l SliderPageStepAdd, \l SliderPageStepSub,

    \l SliderToMinimum, \l SliderToMaximum, and \l SliderMove.

    When the signal is emitted, the \l sliderPosition has been

    adjusted according to the action, but the \l value has not yet

    been propagated (meaning the valueChanged() signal was not yet

    emitted), and the visual display has not been updated. In slots

    connected to this signal you can thus safely adjust any action by

    calling setSliderPosition() yourself, based on both the action and

    the slider's value.

    \sa triggerAction()

*/

/*!

    \enum HbAbstractSliderControl::SliderChange

    This enum defines different slider changes.

 */

/*!

    \reimp

    \fn int HbAbstractSliderControl::type() const

 */

/*!

    \var HbAbstractSliderControl::SliderRangeChange

    The range has changed.

 */

/*!

    \var HbAbstractSliderControl::SliderOrientationChange

    The orientation has changed.

 */

/*!

    \var HbAbstractSliderControl::SliderStepsChange

    The steps have changed.

 */

/*!

    \var HbAbstractSliderControl::SliderValueChange

    The value has changed.

 */

HbAbstractSliderControlPrivate::HbAbstractSliderControlPrivate()

    : minimum(0), maximum(100), singleStep(1), pageStep(10),

    value(0), position(0), pressValue(-1), tracking(true), blocktracking(false), pressed(false),

    invertedAppearance(false), invertedControls(false),

    orientation(Qt::Vertical), repeatAction(HbAbstractSliderControl::SliderNoAction)

{

}

/*!

 */

HbAbstractSliderControlPrivate::~HbAbstractSliderControlPrivate()

{

}

/*!

 */

void HbAbstractSliderControlPrivate::setSteps(int single, int page)

{

    Q_Q(HbAbstractSliderControl);

    singleStep = qAbs(single);

    pageStep = qAbs(page);

    q->sliderChange(HbAbstractSliderControl::SliderStepsChange);

}

/*!

    @beta

    Constructs an abstract slider with \a parent.

    The \l minimum defaults to \c 0, the \l maximum to \c 100, with a \l

    singleStep size of \c 1 and a \l pageStep size of \c 10, and an initial

    \l value of \c 0.

*/

HbAbstractSliderControl::HbAbstractSliderControl(QGraphicsItem *parent)

    : HbWidget(*new HbAbstractSliderControlPrivate, parent)

{

    Q_D(HbAbstractSliderControl);

    d->q_ptr = this;

}

/*!

    @beta

    Constructs an abstract slider with \a orientation and \a parent.

    The \l minimum defaults to \c 0, the \l maximum to \c 100, with a \l

    singleStep size of \c 1 and a \l pageStep size of \c 10, and an initial

    \l value of \c 0.

*/

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

    : HbWidget(*new HbAbstractSliderControlPrivate, parent)

{

    Q_D(HbAbstractSliderControl);

    d->q_ptr = this;

    setOrientation(orientation);

}

/*!

    @beta

    \internal

 */

HbAbstractSliderControl::HbAbstractSliderControl(HbAbstractSliderControlPrivate &dd, QGraphicsItem *parent) :

    HbWidget(dd, parent)

{

}

/*!

    Destroys the slider.

*/

HbAbstractSliderControl::~HbAbstractSliderControl()

{

}

/*!

    @beta

    Sets the \a orientation.

    The default value is \c Qt::Vertical.

    \sa orientation()

 */

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

{

    Q_D(HbAbstractSliderControl);

    if (d->orientation == orientation)

        return;

    d->orientation = orientation;

    updateGeometry();

    sliderChange(SliderOrientationChange);

}

/*!

    @beta

    Returns the orientation.

    The default value is \c Qt::Vertical.

    \sa setOrientation()

 */

Qt::Orientation HbAbstractSliderControl::orientation() const

{

    Q_D(const HbAbstractSliderControl);

    return d->orientation;

}

/*!

    @beta

    Sets the minimum value of the slider.

    When setting this property, the \l maximum is adjusted if

    necessary to ensure that the range remains valid. Also the

    slider's current value is adjusted to be within the new range.

    \sa minimum()

*/

void HbAbstractSliderControl::setMinimum(int min)

{

    Q_D(HbAbstractSliderControl);

    setRange(min, qMax(d->maximum, min));

}

/*!

    @beta

    Returns the minimum value of the slider.

    The default value is \c 0.

    \sa setMinimum()

*/

int HbAbstractSliderControl::minimum() const

{

    Q_D(const HbAbstractSliderControl);

    return d->minimum;

}

/*!

    @beta

    Sets the maximum value of the slider.

    When setting this property, the \l minimum is adjusted if

    necessary to ensure that the range remains valid.  Also the

    slider's current value is adjusted to be within the new range.

    \sa maximum()

*/

void HbAbstractSliderControl::setMaximum(int max)

{

    Q_D(HbAbstractSliderControl);

    setRange(qMin(d->minimum, max), max);

}

/*!

    @beta

    Returns the maximum value of the slider.

    The default value is \c 100.

    \sa setMaximum()

*/

int HbAbstractSliderControl::maximum() const

{

    Q_D(const HbAbstractSliderControl);

    return d->maximum;

}

/*!

    @beta

    This function is provided for convenience. This function

    sets the slider's minimum to \a min and its maximum to \a max.

    If \a max is smaller than \a min, \a min becomes the only legal

    value.

    \sa minimum() maximum()

*/

void HbAbstractSliderControl::setRange(int min, int max)

{

    Q_D(HbAbstractSliderControl);

    int oldMin = d->minimum;

    int oldMax = d->maximum;

    d->minimum = min;

    d->maximum = qMax(min, max);

    if (oldMin != d->minimum || oldMax != d->maximum) {

        sliderChange(SliderRangeChange);

        emit rangeChanged(d->minimum, d->maximum);

        setValue(d->value); // re-bound

    }

}

/*!

    @beta

    Sets the single step of the slider.

    \sa singleStep()

*/

void HbAbstractSliderControl::setSingleStep(int step)

{

    Q_D(HbAbstractSliderControl);

    if (step != d->singleStep)

        d->setSteps(step, d->pageStep);

}

/*!

    @beta

    Returns the single step of the slider.

    Single step is the smaller of two natural steps that an

    abstract sliders provides and typically corresponds to the user

    pressing an arrow key.

    The default value is \c 1.

    \sa setSingleStep()

*/

int HbAbstractSliderControl::singleStep() const

{

    Q_D(const HbAbstractSliderControl);

    return d->singleStep;

}

/*!

    @beta

    Sets the page step of the slider.

    \sa pageStep()

*/

void HbAbstractSliderControl::setPageStep(int step)

{

    Q_D(HbAbstractSliderControl);

    if (step != d->pageStep)

        d->setSteps(d->singleStep, step);

}

/*!

    @beta

    Returns the page step of the slider.

    Page step is the larger of two natural steps that an abstract slider provides

    and typically corresponds to the user pressing PageUp or PageDown.

    The default value is \c 10.

    \sa setPageStep()

*/

int HbAbstractSliderControl::pageStep() const

{

    Q_D(const HbAbstractSliderControl);

    return d->pageStep;

}

/*!

    @beta

    Sets whether slider tracking is enabled.

    The default value is \c true.

    \sa hasTracking()

*/

void HbAbstractSliderControl::setTracking(bool enable)

{

    Q_D(HbAbstractSliderControl);

    d->tracking = enable;

}

/*!

    @beta

    Returns \c true whether slider tracking is enabled.

    If tracking is enabled (the default), the slider emits the

    valueChanged() signal while the slider is being dragged. If

    tracking is disabled, the slider emits the valueChanged() signal

    only when the user releases the slider.

    \sa setTracking()

*/

bool HbAbstractSliderControl::hasTracking() const

{

    Q_D(const HbAbstractSliderControl);

    return d->tracking;

}

/*!

    @beta

    Sets whether the slider is pressed down.

    The property is set by subclasses in order to let the abstract

    slider know whether or not \l tracking has any effect.

    Changing the slider down property emits the sliderPressed() and

    sliderReleased() signals.