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

**

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

#include "hbdatetimepicker_p.h"

#include "hbstyleoption_p.h"

/*!

    @beta

    \class HbDateTimePicker

    \brief The HbDateTimePicker class provides a widget that has multiple vertical tumblers 

    for selecting a date, time, or date and time by flick, drag and tap gestures.

    The number of tumblers depends on the display format. The default constructor creates

    a widget for selecting a date by internally setting the display format to the default 

    locale's short date format. Other constructors enable you to create a widget

    for selecting a time or date and time by passing a QTime or QDateTime variable as an 

    argument. Internally these constructors set the display format to the default locale's

    short time or date and time format, respectively.

    Use setDisplayFormat() to set the display format. Be aware that changing the display format 

    can change the widget from one for selecting the date to one for selecting the time, for 

    example.

    Looping is enabled in the tumblers. The general appearance of the widget depends on the 

    theme that is in use.

    <TABLE border="0">

    <TR><TD>\image html hbdatetimepicker_date.png "Display format: d.MMMM"</TD>

    <TD></TD>

    <TD>\image html hbdatetimepicker_time.png "Display format: h.m.AP"</TD></TR>

    </TABLE>

    You can set the range of values available in the tumblers by defining minimum and maximum 

    values or using convenience range functions. If you change the range, if necessary 

    the widget changes the displayed values so that they are within the new range. Users 

    cannot select a value outside the range. One effect of this is that if you set, 

    for example, an afternoon time range, users cannot scroll to the AM value when the 

    display format includes an AM/PM tumbler. The date range is currently independent of the 

    time range.

    You can use setInterval() to define the increments for the minute tumbler. This is 

    useful when you want users to be able to set the time in 15 minute increments, for example.

    The number of rows displayed depends on how much space is available. To change the number 

    of rows shown when the widget is is in a layout, for example, use 

    QGraphicsLayoutItem::setPreferredHeight() to increase the space available. The widget then

    increases the number of rows to occupy the available space. 

    %HbDateTimePicker emits a dateChanged(), timeChanged() or dateTimeChanged() signal when 

    the user selects a new value. The selected date, time, or date and time value is passed

    in a QDate, QTime, or QDateTime argument. 

    \section _usecases_hbdatetimepicker Using HbDateTimePicker

    The following example demonstrates creating a widget for selecting a date:

    \code

    // Use the default constructor to create a widget for selecting a date.

    HbDateTimePicker *datePicker = new HbDateTimePicker();

    // Set the minumum and maximum dates to display.

    datePicker->setMinimumDate(QDate::currentDate());

    datePicker->setMaximumDate(QDate::currentDate().addDays(365));

    // Specify the display format.

    datePicker->setDisplayFormat("dd.MMMM.yyyy");

    \endcode

    The following example demonstrates connecting the dateChanged() signal to a slot

    on an object, \a d, of a class (not shown). This has a \c setMeetingDate() function 

    that takes a QDate argument.

    \code

    QObject::connect(datePicker, SIGNAL(dateChanged(const QDate&)),

                     d, SLOT(setMeetingDate(const QDate&)));

    \endcode

    The following example demonstrates creating a widget for selecting a time:

    \code

    // Create a widget for selecting a time.

    HbDateTimePicker *timePicker = new HbDateTimePicker(QTime());

    // Set the minimum and maximum times using the convenience range method.

    timePicker->setTimeRange(QTime::currentTime(),

                             QTime::currentTime().addSecs(10*60*60));

    // Set the time interval to be 15 minutes.

    timePicker->setInterval(QDateTimeEdit::MinuteSection, 15);

    // Specify the display format.

    timePicker->setDisplayFormat("hh:mm.ap");

    \endcode

    The following example demonstrates creating a widget for selecting a date and time:

    \code

    // Create a widget for selecting a date and time.

    HbDateTimePicker *dateTimePicker =

            new HbDateTimePicker(QDateTime::currentDateTime());

    // Specify the display format.

    dateTimePicker->setDisplayFormat("dd.MM.yyyy.hh.mm.ap");

    \endcode

    The properties that hold the minimum and maximum values take a QDate, QTime 

    or QDateTime object as an argument. DocML does not directly support properties that

    use QDate, QTime or QDateTime as a parameter. This means that when you add an \b %HbDateTimePicker 

    widget in Application Designer, you must pass the date, time and date and time to these

    properties as a string in a valid ISO 8601 extended format. For example, YYYY-MM-DD for dates, 

    hh:mm:ss for times, and YYYY-MM-DDTHH:MM:SS for combined dates and times. 

    Here is an example of the \c maximumTime property defined in DocML:

    \code

    <widget name="t:dtp" type="HbDateTimePicker">

        <!-- 'maximumTime' is a QTime property of HbDateTimePicker. -->

        <string name ="displayFormat" value="hh:mm:ss" />

        <string name="maximumTime" value="08:30:00" />

    </widget>

    \endcode

    \section _methodgroups_HbDateTimePicker Function groups

    \li \b Range: setDateRange(), setTimeRange(), setDateTimeRange()

    \li \b Minimum \b value: setMinimumDate(), setMinimumTime(), setMinimumDateTime()

    \li \b Maximum \b value: setMaximumDate(), setMaximumTime(), setMaximumDateTime()

    \li \b Time \b interval: setInterval()

    \sa HbDateTimeEdit, HbTumbleView, HbExtendedLocale

*/

/*!

    \fn void HbDateTimePicker::dateChanged(const QDate &date);

    This signal is emitted when there is a change in the day, month or year selected.

    The new date is passed in \a date.

*/

/*!

    \fn void HbDateTimePicker::timeChanged(const QTime &time);

    This signal is emitted when there is a change in the hour, minute, second, or AM/PM

    selected. The new time is passed in \a time.

*/

/*!

    \fn void HbDateTimePicker::dateTimeChanged(const QDateTime &datetime);

    This signal is emitted when there is a change in the value selected in any of the

    tumblers in a date and time picker. The new date and time are passed in \a dateTime.

*/

/*!

    Constructs an %HbDateTimePicker object with the locale's default short date display format 

    and with parent \a parent.

*/

HbDateTimePicker::HbDateTimePicker( QGraphicsItem *parent ):

HbWidget(*new HbDateTimePickerPrivate, parent)

{

    Q_D(HbDateTimePicker);

    //no mode passed so it should take date as mode by default

    d->init(QVariant::Date);

    setDateTime(QDateTime::currentDateTime());

}

/*!

    Constructs an %HbDateTimePicker object with the locale's default short date and time 

    display format and with parent \a parent.

*/

HbDateTimePicker::HbDateTimePicker(const QDateTime &datetime, QGraphicsItem *parent ):

HbWidget(*new HbDateTimePickerPrivate, parent)

{

    Q_D(HbDateTimePicker);

    d->init(QVariant::DateTime);

    setDateTime(datetime);

}

/*!

    Constructs an %HbDateTimePicker object with the locale's default short date 

    display format and with parent \a parent.

*/

HbDateTimePicker::HbDateTimePicker(const QDate &date, QGraphicsItem *parent ):

HbWidget(*new HbDateTimePickerPrivate, parent)

{

    Q_D(HbDateTimePicker);

    d->init(QVariant::Date);

    setDate(date);

}

/*!

    Constructs an %HbDateTimePicker object with the locale's default time 

    display format and with parent \a parent.

*/

HbDateTimePicker::HbDateTimePicker(const QTime &time, QGraphicsItem *pParent ):

HbWidget(*new HbDateTimePickerPrivate, pParent)

{

    Q_D(HbDateTimePicker);

    d->init(QVariant::Time);

    setTime(time);

}

/*!

    Protected constructor for derivations.

    The default mode is date and time. If another mode is required, set the mDateTimeMode 

    variable explicitly in the constructor of the class derived from HbDateTimePicker. This 

    does not set the default date and time value. 

    \sa setDateTime(), setTime(), setDate()

*/

HbDateTimePicker::HbDateTimePicker(HbDateTimePickerPrivate &dd, QGraphicsItem *parent):

HbWidget(dd, parent)

{

    Q_D(HbDateTimePicker);

    d->init(QVariant::DateTime);

}

bool HbDateTimePicker::event(QEvent *e)

    bool result = HbWidget::event(e);

        updatePrimitives();

    }

    return result;

}

/*!

    Destructor.

*/

HbDateTimePicker::~HbDateTimePicker()

{

}

/*!

    Returns the current display format as a QString value.

    \sa setDisplayFormat()

 */

QString HbDateTimePicker::displayFormat() const

{

    Q_D(const HbDateTimePicker);

    return d->mFormat;

}

/*!

    Sets the display format using a suitable combination of the following expressions 

    in QString format.

    These expressions may be used for the date:

    <TABLE>

    <TR><TD><b><b>Expression </b></TD><TD><b>Output</b> </TD></b></TR>

    <TR><TD> d </TD><TD> The day as a number without a leading zero (1 to 31).</TD></TR>

    <TR><TD> dd </TD><TD> The day as a number with a leading zero (01 to 31). </TD></TR>

    <TR><TD> ddd </TD><TD>The abbreviated localized day name (such as <i>Mon</i> to <i>Sun</i>).

            Uses QDate::shortDayName().</TD></TR>

    <TR><TD> dddd </TD><TD>The long localized day name (such as <i>Monday</i> to <i>Sunday</i>).

            Uses QDate::longDayName().</TD></TR>

    <TR><TD> M </TD><TD> The month as a number without a leading zero (1 to 12).</TD></TR>

    <TR><TD> MM </TD><TD> The month as a number with a leading zero (01 to 12).</TD></TR>

    <TR><TD> MMM </TD><TD>The abbreviated localized month name (such as <i>Jan</i> to <i>Dec</i>).

            Uses QDate::shortMonthName().</TD></TR>

    <TR><TD> MMMM </TD><TD>The long localized month name (such as <i>January</i> to <i>December</i>).

            Uses QDate::longMonthName().</TD></TR>

    <TR><TD> yy </TD><TD>The year as a two digit number (00 to 99).</TD></TR>

    <TR><TD> yyyy </TD><TD>The year as a four digit number. If the year is negative,

            a minus sign is prepended.</TD></TR>

    </TABLE>

    These expressions may be used for the time:

    <TABLE>

    <TR><TD><b><b>Expression </b></TD><TD><b>Output</b> </TD></b></TR>

    <TR><TD> h </TD><TD>The hour without a leading zero (0 to 23 or 1 to 12).</TD></TR>

    <TR><TD> hh </TD><TD>The hour with a leading zero (00 to 23 or 01 to 12). </TD></TR>

    <TR><TD>H   </TD><TD>The hour without a leading zero (0 to 23, even with AM/PM display).</TD></TR>

    <TR><TD>HH  </TD><TD>The hour with a leading zero (00 to 23, even with AM/PM display).</TD></TR>

    <TR><TD> m </TD><TD>The minute without a leading zero (0 to 59).</TD></TR>

    <TR><TD> mm </TD><TD>The minute with a leading zero (00 to 59).</TD></TR>

    <TR><TD> s </TD><TD>The second without a leading zero (0 to 59).</TD></TR>

    <TR><TD> ss </TD><TD>The second with a leading zero (00 to 59).</TD></TR>

    <TR><TD>AP or A </TD><TD>Displays AM and PM.</i></TD></TR>

    <TR><TD>ap or a </TD><TD>Displays am and pm.</TD></TR>

    </TABLE>

    \note Currently you must include separators in the format; for example, 'dd.mm.yy'. 

    \sa displayFormat()

*/

void HbDateTimePicker::setDisplayFormat(const QString &format)

{

    Q_D(HbDateTimePicker);

    if(d->isFormatValid(format)){

        d->mFormat = format;

}

/*!

    Returns the currently selected date in QDate format.

    \note DocML does not directly support properties that use QDate as a parameter. For these 

    properties, pass the date as a string in a valid ISO 8601 extended format,

    such as YYYY-MM-DD.

    \code

    <widget name="t:dtp" type="HbDateTimePicker">

        <!-- 'date' is a QDate property of HbDateTimePicker. -->

        <string name="date" value="02-02-15" />

    </widget>

    \endcode

    \sa setDate()

*/

QDate HbDateTimePicker::date() const

{

    Q_D(const HbDateTimePicker);

    return d->mDateTime.date();

}

/*!

    Sets the current date to \a date.

    \param date The date in QDate format.

    \sa date()

*/

void HbDateTimePicker::setDate(const QDate& date)

{

    Q_D(HbDateTimePicker);

    setDateTime(QDateTime(date,d->mDateTime.time()));

}

/*!

    Returns the minimum date in QDate format.

    \note DocML does not directly support properties that use QDate as a parameter. For these 

    properties, pass the date as a string in a valid ISO 8601 extended format, such as YYYY-MM-DD.

    \code

    <widget name="t:dtp" type="HbDateTimePicker">

        <!-- 'minimumDate' is a QDate property of HbDateTimePicker. -->

        <string name="minimumDate" value="02-02-15" />

    </widget>

    \endcode

    \sa setMinimumDate()

*/

QDate HbDateTimePicker::minimumDate()const

{

    Q_D(const HbDateTimePicker);

    return d->mMinimumDate.date();

}

/*!

    Sets the minimum date to \a date. 

    \param date The minimum date in QDate format.

    \sa minimumDate(), setDateRange()

*/

void HbDateTimePicker::setMinimumDate(const QDate& date)

{

    Q_D(HbDateTimePicker);

    setMinimumDateTime(QDateTime(date, d->mMinimumDate.time()));

}

/*!

    Returns the maximum date in QDate format.

    \note DocML does not directly support properties that use QDate as a parameter. For these 

    properties, pass the date as a string in a valid ISO 8601 extended format, such as YYYY-MM-DD.

    \code

    <widget name="t:dtp" type="HbDateTimePicker">

        <!-- 'maximumDate' is a QDate property of HbDateTimePicker. -->

        <string name="maximumDate" value="02-02-15" />

    </widget>

    \endcode

    \sa setMaximumDate()

*/

QDate HbDateTimePicker::maximumDate()const

{

    Q_D(const HbDateTimePicker);

    return d->mMaximumDate.date();

}

/*!

    Sets the maximum date to \a date. 

    \param date The maximum date in QDate format.

    \sa maximumDate(), setDateRange()

*/

void HbDateTimePicker::setMaximumDate(const QDate& date)

{

    Q_D(HbDateTimePicker);

    setMaximumDateTime(QDateTime(date, d->mMaximumDate.time()));

}

/*!

    Sets the minimum and maximum dates.

    \param minDate The minimum date in QDate format.

    \param maxDate The maximum date in QDate format.

    \sa setMinimumDate(), setMaximumDate()

*/

void HbDateTimePicker::setDateRange(const QDate &minDate, const QDate &maxDate)

{

    Q_D(HbDateTimePicker);

    setDateTimeRange(QDateTime(minDate, d->mMinimumDate.time()),

                         QDateTime(maxDate, d->mMaximumDate.time()));

}

/*!

    Returns the currently selected date and time in QDateTime format.

    \note DocML does not directly support properties that use QDate, QTime or QDateTime as a 

    parameter. For these properties, pass the date, time or date and time as a string in a 

    valid ISO 8601 extended format. For example, YYYY-MM-DD for dates and YYYY-MM-DDTHH:MM:SS

    for combined dates and times.

    \code

    <widget name="t:dtp" type="HbDateTimePicker">

        <!-- 'dateTime' is a QDateTime property of HbDateTimePicker. -->

        <string name="dateTime" value="02-02-15T02-15-30" />

    </widget>

    \endcode

    \sa setDateTime()

*/

QDateTime HbDateTimePicker::dateTime()const

{

    Q_D(const HbDateTimePicker);

    return d->mDateTime;

}

/*!

    Sets the current date and time.

    \param datetime The date and time in QDateTime format.

    \sa dateTime()

*/

void HbDateTimePicker::setDateTime(const QDateTime &datetime)

{

    Q_D(HbDateTimePicker);

    d->setDateTime(datetime);

}