QDateTimeEdit Class Reference
^{[QtGui module]}

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 maximum and minimum values for a date value in the date editor default to the maximum and minimum values for a QDate. You can change this by calling setMinimumDate(), setMaximumDate(), setMinimumTime(), and setMaximumTime().

Member Type Documentation

enum QDateTimeEdit::Section
flags QDateTimeEdit::Sections

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

Property Documentation

currentSection : Section

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

Access functions:

• Section currentSection () const
• void setCurrentSection ( Section section )

date : QDate

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

Access functions:

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

See also time.

dateTime : QDateTime

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

Access functions:

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

See also minimumDate, minimumTime, maximumDate, and maximumTime.

displayFormat : QString

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

This format is a subset of the format described in QDateTime::toString()

These expressions may be used:

All other input characters or sequence of characters that are enclosed in singlequotes will be treated as text and can be used as delimiters.

Example format strings (assuming that the date is 20 July 1969):

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

Multiple instances of the same field is not allowed.A format with no valid fields is not allowed either.

Warning: Since QDateTimeEdit internally always operates on a QDateTime, changing the format can change the minimum time or date and the current time or date. For example:

    QDateTimeEdit edit;     // default format is "yyyy.MM.dd hh:mm:ss"
    edit.setMinimumDate(QDate(2000, 1, 1));
    edit.setMaximumDate(QDate(2003, 1, 1));
    edit.setDateTime(QDateTime(QDate(2002, 5, 5), QTime(10, 10, 10)));
    edit.setDisplayFormat("hh:mm:ss");

    // edit can no longer display dates. This means that the
    // minimum and maximum date will be set to the current date,
    // e.g. 2002, 5, 5.

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.

Access functions:

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

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

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.

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.

Access functions:

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

See also minimumTime, maximumTime, and setDateRange().

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.

Access functions:

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

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

time : QTime

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

Access functions:

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

See also date.

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.

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

QString QDateTimeEdit::sectionText ( Section section ) const

Returns the text from the given section.

See also currentSection().

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.

See also setMinimumDate(), maximumDate(), setMaximumDate(), clearMinimumDate(), setMinimumTime(), maximumTime(), setMaximumTime(), clearMinimumTime(), and QDate::isValid().

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.

See also setMinimumDate(), maximumDate(), setMaximumDate(), clearMinimumDate(), setMinimumTime(), maximumTime(), setMaximumTime(), clearMinimumTime(), and QTime::isValid().

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