Qt 4.3: QDateTimeEdit Class Reference

|  | Home · All Classes · Main Classes · Grouped Classes · Modules · Functions |

# QDateTimeEdit Class Reference
[QtGui module]

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 maximumTime : QTime minimumDate : QDate minimumTime : QTime sectionCount : const int time : QTime

- 11 properties inherited from QAbstractSpinBox
- 56 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
- void clearMaximumDate ()
- void clearMaximumTime ()
- void clearMinimumDate ()
- void clearMinimumTime ()
- Section currentSection () const
- int currentSectionIndex () const
- QDate date () const
- QDateTime dateTime () const
- QString displayFormat () const
- Sections displayedSections () const
- QDate maximumDate () const
- QTime maximumTime () const
- QDate minimumDate () const
- QTime minimumTime () const
- Section sectionAt ( int index ) const
- int sectionCount () const
- QString sectionText ( Section section ) const
- void setCalendarPopup ( bool enable )
- void setCurrentSection ( Section section )
- void setCurrentSectionIndex ( int index )
- void setDateRange ( const QDate & min, const QDate & max )
- void setDisplayFormat ( const QString & format )
- void setMaximumDate ( const QDate & max )
- void setMaximumTime ( const QTime & max )
- void setMinimumDate ( const QDate & min )
- void setMinimumTime ( const QTime & min )
- void setSelectedSection ( Section section )
- void setTimeRange ( const QTime & min, const QTime & max )
- QTime time () const

- 24 public functions inherited from QAbstractSpinBox
- 201 public functions inherited from QWidget
- 29 public functions inherited from QObject
- 12 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

- 4 protected functions inherited from QAbstractSpinBox
- 38 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().

| 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 popup showing mode.

The calendar popup 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 )

See also setDisplayFormat().

### 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 )

See also currentSection().

### 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 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

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.

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

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

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

See also QStyleOption::initFrom().

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

### note about not working when not Acceptable

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

See also currentSection().

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