class QDateTimeEdit#

The QDateTimeEdit class provides a widget for editing dates and times. More…

Inheritance diagram of PySide6.QtWidgets.QDateTimeEdit

Inherited by: QTimeEdit, QDateEdit

Synopsis#

Properties#

Methods#

Virtual methods#

Slots#

Signals#

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description#

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

../../_images/windows-datetimeedit.png

QDateTimeEdit allows the user to edit dates by using the keyboard or the arrow keys to increase and decrease date and time values. The arrow keys can be used to move from section to section within the QDateTimeEdit box. Dates and times appear in accordance with the format set; see setDisplayFormat() .

dateEdit = QDateTimeEdit(QDate.currentDate())
dateEdit.setMinimumDate(QDate.currentDate().addDays(-365))
dateEdit.setMaximumDate(QDate.currentDate().addDays(365))
dateEdit.setDisplayFormat("yyyy.MM.dd")

Here we’ve created a new QDateTimeEdit object initialized with today’s date, and restricted the valid date range to today plus or minus 365 days. We’ve set the order to month, day, year.

The range of valid values for a QDateTimeEdit is controlled by the properties minimumDateTime , maximumDateTime , and their respective date and time components. By default, any date-time from the start of 100 CE to the end of 9999 CE is valid.

Using a Pop-up Calendar Widget#

QDateTimeEdit can be configured to allow a QCalendarWidget to be used to select dates. This is enabled by setting the calendarPopup property. Additionally, you can supply a custom calendar widget for use as the calendar pop-up by calling the setCalendarWidget() function. The existing calendar widget can be retrieved with calendarWidget() .

Keyboard Tracking#

When keyboard tracking is enabled (the default), every keystroke of editing a field triggers signals for value changes.

When the allowed range is narrower than some time interval whose end it straddles, keyboard tracking prevents the user editing the date or time to access the later part of the interval. For example, for a range from 29.04.2020 to 02.05.2020 and an initial date of 30.04.2020, the user can change neither the month (May 30th is outside the range) nor the day (April 2nd is outside the range).

When keyboard tracking is disabled, changes are only signalled when focus leaves the text field after edits have modified the content. This allows the user to edit via an invalid date-time to reach a valid one.

See also

QDateEdit QTimeEdit QDateQTime

class Section#

Constant

Description

QDateTimeEdit.NoSection

QDateTimeEdit.AmPmSection

QDateTimeEdit.MSecSection

QDateTimeEdit.SecondSection

QDateTimeEdit.MinuteSection

QDateTimeEdit.HourSection

QDateTimeEdit.DaySection

QDateTimeEdit.MonthSection

QDateTimeEdit.YearSection

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property calendarPopupᅟ: bool#

This property holds The current calendar pop-up show mode..

The calendar pop-up will be shown upon clicking the arrow button. This property is valid only if there is a valid date display format.

Access functions:
property currentSectionᅟ: QDateTimeEdit.Section#

This property holds The current section of the spinbox..

Access functions:
property currentSectionIndexᅟ: int#

This property holds The current section index of the spinbox..

If the format is ‘yyyy/MM/dd’, the displayText is ‘2001/05/21’, and the cursorPosition is 5, currentSectionIndex returns 1. If the cursorPosition is 3, currentSectionIndex is 0, and so on.

Access functions:
property dateᅟ: QDate#

This property holds The QDate that is set in the widget..

By default, this property contains a date that refers to January 1, 2000.

See also

time dateTime

Access functions:
property dateTimeᅟ: QDateTime#

This property holds The QDateTime that is set in the QDateTimeEdit ..

When setting this property, the new QDateTime is converted to the time system of the QDateTimeEdit , which thus remains unchanged.

By default, this property is set to the start of 2000 CE. It can only be set to a valid QDateTime value. If any operation causes this property to have an invalid date-time as value, it is reset to the value of the minimumDateTime property.

If the QDateTimeEdit has no date fields, setting this property sets the widget’s date-range to start and end on the date of the new value of this property.

Access functions:
property displayFormatᅟ: str#

This property holds The format used to display the time/date of the date time edit..

This format is described in QDateTime::toString() and QDateTime::fromString()

Example format strings (assuming that the date is 2nd of July 1969):

Format

Result

dd.MM.yyyy

02.07.1969

MMM d yy

Jul 2 69

MMMM d yy

July 2 69

Note that if you specify a two digit year, it will be interpreted to be in the century in which the date time edit was initialized. The default century is the 21st (2000-2099).

If you specify an invalid format the format will not be set.

Access functions:
property displayedSectionsᅟ: Combination of QDateTimeEdit.Section#

This property holds The currently displayed fields of the date time edit..

Returns a bit set of the displayed sections for this format.

Access functions:
property maximumDateᅟ: QDate#

This property holds The maximum date of the date time edit..

Changing this property updates the date of the maximumDateTime property while preserving the maximumTime property. When setting this property, the minimumDate is adjusted, if necessary, to ensure that the range remains valid. When this happens, the minimumTime property is also adjusted if it is greater than the maximumTime property. Otherwise, changes to this property preserve the minimumDateTime property.

This property can only be set to a valid QDate object describing a date on which the current maximumTime property makes a valid QDateTime object. The latest date that setMaximumDate() accepts is the end of 9999 CE. This is the default for this property. This default can be restored with clearMaximumDateTime() .

Access functions:
property maximumDateTimeᅟ: QDateTime#

This property holds The maximum datetime of the date time edit..

Changing this property implicitly updates the maximumDate and maximumTime properties to the date and time parts of this property, respectively. When setting this property, the minimumDateTime is adjusted, if necessary, to ensure that the range remains valid. Otherwise, changing this property preserves the minimumDateTime property.

This property can only be set to a valid QDateTime value. The latest date-time that setMaximumDateTime() accepts is the end of 9999 CE. This is the default for this property. This default can be restored with clearMaximumDateTime().

Access functions:
property maximumTimeᅟ: QTime#

This property holds The maximum time of the date time edit..

Changing this property updates the time of the maximumDateTime property while preserving the minimumDate and maximumDate properties. If those date properties coincide, when setting this property, the minimumTime property is adjusted, if necessary, to ensure that the range remains valid. Otherwise, changing this property preserves the minimumDateTime property.

This property can be set to any valid QTime value. By default, this property contains a time of 23:59:59 and 999 milliseconds. This default can be restored with clearMaximumTime().

Access functions:
property minimumDateᅟ: QDate#

This property holds The minimum date of the date time edit..

Changing this property updates the date of the minimumDateTime property while preserving the minimumTime property. When setting this property, the maximumDate is adjusted, if necessary, to ensure that the range remains valid. When this happens, the maximumTime property is also adjusted if it is less than the minimumTime property. Otherwise, changes to this property preserve the maximumDateTime property.

This property can only be set to a valid QDate object describing a date on which the current minimumTime property makes a valid QDateTime object. The earliest date that setMinimumDate() accepts is the start of 100 CE. The default for this property is September 14, 1752 CE. This default can be restored with clearMinimumDateTime() .

Access functions:
property minimumDateTimeᅟ: QDateTime#

This property holds The minimum datetime of the date time edit..

Changing this property implicitly updates the minimumDate and minimumTime properties to the date and time parts of this property, respectively. When setting this property, the maximumDateTime is adjusted, if necessary, to ensure that the range remains valid. Otherwise, changing this property preserves the maximumDateTime property.

This property can only be set to a valid QDateTime value. The earliest date-time that setMinimumDateTime() accepts is the start of 100 CE. The property’s default is the start of September 14, 1752 CE. This default can be restored with clearMinimumDateTime().

Access functions:
property minimumTimeᅟ: QTime#

This property holds The minimum time of the date time edit..

Changing this property updates the time of the minimumDateTime property while preserving the minimumDate and maximumDate properties. If those date properties coincide, when setting this property, the maximumTime property is adjusted, if necessary, to ensure that the range remains valid. Otherwise, changing this property preserves the maximumDateTime property.

This property can be set to any valid QTime value. By default, this property contains a time of 00:00:00 and 0 milliseconds. This default can be restored with clearMinimumTime().

Access functions:
property sectionCountᅟ: int#

This property holds The number of sections displayed. If the format is ‘yyyy/yy/yyyy’, sectionCount returns 3.

Access functions:
property timeᅟ: QTime#

This property holds The QTime that is set in the widget..

By default, this property contains a time of 00:00:00 and 0 milliseconds.

See also

date dateTime

Access functions:
property timeSpecᅟ: Qt.TimeSpec#

Use timeZone instead.

This property holds The current timespec used by the date time edit..

Since Qt 6.7 this is an indirect accessor for the timeZone property.

See also

timeZone

Access functions:
property timeZoneᅟ: QTimeZone#

This property holds The current timezone used by the datetime editing widget.

If the datetime format in use includes a timezone indicator - that is, a t, tt, ttt or tttt format specifier - the user’s input is re-expressed in this timezone whenever it is parsed, overriding any timezone the user may have specified.

See also

displayFormat

Access functions:
__init__(t[, parent=None])#
Parameters:

Constructs an empty date time editor with a parent. The value is set to time.

__init__(d[, parent=None])
Parameters:

Constructs an empty date time editor with a parent. The value is set to date.

__init__(val, parserType[, parent=None])
Parameters:

  • val – object

  • parserType – Type

  • parent – QWidget

__init__([parent=None])
Parameters:

parent – QWidget

Constructs an empty date time editor with a parent.

__init__(dt[, parent=None])
Parameters:

Constructs an empty date time editor with a parent. The value is set to datetime.

calendar()#
Return type:

QCalendar

calendarPopup()#
Return type:

bool

See also

setCalendarPopup()

Getter of property calendarPopupᅟ .

calendarWidget()#
Return type:

QCalendarWidget

Returns the calendar widget for the editor if calendarPopup is set to true and (sections() & DateSections_Mask ) != 0.

This function creates and returns a calendar widget if none has been set.

clearMaximumDate()#

Reset function of property maximumDateᅟ .

clearMaximumDateTime()#

Reset function of property maximumDateTimeᅟ .

clearMaximumTime()#

Reset function of property maximumTimeᅟ .

clearMinimumDate()#

Reset function of property minimumDateᅟ .

clearMinimumDateTime()#

Reset function of property minimumDateTimeᅟ .

clearMinimumTime()#

Reset function of property minimumTimeᅟ .

currentSection()#
Return type:

Section

See also

setCurrentSection()

Getter of property currentSectionᅟ .

currentSectionIndex()#
Return type:

int

See also

setCurrentSectionIndex()

Getter of property currentSectionIndexᅟ .

date()#
Return type:

QDate

Returns the date of the date time edit.

See also

setDate()

Getter of property dateᅟ .

dateChanged(date)#
Parameters:

date – QDate

This signal is emitted whenever the date is changed. The new date is passed in date.

See also

Keyboard Tracking

Notification signal of property dateᅟ .

dateTime()#
Return type:

QDateTime

See also

setDateTime()

Getter of property dateTimeᅟ .

dateTimeChanged(dateTime)#
Parameters:

dateTime – QDateTime

This signal is emitted whenever the date or time is changed. The new date and time is passed in datetime.

See also

Keyboard Tracking

Notification signal of property dateTimeᅟ .

dateTimeFromText(text)#
Parameters:

text – str

Return type:

QDateTime

Returns an appropriate datetime for the given text.

This virtual function is used by the datetime edit whenever it needs to interpret text entered by the user as a value.

See also

textFromDateTime() validate()

displayFormat()#
Return type:

str

See also

setDisplayFormat()

Getter of property displayFormatᅟ .

displayedSections()#
Return type:

Combination of Section

Getter of property displayedSectionsᅟ .

maximumDate()#
Return type:

QDate

See also

setMaximumDate()

Getter of property maximumDateᅟ .

maximumDateTime()#
Return type:

QDateTime

See also

setMaximumDateTime()

Getter of property maximumDateTimeᅟ .

maximumTime()#
Return type:

QTime

See also

setMaximumTime()

Getter of property maximumTimeᅟ .

minimumDate()#
Return type:

QDate

See also

setMinimumDate()

Getter of property minimumDateᅟ .

minimumDateTime()#
Return type:

QDateTime

See also

setMinimumDateTime()

Getter of property minimumDateTimeᅟ .

minimumTime()#
Return type:

QTime

See also

setMinimumTime()

Getter of property minimumTimeᅟ .

sectionAt(index)#
Parameters:

index – int

Return type:

Section

Returns the Section at index.

If the format is ‘yyyy/MM/dd’, sectionAt(0) returns YearSection , sectionAt(1) returns MonthSection , and sectionAt(2) returns YearSection ,

sectionCount()#
Return type:

int

Getter of property sectionCountᅟ .

sectionText(section)#
Parameters:

section – Section

Return type:

str

Returns the text from the given section.

See also

currentSection()

setCalendar(calendar)#
Parameters:

calendar – QCalendar

setCalendarPopup(enable)#
Parameters:

enable – bool

See also

calendarPopup()

Setter of property calendarPopupᅟ .

setCalendarWidget(calendarWidget)#
Parameters:

calendarWidget – QCalendarWidget

Sets the given calendarWidget as the widget to be used for the calendar pop-up. The editor does not automatically take ownership of the calendar widget.

Note

calendarPopup must be set to true before setting the calendar widget.

See also

calendarWidget() calendarPopup

setCurrentSection(section)#
Parameters:

section – Section

See also

currentSection()

Setter of property currentSectionᅟ .

setCurrentSectionIndex(index)#
Parameters:

index – int

See also

currentSectionIndex()

Setter of property currentSectionIndexᅟ .

setDate(date)#
Parameters:

date – QDate

See also

date()

Setter of property dateᅟ .

setDateRange(min, max)#
Parameters:

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

Set the range of allowed dates for the date time edit.

This convenience function sets the minimumDate and maximumDate properties.

setDateRange(min, max)

is analogous to:

setMinimumDate(min)
setMaximumDate(max)

If either min or max is invalid, this function does nothing. This function preserves the minimumTime property. If max is less than min, the new maximumDateTime property shall be the new minimumDateTime property. If max is equal to min and the maximumTime property was less then the minimumTime property, the maximumTime property is set to the minimumTime property. Otherwise, this preserves the maximumTime property.

If the range is narrower then a time interval whose end it spans, for example a week that spans the end of a month, users can only edit the date to one in the later part of the range if keyboard-tracking is disabled.

See also

minimumDate maximumDate setDateTimeRange() Keyboard Tracking

setDateTime(dateTime)#
Parameters:

dateTime – QDateTime

See also

dateTime()

Setter of property dateTimeᅟ .

setDateTimeRange(min, max)#
Parameters:

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

Set the range of allowed date-times for the date time edit.

This convenience function sets the minimumDateTime and maximumDateTime properties.

setDateTimeRange(min, max)

is analogous to:

setMinimumDateTime(min)
setMaximumDateTime(max)

If either min or max is invalid, this function does nothing. If max is less than min, min is used also as max.

If the range is narrower then a time interval whose end it spans, for example a week that spans the end of a month, users can only edit the date-time to one in the later part of the range if keyboard-tracking is disabled.

setDisplayFormat(format)#
Parameters:

format – str

See also

displayFormat()

Setter of property displayFormatᅟ .

setMaximumDate(max)#
Parameters:

max – QDate

See also

maximumDate()

Setter of property maximumDateᅟ .

setMaximumDateTime(dt)#
Parameters:

dt – QDateTime

See also

maximumDateTime()

Setter of property maximumDateTimeᅟ .

setMaximumTime(max)#
Parameters:

max – QTime

See also

maximumTime()

Setter of property maximumTimeᅟ .

setMinimumDate(min)#
Parameters:

min – QDate

See also

minimumDate()

Setter of property minimumDateᅟ .

setMinimumDateTime(dt)#
Parameters:

dt – QDateTime

See also

minimumDateTime()

Setter of property minimumDateTimeᅟ .

setMinimumTime(min)#
Parameters:

min – QTime

See also

minimumTime()

Setter of property minimumTimeᅟ .

setSelectedSection(section)#
Parameters:

section – Section

Selects section. If section doesn’t exist in the currently displayed sections, this function does nothing. If section is NoSection , this function will unselect all text in the editor. Otherwise, this function will move the cursor and the current section to the selected section.

See also

currentSection()

setTime(time)#
Parameters:

time – QTime

See also

time()

Setter of property timeᅟ .

setTimeRange(min, max)#
Parameters:

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

Set the range of allowed times for the date time edit.

This convenience function sets the minimumTime and maximumTime properties.

Note that these only constrain the date time edit’s value on, respectively, the minimumDate and maximumDate . When these date properties do not coincide, times after max are allowed on dates before maximumDate and times before min are allowed on dates after minimumDate .

setTimeRange(min, max)

is analogous to:

setMinimumTime(min)
setMaximumTime(max)

If either min or max is invalid, this function does nothing. This function preserves the minimumDate and maximumDate properties. If those properties coincide and max is less than min, min is used as max.

If the range is narrower then a time interval whose end it spans, for example the interval from ten to an hour to ten past the same hour, users can only edit the time to one in the later part of the range if keyboard-tracking is disabled.

See also

minimumTime maximumTime setDateTimeRange() Keyboard Tracking

setTimeSpec(spec)#
Parameters:

spec – TimeSpec

See also

timeSpec()

Setter of property timeSpecᅟ .

setTimeZone(zone)#
Parameters:

zone – QTimeZone

See also

timeZone()

Setter of property timeZoneᅟ .

textFromDateTime(dt)#
Parameters:

dt – QDateTime

Return type:

str

This virtual function is used by the date time edit whenever it needs to display dateTime.

If you reimplement this, you may also need to reimplement validate() .

See also

dateTimeFromText() validate()

time()#
Return type:

QTime

Returns the time of the date time edit.

See also

setTime()

Getter of property timeᅟ .

timeChanged(time)#
Parameters:

time – QTime

This signal is emitted whenever the time is changed. The new time is passed in time.

See also

Keyboard Tracking

Notification signal of property timeᅟ .

timeSpec()#
Return type:

TimeSpec

See also

setTimeSpec()

Getter of property timeSpecᅟ .

timeZone()#
Return type:

QTimeZone

See also

setTimeZone()

Getter of property timeZoneᅟ .