QTime¶
Synopsis¶
Functions¶
- def __eq__ (other)
- def __ge__ (other)
- def __gt__ (other)
- def __le__ (other)
- def __lt__ (other)
- def __ne__ (other)
- def __reduce__ ()
- def __repr__ ()
- def addMSecs (ms)
- def addSecs (secs)
- def ds ()
- def elapsed ()
- def hour ()
- def isNull ()
- def isValid ()
- def minute ()
- def msec ()
- def msecsTo (arg__1)
- def restart ()
- def second ()
- def secsTo (arg__1)
- def setHMS (h, m, s[, ms=0])
- def start ()
- def toPython ()
- def toString ([f=Qt.TextDate])
- def toString (format)
Static functions¶
- def currentTime ()
- def fromString (s, format)
- def fromString (s[, f=Qt.TextDate])
- def isValid (h, m, s[, ms=0])
Detailed Description¶
The PySide.QtCore.QTime class provides clock time functions.
A PySide.QtCore.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 milliseconds.
PySide.QtCore.QTime uses the 24-hour clock format; it has no concept of AM/PM. Unlike PySide.QtCore.QDateTime , PySide.QtCore.QTime knows nothing about time zones or daylight savings time (DST).
A PySide.QtCore.QTime object is typically created either by giving the number of hours, minutes, seconds, and milliseconds explicitly, or by using the static function PySide.QtCore.QTime.currentTime() , which creates a PySide.QtCore.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 PySide.QtCore.QTime.hour() , PySide.QtCore.QTime.minute() , PySide.QtCore.QTime.second() , and PySide.QtCore.QTime.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 PySide.QtCore.QTime.toString() function.
PySide.QtCore.QTime provides a full set of operators to compare two PySide.QtCore.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 PySide.QtCore.QTime.addSecs() or PySide.QtCore.QTime.addMSecs() functions. Correspondingly, the number of seconds or milliseconds between two times can be found using PySide.QtCore.QTime.secsTo() or PySide.QtCore.QTime.msecsTo() .
PySide.QtCore.QTime can be used to measure a span of elapsed time using the PySide.QtCore.QTime.start() , PySide.QtCore.QTime.restart() , and PySide.QtCore.QTime.elapsed() functions.
- class PySide.QtCore.QTime¶
- class PySide.QtCore.QTime(QTime)
- class PySide.QtCore.QTime(h, m[, s=0[, ms=0]])
Parameters: - h – PySide.QtCore.int
- ms – PySide.QtCore.int
- m – PySide.QtCore.int
- QTime – PySide.QtCore.QTime
- s – PySide.QtCore.int
Constructs a null time object. A null time can be a PySide.QtCore.QTime (0, 0, 0, 0) (i.e., midnight) object, except that PySide.QtCore.QTime.isNull() returns true and PySide.QtCore.QTime.isValid() returns false.
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
- PySide.QtCore.QTime.TimeFlag¶
- PySide.QtCore.QTime.__reduce__()¶
Return type: PyObject
- PySide.QtCore.QTime.__repr__()¶
Return type: PyObject
- PySide.QtCore.QTime.addMSecs(ms)¶
Parameters: ms – PySide.QtCore.int Return type: PySide.QtCore.QTime Returns a PySide.QtCore.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 PySide.QtCore.QTime.addSecs() for an example.
- PySide.QtCore.QTime.addSecs(secs)¶
Parameters: secs – PySide.QtCore.int Return type: PySide.QtCore.QTime Returns a PySide.QtCore.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.
Example:
n = QTime(14, 0, 0) # n == 14:00:00 t = QTime() 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
- static PySide.QtCore.QTime.currentTime()¶
Return type: PySide.QtCore.QTime 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.
- PySide.QtCore.QTime.ds()¶
Return type: PySide.QtCore.int
- PySide.QtCore.QTime.elapsed()¶
Return type: PySide.QtCore.int Returns the number of milliseconds that have elapsed since the last time PySide.QtCore.QTime.start() or PySide.QtCore.QTime.restart() was called.
Note that the counter wraps to zero 24 hours after the last call to PySide.QtCore.QTime.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 PySide.QtCore.QTime.start() or PySide.QtCore.QTime.restart() was called, the result is undefined. This can happen when daylight savings time is turned on or off.
- static PySide.QtCore.QTime.fromString(s[, f=Qt.TextDate])¶
Parameters: - s – unicode
- f – PySide.QtCore.Qt.DateFormat
Return type:
- static PySide.QtCore.QTime.fromString(s, format)
Parameters: - s – unicode
- format – unicode
Return type: Returns the PySide.QtCore.QTime represented by the string , using the format given, or an invalid time if the string cannot be parsed.
These expressions may be used for the format:
Expression Output h the hour without a leading zero (0 to 23 or 1 to 12 if AM/PM display) hh the hour with a leading zero (00 to 23 or 01 to 12 if AM/PM display) m the minute without a leading zero (0 to 59) mm the minute with a leading zero (00 to 59) s the second without a leading zero (0 to 59) ss the second with a leading zero (00 to 59) z the milliseconds without leading zeroes (0 to 999) zzz the milliseconds with leading zeroes (000 to 999) AP interpret as an AM/PM time. AP must be either “AM” or “PM”. ap Interpret as an AM/PM time. ap must be either “am” or “pm”. All other input characters will be treated as text. Any sequence of characters that are enclosed in single quotes will also be treated as text and not be used as an expression.
time = QTime.fromString("1mm12car00", "m'mm'hcarss") # time is 12:01.00
If the format is not satisfied an invalid PySide.QtCore.QTime is returned. Expressions that do not expect leading zeroes to be given (h, m, s and z) are greedy. This means that they will use two digits even if this puts them outside the range of accepted values and leaves too few digits for other sections. For example, the following string could have meant 00:07:10, but the m will grab two digits, resulting in an invalid time:
time = QTime.fromString("00:710", "hh:ms") # invalid
Any field that is not represented in the format will be set to zero. For example:
time = QTime.fromString("1.30", "m.s") # time is 00:01:30.000
- PySide.QtCore.QTime.hour()¶
Return type: PySide.QtCore.int Returns the hour part (0 to 23) of the time.
- PySide.QtCore.QTime.isNull()¶
Return type: PySide.QtCore.bool Returns true if the time is null (i.e., the PySide.QtCore.QTime object was constructed using the default constructor); otherwise returns false. A null time is also an invalid time.
See also
- PySide.QtCore.QTime.isValid()¶
Return type: PySide.QtCore.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
- static PySide.QtCore.QTime.isValid(h, m, s[, ms=0])
Parameters: - h – PySide.QtCore.int
- m – PySide.QtCore.int
- s – PySide.QtCore.int
- ms – PySide.QtCore.int
Return type: PySide.QtCore.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
- PySide.QtCore.QTime.minute()¶
Return type: PySide.QtCore.int Returns the minute part (0 to 59) of the time.
- PySide.QtCore.QTime.msec()¶
Return type: PySide.QtCore.int Returns the millisecond part (0 to 999) of the time.
- PySide.QtCore.QTime.msecsTo(arg__1)¶
Parameters: arg__1 – PySide.QtCore.QTime Return type: PySide.QtCore.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 PySide.QtCore.QTime measures time within a day and there are 86400 seconds in a day, the result is always between -86400000 and 86400000 ms.
- PySide.QtCore.QTime.__ne__(other)¶
Parameters: other – PySide.QtCore.QTime Return type: PySide.QtCore.bool Returns true if this time is different from t ; otherwise returns false.
- PySide.QtCore.QTime.__lt__(other)¶
Parameters: other – PySide.QtCore.QTime Return type: PySide.QtCore.bool Returns true if this time is earlier than t ; otherwise returns false.
- PySide.QtCore.QTime.__le__(other)¶
Parameters: other – PySide.QtCore.QTime Return type: PySide.QtCore.bool Returns true if this time is earlier than or equal to t ; otherwise returns false.
- PySide.QtCore.QTime.__eq__(other)¶
Parameters: other – PySide.QtCore.QTime Return type: PySide.QtCore.bool Returns true if this time is equal to t ; otherwise returns false.
- PySide.QtCore.QTime.__gt__(other)¶
Parameters: other – PySide.QtCore.QTime Return type: PySide.QtCore.bool Returns true if this time is later than t ; otherwise returns false.
- PySide.QtCore.QTime.__ge__(other)¶
Parameters: other – PySide.QtCore.QTime Return type: PySide.QtCore.bool Returns true if this time is later than or equal to t ; otherwise returns false.
- PySide.QtCore.QTime.restart()¶
Return type: PySide.QtCore.int Sets this time to the current time and returns the number of milliseconds that have elapsed since the last time PySide.QtCore.QTime.start() or PySide.QtCore.QTime.restart() was called.
This function is guaranteed to be atomic and is thus very handy for repeated measurements. Call PySide.QtCore.QTime.start() to start the first measurement, and PySide.QtCore.QTime.restart() for each later measurement.
Note that the counter wraps to zero 24 hours after the last call to PySide.QtCore.QTime.start() or PySide.QtCore.QTime.restart() .
Warning
If the system’s clock setting has been changed since the last time PySide.QtCore.QTime.start() or PySide.QtCore.QTime.restart() was called, the result is undefined. This can happen when daylight savings time is turned on or off.
- PySide.QtCore.QTime.second()¶
Return type: PySide.QtCore.int Returns the second part (0 to 59) of the time.
- PySide.QtCore.QTime.secsTo(arg__1)¶
Parameters: arg__1 – PySide.QtCore.QTime Return type: PySide.QtCore.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 PySide.QtCore.QTime measures time within a day and there are 86400 seconds in a day, the result is always between -86400 and 86400.
PySide.QtCore.QTime.secsTo() does not take into account any milliseconds.
- PySide.QtCore.QTime.setHMS(h, m, s[, ms=0])¶
Parameters: - h – PySide.QtCore.int
- m – PySide.QtCore.int
- s – PySide.QtCore.int
- ms – PySide.QtCore.int
Return type: PySide.QtCore.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
- PySide.QtCore.QTime.start()¶
Sets this time to the current time. This is practical for timing:
t = QTime() t.start() some_lengthy_task() print ("Time elapsed: %d ms" % t.elapsed())
- PySide.QtCore.QTime.toPython()¶
Return type: PyObject
- PySide.QtCore.QTime.toString([f=Qt.TextDate])¶
Parameters: f – PySide.QtCore.Qt.DateFormat Return type: unicode
- PySide.QtCore.QTime.toString(format)
Parameters: format – unicode Return type: unicode 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 to 23 or 1 to 12 if AM/PM display) hh the hour with a leading zero (00 to 23 or 01 to 12 if AM/PM display) H the hour without a leading zero (0 to 23, even with AM/PM display) HH the hour with a leading zero (00 to 23, even with AM/PM display) m the minute without a leading zero (0 to 59) mm the minute with a leading zero (00 to 59) s the second without a leading zero (0 to 59) ss the second with a leading zero (00 to 59) z the milliseconds without leading zeroes (0 to 999) zzz the milliseconds with leading zeroes (000 to 999) AP or A use AM/PM display. AP will be replaced by either “AM” or “PM”. ap or a use am/pm display. ap will be replaced by either “am” or “pm”. t the timezone (for example “CEST”) 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 (assuming that the PySide.QtCore.QTime is 14:13:09.042)
Format Result hh:mm:ss.zzz 14:13:09.042 h:m:s ap 2:13:9 pm H:m:s a 14:13:9 pm If the datetime is invalid, an empty string will be returned. If format is empty, the default format “hh:mm:ss” is used.
See also
