QDateTime Class Reference

Detailed Description

A QDateTime object contains a calendar date and a clock time (a "datetime"). It is a combination of the QDate and QTime classes. It can read the current datetime from the system clock. It provides functions for comparing datetimes and for manipulating a datetime by adding a number of seconds, days, months or years.

A QDateTime object is typically created either by giving a date and time explicitly in the constructor, or by using the static function currentDateTime(), which returns a QDateTime object set to the system clock's time. The date and time can be changed with setDate() and setTime(). A datetime can also be set using the setTime_t() function, which takes a POSIX-standard "number of seconds since 00:00:00 on January 1, 1970" value. The fromString() function returns a QDateTime given a string and a date format which is used to interpret the date within the string.

The date() and time() functions provide access to the date and time parts of the datetime. The same information is provided in textual format by the toString() function.

QDateTime provides a full set of operators to compare two QDateTime objects where smaller means earlier and larger means later.

You can increment (or decrement) a datetime by a given number of seconds using addSecs() or days using addDays(). Similarly you can use addMonths() and addYears(). The daysTo() function returns the number of days between two datetimes, and secsTo() returns the number of seconds between two datetimes.

The range of a datetime object is constrained to the ranges of the QDate and QTime objects which it embodies.

See also QDate, QTime, QDateTimeEdit and Time and Date.

Member Function Documentation

QDateTime::QDateTime ()

Constructs a null datetime (i.e. null date and null time). A null datetime is invalid, since the date is invalid.

See also isValid().

QDateTime::QDateTime ( const QDate & date )

QDateTime::QDateTime ( const QDate & date, const QTime & time )

QDateTime QDateTime::addDays ( int ndays ) const

See also daysTo(), addMonths(), addYears() and addSecs().

QDateTime QDateTime::addMonths ( int nmonths ) const

See also daysTo(), addDays(), addYears() and addSecs().

QDateTime QDateTime::addSecs ( int nsecs ) const

See also secsTo(), addDays(), addMonths() and addYears().

Example: listviews/listviews.cpp.

QDateTime QDateTime::addYears ( int nyears ) const

See also daysTo(), addDays(), addMonths() and addSecs().

QDateTime QDateTime::currentDateTime () [static]

See also QDate::currentDate() and QTime::currentTime().

Example: listviews/listviews.cpp.

QDate QDateTime::date () const

Returns the date part of the datetime.

See also setDate() and time().

int QDateTime::daysTo ( const QDateTime & dt ) const

See also addDays() and secsTo().

QDateTime QDateTime::fromString ( const QString & s, Qt::DateFormat f = Qt::TextDate ) [static]

Note for Qt::TextDate: It is recommended that you use the English short month names (e.g. "Jan"). Although localized month names can also be used, they depend on the user's locale settings.

Warning: Note that Qt::LocalDate cannot be used here.

bool QDateTime::isNull () const

Returns TRUE if both the date and the time are null; otherwise returns FALSE. A null datetime is invalid.

See also QDate::isNull() and QTime::isNull().

bool QDateTime::isValid () const

Returns TRUE if both the date and the time are valid; otherwise returns FALSE.

See also QDate::isValid() and QTime::isValid().

bool QDateTime::operator!= ( const QDateTime & dt ) const

See also operator==().

bool QDateTime::operator< ( const QDateTime & dt ) const

bool QDateTime::operator<= ( const QDateTime & dt ) const

bool QDateTime::operator== ( const QDateTime & dt ) const

See also operator!=().

bool QDateTime::operator> ( const QDateTime & dt ) const

bool QDateTime::operator>= ( const QDateTime & dt ) const

int QDateTime::secsTo ( const QDateTime & dt ) const

Example:

    QDateTime dt = QDateTime::currentDateTime();
    QDateTime xmas( QDate(dt.year(),12,24), QTime(17,00) );
    qDebug( "There are %d seconds to Christmas", dt.secsTo(xmas) );
    

See also addSecs(), daysTo() and QTime::secsTo().

void QDateTime::setDate ( const QDate & date )

Sets the date part of this datetime to date.

See also date() and setTime().

void QDateTime::setTime ( const QTime & time )

Sets the time part of this datetime to time.

See also time() and setDate().

void QDateTime::setTime_t ( uint secsSince1Jan1970UTC )

Note that Microsoft Windows only supports a limited range of values for secsSince1Jan1970UTC.

QTime QDateTime::time () const

Returns the time part of the datetime.

See also setTime() and date().

QString QDateTime::toString ( const QString & format ) const

These expressions may be used for the date:

These expressions may be used for the time:

All other input characters will be ignored.

Example format strings (assumed that the QDateTime is 21^st May 2001 14:13:09)

See also QDate::toString() and QTime::toString().

QString QDateTime::toString ( Qt::DateFormat f = Qt::TextDate ) const

Returns the datetime as a string. The f parameter determines the format of the string.

If f is Qt::TextDate, the string format is "Wed May 20 03:40:13 1998" (using QDate::shortDayName(), QDate::shortMonthName(), and QTime::toString() to generate the string, so the day and month names will have localized names).

If f is Qt::ISODate, the string format corresponds to the ISO 8601 extended specification for representations of dates and times, which is YYYY-MM-DDTHH:MM:SS.

If f is Qt::LocalDate, the string format depends on the locale settings of the system.

If the format f is invalid, toString() returns a null string.

See also QDate::toString() and QTime::toString().

Related Functions

QDataStream & operator<< ( QDataStream & s, const QDateTime & dt )

Writes the datetime dt to the stream s.

See also Format of the QDataStream operators.

QDataStream & operator>> ( QDataStream & s, QDateTime & dt )

Reads a datetime from the stream s into dt.

See also Format of the QDataStream operators.

This file is part of the Qt toolkit. Copyright © 1995-2002 Trolltech. All Rights Reserved.