QTime

PyQt5.QtCore.QTime

Description

The QTime class provides clock time functions.

A QTime object contains a clock time, which it can express as the numbers 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 milliseconds.

QTime uses the 24-hour clock format; it has no concept of AM/PM. Unlike QDateTime, QTime knows nothing about time zones or daylight-saving time (DST).

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 local 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.

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

QTime provides a full set of operators to compare two QTime objects; an earlier time is considered smaller than a later one; if A.msecsTo()(B) is positive, then A < B.

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

See also

QDate, QDateTime.

Methods

__init__()

TODO

---

__init__(QTime)

TODO

---

__init__(int, int, second: int = 0, msec: int = 0)

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

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

See also

isValid().

---

addMSecs(int) → QTime

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.

Returns a null time if this time is invalid.

See also

addSecs(), msecsTo(), addMSecs().

---

addSecs(int) → QTime

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

Note that the time will wrap if it passes midnight.

Returns a null time if this time is invalid.

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

---

__bool__() → int

TODO

---

@staticmethod
currentTime() → QTime

TODO

---

elapsed() → int

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-saving time is turned on or off.

See also

start(), restart().

---

__eq__(Union[QTime, datetime.time]) → bool

TODO

---

@staticmethod
fromMSecsSinceStartOfDay(int) → QTime

TODO

---

@staticmethod
fromString(str, format: DateFormat = TextDate) → QTime

TODO

---

@staticmethod
fromString(str, str) → QTime

TODO

---

__ge__(Union[QTime, datetime.time]) → bool

TODO

---

__gt__(Union[QTime, datetime.time]) → bool

TODO

---

__hash__() → int

TODO

---

hour() → int

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

Returns -1 if the time is invalid.

See also

minute(), second(), msec().

---

isNull() → bool

TODO

---

isValid() → bool

Returns true if the time is valid; otherwise returns false. For example, the time 23:30:55.746 is valid, but 24:12:30 is invalid.

See also

isNull().

---

@staticmethod
isValid(int, int, int, msec: int = 0) → bool

This is an overloaded function.

Returns true if the specified time is valid; otherwise returns false.

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

Example:

# QTime::isValid(21, 10, 30); // returns true
# QTime::isValid(22, 5,  62); // returns false

---

__le__(Union[QTime, datetime.time]) → bool

TODO

---

__lt__(Union[QTime, datetime.time]) → bool

TODO

---

minute() → int

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

Returns -1 if the time is invalid.

See also

hour(), second(), msec().

---

msec() → int

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

Returns -1 if the time is invalid.

See also

hour(), minute(), second().

---

msecsSinceStartOfDay() → int

TODO

---

msecsTo(Union[QTime, datetime.time]) → int

Returns the number of milliseconds from this time to t. If t is earlier than this time, the number of milliseconds returned is negative.

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

Returns 0 if either time is invalid.

See also

secsTo(), addMSecs(), msecsTo().

---

__ne__(Union[QTime, datetime.time]) → bool

TODO

---

__repr__() → str

TODO

---

restart() → int

Sets this time to the current time and returns the number of milliseconds that have elapsed since the last time start() or 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 for each later measurement.

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

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

See also

start(), elapsed(), currentTime().

---

second() → int

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

Returns -1 if the time is invalid.

See also

hour(), minute(), msec().

---

secsTo(Union[QTime, datetime.time]) → int

Returns the number of seconds from this time to t. If t is earlier than this time, the number of seconds returned is negative.

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

does not take into account any milliseconds.

Returns 0 if either time is invalid.

See also

addSecs(), secsTo().

---

setHMS(int, int, int, msec: int = 0) → bool

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

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

See also

isValid().

---

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

---

toPyTime() → datetime.time

TODO

---

toString(format: DateFormat = TextDate) → str

TODO

---

toString(str) → str

TODO