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)

Constructs a datetime with the given date, a valid time(00:00:00.000), and sets the timeSpec() to Qt::LocalTime.

QDateTime::QDateTime(const QDate & date, const QTime & time, Qt::TimeSpec spec = Qt::LocalTime)

Constructs a datetime with the given date and time, using the time specification defined by spec.

If date is valid and time is not, the time will be set to midnight.

QDateTime::QDateTime(const QDateTime & other)

Constructs a copy of the other datetime.

QDateTime::~QDateTime()

Destroys the datetime.

QDateTime QDateTime::addDays(int ndays) const

Returns a QDateTime object containing a datetime ndays days later than the datetime of this object (or earlier if ndays is negative).

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

QDateTime QDateTime::addMSecs(qint64 msecs) const

Returns a QDateTime object containing a datetime msecs miliseconds later than the datetime of this object (or earlier if msecs is negative).

See also addSecs(), msecsTo(), addDays(), addMonths(), and addYears().

QDateTime QDateTime::addMonths(int nmonths) const

Returns a QDateTime object containing a datetime nmonths months later than the datetime of this object (or earlier if nmonths is negative).

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

QDateTime QDateTime::addSecs(int s) const

Returns a QDateTime object containing a datetime s seconds later than the datetime of this object (or earlier if s is negative).

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

QDateTime QDateTime::addYears(int nyears) const

Returns a QDateTime object containing a datetime nyears years later than the datetime of this object (or earlier if nyears is negative).

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

[static] QDateTime QDateTime::currentDateTime()

Returns the current datetime, as reported by the system clock, in the local time zone.

See also currentDateTimeUtc(), QDate::currentDate(), QTime::currentTime(), and toTimeSpec().

[static] QDateTime QDateTime::currentDateTimeUtc()

Returns the current datetime, as reported by the system clock, in UTC.

This function was introduced in Qt 4.7.

See also currentDateTime(), QDate::currentDate(), QTime::currentTime(), and toTimeSpec().

[static] qint64 QDateTime::currentMSecsSinceEpoch()

Returns the number of milliseconds since 1970-01-01T00:00:00 Universal Coordinated Time. This number is like the POSIX time_t variable, but expressed in milliseconds instead.

This function was introduced in Qt 4.7.

See also currentDateTime(), currentDateTimeUtc(), toTime_t(), and toTimeSpec().

QDate QDateTime::date() const

Returns the date part of the datetime.

See also setDate(), time(), and timeSpec().

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

Returns the number of days from this datetime to the other datetime. If the other datetime is earlier than this datetime, the value returned is negative.

See also addDays(), secsTo(), and msecsTo().

[static] QDateTime QDateTime::fromMSecsSinceEpoch(qint64 msecs)

Returns a datetime whose date and time are the number of milliseconds, msecs, that have passed since 1970-01-01T00:00:00.000, Coordinated Universal Time (Qt::UTC). On systems that do not support time zones, the time will be set as if local time were Qt::UTC.

Note that there are possible values for msecs that lie outside the valid range of QDateTime, both negative and positive. The behavior of this function is undefined for those values.

This function was introduced in Qt 4.7.

See also toTime_t() and setTime_t().

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

Returns the QDateTime represented by the string, using the format given, or an invalid datetime if this is not possible.

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.

[static] QDateTime QDateTime::fromString(const QString & string, const QString & format)

Returns the QDateTime represented by the string, using the format given, or an invalid datetime if the string cannot be parsed.

These expressions may be used for the date part of the format string:

Note: Unlike the other version of this function, day and month names must be given in the user's local language. It is only possible to use the English names if the user's language is English.

These expressions may be used for the time part of the format string:

All other input characters will be treated as text. Any sequence of characters that are enclosed in singlequotes will also be treated as text and not be used as an expression.

QTime time1 = QTime::fromString("131", "HHh");
// time1 is 13:00:00
QTime time1 = QTime::fromString("1apA", "1amAM");
// time1 is 01:00:00

QDateTime dateTime2 = QDateTime::fromString("M1d1y9800:01:02",
                                            "'M'M'd'd'y'yyhh:mm:ss");
// dateTime is 1 January 1998 00:01:02

If the format is not satisfied an invalid QDateTime is returned. The expressions that don't have leading zeroes (d, M, h, m, s, z) will be greedy. This means that they will use two digits even if this will put them outside the range and/or leave too few digits for other sections.

QDateTime dateTime = QDateTime::fromString("130", "Mm"); // invalid

This could have meant 1 January 00:30.00 but the M will grab two digits.

For any field that is not represented in the format the following defaults are used:

For example:

QDateTime dateTime = QDateTime::fromString("1.30.1", "M.d.s");
// dateTime is January 30 in 1900 at 00:00:01.

QDateTime::toString() QTime::toString()

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

[static] QDateTime QDateTime::fromTime_t(uint seconds)

Returns a datetime whose date and time are the number of seconds that have passed since 1970-01-01T00:00:00, Coordinated Universal Time (Qt::UTC). On systems that do not support time zones, the time will be set as if local time were Qt::UTC.

This function was introduced in Qt 4.2.

See also toTime_t() and setTime_t().

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

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

qint64 QDateTime::msecsTo(const QDateTime & other) const

Returns the number of milliseconds from this datetime to the other datetime. If the other datetime is earlier than this datetime, the value returned is negative.

Before performing the comparison, the two datetimes are converted to Qt::UTC to ensure that the result is correct if one of the two datetimes has daylight saving time (DST) and the other doesn't.

This function was introduced in Qt 4.7.

See also addMSecs(), daysTo(), and QTime::msecsTo().

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

Returns the number of seconds from this datetime to the other datetime. If the other datetime is earlier than this datetime, the value returned is negative.

Before performing the comparison, the two datetimes are converted to Qt::UTC to ensure that the result is correct if one of the two datetimes has daylight saving time (DST) and the other doesn't.

Example:

QDateTime now = QDateTime::currentDateTime();
QDateTime xmas(QDate(now.date().year(), 12, 25), QTime(0, 0));
qDebug("There are %d seconds to Christmas", now.secsTo(xmas));

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

void QDateTime::setDate(const QDate & date)

Sets the date part of this datetime to date. If no time is set, it is set to midnight.

See also date(), setTime(), and setTimeSpec().

void QDateTime::setMSecsSinceEpoch(qint64 msecs)

Sets the date and time given the number of milliseconds,msecs, that have passed since 1970-01-01T00:00:00.000, Coordinated Universal Time (Qt::UTC). On systems that do not support time zones this function will behave as if local time were Qt::UTC.

Note that there are possible values for msecs that lie outside the valid range of QDateTime, both negative and positive. The behavior of this function is undefined for those values.

This function was introduced in Qt 4.7.

See also toMSecsSinceEpoch() and setTime_t().

void QDateTime::setTime(const QTime & time)

Sets the time part of this datetime to time.

See also time(), setDate(), and setTimeSpec().

void QDateTime::setTimeSpec(Qt::TimeSpec spec)

Sets the time specification used in this datetime to spec.

See also timeSpec(), setDate(), setTime(), and Qt::TimeSpec.

void QDateTime::setTime_t(uint seconds)

Sets the date and time given the number of seconds that have passed since 1970-01-01T00:00:00, Coordinated Universal Time (Qt::UTC). On systems that do not support time zones this function will behave as if local time were Qt::UTC.

See also toTime_t().

QTime QDateTime::time() const

Returns the time part of the datetime.

See also setTime(), date(), and timeSpec().

Qt::TimeSpec QDateTime::timeSpec() const

Returns the time specification of the datetime.

See also setTimeSpec(), date(), time(), and Qt::TimeSpec.

QDateTime QDateTime::toLocalTime() const

Returns a datetime containing the date and time information in this datetime, but specified using the Qt::LocalTime definition.

See also toTimeSpec().

qint64 QDateTime::toMSecsSinceEpoch() const

Returns the datetime as the number of milliseconds that have passed since 1970-01-01T00:00:00.000, Coordinated Universal Time (Qt::UTC).

On systems that do not support time zones, this function will behave as if local time were Qt::UTC.

The behavior for this function is undefined if the datetime stored in this object is not valid. However, for all valid dates, this function returns a unique value.

This function was introduced in Qt 4.7.

See also toTime_t() and setMSecsSinceEpoch().

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

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

These expressions may be used for the date:

These expressions may be used for the time:

All other input characters will be ignored. Any sequence of characters that are enclosed in singlequotes will be treated as text and not be used as an expression. Two consecutive singlequotes ("''") are replaced by a singlequote in the output.

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

If the datetime is invalid, an empty string will be returned.

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

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

This is an overloaded function.

Returns the datetime as a string in the format given.

If the format is Qt::TextDate, the string is formatted in the default way. QDate::shortDayName(), QDate::shortMonthName(), and QTime::toString() are used to generate the string, so the day and month names will be localized names. An example of this formatting is "Wed May 20 03:40:13 1998".

If the format is Qt::ISODate, the string format corresponds to the ISO 8601 extended specification for representations of dates and times, taking the form YYYY-MM-DDTHH:mm:ss[Z|[+|-]HH:mm], depending on the timeSpec() of the QDateTime. If the timeSpec() is Qt::UTC, Z will be appended to the string; if the timeSpec() is Qt::OffsetFromUTC the offset in hours and minutes from UTC will be appended to the string.

If the format is Qt::SystemLocaleShortDate or Qt::SystemLocaleLongDate, the string format depends on the locale settings of the system. Identical to calling QLocale::system().toString(datetime, QLocale::ShortFormat) or QLocale::system().toString(datetime, QLocale::LongFormat).

If the format is Qt::DefaultLocaleShortDate or Qt::DefaultLocaleLongDate, the string format depends on the default application locale. This is the locale set with QLocale::setDefault(), or the system locale if no default locale has been set. Identical to calling QLocale().toString(datetime, QLocale::ShortFormat) or QLocale().toString(datetime, QLocale::LongFormat).

If the datetime is invalid, an empty string will be returned.

Warning: The Qt::ISODate format is only valid for years in the range 0 to 9999. This restriction may apply to locale-aware formats as well, depending on the locale settings.

See also QDate::toString(), QTime::toString(), and Qt::DateFormat.

QDateTime QDateTime::toTimeSpec(Qt::TimeSpec specification) const

Returns a copy of this datetime configured to use the given time specification.

See also timeSpec(), toUTC(), and toLocalTime().

uint QDateTime::toTime_t() const

Returns the datetime as the number of seconds that have passed since 1970-01-01T00:00:00, Coordinated Universal Time (Qt::UTC).

On systems that do not support time zones, this function will behave as if local time were Qt::UTC.

Note: This function returns a 32-bit unsigned integer, so it does not support dates before 1970, but it does support dates after 2038-01-19T03:14:06, which may not be valid time_t values. Be careful when passing those time_t values to system functions, which could interpret them as negative dates.

If the date is outside the range 1970-01-01T00:00:00 to 2106-02-07T06:28:14, this function returns -1 cast to an unsigned integer (i.e., 0xFFFFFFFF).

To get an extended range, use toMSecsSinceEpoch().

See also toMSecsSinceEpoch() and setTime_t().

QDateTime QDateTime::toUTC() const

Returns a datetime containing the date and time information in this datetime, but specified using the Qt::UTC definition.

See also toTimeSpec().

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

Returns true if this datetime is different from the other datetime; otherwise returns false.

Two datetimes are different if either the date, the time, or the time zone components are different.

See also operator==().

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

Returns true if this datetime is earlier than the other datetime; otherwise returns false.

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

Returns true if this datetime is earlier than or equal to the other datetime; otherwise returns false.

QDateTime & QDateTime::operator=(const QDateTime & other)

Makes a copy of the other datetime and returns a reference to the copy.

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

Returns true if this datetime is equal to the other datetime; otherwise returns false.

See also operator!=().

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

Returns true if this datetime is later than the other datetime; otherwise returns false.

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

Returns true if this datetime is later than or equal to the other datetime; otherwise returns false.