Member Function Documentation

QCalendarWidget::QCalendarWidget(QWidget *parent = nullptr)

Constructs a calendar widget with the given parent.

The widget is initialized with the current month and year, and the currently selected date is today.

See also setCurrentPage().

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

This signal is emitted whenever the user presses the Return or Enter key or double-clicks a date in the calendar widget.

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

This signal is emitted when a mouse button is clicked. The date the mouse was clicked on is specified by date. The signal is only emitted when clicked on a valid date, e.g., dates are not outside the minimumDate() and maximumDate(). If the selection mode is NoSelection, this signal will not be emitted.

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

This signal is emitted when the currently shown month is changed. The new year and month are passed as parameters.

See also setCurrentPage().

[signal] void QCalendarWidget::selectionChanged()

This signal is emitted when the currently selected date is changed.

The currently selected date can be changed by the user using the mouse or keyboard, or by the programmer using setSelectedDate().

See also selectedDate().

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

Displays the given month of the given year without changing the selected date. Use the setSelectedDate() function to alter the selected date.

The currently displayed month and year can be retrieved using the monthShown() and yearShown() functions respectively.

See also yearShown(), monthShown(), showPreviousMonth(), showNextMonth(), showPreviousYear(), and showNextYear().

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

Defines a date range by setting the minimumDate and maximumDate properties.

The date range restricts the user selection, i.e. the user can only select dates within the specified date range. Note that

QCalendarWidget *calendar;

calendar->setDateRange(min, max);

is analogous to

QCalendarWidget *calendar;

calendar->setMinimumDate(min);
calendar->setMaximumDate(max);

If either the min or max parameters are not valid QDate objects, this function does nothing.

See also setMinimumDate() and setMaximumDate().

[slot] void QCalendarWidget::showNextMonth()

Shows the next month relative to the currently displayed month. Note that the selected date is not changed.

See also showPreviousMonth(), setCurrentPage(), and setSelectedDate().

[slot] void QCalendarWidget::showNextYear()

Shows the currently displayed month in the next year relative to the currently displayed year. Note that the selected date is not changed.

See also showPreviousYear(), setCurrentPage(), and setSelectedDate().

[slot] void QCalendarWidget::showPreviousMonth()

Shows the previous month relative to the currently displayed month. Note that the selected date is not changed.

See also showNextMonth(), setCurrentPage(), and setSelectedDate().

[slot] void QCalendarWidget::showPreviousYear()

Shows the currently displayed month in the previous year relative to the currently displayed year. Note that the selected date is not changed.

See also showNextYear(), setCurrentPage(), and setSelectedDate().

[slot] void QCalendarWidget::showSelectedDate()

Shows the month of the selected date.

See also selectedDate() and setCurrentPage().

[slot] void QCalendarWidget::showToday()

Shows the month of the today's date.

See also selectedDate() and setCurrentPage().

[virtual] QCalendarWidget::~QCalendarWidget()

Destroys the calendar widget.

QMap<QDate, QTextCharFormat> QCalendarWidget::dateTextFormat() const

Returns a QMap from QDate to QTextCharFormat showing all dates that use a special format that alters their rendering.

See also setDateTextFormat().

QTextCharFormat QCalendarWidget::dateTextFormat(const QDate &date) const

Returns a QTextCharFormat for date. The char format can be be empty if the date is not renderd specially.

[override virtual protected] bool QCalendarWidget::event(QEvent *event)

Reimplements: QWidget::event(QEvent *event).

[override virtual protected] bool QCalendarWidget::eventFilter(QObject *watched, QEvent *event)

Reimplements: QObject::eventFilter(QObject *watched, QEvent *event).

QTextCharFormat QCalendarWidget::headerTextFormat() const

Returns the text char format for rendering the header.

See also setHeaderTextFormat().

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

Reimplements: QWidget::keyPressEvent(QKeyEvent *event).

[override virtual] QSize QCalendarWidget::minimumSizeHint() const

Reimplements an access function for property: QWidget::minimumSizeHint.

int QCalendarWidget::monthShown() const

Returns the currently displayed month. Months are numbered from 1 to 12.

See also yearShown() and setCurrentPage().

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

Reimplements: QWidget::mousePressEvent(QMouseEvent *event).

[virtual protected] void QCalendarWidget::paintCell(QPainter *painter, const QRect &rect, const QDate &date) const

Paints the cell specified by the given date, using the given painter and rect.

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

Reimplements: QWidget::resizeEvent(QResizeEvent *event).

void QCalendarWidget::setDateTextFormat(const QDate &date, const QTextCharFormat &format)

Sets the format used to render the given date to that specified by format.

If date is null, all date formats are cleared.

See also dateTextFormat().

void QCalendarWidget::setHeaderTextFormat(const QTextCharFormat &format)

Sets the text char format for rendering the header to format. If you also set a weekday text format, this format's foreground and background color will take precedence over the header's format. The other formatting information will still be decided by the header's format.

See also headerTextFormat().

void QCalendarWidget::setWeekdayTextFormat(Qt::DayOfWeek dayOfWeek, const QTextCharFormat &format)

Sets the text char format for rendering of day in the week dayOfWeek to format. The format will take precedence over the header format in case of foreground and background color. Other text formatting information is taken from the headers format.

See also weekdayTextFormat() and setHeaderTextFormat().

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

Reimplements an access function for property: QWidget::sizeHint.

[protected] void QCalendarWidget::updateCell(const QDate &date)

Updates the cell specified by the given date unless updates are disabled or the cell is hidden.

This function was introduced in Qt 4.4.

See also updateCells(), yearShown(), and monthShown().

[protected] void QCalendarWidget::updateCells()

Updates all visible cells unless updates are disabled.

This function was introduced in Qt 4.4.

See also updateCell().

QTextCharFormat QCalendarWidget::weekdayTextFormat(Qt::DayOfWeek dayOfWeek) const

Returns the text char format for rendering of day in the week dayOfWeek.

See also setWeekdayTextFormat() and headerTextFormat().

int QCalendarWidget::yearShown() const

Returns the year of the currently displayed month. Months are numbered from 1 to 12.

See also monthShown() and setCurrentPage().