QDateTimeEdit Class Reference

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

 #include <QDateTimeEdit>

Inherits QAbstractSpinBox.

Inherited by QDateEdit and QTimeEdit.

List of all members, including inherited members

Public Types

enum	Section { NoSection, AmPmSection, MSecSection, SecondSection, ..., 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

11 properties inherited from QAbstractSpinBox
58 properties inherited from QWidget
1 property inherited from QObject

Public Functions

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

Reimplemented Public Functions

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

28 public functions inherited from QAbstractSpinBox
217 public functions inherited from QWidget
29 public functions inherited from QObject
13 public functions inherited from QPaintDevice

Public Slots

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

4 public slots inherited from QAbstractSpinBox
19 public slots inherited from QWidget
1 public slot inherited from QObject

Signals

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

1 signal inherited from QAbstractSpinBox
1 signal inherited from QWidget
1 signal inherited from QObject

Protected Functions

virtual QDateTime	dateTimeFromText ( const QString & text ) const
void	initStyleOption ( QStyleOptionSpinBox * option ) const
virtual QString	textFromDateTime ( const QDateTime & dateTime ) const

Reimplemented Protected Functions

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

20 protected functions inherited from QAbstractSpinBox
37 protected functions inherited from QWidget
7 protected functions inherited from QObject
1 protected function inherited from QPaintDevice

Additional Inherited Members

4 static public members inherited from QWidget
5 static public members inherited from QObject
1 protected slot inherited from QWidget

Detailed Description

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

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 minimum value for QDateTimeEdit is 14 September 1752, and 2 January 4713BC for QDate. You can change this by calling setMinimumDate(), setMaximumDate(), setMinimumTime(), and setMaximumTime().

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

	A date time editing widget shown in the Windows XP widget style.
	A date time editing widget shown in the Macintosh widget style.
	A date time editing widget shown in the Plastique widget style.

See also QDateEdit, QTimeEdit, QDate, and QTime.

Member Type Documentation

enum QDateTimeEdit::Section
flags 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.

Property Documentation

calendarPopup : bool

This property holds the current calender pop-up showing 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.

This property was introduced in Qt 4.2.

Access functions:

bool	calendarPopup () const
void	setCalendarPopup ( bool enable )

currentSection : Section

This property holds the current section of the spinbox setCurrentSection().

Access functions:

Section	currentSection () const
void	setCurrentSection ( Section section )

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 etc.

setCurrentSection()

This property was introduced in Qt 4.3.

Access functions:

int	currentSectionIndex () const
void	setCurrentSectionIndex ( int index )

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.

Access functions:

QDate	date () const
void	setDate ( const QDate & date )

Notifier signal:

void	dateChanged ( const QDate & date )

dateTime : QDateTime

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

When setting this property the timespec of the QDateTimeEdit remains the same and the timespec of the new QDateTime is ignored.

By default, this property contains a date that refers to January 1, 2000 and a time of 00:00:00 and 0 milliseconds.

Access functions:

QDateTime	dateTime () const
void	setDateTime ( const QDateTime & dateTime )

Notifier signal:

void	dateTimeChanged ( const QDateTime & datetime )

displayFormat : QString

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

This format is the same as the one used 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 21 (2000-2099).

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

Access functions:

QString	displayFormat () const
void	setDisplayFormat ( const QString & format )

See also QDateTime::toString() and displayedSections().

displayedSections : const Sections

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

Returns a bit set of the displayed sections for this format. setDisplayFormat(), displayFormat()

Access functions:

Sections displayedSections () const

maximumDate : QDate

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

When setting this property the minimumDate is adjusted if necessary to ensure that the range remains valid. If the date is not a valid QDate object, this function does nothing.

By default, this property contains a date that refers to December 31, 7999.

Access functions:

QDate	maximumDate () const
void	setMaximumDate ( const QDate & max )
void	clearMaximumDate ()

See also minimumDate, minimumTime, maximumTime, and setDateRange().

maximumDateTime : QDateTime

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

When setting this property the minimumDateTime() is adjusted if necessary to ensure that the range remains valid. If the datetime is not a valid QDateTime object, this function does nothing.

The default maximumDateTime can be restored with clearMaximumDateTime().

By default, this property contains a date that refers to 31 December, 7999 and a time of 23:59:59 and 999 milliseconds.

This property was introduced in Qt 4.4.

Access functions:

QDateTime	maximumDateTime () const
void	setMaximumDateTime ( const QDateTime & dt )
void	clearMaximumDateTime ()

maximumTime : QTime

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

When setting this property, the minimumTime is adjusted if necessary to ensure that the range remains valid. If the time is not a valid QTime object, this function does nothing.

By default, this property contains a time of 23:59:59 and 999 milliseconds.

Access functions:

QTime	maximumTime () const
void	setMaximumTime ( const QTime & max )
void	clearMaximumTime ()

See also minimumTime, minimumDate, maximumDate, and setTimeRange().

minimumDate : QDate

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

When setting this property the maximumDate is adjusted if necessary, to ensure that the range remains valid. If the date is not a valid QDate object, this function does nothing.

By default, this property contains a date that refers to September 14, 1752. The minimum date must be at least the first day in year 100, otherwise setMinimumDate() has no effect.

Access functions:

QDate	minimumDate () const
void	setMinimumDate ( const QDate & min )
void	clearMinimumDate ()

See also minimumTime(), maximumTime(), and setDateRange().

minimumDateTime : QDateTime

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

When setting this property the maximumDateTime() is adjusted if necessary to ensure that the range remains valid. If the datetime is not a valid QDateTime object, this function does nothing.

The default minimumDateTime can be restored with clearMinimumDateTime()

By default, this property contains a date that refers to September 14, 1752 and a time of 00:00:00 and 0 milliseconds.

This property was introduced in Qt 4.4.

Access functions:

QDateTime	minimumDateTime () const
void	setMinimumDateTime ( const QDateTime & dt )
void	clearMinimumDateTime ()

minimumTime : QTime

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

When setting this property the maximumTime is adjusted if necessary, to ensure that the range remains valid. If the time is not a valid QTime object, this function does nothing.

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

Access functions:

QTime	minimumTime () const
void	setMinimumTime ( const QTime & min )
void	clearMinimumTime ()

See also maximumTime, minimumDate, maximumDate, and setTimeRange().

sectionCount : const int

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

This property was introduced in Qt 4.3.

Access functions:

int	sectionCount () const

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.

Access functions:

QTime	time () const
void	setTime ( const QTime & time )

Notifier signal:

void	timeChanged ( const QTime & time )

timeSpec : Qt::TimeSpec

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

This property was introduced in Qt 4.4.

Access functions:

Qt::TimeSpec	timeSpec () const
void	setTimeSpec ( Qt::TimeSpec spec )

Member Function Documentation

QDateTimeEdit::QDateTimeEdit ( QWidget * parent = 0 )

Constructs an empty date time editor with a parent.

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

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

QDateTimeEdit::QDateTimeEdit ( const QDate & date, QWidget * parent = 0 )

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

QDateTimeEdit::QDateTimeEdit ( const QTime & time, QWidget * parent = 0 )

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

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.

This function was introduced in Qt 4.4.

void QDateTimeEdit::clear () `[virtual]`

Reimplemented from QAbstractSpinBox::clear().

void QDateTimeEdit::dateChanged ( const QDate & date ) `[signal]`

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

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

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

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

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

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

Reimplemented from QObject::event().

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

Reimplemented from QAbstractSpinBox::fixup().

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

Reimplemented from QWidget::focusInEvent().

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

Reimplemented from QWidget::focusNextPrevChild().

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

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.

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

Reimplemented from QWidget::keyPressEvent().

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

Reimplemented from QWidget::mousePressEvent().

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

Reimplemented from QWidget::paintEvent().

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,

This function was introduced in Qt 4.3.

QString QDateTimeEdit::sectionText ( Section section ) const

Returns the text from the given section.

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.

This function was introduced in Qt 4.4.

See also calendarWidget() and calendarPopup.

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

Convenience function to set minimum and maximum date with one function call.

 setDateRange(min, max);

is analogous to:

 setMinimumDate(min);
 setMaximumDate(max);

If either min or max are not valid, this function does nothing.

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

Convenience function to set minimum and maximum date time with one function call.

 setDateTimeRange(min, max);

is analogous to:

 setMinimumDateTime(min);
 setMaximumDateTime(max);

If either min or max are not valid, this function does nothing.

This function was introduced in Qt 4.4.

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

This function was introduced in Qt 4.2.

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

Convenience function to set minimum and maximum time with one function call.

 setTimeRange(min, max);

is analogous to:

 setMinimumTime(min);
 setMaximumTime(max);

If either min or max are not valid, this function does nothing.

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

Reimplemented from QWidget::sizeHint().

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

Reimplemented from QAbstractSpinBox::stepBy().

StepEnabled QDateTimeEdit::stepEnabled () const `[virtual protected]`

Reimplemented from QAbstractSpinBox::stepEnabled().

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

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

void QDateTimeEdit::timeChanged ( const QTime & time ) `[signal]`

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

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

Reimplemented from QAbstractSpinBox::validate().

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

Reimplemented from QWidget::wheelEvent().

[+] Documentation Feedback

API Lookup

Qt Topics

Examples

Contents

QDateTimeEdit Class Reference

Public Types

Properties

Public Functions

Reimplemented Public Functions

Public Slots

Signals

Protected Functions

Reimplemented Protected Functions

Additional Inherited Members

Detailed Description

Using a Pop-up Calendar Widget

Member Type Documentation

enum QDateTimeEdit::Sectionflags QDateTimeEdit::Sections

Property Documentation

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

Member Function Documentation

QDateTimeEdit::QDateTimeEdit ( QWidget * parent = 0 )

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

QDateTimeEdit::QDateTimeEdit ( const QDate & date, QWidget * parent = 0 )

QDateTimeEdit::QDateTimeEdit ( const QTime & time, QWidget * parent = 0 )

QCalendarWidget * QDateTimeEdit::calendarWidget () const

void QDateTimeEdit::clear () [virtual]

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

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

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

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

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

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

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

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

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

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

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

Section QDateTimeEdit::sectionAt ( int index ) const

QString QDateTimeEdit::sectionText ( Section section ) const

void QDateTimeEdit::setCalendarWidget ( QCalendarWidget * calendarWidget )

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

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

void QDateTimeEdit::setSelectedSection ( Section section )

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

QSize QDateTimeEdit::sizeHint () const [virtual]

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

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

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

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

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

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

enum QDateTimeEdit::Section
flags QDateTimeEdit::Sections

void QDateTimeEdit::clear () `[virtual]`

void QDateTimeEdit::dateChanged ( const QDate & date ) `[signal]`

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

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

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

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

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

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

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

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

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

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

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

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

StepEnabled QDateTimeEdit::stepEnabled () const `[virtual protected]`

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

void QDateTimeEdit::timeChanged ( const QTime & time ) `[signal]`

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

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