kdatetimeedit.h

Go to the documentation of this file.

/*
    Copyright 2011 John Layt <john@layt.net>

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/

#ifndef KDATETIMEEDIT_H
#define KDATETIMEEDIT_H

#include <kdeui_export.h>

#include <QtGui/QWidget>

#include "klocale.h"
#include "kdatetime.h"

class KDateTimeEditPrivate;
class KCalendarSystem;

class KDEUI_EXPORT KDateTimeEdit : public QWidget
{
    Q_OBJECT

    Q_PROPERTY(QDate date READ date WRITE setDate NOTIFY dateChanged USER true)
    Q_PROPERTY(QTime time READ time WRITE setTime NOTIFY timeChanged USER true)
    Q_PROPERTY(int timeListInterval READ timeListInterval WRITE setTimeListInterval)
    Q_PROPERTY(Options options READ options WRITE setOptions)
    Q_FLAGS(Options)

public:

    enum Option {
        ShowCalendar     = 0x00001,  
        ShowDate         = 0x00002,  
        ShowTime         = 0x00004,  
        ShowTimeSpec     = 0x00008,  
        //EditCalendar     = 0x00010,  /**< Allow the user to manually edit the calendar */
        EditDate         = 0x00020,  
        EditTime         = 0x00040,  
        //EditTimeSpec     = 0x00080,  /**< Allow the user to manually edit the time spec */
        SelectCalendar   = 0x00100,  
        SelectDate       = 0x00200,  
        SelectTime       = 0x00400,  
        SelectTimeSpec   = 0x00800,  
        DatePicker       = 0x01000,  
        DateKeywords     = 0x02000,  
        ForceTime        = 0x04000,  
        WarnOnInvalid    = 0x08000   
    };
    Q_DECLARE_FLAGS(Options, Option)

    
    explicit KDateTimeEdit(QWidget *parent = 0);

    virtual ~KDateTimeEdit();

    Options options() const;

    KDateTime dateTime() const;

    KLocale::CalendarSystem calendarSystem() const;

    const KCalendarSystem *calendar() const;

    QDate date() const;

    QTime time() const;

    KDateTime::Spec timeSpec() const;

    QList<KLocale::CalendarSystem> calendarSystemsList() const;

    KDateTime minimumDateTime() const;

    KDateTime maximumDateTime() const;

    KLocale::DateFormat dateDisplayFormat() const;

    QMap<QDate, QString> dateMap() const;

    KLocale::TimeFormatOptions timeDisplayFormat() const;

    int timeListInterval() const;

    QList<QTime> timeList() const;

    KTimeZones::ZoneMap timeZones() const;

    bool isValid() const;

    bool isNull() const;

    bool isValidDate() const;

    bool isNullDate() const;
    bool isValidTime() const;

    bool isNullTime() const;

Q_SIGNALS:

    void dateTimeEntered(const KDateTime &dateTime);

    void dateTimeChanged(const KDateTime &dateTime);

    void dateTimeEdited(const KDateTime &dateTime);

    void calendarEntered(KLocale::CalendarSystem calendarSystem);

    void calendarChanged(KLocale::CalendarSystem calendarSystem);

    void dateEntered(const QDate &date);

    void dateChanged(const QDate &date);

    void dateEdited(const QDate &date);

    void timeEntered(const QTime &time);

    void timeChanged(const QTime &time);

    void timeEdited(const QTime &time);

    void timeSpecEntered(const KDateTime::Spec &spec);

    void timeSpecChanged(const KDateTime::Spec &spec);

public Q_SLOTS:

    void setOptions(Options options);

    void setDateTime(const KDateTime &dateTime);

    void setCalendarSystem(KLocale::CalendarSystem calendarSystem);

    void setCalendar(KCalendarSystem *calendar = 0);

    void setDate(const QDate &date);

    void setTime(const QTime &time);

    void setTimeSpec(const KDateTime::Spec &spec);

    void setDateTimeRange(const KDateTime &minDateTime,
                          const KDateTime &maxDateTime,
                          const QString &minWarnMsg = QString(),
                          const QString &maxWarnMsg = QString());

    void resetDateTimeRange();

    void setMinimumDateTime(const KDateTime &minDateTime, const QString &minWarnMsg = QString());

    void resetMinimumDateTime();

    void setMaximumDateTime(const KDateTime &maxDateTime, const QString &maxWarnMsg = QString());

    void resetMaximumDateTime();

    void setDateDisplayFormat(KLocale::DateFormat format);

    void setCalendarSystemsList(QList<KLocale::CalendarSystem> calendars);

    void setDateMap(QMap<QDate, QString> dateMap);

    void setTimeDisplayFormat(KLocale::TimeFormatOptions formatOptions);

    void setTimeListInterval(int minutes);

    void setTimeList(QList<QTime> timeList,
                     const QString &minWarnMsg = QString(),
                     const QString &maxWarnMsg = QString());

    void setTimeZones(const KTimeZones::ZoneMap &zones);

protected:

    virtual bool eventFilter(QObject *object, QEvent *event);
    virtual void focusInEvent(QFocusEvent *event);
    virtual void focusOutEvent(QFocusEvent *event);
    virtual void resizeEvent(QResizeEvent *event);

    virtual void assignDateTime(const KDateTime &dateTime);

    virtual void assignDate(const QDate &date);

    void assignCalendarSystem(KLocale::CalendarSystem calendarSystem);

    virtual void assignTime(const QTime &time);

    void assignTimeSpec(const KDateTime::Spec &spec);

private:

    friend class KDateTimeEditPrivate;
    KDateTimeEditPrivate *const d;

    Q_PRIVATE_SLOT(d, void selectCalendar(int))
    Q_PRIVATE_SLOT(d, void enterCalendar(KLocale::CalendarSystem))
    Q_PRIVATE_SLOT(d, void selectTimeZone(int))
    Q_PRIVATE_SLOT(d, void enterTimeZone(const QString&))
};

Q_DECLARE_OPERATORS_FOR_FLAGS(KDateTimeEdit::Options)

#endif // KDATETIMEEDIT_H