From ea318d1431c89e647598c510c4245c6571aa5f46 Mon Sep 17 00:00:00 2001 From: Timothy Pearson Date: Thu, 26 Jan 2012 23:32:43 -0600 Subject: Update to latest tqt3 automated conversion --- doc/html/ntqdatetime.html | 393 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 393 insertions(+) create mode 100644 doc/html/ntqdatetime.html (limited to 'doc/html/ntqdatetime.html') diff --git a/doc/html/ntqdatetime.html b/doc/html/ntqdatetime.html new file mode 100644 index 000000000..614c23be5 --- /dev/null +++ b/doc/html/ntqdatetime.html @@ -0,0 +1,393 @@ + + + + + +TQDateTime Class + + + + + + + +
+ +Home + | +All Classes + | +Main Classes + | +Annotated + | +Grouped Classes + | +Functions +

TQDateTime Class Reference

+ +

The TQDateTime class provides date and time functions. +More... +

All the functions in this class are reentrant when TQt is built with thread support.

+

#include <ntqdatetime.h> +

List of all member functions. +

Public Members

+ +

Static Public Members

+ +

Related Functions

+ +

Detailed Description

+ + + +The TQDateTime class provides date and time functions. +

+ +

A TQDateTime object contains a calendar date and a clock time (a +"datetime"). It is a combination of the TQDate and TQTime 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 TQDateTime 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 TQDateTime 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 TQDateTime 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. +

TQDateTime provides a full set of operators to compare two +TQDateTime 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 +TQDate and TQTime objects which it embodies. +

See also TQDate, TQTime, TQDateTimeEdit, and Time and Date. + +

Member Function Documentation

+

TQDateTime::TQDateTime () +

+ +

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

See also isValid(). + +

TQDateTime::TQDateTime ( const TQDate & date ) +

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

TQDateTime::TQDateTime ( const TQDate & date, const TQTime & time ) +

+Constructs a datetime with date date and time time. + +

TQDateTime TQDateTime::addDays ( int ndays ) const +

+Returns a TQDateTime 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(). + +

TQDateTime TQDateTime::addMonths ( int nmonths ) const +

+Returns a TQDateTime 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(). + +

TQDateTime TQDateTime::addSecs ( int nsecs ) const +

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

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

Example: listviews/listviews.cpp. +

TQDateTime TQDateTime::addYears ( int nyears ) const +

+Returns a TQDateTime 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(). + +

TQDateTime TQDateTime::currentDateTime ( TQt::TimeSpec ts ) [static] +

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

See also TQDate::currentDate(), TQTime::currentTime(), and TQt::TimeSpec. + +

Example: listviews/listviews.cpp. +

TQDateTime TQDateTime::currentDateTime () [static] +

+This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +

Returns the current datetime, as reported by the system clock. +

See also TQDate::currentDate() and TQTime::currentTime(). + +

TQDate TQDateTime::date () const +

+ +

Returns the date part of the datetime. +

See also setDate() and time(). + +

int TQDateTime::daysTo ( const TQDateTime & 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() and secsTo(). + +

TQDateTime TQDateTime::fromString ( const TQString & s, TQt::DateFormat f = TQt::TextDate ) [static] +

+Returns the TQDateTime represented by the string s, using the +format f, or an invalid datetime if this is not possible. +

Note for TQt::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 TQt::LocalDate cannot be used here. + +

bool TQDateTime::isNull () const +

+ +

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

See also TQDate::isNull() and TQTime::isNull(). + +

bool TQDateTime::isValid () const +

+ +

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

See also TQDate::isValid() and TQTime::isValid(). + +

bool TQDateTime::operator!= ( const TQDateTime & dt ) const +

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

See also operator==(). + +

bool TQDateTime::operator< ( const TQDateTime & dt ) const +

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

bool TQDateTime::operator<= ( const TQDateTime & dt ) const +

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

bool TQDateTime::operator== ( const TQDateTime & dt ) const +

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

See also operator!=(). + +

bool TQDateTime::operator> ( const TQDateTime & dt ) const +

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

bool TQDateTime::operator>= ( const TQDateTime & dt ) const +

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

int TQDateTime::secsTo ( const TQDateTime & dt ) const +

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

Example: +

+    TQDateTime dt = TQDateTime::currentDateTime();
+    TQDateTime xmas( TQDate(dt.date().year(),12,24), TQTime(17,00) );
+    qDebug( "There are %d seconds to Christmas", dt.secsTo(xmas) );
+
+ +

See also addSecs(), daysTo(), and TQTime::secsTo(). + +

void TQDateTime::setDate ( const TQDate & date ) +

+ +

Sets the date part of this datetime to date. +

See also date() and setTime(). + +

void TQDateTime::setTime ( const TQTime & time ) +

+ +

Sets the time part of this datetime to time. +

See also time() and setDate(). + +

void TQDateTime::setTime_t ( uint secsSince1Jan1970UTC, TQt::TimeSpec ts ) +

+Sets the date and time to ts time (TQt::LocalTime or TQt::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(). + +

void TQDateTime::setTime_t ( uint secsSince1Jan1970UTC ) +

+This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +

Convenience function that sets the date and time to local time +based on the given UTC time. + +

TQTime TQDateTime::time () const +

+ +

Returns the time part of the datetime. +

See also setTime() and date(). + +

TQString TQDateTime::toString ( const TQString & 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 TQDate::shortDayName(). +
dddd +the long localized day name (e.g. 'Monday'..'Sunday'). +Uses TQDate::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 TQDate::shortMonthName(). +
MMMM +the long localized month name (e.g. 'January'..'December'). +Uses TQDate::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 TQDateTime 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 +
+

If the datetime is an invalid datetime, then TQString::null will be returned. +

See also TQDate::toString() and TQTime::toString(). + +

TQString TQDateTime::toString ( TQt::DateFormat f = TQt::TextDate ) const +

+This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +

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

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

If f is TQt::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 TQt::LocalDate, the string format depends on the +locale settings of the system. +

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

See also TQDate::toString() and TQTime::toString(). + +

uint TQDateTime::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(). + +

Related Functions

+

TQDataStream & operator<< ( TQDataStream & s, const TQDateTime & dt ) +

+ +

Writes the datetime dt to the stream s. +

See also Format of the TQDataStream operators. + +

TQDataStream & operator>> ( TQDataStream & s, TQDateTime & dt ) +

+ +

Reads a datetime from the stream s into dt. +

See also Format of the TQDataStream operators. + + +

+This file is part of the TQt toolkit. +Copyright © 1995-2007 +Trolltech. All Rights Reserved.

+ +
Copyright © 2007 +TrolltechTrademarks +
TQt 3.3.8
+
+ -- cgit v1.2.1