From bd0f3345a938b35ce6a12f6150373b0955b8dd12 Mon Sep 17 00:00:00 2001 From: Timothy Pearson Date: Sun, 10 Jul 2011 15:24:15 -0500 Subject: Add Qt3 development HEAD version --- doc/html/qtime.html | 393 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 393 insertions(+) create mode 100644 doc/html/qtime.html (limited to 'doc/html/qtime.html') diff --git a/doc/html/qtime.html b/doc/html/qtime.html new file mode 100644 index 0000000..f793a97 --- /dev/null +++ b/doc/html/qtime.html @@ -0,0 +1,393 @@ + + + + + +QTime Class + + + + + + + +
+ +Home + | +All Classes + | +Main Classes + | +Annotated + | +Grouped Classes + | +Functions +

QTime Class Reference

+ +

The QTime class provides clock time functions. +More... +

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

+

#include <qdatetime.h> +

List of all member functions. +

Public Members

+ +

Static Public Members

+ +

Related Functions

+ +

Detailed Description

+ + + +

The QTime class provides clock time functions. +

+ +

A QTime object contains a clock time, i.e. the number of hours, +minutes, seconds, and milliseconds since midnight. It can read the +current time from the system clock and measure a span of elapsed +time. It provides functions for comparing times and for +manipulating a time by adding a number of (milli)seconds. +

QTime uses the 24-hour clock format; it has no concept of AM/PM. +It operates in local time; it knows nothing about time zones or +daylight savings time. +

A QTime object is typically created either by giving the number of +hours, minutes, seconds, and milliseconds explicitly, or by using +the static function currentTime(), which creates a QTime object +that contains the system's clock time. Note that the accuracy +depends on the accuracy of the underlying operating system; not +all systems provide 1-millisecond accuracy. +

The hour(), minute(), second(), and msec() functions provide +access to the number of hours, minutes, seconds, and milliseconds +of the time. The same information is provided in textual format by +the toString() function. +

QTime provides a full set of operators to compare two QTime +objects. One time is considered smaller than another if it is +earlier than the other. +

The time a given number of seconds or milliseconds later than a +given time can be found using the addSecs() or addMSecs() +functions. Correspondingly, the number of (milli)seconds between +two times can be found using the secsTo() or msecsTo() functions. +

QTime can be used to measure a span of elapsed time using the +start(), restart(), and elapsed() functions. +

See also QDate, QDateTime, and Time and Date. + +

Member Function Documentation

+

QTime::QTime () +

+ +

Constructs the time 0 hours, minutes, seconds and milliseconds, +i.e. 00:00:00.000 (midnight). This is a valid time. +

See also isValid(). + +

QTime::QTime ( int h, int m, int s = 0, int ms = 0 ) +

+Constructs a time with hour h, minute m, seconds s and +milliseconds ms. +

h must be in the range 0..23, m and s must be in the +range 0..59, and ms must be in the range 0..999. +

See also isValid(). + +

QTime QTime::addMSecs ( int ms ) const +

+Returns a QTime object containing a time ms milliseconds later +than the time of this object (or earlier if ms is negative). +

Note that the time will wrap if it passes midnight. See addSecs() +for an example. +

See also addSecs() and msecsTo(). + +

QTime QTime::addSecs ( int nsecs ) const +

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

Note that the time will wrap if it passes midnight. +

Example: +

+    QTime n( 14, 0, 0 );                // n == 14:00:00
+    QTime t;
+    t = n.addSecs( 70 );                // t == 14:01:10
+    t = n.addSecs( -70 );               // t == 13:58:50
+    t = n.addSecs( 10*60*60 + 5 );      // t == 00:00:05
+    t = n.addSecs( -15*60*60 );         // t == 23:00:00
+
+ +

See also addMSecs(), secsTo(), and QDateTime::addSecs(). + +

QTime QTime::currentTime ( Qt::TimeSpec ts ) [static] +

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

Note that the accuracy depends on the accuracy of the underlying +operating system; not all systems provide 1-millisecond accuracy. +

See also Qt::TimeSpec. + +

Examples: aclock/aclock.cpp, dclock/dclock.cpp, t12/cannon.cpp, and tictac/tictac.cpp. +

QTime QTime::currentTime () [static] +

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

Returns the current time as reported by the system clock. +

Note that the accuracy depends on the accuracy of the underlying +operating system; not all systems provide 1-millisecond accuracy. + +

int QTime::elapsed () const +

+Returns the number of milliseconds that have elapsed since the +last time start() or restart() was called. +

Note that the counter wraps to zero 24 hours after the last call +to start() or restart. +

Note that the accuracy depends on the accuracy of the underlying +operating system; not all systems provide 1-millisecond accuracy. +

Warning: If the system's clock setting has been changed since the +last time start() or restart() was called, the result is +undefined. This can happen when daylight savings time is turned on +or off. +

See also start() and restart(). + +

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

+Returns the representation s as a QTime using the format f, +or an invalid time if this is not possible. +

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

int QTime::hour () const +

+Returns the hour part (0..23) of the time. + +

Examples: aclock/aclock.cpp and tictac/tictac.cpp. +

bool QTime::isNull () const +

+ +

Returns TRUE if the time is equal to 00:00:00.000; otherwise +returns FALSE. A null time is valid. +

See also isValid(). + +

bool QTime::isValid () const +

+Returns TRUE if the time is valid; otherwise returns FALSE. The +time 23:30:55.746 is valid, whereas 24:12:30 is invalid. +

See also isNull(). + +

bool QTime::isValid ( int h, int m, int s, int ms = 0 ) [static] +

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

Returns TRUE if the specified time is valid; otherwise returns +FALSE. +

The time is valid if h is in the range 0..23, m and s are +in the range 0..59, and ms is in the range 0..999. +

Example: +

+    QTime::isValid(21, 10, 30); // returns TRUE
+    QTime::isValid(22, 5,  62); // returns FALSE
+
+ + +

int QTime::minute () const +

+Returns the minute part (0..59) of the time. + +

Examples: aclock/aclock.cpp and tictac/tictac.cpp. +

int QTime::msec () const +

+Returns the millisecond part (0..999) of the time. + +

int QTime::msecsTo ( const QTime & t ) const +

+Returns the number of milliseconds from this time to t (which +is negative if t is earlier than this time). +

Because QTime measures time within a day and there are 86400 +seconds in a day, the result is always between -86400000 and +86400000 msec. +

See also secsTo(). + +

bool QTime::operator!= ( const QTime & t ) const +

+ +

Returns TRUE if this time is different from t; otherwise returns FALSE. + +

bool QTime::operator< ( const QTime & t ) const +

+ +

Returns TRUE if this time is earlier than t; otherwise returns FALSE. + +

bool QTime::operator<= ( const QTime & t ) const +

+ +

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

bool QTime::operator== ( const QTime & t ) const +

+ +

Returns TRUE if this time is equal to t; otherwise returns FALSE. + +

bool QTime::operator> ( const QTime & t ) const +

+ +

Returns TRUE if this time is later than t; otherwise returns FALSE. + +

bool QTime::operator>= ( const QTime & t ) const +

+ +

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

int QTime::restart () +

+Sets this time to the current time and returns the number of +milliseconds that have elapsed since the last time start() or +restart() was called. +

This function is guaranteed to be atomic and is thus very handy +for repeated measurements. Call start() to start the first +measurement and then restart() for each later measurement. +

Note that the counter wraps to zero 24 hours after the last call +to start() or restart(). +

Warning: If the system's clock setting has been changed since the +last time start() or restart() was called, the result is +undefined. This can happen when daylight savings time is turned on +or off. +

See also start(), elapsed(), and currentTime(). + +

int QTime::second () const +

+Returns the second part (0..59) of the time. + +

Example: tictac/tictac.cpp. +

int QTime::secsTo ( const QTime & t ) const +

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

Because QTime measures time within a day and there are 86400 +seconds in a day, the result is always between -86400 and 86400. +

See also addSecs() and QDateTime::secsTo(). + +

Example: t12/cannon.cpp. +

bool QTime::setHMS ( int h, int m, int s, int ms = 0 ) +

+Sets the time to hour h, minute m, seconds s and +milliseconds ms. +

h must be in the range 0..23, m and s must be in the +range 0..59, and ms must be in the range 0..999. Returns TRUE +if the set time is valid; otherwise returns FALSE. +

See also isValid(). + +

void QTime::start () +

+Sets this time to the current time. This is practical for timing: +

+    QTime t;
+    t.start();
+    some_lengthy_task();
+    qDebug( "Time elapsed: %d ms", t.elapsed() );
+
+ +

See also restart(), elapsed(), and currentTime(). + +

QString QTime::toString ( const QString & format ) const +

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

These expressions may be used: +

+
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 (assuming that the QTime is 14:13:09.042) +

+
Format Result +
hh:mm:ss.zzz 14:13:09.042 +
h:m:s ap 2:13:9 pm +
+

If the time is an invalid time, then QString::null will be returned. +

See also QDate::toString() and QDateTime::toString(). + +

QString QTime::toString ( Qt::DateFormat f = Qt::TextDate ) const +

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

Returns the time as a string. Milliseconds are not included. The +f parameter determines the format of the string. +

If f is Qt::TextDate, the string format is HH:MM:SS; e.g. 1 +second before midnight would be "23:59:59". +

If f is Qt::ISODate, the string format corresponds to the +ISO 8601 extended specification for representations of dates, +which is also HH:MM:SS. +

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

If the time is an invalid time, then QString::null will be returned. + +

Related Functions

+

QDataStream & operator<< ( QDataStream & s, const QTime & t ) +

+ +

Writes time t to the stream s. +

See also Format of the QDataStream operators. + +

QDataStream & operator>> ( QDataStream & s, QTime & t ) +

+ +

Reads a time from the stream s into t. +

See also Format of the QDataStream operators. + + +

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

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