kdatewidget.h

/* This file is part of the KDE libraries
    Copyright (C) 2001 Waldo Bastian ([email protected])
    Copyright (c) 2007 John Layt <[email protected]>

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License version 2 as published by the Free Software Foundation.

    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 KDATEWIDGET_H
#define KDATEWIDGET_H

#include <kdelibs4support_export.h>

#include <QWidget>

#include "klocale.h"

class KCalendarSystem;

class QDate;

/**
 * @short A date selection widget.
 *
 * This widget can be used to display or allow user selection of a date.
 *
 * \image html kdatewidget.png "KDE Date Widget"
 *
 * @see KDatePicker
 *
 * @author Waldo Bastian <[email protected]>, John Layt <[email protected]>
 */
class KDELIBS4SUPPORT_EXPORT KDateWidget : public QWidget
{
    Q_OBJECT
    Q_PROPERTY(QDate date READ date WRITE setDate NOTIFY changed USER true)
//FIXME    Q_PROPERTY( KCalendarSystem calendar READ calendar WRITE setCalendar USER true )

public:
    /**
     * Constructs a date selection widget.
     */
    KDELIBS4SUPPORT_DEPRECATED explicit KDateWidget(QWidget *parent = nullptr);

    /**
     * Constructs a date selection widget with the initial date set to @p date.
     */
    KDELIBS4SUPPORT_DEPRECATED explicit KDateWidget(const QDate &date, QWidget *parent = nullptr);

    /**
     * Destructs the date selection widget.
     */
    ~KDateWidget() override;

    // KDE5 remove const &
    /**
     * Returns the currently selected date.
     */
    const QDate &date() const;

    /**
     * Changes the selected date to @p date.
     *
     * @return @c true if the date was successfully set, @c false otherwise
     */
    bool setDate(const QDate &date);

    /**
     * Returns the currently selected calendar system.
     *
     * @return a KCalendarSystem object
     */
    const KCalendarSystem *calendar() const;

    /**
     * Changes the calendar system to use.  Can use its own local locale if set.
     *
     * @param calendar the calendar system object to use, defaults to global
     *
     * @return @c true if the calendar system was successfully set, @c false otherwise
     */
    bool setCalendar(KCalendarSystem *calendar = nullptr);

    /**
     * @since 4.6
     *
     * Changes the calendar system to use.  Will always use global locale.
     *
     * @param calendarSystem the calendar system to use
     * @return @c true if the calendar system was successfully set, @c false otherwise
     */
    bool setCalendarSystem(KLocale::CalendarSystem calendarSystem);

Q_SIGNALS:
    /**
     * Emitted whenever the date of the widget
     * is changed, either with setDate() or via user selection.
     */
    void changed(const QDate &date);

protected:
    void initWidget(const QDate &date);

protected Q_SLOTS:
    void slotDateChanged();

private:
    class KDateWidgetPrivate;
    KDateWidgetPrivate *const d;
};

#endif // KDATEWIDGET_H