QCalendarWidget Class

The QCalendarWidget class shows a month and lets the user pick a date. More…

List of all members, including inherited members

Public Types

Public Functions

Reimplemented Public Functions

Public Slots

Signals

Reimplemented Protected Functions

Detailed Description

A calendar shows the days of one month in a grid of weeks, with the days before and after it in gray, and a bar above it with the month and the year and buttons for the previous and the next month:

auto *calendar = new QCalendarWidget(window);
calendar->setDateRange(QDate::currentDate(), QDate::currentDate().addYears(1));
connect(calendar, &QCalendarWidget::clicked, [](QDate date) { book(date); });

The user clicks a day, turns the mouse wheel to change the month, or uses the arrow keys (a day or a week), Page Up and Page Down (a month), Home and End (the first and last day of the month) and Return. Dates outside the range cannot be selected.

See also QDateEdit and QDate.

Differences from Qt

Member Type Documentation

enum QCalendarWidget::SelectionMode

Whether the user can select a date.

enum QCalendarWidget::VerticalHeaderFormat

What is shown at the left of the weeks.

Member Function Documentation

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

Constructs a calendar with the given parent. Today is selected and its month is shown; the range is from 1752-09-14 to 9999-12-31, as in Qt.

[override] QCalendarWidget::~QCalendarWidget()

Destroys the calendar.

[signal] void QCalendarWidget::activated(QDate date)

This signal is emitted when the user double-clicks the date or presses Return or Enter on it.

[override, protected] void QCalendarWidget::changeEvent(QEvent *event)

Reimplements QWidget::changeEvent().

[signal] void QCalendarWidget::clicked(QDate date)

This signal is emitted when the user clicks the date, if it is in the range.

[signal] void QCalendarWidget::currentPageChanged(int year, int month)

This signal is emitted when the calendar shows another month: the month of the year.

Qt::DayOfWeek QCalendarWidget::firstDayOfWeek() const

Returns the day in the first column, Qt::Monday by default.

bool QCalendarWidget::isGridVisible() const

Returns whether lines are drawn between the days. The default is false.

bool QCalendarWidget::isNavigationBarVisible() const

Returns whether the navigation bar is shown. The default is true.

[override, protected] void QCalendarWidget::keyPressEvent(QKeyEvent *event)

Reimplements QWidget::keyPressEvent().

The arrow keys move the selection by a day or a week, Page Up and Page Down by a month, Home and End to the first and last day of the month. Return and Enter emit activated().

QDate QCalendarWidget::maximumDate() const

Returns the last date that can be selected.

See also setDateRange().

QDate QCalendarWidget::minimumDate() const

Returns the first date that can be selected.

See also setDateRange().

[override] QSize QCalendarWidget::minimumSizeHint() const

Reimplements QWidget::minimumSizeHint().

int QCalendarWidget::monthShown() const

Returns the month that is shown, from 1 to 12.

[override, protected] void QCalendarWidget::mouseDoubleClickEvent(QMouseEvent *event)

Reimplements QWidget::mouseDoubleClickEvent().

[override, protected] void QCalendarWidget::mousePressEvent(QMouseEvent *event)

Reimplements QWidget::mousePressEvent().

A click on a date in the range selects it and emits clicked(); a date of another month shows that month.

[override, protected] void QCalendarWidget::paintEvent(QPaintEvent *event)

Reimplements QWidget::paintEvent().

[override, protected] void QCalendarWidget::resizeEvent(QResizeEvent *event)

Reimplements QWidget::resizeEvent().

QDate QCalendarWidget::selectedDate() const

Returns the selected date.

See also setSelectedDate().

[signal] void QCalendarWidget::selectionChanged()

This signal is emitted when the selected date changes, by the user or by setSelectedDate().

SelectionMode QCalendarWidget::selectionMode() const

Returns whether the user can select a date, SingleSelection by default.

[slot] void QCalendarWidget::setCurrentPage(int year, int month)

Shows the month of the year, without changing the selected date, and emits currentPageChanged().

[slot] void QCalendarWidget::setDateRange(QDate min, QDate max)

Sets the range of dates that can be selected to min to max, and brings the selected date into it.

void QCalendarWidget::setFirstDayOfWeek(Qt::DayOfWeek dayOfWeek)

Sets the day in the first column to dayOfWeek.

[slot] void QCalendarWidget::setGridVisible(bool show)

Sets whether lines are drawn between the days to show.

void QCalendarWidget::setMaximumDate(QDate date)

Sets the last date that can be selected to date. The first date falls to it if it was later, and the selected date is brought into the range.

void QCalendarWidget::setMinimumDate(QDate date)

Sets the first date that can be selected to date. The last date grows to it if it was earlier, and the selected date is brought into the range.

[slot] void QCalendarWidget::setNavigationBarVisible(bool visible)

Shows the navigation bar if visible is true, and hides it otherwise.

[slot] void QCalendarWidget::setSelectedDate(QDate date)

Selects date if it is in the range, shows its month, and emits selectionChanged() if it changes.

See also selectedDate().

void QCalendarWidget::setSelectionMode(SelectionMode mode)

Sets whether the user can select a date to mode.

void QCalendarWidget::setVerticalHeaderFormat(VerticalHeaderFormat format)

Sets what is shown at the left of the weeks to format.

[slot] void QCalendarWidget::showNextMonth()

Shows the month after the one that is shown.

[slot] void QCalendarWidget::showNextYear()

Shows the month of the next year.

[slot] void QCalendarWidget::showPreviousMonth()

Shows the month before the one that is shown.

[slot] void QCalendarWidget::showPreviousYear()

Shows the month of the previous year.

[slot] void QCalendarWidget::showSelectedDate()

Shows the month of the selected date.

[slot] void QCalendarWidget::showToday()

Shows the month of today.

[override] QSize QCalendarWidget::sizeHint() const

Reimplements QWidget::sizeHint().

VerticalHeaderFormat QCalendarWidget::verticalHeaderFormat() const

Returns what is shown at the left of the weeks, ISOWeekNumbers by default.

[override, protected] void QCalendarWidget::wheelEvent(QWheelEvent *event)

Reimplements QWidget::wheelEvent().

The wheel shows the previous or the next month.

int QCalendarWidget::yearShown() const

Returns the year of the month that is shown.