Home · All Classes · Modules

QCalendarWidget Class Reference
^{^{[QtGui module]}}

The QCalendarWidget class provides a monthly based calendar widget allowing the user to select a date. More...

Inherits QWidget.

Types

enum HorizontalHeaderFormat { NoHorizontalHeader, SingleLetterDayNames, ShortDayNames, LongDayNames }
enum SelectionMode { NoSelection, SingleSelection }
enum VerticalHeaderFormat { NoVerticalHeader, ISOWeekNumbers }

Methods

__init__ (self, QWidget parent = None)
int dateEditAcceptDelay (self)
dict-of-QDate-QTextCharFormat dateTextFormat (self)
QTextCharFormat dateTextFormat (self, QDate date)
bool event (self, QEvent event)
bool eventFilter (self, QObject watched, QEvent event)
Qt.DayOfWeek firstDayOfWeek (self)
QTextCharFormat headerTextFormat (self)
HorizontalHeaderFormat horizontalHeaderFormat (self)
bool isDateEditEnabled (self)
bool isGridVisible (self)
bool isHeaderVisible (self)
bool isNavigationBarVisible (self)
keyPressEvent (self, QKeyEvent event)
QDate maximumDate (self)
QDate minimumDate (self)
QSize minimumSizeHint (self)
int monthShown (self)
mousePressEvent (self, QMouseEvent event)
paintCell (self, QPainter painter, QRect rect, QDate date)
resizeEvent (self, QResizeEvent event)
QDate selectedDate (self)
SelectionMode selectionMode (self)
setCurrentPage (self, int year, int month)
setDateEditAcceptDelay (self, int delay)
setDateEditEnabled (self, bool enable)
setDateRange (self, QDate min, QDate max)
setDateTextFormat (self, QDate date, QTextCharFormat color)
setFirstDayOfWeek (self, Qt.DayOfWeek dayOfWeek)
setGridVisible (self, bool show)
setHeaderTextFormat (self, QTextCharFormat format)
setHeaderVisible (self, bool show)
setHorizontalHeaderFormat (self, HorizontalHeaderFormat format)
setMaximumDate (self, QDate date)
setMinimumDate (self, QDate date)
setNavigationBarVisible (self, bool visible)
setSelectedDate (self, QDate date)
setSelectionMode (self, SelectionMode mode)
setVerticalHeaderFormat (self, VerticalHeaderFormat format)
setWeekdayTextFormat (self, Qt.DayOfWeek dayOfWeek, QTextCharFormat format)
showNextMonth (self)
showNextYear (self)
showPreviousMonth (self)
showPreviousYear (self)
showSelectedDate (self)
showToday (self)
QSize sizeHint (self)
updateCell (self, QDate date)
updateCells (self)
VerticalHeaderFormat verticalHeaderFormat (self)
QTextCharFormat weekdayTextFormat (self, Qt.DayOfWeek dayOfWeek)
int yearShown (self)

Qt Signals

void activated (const QDate&)
void clicked (const QDate&)
void currentPageChanged (int,int)
void selectionChanged ()

Detailed Description

The QCalendarWidget class provides a monthly based calendar widget allowing the user to select a date.

The widget is initialized with the current month and year, but QCalendarWidget provides several public slots to change the year and month that is shown.

By default, today's date is selected, and the user can select a date using both mouse and keyboard. The currently selected date can be retrieved using the selectedDate() function. It is possible to constrain the user selection to a given date range by setting the minimumDate and maximumDate properties. Alternatively, both properties can be set in one go using the setDateRange() convenience slot. Set the selectionMode property to NoSelection to prohibit the user from selecting at all. Note that a date also can be selected programmatically using the setSelectedDate() slot.

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

A newly created calendar widget uses abbreviated day names, and both Saturdays and Sundays are marked in red. The calendar grid is not visible. The week numbers are displayed, and the first column day is Sunday.

The notation of the days can be altered to a single letter abbreviations ("M" for "Monday") by setting the horizontalHeaderFormat property to QCalendarWidget.SingleLetterDayNames. Setting the same property to QCalendarWidget.LongDayNames makes the header display the complete day names. The week numbers can be removed by setting the verticalHeaderFormat property to QCalendarWidget.NoVerticalHeader. The calendar grid can be turned on by setting the gridVisible property to true using the setGridVisible() function:

 QCalendarWidget *calendar;
 calendar->setGridVisible(true);

Finally, the day in the first column can be altered using the setFirstDayOfWeek() function.

The QCalendarWidget class also provides three signals, selectionChanged(), activated() and currentPageChanged() making it possible to respond to user interaction.

The rendering of the headers, weekdays or single days can be largely customized by setting QTextCharFormat's for some special weekday, a special date or for the rendering of the headers.

Only a subset of the properties in QTextCharFormat are used by the calendar widget. Currently, the foreground, background and font properties are used to determine the rendering of individual cells in the widget.

Type Documentation

QCalendarWidget.HorizontalHeaderFormat

This enum type defines the various formats the horizontal header can display.

Constant	Value	Description
`QCalendarWidget.SingleLetterDayNames`	`1`	The header displays a single letter abbreviation for day names (e.g. M for Monday).
`QCalendarWidget.ShortDayNames`	`2`	The header displays a short abbreviation for day names (e.g. Mon for Monday).
`QCalendarWidget.LongDayNames`	`3`	The header displays complete day names (e.g. Monday).
`QCalendarWidget.NoHorizontalHeader`	`0`	The header is hidden.

QCalendarWidget.SelectionMode

This enum describes the types of selection offered to the user for selecting dates in the calendar.

Constant	Value	Description
`QCalendarWidget.NoSelection`	`0`	Dates cannot be selected.
`QCalendarWidget.SingleSelection`	`1`	Single dates can be selected.

See also selectionMode.

QCalendarWidget.VerticalHeaderFormat

This enum type defines the various formats the vertical header can display.

Constant	Value	Description
`QCalendarWidget.ISOWeekNumbers`	`1`	The header displays ISO week numbers as described by QDate.weekNumber().
`QCalendarWidget.NoVerticalHeader`	`0`	The header is hidden.

Method Documentation

QCalendarWidget.init (self, QWidget parent = None)

The parent argument, if not None, causes self to be owned by Qt instead of PyQt.

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().

int QCalendarWidget.dateEditAcceptDelay (self)

dict-of-QDate-QTextCharFormat QCalendarWidget.dateTextFormat (self)

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 (self, QDate date)

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

bool QCalendarWidget.event (self, QEvent event)

Reimplemented from QObject.event().

bool QCalendarWidget.eventFilter (self, QObject watched, QEvent event)

Reimplemented from QObject.eventFilter().

Qt.DayOfWeek QCalendarWidget.firstDayOfWeek (self)

QTextCharFormat QCalendarWidget.headerTextFormat (self)

Returns the text char format for rendering the header.

See also setHeaderTextFormat().

HorizontalHeaderFormat QCalendarWidget.horizontalHeaderFormat (self)

bool QCalendarWidget.isDateEditEnabled (self)

bool QCalendarWidget.isGridVisible (self)

bool QCalendarWidget.isHeaderVisible (self)

bool QCalendarWidget.isNavigationBarVisible (self)

QCalendarWidget.keyPressEvent (self, QKeyEvent event)

Reimplemented from QWidget.keyPressEvent().

QDate QCalendarWidget.maximumDate (self)

QDate QCalendarWidget.minimumDate (self)

QCalendarWidget.paintCell (self, QPainter painter, QRect rect, QDate date)

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

QCalendarWidget.resizeEvent (self, QResizeEvent event)

Reimplemented from QWidget.resizeEvent().

QDate QCalendarWidget.selectedDate (self)

SelectionMode QCalendarWidget.selectionMode (self)

QCalendarWidget.setCurrentPage (self, int year, int month)

This method is also a Qt slot with the C++ signature void setCurrentPage(int,int).

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().

QCalendarWidget.setDateEditAcceptDelay (self, int delay)

QCalendarWidget.setDateEditEnabled (self, bool enable)

QCalendarWidget.setDateRange (self, QDate min, QDate max)

This method is also a Qt slot with the C++ signature void setDateRange(const QDate&,const QDate&).

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().

QCalendarWidget.setDateTextFormat (self, QDate date, QTextCharFormat color)

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().

QCalendarWidget.setFirstDayOfWeek (self, Qt.DayOfWeek dayOfWeek)

QCalendarWidget.setGridVisible (self, bool show)

QCalendarWidget.setHeaderTextFormat (self, 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().

QCalendarWidget.setHeaderVisible (self, bool show)

QCalendarWidget.setHorizontalHeaderFormat (self, HorizontalHeaderFormat format)

QCalendarWidget.setMaximumDate (self, QDate date)

QCalendarWidget.setMinimumDate (self, QDate date)

QCalendarWidget.setNavigationBarVisible (self, bool visible)

This method is also a Qt slot with the C++ signature void setNavigationBarVisible(bool).

QCalendarWidget.setSelectedDate (self, QDate date)

This method is also a Qt slot with the C++ signature void setSelectedDate(const QDate&).

QCalendarWidget.setSelectionMode (self, SelectionMode mode)

QCalendarWidget.setVerticalHeaderFormat (self, VerticalHeaderFormat format)

QCalendarWidget.setWeekdayTextFormat (self, Qt.DayOfWeek dayOfWeek, 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().