Contents

KDatePicker Class

A date selection widget. More...

Header: #include <KDatePicker>
CMake: find_package(KF6 REQUIRED COMPONENTS WidgetsAddons)
target_link_libraries(mytarget PRIVATE KF6::WidgetsAddons)
Inherits: QFrame

Properties

Public Functions

KDatePicker(QWidget *parent = nullptr)
KDatePicker(const QDate &dt, QWidget *parent = nullptr)
const QDate &date() const
int fontSize() const
bool hasCloseButton() const
void setCloseButton(bool enable)
bool setDate(const QDate &date)
void setFontSize(int)

Reimplemented Public Functions

virtual QSize sizeHint() const override

Signals

void dateChanged(const QDate &date)
void dateEntered(const QDate &date)
void dateSelected(const QDate &date)
void tableClicked()

Detailed Description

Provides a widget for calendar date input.

Different from the previous versions, it now emits two types of signals, either dateSelected() or dateEntered() (see documentation for both signals).

A line edit has been added in the newer versions to allow the user to select a date directly by entering numbers like 19990101 or 990101.

"KDatePicker Widget"

Property Documentation

closeButton : bool

Access functions:

bool hasCloseButton() const
void setCloseButton(bool enable)

date : QDate

Access functions:

const QDate &date() const
bool setDate(const QDate &date)

Notifier signal:

void dateChanged(const QDate &date)

fontSize : int

Access functions:

int fontSize() const
void setFontSize(int)

Member Function Documentation

[explicit] KDatePicker::KDatePicker(QWidget *parent = nullptr)

The constructor. The current date will be displayed initially.

[explicit] KDatePicker::KDatePicker(const QDate &dt, QWidget *parent = nullptr)

The constructor. The given date will be displayed initially.

const QDate &KDatePicker::date() const

Returns the selected date.

Note: Getter function for property date.

See also setDate().

[signal] void KDatePicker::dateChanged(const QDate &date)

This signal is emitted each time the selected date is changed. Usually, this does not mean that the date has been entered, since the date also changes, for example, when another month is selected.

Note: Notifier signal for property date.

See also dateSelected.

[signal] void KDatePicker::dateEntered(const QDate &date)

This signal is emitted when enter is pressed and a VALID date has been entered before into the line edit. Connect to both dateEntered() and dateSelected() to receive all events where the user really enters a date.

[signal] void KDatePicker::dateSelected(const QDate &date)

This signal is emitted each time a day has been selected by clicking on the table (hitting a day in the current month). It has the same meaning as dateSelected() in older versions of KDatePicker.

int KDatePicker::fontSize() const

Returns the font size of the widget elements.

Note: Getter function for property fontSize.

See also setFontSize().

bool KDatePicker::hasCloseButton() const

Returns true if a KDatePicker shows a close-button.

Note: Getter function for property closeButton.

See also setCloseButton.

void KDatePicker::setCloseButton(bool enable)

By calling this method with enable = true, KDatePicker will show a little close-button in the upper button-row. Clicking the close-button will cause the KDatePicker's topLevelWidget()'s close() method being called. This is mostly useful for toplevel datepickers without a window manager decoration.

Note: Setter function for property closeButton.

See also hasCloseButton.

bool KDatePicker::setDate(const QDate &date)

Sets the date.

Returns false and does not change anything if the date given is invalid.

Note: Setter function for property date.

See also date().

void KDatePicker::setFontSize(int)

Sets the font size of the widgets elements.

Note: Setter function for property fontSize.

See also fontSize().

[override virtual] QSize KDatePicker::sizeHint() const

Reimplements: QFrame::sizeHint() const.

The size hint for date pickers. The size hint recommends the minimum size of the widget so that all elements may be placed without clipping. This sometimes looks ugly, so when using the size hint, try adding 28 to each of the reported numbers of pixels.

[signal] void KDatePicker::tableClicked()

This signal is emitted when the day has been selected by clicking on it in the table.