Skip to content

CalendarWidget

Qt Base Class: QCalendarWidget

Signature: QCalendarWidget(self, parent: Optional[PySide6.QtWidgets.QWidget] = None) -> None

Base classes

Name Children Inherits
WidgetMixin
prettyqt.widgets.widget
QCalendarWidget
PySide6.QtWidgets
QCalendarWidget(self, parent: Optional[PySide6.QtWidgets.QWidget] \= None) -> None

⋔ Inheritance diagram

graph TD
  1473296267600["widgets.CalendarWidget"]
  1473293688240["widgets.WidgetMixin"]
  1473299815024["core.ObjectMixin"]
  140713234304496["builtins.object"]
  1473245548480["gui.PaintDeviceMixin"]
  1473241389600["QtWidgets.QCalendarWidget"]
  1473290849680["QtWidgets.QWidget"]
  1473288842240["QtCore.QObject"]
  1473291690208["Shiboken.Object"]
  1473300082368["QtGui.QPaintDevice"]
  1473293688240 --> 1473296267600
  1473299815024 --> 1473293688240
  140713234304496 --> 1473299815024
  1473245548480 --> 1473293688240
  140713234304496 --> 1473245548480
  1473241389600 --> 1473296267600
  1473290849680 --> 1473241389600
  1473288842240 --> 1473290849680
  1473291690208 --> 1473288842240
  140713234304496 --> 1473291690208
  1473300082368 --> 1473290849680
  1473291690208 --> 1473300082368

🛈 DocStrings

Bases: WidgetMixin, QCalendarWidget

Monthly based calendar widget allowing the user to select a date.

Source code in prettyqt\widgets\calendarwidget.py 
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
class CalendarWidget(widgets.WidgetMixin, widgets.QCalendarWidget):
    """Monthly based calendar widget allowing the user to select a date."""

    def _get_map(self):
        maps = super()._get_map()
        maps |= {
            "firstDayOfWeek": constants.DAY_OF_WEEK,
            "horizontalHeaderFormat": HORIZONTAL_HEADER_FORMAT,
            "verticalHeaderFormat": VERTICAL_HEADER_FORMAT,
            "selectionMode": SELECTION_MODE,
        }
        return maps

    def get_date(self) -> datetime.date:
        return self.selectedDate().toPython()

    def get_value(self) -> datetime.date:
        return self.get_date()

    def set_value(self, value: datatypes.DateType):
        self.setSelectedDate(datatypes.to_date(value))

    def set_range(
        self,
        lower: datatypes.DateType,
        upper: datatypes.DateType,
    ):
        self.setMinimumDate(datatypes.to_date(lower))
        self.setMaximumDate(datatypes.to_date(upper))

    def set_selection_mode(
        self, mode: SelectionModeStr | widgets.QCalendarWidget.SelectionMode | None
    ):
        """Set selection mode for given calendar widget.

        Args:
            mode: selection mode to use
        """
        if mode is None:
            mode = "none"
        self.setSelectionMode(SELECTION_MODE.get_enum_value(mode))

    def get_selection_mode(self) -> SelectionModeStr:
        """Return current selection mode.

        Returns:
            selection mode
        """
        return SELECTION_MODE.inverse[self.selectionMode()]

get_selection_mode() -> SelectionModeStr

Return current selection mode.

Source code in prettyqt\widgets\calendarwidget.py 
81
82
83
84
85
86
87
def get_selection_mode(self) -> SelectionModeStr:
    """Return current selection mode.

    Returns:
        selection mode
    """
    return SELECTION_MODE.inverse[self.selectionMode()]

set_selection_mode(mode: SelectionModeStr | widgets.QCalendarWidget.SelectionMode | None)

Set selection mode for given calendar widget.

Parameters:

Name Type Description Default
mode SelectionModeStr | SelectionMode | None

selection mode to use

 required
Source code in prettyqt\widgets\calendarwidget.py 
69
70
71
72
73
74
75
76
77
78
79
def set_selection_mode(
    self, mode: SelectionModeStr | widgets.QCalendarWidget.SelectionMode | None
):
    """Set selection mode for given calendar widget.

    Args:
        mode: selection mode to use
    """
    if mode is None:
        mode = "none"
    self.setSelectionMode(SELECTION_MODE.get_enum_value(mode))

⌗ Property table

Qt Property Type Doc
objectName QString
modal bool
windowModality Qt::WindowModality
enabled bool
geometry QRect
frameGeometry QRect
normalGeometry QRect
x int
y int
pos QPoint
frameSize QSize
size QSize
width int
height int
rect QRect
childrenRect QRect
childrenRegion QRegion
sizePolicy QSizePolicy
minimumSize QSize
maximumSize QSize
minimumWidth int
minimumHeight int
maximumWidth int
maximumHeight int
sizeIncrement QSize
baseSize QSize
palette QPalette
font QFont
cursor QCursor
mouseTracking bool
tabletTracking bool
isActiveWindow bool
focusPolicy Qt::FocusPolicy
focus bool
contextMenuPolicy Qt::ContextMenuPolicy
updatesEnabled bool
visible bool
minimized bool
maximized bool
fullScreen bool
sizeHint QSize
minimumSizeHint QSize
acceptDrops bool
windowTitle QString
windowIcon QIcon
windowIconText QString
windowOpacity double
windowModified bool
toolTip QString
toolTipDuration int
statusTip QString
whatsThis QString
accessibleName QString
accessibleDescription QString
layoutDirection Qt::LayoutDirection
autoFillBackground bool
styleSheet QString
locale QLocale
windowFilePath QString
inputMethodHints QFlags
selectedDate QDate
minimumDate QDate
maximumDate QDate
firstDayOfWeek Qt::DayOfWeek
gridVisible bool
selectionMode QCalendarWidget::SelectionMode
horizontalHeaderFormat QCalendarWidget::HorizontalHeaderFormat
verticalHeaderFormat QCalendarWidget::VerticalHeaderFormat
navigationBarVisible bool
dateEditEnabled bool
dateEditAcceptDelay int