kdatecombobox.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 KDATECOMBOBOX_H
#define KDATECOMBOBOX_H

#include <kdeui_export.h>

#include <QtGui/QWidget>

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

class KDateComboBoxPrivate;
class KCalendarSystem;

class KDEUI_EXPORT KDateComboBox : public KComboBox
{
    Q_OBJECT

    Q_PROPERTY(QDate date READ date WRITE setDate NOTIFY dateChanged USER true)
    Q_PROPERTY(QDate minimumDate READ minimumDate WRITE setMinimumDate RESET resetMinimumDate)
    Q_PROPERTY(QDate maximumDate READ maximumDate WRITE setMaximumDate RESET resetMaximumDate)
    Q_PROPERTY(Options options READ options WRITE setOptions)
    Q_FLAGS(Options)

public:

    enum Option {
        EditDate         = 0x0001,  
        SelectDate       = 0x0002,  
        DatePicker       = 0x0004,  
        DateKeywords     = 0x0008,  
        WarnOnInvalid    = 0x0010   
    };
    Q_DECLARE_FLAGS(Options, Option)

    
    explicit KDateComboBox(QWidget *parent = 0);

    virtual ~KDateComboBox();

    QDate date() const;

    KLocale::CalendarSystem calendarSystem() const;

    const KCalendarSystem *calendar() const;

    bool isValid() const;

    bool isNull() const;

    Options options() const;

    KLocale::DateFormat displayFormat() const;

    QDate minimumDate() const;

    QDate maximumDate() const;

    QMap<QDate, QString> dateMap() const;

Q_SIGNALS:

    void dateEntered(const QDate &date);

    void dateChanged(const QDate &date);

    void dateEdited(const QDate &date);

public Q_SLOTS:

    void setDate(const QDate &date);

    void setCalendarSystem(KLocale::CalendarSystem calendarSystem);

    void setCalendar(KCalendarSystem *calendar = 0);

    void setOptions(Options options);

    void setDisplayFormat(KLocale::DateFormat format);

    void setDateRange(const QDate &minDate,
                      const QDate &maxDate,
                      const QString &minWarnMsg = QString(),
                      const QString &maxWarnMsg = QString());

    void resetDateRange();

    void setMinimumDate(const QDate &minTime, const QString &minWarnMsg = QString());

    void resetMinimumDate();

    void setMaximumDate(const QDate &maxDate, const QString &maxWarnMsg = QString());

    void resetMaximumDate();

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

protected:

    virtual bool eventFilter(QObject *object, QEvent *event);
    virtual void showPopup();
    virtual void hidePopup();
    virtual void mousePressEvent(QMouseEvent *event);
    virtual void wheelEvent(QWheelEvent *event);
    virtual void keyPressEvent(QKeyEvent *event);
    virtual void focusInEvent(QFocusEvent *event);
    virtual void focusOutEvent(QFocusEvent *event);
    virtual void resizeEvent(QResizeEvent *event);

    virtual void assignDate(const QDate &date);

    virtual void assignCalendarSystem(KLocale::CalendarSystem calendarSystem);

private:

    friend class KDateComboBoxPrivate;
    KDateComboBoxPrivate *const d;

    Q_PRIVATE_SLOT(d, void clickDate())
    Q_PRIVATE_SLOT(d, void selectDate(QAction*))
    Q_PRIVATE_SLOT(d, void editDate(const QString&))
    Q_PRIVATE_SLOT(d, void enterDate(const QDate&))
    Q_PRIVATE_SLOT(d, void parseDate())

};

Q_DECLARE_OPERATORS_FOR_FLAGS(KDateComboBox::Options)

#endif // KDATECOMBOBOX_H