Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

QDateTime Class Reference

The QDateTime class provides date and time functions. More...

#include </home/clem/local/src/opie/qmake/include/qdatetime.h>

Collaboration diagram for QDateTime:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 QDateTime ()
 QDateTime (const QDate &)
 QDateTime (const QDate &, const QTime &)
bool isNull () const
bool isValid () const
QDate date () const
QTime time () const
uint toTime_t () const
void setDate (const QDate &date)
void setTime (const QTime &time)
void setTime_t (uint secsSince1Jan1970UTC)
void setTime_t (uint secsSince1Jan1970UTC, Qt::TimeSpec)
QString toString (Qt::DateFormat f=Qt::TextDate) const
QString toString (const QString &format) const
QDateTime addDays (int days) const
QDateTime addMonths (int months) const
QDateTime addYears (int years) const
QDateTime addSecs (int secs) const
int daysTo (const QDateTime &) const
int secsTo (const QDateTime &) const
bool operator== (const QDateTime &dt) const
bool operator!= (const QDateTime &dt) const
bool operator< (const QDateTime &dt) const
bool operator<= (const QDateTime &dt) const
bool operator> (const QDateTime &dt) const
bool operator>= (const QDateTime &dt) const

Static Public Member Functions

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

Private Attributes

QDate d
QTime t

Friends

Q_EXPORT QDataStreamoperator<< (QDataStream &, const QDateTime &)
Q_EXPORT QDataStreamoperator>> (QDataStream &, QDateTime &)

Detailed Description

The QDateTime class provides date and time functions.

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

Definition at line 184 of file qdatetime.h.


Constructor & Destructor Documentation

QDateTime::QDateTime  )  [inline]
 

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

See also:
isValid()

Definition at line 187 of file qdatetime.h.

Referenced by addDays(), addMonths(), addYears(), and fromString().

QDateTime::QDateTime const QDate date  ) 
 

Constructs a datetime with date date and null (but valid) time (00:00:00.000).

Definition at line 1871 of file qdatetime.cpp.

QDateTime::QDateTime const QDate date,
const QTime time
 

Constructs a datetime with date date and time time.

Definition at line 1880 of file qdatetime.cpp.


Member Function Documentation

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(), addSecs()

Definition at line 2176 of file qdatetime.cpp.

References QDate::addDays(), d, QDateTime(), and t.

Referenced by Opie::OPimBase::convertOccurrenceFromBackend(), events(), DateBookDB::getEffectiveEvents(), DateBookDB::getNonRepeatingEvents(), and Clock::nextAlarm().

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(), addSecs()

Definition at line 2189 of file qdatetime.cpp.

References QDate::addMonths(), d, QDateTime(), and t.

QDateTime QDateTime::addSecs int  nsecs  )  const
 

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

See also:
secsTo(), addDays(), addMonths(), addYears()

Definition at line 2215 of file qdatetime.cpp.

References d, QTime::ds, QDate::jd, MSECS_PER_DAY, SECS_PER_DAY, and t.

Referenced by DateBook::appMessage(), AlarmDlg::checkSnooze(), createVObject(), nextAlarm(), and Interface::refresh().

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(), addSecs()

Definition at line 2202 of file qdatetime.cpp.

References QDate::addYears(), d, QDateTime(), and t.

QDateTime QDateTime::currentDateTime Qt::TimeSpec  ts  )  [static]
 

Returns the current datetime, as reported by the system clock, for the TimeSpec ts. The default TimeSpec is LocalTime.

See also:
QDate::currentDate(), QTime::currentTime(), Qt::TimeSpec

Definition at line 2367 of file qdatetime.cpp.

References QDate::currentDate(), QTime::currentTime(), setDate(), setTime(), and t.

QDateTime QDateTime::currentDateTime  )  [static]
 

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Returns the current datetime, as reported by the system clock.

See also:
QDate::currentDate(), QTime::currentTime()

Definition at line 2355 of file qdatetime.cpp.

References Qt::LocalTime.

Referenced by OPimMainWindow::appMessage(), Opie::OPimMainWindow::appMessage(), DateBook::appMessage(), Page::backup(), BackupAndRestore::backupRootFs(), BackupAndRestore::backupUserData(), LauncherClock::changeTime(), AlarmDlg::checkSnooze(), ConfigEx::ConfigEx(), QUuid::createUuid(), createVObject(), OContactAccessBackend_VCard::createVObject(), Opie::OPimContactAccessBackend_VCard::createVObject(), ORecur::Data::Data(), Opie::OPimRecurrence::Data::Data(), Opie::DB::OSQLResultItem::dataToDateTime(), QMakeProject::doProjectTest(), QMakeProject::doVariableReplace(), TextEdit::editPasteTimeDate(), execAutoStart(), DatebookPluginWidget::getDates(), DatebookSearch::insertItem(), ConfigEx::load(), WavFile::newFile(), BackGammon::newgame(), nextAlarm(), Clock::nextAlarm(), Page::Page(), IRCMessageParser::parseCTCPPing(), parseVObject(), MineSweep::readConfig(), Interface::refresh(), TimerReceiverObject::resetTimer(), ScreenshotControl::savePixmap(), IRCConnection::sendCTCPPing(), Score::setScore(), TimeString::shortTime(), TaskEditorAlarms::slotNew(), PredictTabWidget::slotPredictTime(), TimeTabWidget::slotTZChanged(), OpieStumbler::slotUpdateStations(), DrawPadCanvasXmlHandler::startElement(), MineSweep::startPlaying(), VMemo::startRecording(), TimerReceiverObject::timerEvent(), TimeTabWidget::TimeTabWidget(), ServerApplication::togglePower(), Clock::updateClock(), NewGame::updateRuleSets(), MineSweep::updateTime(), MineSweep::writeConfig(), and ProjectGenerator::writeMakefile().

QDate QDateTime::date  )  const [inline]
 

Returns the date part of the datetime.

See also:
setDate(), time()

Definition at line 194 of file qdatetime.h.

References d.

Referenced by BackupAndRestore::backupRootFs(), BackupAndRestore::backupUserData(), DatebookAlldayDisp::beam_single_event(), DateBook::checkEvent(), Opie::OPimBase::convertOccurrenceFromBackend(), TimeString::dateString(), PageListBoxItem::dateTimeString(), PageInformationDialog::dateTimeString(), OConversion::dateTimeToString(), Opie::OPimDateConversion::dateTimeToString(), ODateBookAccessBackend::effectiveEvents(), ODateBookAccessBackend::effectiveNonRepeatingEvents(), Opie::ODateBookAccessBackend::effectiveNonRepeatingEvents(), OEvent::endDateTime(), Opie::OPimEvent::endDateTime(), OPimNotify::endTime(), Opie::OPimNotify::endTime(), events(), Opie::ODateBookAccessBackend::filterOccurrences(), KLocale::formatDateTime(), fromString(), DateBookDB::getEffectiveEvents(), DateBookHoliday::getEffectiveEvents(), DateBookDB::getEvents(), DateBookDB::getNonRepeatingEvents(), OEvent::isMultipleDay(), Opie::OPimEvent::isMultipleDay(), DateBookDayWidget::mousePressEvent(), BackGammon::newgame(), nextAlarm(), Clock::nextAlarm(), nextOccurance(), Opie::OPimAccessBackend< T >::occurrences(), Opie::ODateBookAccessBackend::occurrences(), Score::paintEvent(), OContactAccessBackend_XML::queryByExample(), Opie::OPimContactAccessBackend_SQL::queryByExample(), Opie::OPimContactAccessBackend::queryByExample(), AlarmItem::setAlarm(), RecMail::setDate(), DateEntry::setDates(), TimeTabWidget::setDateTime(), Opie::OPimOccurrence::setPeriod(), TimeString::shortTime(), OEvent::startDateTime(), Opie::OPimEvent::startDateTime(), to_Time_t(), Opie::to_Time_t(), toISOLocal(), and TimeConversion::toUTC().

int QDateTime::daysTo const QDateTime dt  )  const
 

Returns the number of days from this datetime to dt (which is negative if dt is earlier than this datetime).

See also:
addDays(), secsTo()

Definition at line 2251 of file qdatetime.cpp.

References d, and QDate::daysTo().

Referenced by Opie::OPimBase::convertOccurrenceFromBackend().

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

Returns the QDateTime represented by the string s, using the format f, 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.

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

Definition at line 2389 of file qdatetime.cpp.

References date(), QTime::fromString(), QDate::fromString(), i, Qt::ISODate, Qt::LocalDate, QDateTime(), qt_shortMonthNames, qWarning(), QTime::setHMS(), QDate::shortMonthName(), Qt::TextDate, and time().

bool QDateTime::isNull  )  const [inline]
 

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

Definition at line 191 of file qdatetime.h.

References d, and t.

Referenced by OConversion::dateTimeToString(), Opie::OPimDateConversion::dateTimeToString(), and AlarmServer::deleteAlarm().

bool QDateTime::isValid  )  const [inline]
 

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

See also:
QDate::isValid(), QTime::isValid()

Definition at line 192 of file qdatetime.h.

References d, and t.

Referenced by OConversion::dateTimeToString(), Opie::OPimDateConversion::dateTimeToString(), Opie::OPimEvent::endDateTime(), Opie::OPimContactAccessBackend_SQL::queryByExample(), Opie::Internal::testAlarmNotifiers(), and Opie::Internal::OPimSortVector< T >::testDateTime().

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

Returns TRUE if this datetime is different from dt; otherwise returns FALSE.

See also:
operator==()

Definition at line 2294 of file qdatetime.cpp.

References d, and t.

bool QDateTime::operator< const QDateTime dt  )  const
 

Returns TRUE if this datetime is earlier than dt; otherwise returns FALSE.

Definition at line 2304 of file qdatetime.cpp.

References d, FALSE, t, and TRUE.

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

Returns TRUE if this datetime is earlier than or equal to dt; otherwise returns FALSE.

Definition at line 2316 of file qdatetime.cpp.

References d, FALSE, t, and TRUE.

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

Returns TRUE if this datetime is equal to dt; otherwise returns FALSE.

See also:
operator!=()

Definition at line 2282 of file qdatetime.cpp.

References d, and t.

bool QDateTime::operator> const QDateTime dt  )  const
 

Returns TRUE if this datetime is later than dt; otherwise returns FALSE.

Definition at line 2328 of file qdatetime.cpp.

References d, FALSE, t, and TRUE.

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

Returns TRUE if this datetime is later than or equal to dt; otherwise returns FALSE.

Definition at line 2340 of file qdatetime.cpp.

References d, FALSE, t, and TRUE.

int QDateTime::secsTo const QDateTime dt  )  const
 

Returns the number of seconds from this datetime to dt (which is negative if dt is earlier than this datetime).

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(), QTime::secsTo()

Definition at line 2270 of file qdatetime.cpp.

References d, QDate::daysTo(), SECS_PER_DAY, QTime::secsTo(), and t.

Referenced by ODateBookAccessBackend::effectiveEvents(), ODateBookAccessBackend::effectiveNonRepeatingEvents(), execAutoStart(), DateBookDB::getEffectiveEvents(), FileItem::key(), IRCMessageParser::parseCTCPPing(), parseVObject(), IRCConnection::sendCTCPPing(), MineSweep::updateTime(), and MineSweep::writeConfig().

void QDateTime::setDate const QDate date  )  [inline]
 

Sets the date part of this datetime to date.

See also:
date(), setTime()

Definition at line 197 of file qdatetime.h.

References d.

Referenced by DatebookAlldayDisp::beam_single_event(), currentDateTime(), TimeConversion::fromUTC(), TaskEditorAlarms::inlineSetDate(), DateBookDayWidget::mousePressEvent(), parseDateTime(), DateBookDay::selectedDates(), utcTime(), and Opie::utcTime().

void QDateTime::setTime const QTime time  )  [inline]
 

Sets the time part of this datetime to time.

See also:
time(), setDate()

Definition at line 198 of file qdatetime.h.

References t.

Referenced by currentDateTime(), Event::end(), events(), TimeConversion::fromUTC(), DateBookDB::getEffectiveEvents(), DateBookDB::getNonRepeatingEvents(), TaskEditorAlarms::inlineSetTime(), DateBookDayWidget::mousePressEvent(), DateBookWeekLstDayHdr::newEvent(), parseDateTime(), DateBookDay::selectedDates(), DateBook::slotNewEventFromKey(), Event::start(), utcTime(), and Opie::utcTime().

void QDateTime::setTime_t uint  secsSince1Jan1970UTC,
Qt::TimeSpec  ts
 

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

On Windows, only a subset of secsSince1Jan1970UTC values are supported, as Windows starts counting from 1980.

See also:
toTime_t()

Definition at line 1987 of file qdatetime.cpp.

References d, QTime::ds, QDate::gregorianToJulian(), QDate::jd, Qt::LocalTime, MSECS_PER_HOUR, MSECS_PER_MIN, and t.

void QDateTime::setTime_t uint  secsSince1Jan1970UTC  ) 
 

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Convenience function that sets the date and time to local time based on the given UTC time.

Definition at line 1970 of file qdatetime.cpp.

References Qt::LocalTime.

Referenced by QFileInfo::created(), QFileInfo::lastModified(), QFileInfo::lastRead(), IRCMessageParser::parseCTCPPing(), IRCMessageParser::parseNumericalWhoisIdle(), IRCConnection::sendCTCPPing(), and PacketView::showPacket().

QTime QDateTime::time void   )  const [inline]
 

Returns the time part of the datetime.

See also:
setTime(), date()

Definition at line 195 of file qdatetime.h.

References t.

Referenced by OPimMainWindow::appMessage(), Opie::OPimMainWindow::appMessage(), DateBook::appMessage(), Clock::appMessage(), Opie::OPimBase::convertOccurrenceFromBackend(), TimeString::dateString(), PageListBoxItem::dateTimeString(), PageInformationDialog::dateTimeString(), OConversion::dateTimeToString(), Opie::OPimDateConversion::dateTimeToString(), OPimNotify::endTime(), Opie::OPimNotify::endTime(), events(), Opie::ODateBookAccessBackend::filterOccurrences(), KLocale::formatDateTime(), fromString(), DateBookDB::getEffectiveEvents(), DateBookDB::getNonRepeatingEvents(), TaskEditorAlarms::inlineSetTime(), BackGammon::newgame(), AlarmItem::setAlarm(), RecMail::setDate(), DateEntry::setDates(), TimeTabWidget::setDateTime(), Opie::OPimOccurrence::setPeriod(), TimeString::shortTime(), Event::start(), to_Time_t(), Opie::to_Time_t(), toISOLocal(), and TimeConversion::toUTC().

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:

Expression Output d the day as number without a leading zero (1-31) dd the day as number with a leading zero (01-31) ddd the abbreviated localized day name (e.g. 'Mon'..'Sun'). Uses QDate::shortDayName(). dddd the long localized day name (e.g. 'Monday'..'Sunday'). Uses QDate::longDayName(). M the month as number without a leading zero (1-12) MM the month as number with a leading zero (01-12) MMM the abbreviated localized month name (e.g. 'Jan'..'Dec'). Uses QDate::shortMonthName(). MMMM the long localized month name (e.g. 'January'..'December'). Uses QDate::longMonthName(). yy the year as two digit number (00-99) yyyy the year as four digit number (1752-8000)

These expressions may be used for the time:

Expression Output h the hour without a leading zero (0..23 or 1..12 if AM/PM display) hh the hour with a leading zero (00..23 or 01..12 if AM/PM display) m the minute without a leading zero (0..59) mm the minute with a leading zero (00..59) s the second whithout a leading zero (0..59) ss the second whith a leading zero (00..59) z the milliseconds without leading zeroes (0..999) zzz the milliseconds with leading zeroes (000..999) AP use AM/PM display. AP will be replaced by either "AM" or "PM". ap use am/pm display. ap will be replaced by either "am" or "pm".

All other input characters will be ignored.

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

Format Result dd.MM.yyyy 21.05.2001 ddd MMMM d yy Tue May 21 01 hh:mm:ss.zzz 14:13:09.042 h:m:s ap 2:13:9 pm

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

Definition at line 2162 of file qdatetime.cpp.

References d, fmtDateTime(), and t.

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

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. 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() QTime::toString()

Definition at line 2051 of file qdatetime.cpp.

References buf, d, QDate::day(), QDate::dayOfWeek(), QString::fromLocal8Bit(), QString::fromUcs2(), Qt::ISODate, Qt::LocalDate, QDate::month(), QString::null, out, QDate::shortDayName(), QDate::shortMonthName(), t, Qt::TextDate, QString::toInt(), QTime::toString(), QDate::toString(), and QDate::year().

Referenced by TextEdit::editPasteTimeDate(), ODateBookAccessBackend_XML::finalizeRecord(), OEvent::fromMap(), OEvent::match(), Opie::OPimEvent::match(), WavFile::newFile(), Opie::Core::odbgstream::operator<<(), IRCMessageParser::parseNumericalWhoisIdle(), Interface::refresh(), PacketView::showPacket(), and PredictTabWidget::slotPredictTime().

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

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

See also:
setTime_t()

Definition at line 1947 of file qdatetime.cpp.

References d, QDate::day(), QTime::hour(), QTime::minute(), QDate::month(), QTime::second(), t, and QDate::year().


Friends And Related Function Documentation

QDataStream & operator<< QDataStream s,
const QDateTime dt
[friend]
 

Writes the datetime dt to the stream s.

See also:
Format of the QDataStream operators

Definition at line 2518 of file qdatetime.cpp.

QDataStream & operator>> QDataStream s,
QDateTime dt
[friend]
 

Reads a datetime from the stream s into dt.

See also:
Format of the QDataStream operators

Definition at line 2531 of file qdatetime.cpp.


Member Data Documentation

QDate QDateTime::d [private]
 

Definition at line 227 of file qdatetime.h.

Referenced by addDays(), addMonths(), addSecs(), addYears(), daysTo(), operator!=(), operator<(), operator<=(), operator==(), operator>(), operator>=(), secsTo(), setTime_t(), toString(), and toTime_t().

QTime QDateTime::t [private]
 

Definition at line 228 of file qdatetime.h.

Referenced by addDays(), addMonths(), addSecs(), addYears(), currentDateTime(), operator!=(), operator<(), operator<=(), operator==(), operator>(), operator>=(), secsTo(), setTime_t(), toString(), and toTime_t().


The documentation for this class was generated from the following files:
Generated on Sat Nov 5 17:46:31 2005 for OPIE by  doxygen 1.4.2