QDateTimeEdit Class

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

Header:	#include <QDateTimeEdit>
CMake:	find_package(Qt6 COMPONENTS Widgets REQUIRED) target_link_libraries(mytarget PRIVATE Qt6::Widgets)
qmake:	QT += widgets
Inherits:	QAbstractSpinBox
Inherited By:	QDateEdit and QTimeEdit

• List of all members, including inherited members

Public Types

enum	Section { NoSection, AmPmSection, MSecSection, SecondSection, MinuteSection, …, YearSection }
flags	Sections

Properties

calendarPopup : bool currentSection : Section currentSectionIndex : int date : QDate dateTime : QDateTime displayFormat : QString displayedSections : const Sections maximumDate : QDate

maximumDateTime : QDateTime maximumTime : QTime minimumDate : QDate minimumDateTime : QDateTime minimumTime : QTime sectionCount : const int time : QTime timeSpec : Qt::TimeSpec

Public Functions

	QDateTimeEdit(QTime time, QWidget *parent = nullptr)
	QDateTimeEdit(QDate date, QWidget *parent = nullptr)
	QDateTimeEdit(const QDateTime &datetime, QWidget *parent = nullptr)
	QDateTimeEdit(QWidget *parent = nullptr)
virtual	~QDateTimeEdit()
bool	calendarPopup() const
QCalendarWidget *	calendarWidget() const
void	clearMaximumDate()
void	clearMaximumDateTime()
void	clearMaximumTime()
void	clearMinimumDate()
void	clearMinimumDateTime()
void	clearMinimumTime()
QDateTimeEdit::Section	currentSection() const
int	currentSectionIndex() const
QDate	date() const
QDateTime	dateTime() const
QString	displayFormat() const
QDateTimeEdit::Sections	displayedSections() const
QDate	maximumDate() const
QDateTime	maximumDateTime() const
QTime	maximumTime() const
QDate	minimumDate() const
QDateTime	minimumDateTime() const
QTime	minimumTime() const
QDateTimeEdit::Section	sectionAt(int index) const
int	sectionCount() const
QString	sectionText(QDateTimeEdit::Section section) const
void	setCalendarPopup(bool enable)
void	setCalendarWidget(QCalendarWidget *calendarWidget)
void	setCurrentSection(QDateTimeEdit::Section section)
void	setCurrentSectionIndex(int index)
void	setDateRange(QDate min, QDate max)
void	setDateTimeRange(const QDateTime &min, const QDateTime &max)
void	setDisplayFormat(const QString &format)
void	setMaximumDate(QDate max)
void	setMaximumDateTime(const QDateTime &dt)
void	setMaximumTime(QTime max)
void	setMinimumDate(QDate min)
void	setMinimumDateTime(const QDateTime &dt)
void	setMinimumTime(QTime min)
void	setSelectedSection(QDateTimeEdit::Section section)
void	setTimeRange(QTime min, QTime max)
void	setTimeSpec(Qt::TimeSpec spec)
QTime	time() const
Qt::TimeSpec	timeSpec() const

Reimplemented Public Functions

virtual void	clear() override
virtual bool	event(QEvent *event) override
virtual QSize	sizeHint() const override
virtual void	stepBy(int steps) override

Public Slots

void	setDate(QDate date)
void	setDateTime(const QDateTime &dateTime)
void	setTime(QTime time)

Signals

void	dateChanged(QDate date)
void	dateTimeChanged(const QDateTime &datetime)
void	timeChanged(QTime time)

Protected Functions

virtual QDateTime	dateTimeFromText(const QString &text) const
virtual QString	textFromDateTime(const QDateTime &dateTime) const

Reimplemented Protected Functions

virtual void	fixup(QString &input) const override
virtual void	focusInEvent(QFocusEvent *event) override
virtual bool	focusNextPrevChild(bool next) override
virtual void	initStyleOption(QStyleOptionSpinBox *option) const override
virtual void	keyPressEvent(QKeyEvent *event) override
virtual void	mousePressEvent(QMouseEvent *event) override
virtual void	paintEvent(QPaintEvent *event) override
virtual QAbstractSpinBox::StepEnabled	stepEnabled() const override
virtual QValidator::State	validate(QString &text, int &pos) const override
virtual void	wheelEvent(QWheelEvent *event) override

Detailed Description

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

QDateTimeEdit *dateEdit = new 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, QDate, and QTime.

Member Type Documentation

enum QDateTimeEdit::Sectionflags QDateTimeEdit::Sections

Constant	Value
QDateTimeEdit::NoSection	0x0000
QDateTimeEdit::AmPmSection	0x0001
QDateTimeEdit::MSecSection	0x0002
QDateTimeEdit::SecondSection	0x0004
QDateTimeEdit::MinuteSection	0x0008
QDateTimeEdit::HourSection	0x0010
QDateTimeEdit::DaySection	0x0100
QDateTimeEdit::MonthSection	0x0200
QDateTimeEdit::YearSection	0x0400

The Sections type is a typedef for QFlags<Section>. It stores an OR combination of Section values.

Member Function Documentation

QDateTimeEdit::QDateTimeEdit(QTime time, QWidget *parent = nullptr)

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

QDateTimeEdit::QDateTimeEdit(QDate date, QWidget *parent = nullptr)

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

QDateTimeEdit::QDateTimeEdit(const QDateTime &datetime, QWidget *parent = nullptr)

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

QDateTimeEdit::QDateTimeEdit(QWidget *parent = nullptr)

Constructs an empty date time editor with a parent.

[signal] void QDateTimeEdit::dateChanged(QDate date)

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

Note: Notifier signal for property date.

See also Keyboard Tracking.

[signal] void QDateTimeEdit::dateTimeChanged(const QDateTime &datetime)

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

Note: Notifier signal for property dateTime.

See also Keyboard Tracking.

[signal] void QDateTimeEdit::timeChanged(QTime time)

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

Note: Notifier signal for property time.

See also Keyboard Tracking.

[virtual] QDateTimeEdit::~QDateTimeEdit()

Destructor.

QCalendarWidget *QDateTimeEdit::calendarWidget() const

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.

See also setCalendarWidget().

[override virtual] void QDateTimeEdit::clear()

Reimplements: QAbstractSpinBox::clear().

QDate QDateTimeEdit::date() const

Returns the date of the date time edit.

Note: Getter function for property date.

See also setDate().

[virtual protected] QDateTime QDateTimeEdit::dateTimeFromText(const QString &text) const

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

[override virtual] bool QDateTimeEdit::event(QEvent *event)

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

[override virtual protected] void QDateTimeEdit::fixup(QString &input) const

Reimplements: QAbstractSpinBox::fixup(QString &input) const.

[override virtual protected] void QDateTimeEdit::focusInEvent(QFocusEvent *event)

Reimplements: QAbstractSpinBox::focusInEvent(QFocusEvent *event).

[override virtual protected] bool QDateTimeEdit::focusNextPrevChild(bool next)

Reimplements: QWidget::focusNextPrevChild(bool next).

[override virtual protected] void QDateTimeEdit::initStyleOption(QStyleOptionSpinBox *option) const

Reimplements: QAbstractSpinBox::initStyleOption(QStyleOptionSpinBox *option) const.

Initialize option with the values from this QDataTimeEdit. This method is useful for subclasses when they need a QStyleOptionSpinBox, but don't want to fill in all the information themselves.

See also QStyleOption::initFrom().

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

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

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

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

[override virtual protected] void QDateTimeEdit::paintEvent(QPaintEvent *event)

Reimplements: QAbstractSpinBox::paintEvent(QPaintEvent *event).

QDateTimeEdit::Section QDateTimeEdit::sectionAt(int index) const

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,

QString QDateTimeEdit::sectionText(QDateTimeEdit::Section section) const

Returns the text from the given section.

See also currentSection().

void QDateTimeEdit::setCalendarWidget(QCalendarWidget *calendarWidget)

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

void QDateTimeEdit::setDateRange(QDate min, QDate max)

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(), QDate::isValid(), and Keyboard Tracking.

void QDateTimeEdit::setDateTimeRange(const QDateTime &min, const QDateTime &max)

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.

See also minimumDateTime, maximumDateTime, setDateRange(), setTimeRange(), QDateTime::isValid(), and Keyboard Tracking.

void QDateTimeEdit::setSelectedSection(QDateTimeEdit::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().

void QDateTimeEdit::setTimeRange(QTime min, QTime max)

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(), QTime::isValid(), and Keyboard Tracking.

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

Reimplements: QAbstractSpinBox::sizeHint() const.

[override virtual] void QDateTimeEdit::stepBy(int steps)

Reimplements: QAbstractSpinBox::stepBy(int steps).

[override virtual protected] QAbstractSpinBox::StepEnabled QDateTimeEdit::stepEnabled() const

Reimplements: QAbstractSpinBox::stepEnabled() const.

[virtual protected] QString QDateTimeEdit::textFromDateTime(const QDateTime &dateTime) const

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

QTime QDateTimeEdit::time() const

Returns the time of the date time edit.

Note: Getter function for property time.

See also setTime().

[override virtual protected] QValidator::State QDateTimeEdit::validate(QString &text, int &pos) const

Reimplements: QAbstractSpinBox::validate(QString &input, int &pos) const.

[override virtual protected] void QDateTimeEdit::wheelEvent(QWheelEvent *event)

Reimplements: QAbstractSpinBox::wheelEvent(QWheelEvent *event).