1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qdatetime.cpp -->
<title>Qt 4.8: QTime Class Reference</title>
<link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
<div class="content">
<a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
</div>
<div class="breadcrumb toolblock">
<ul>
<li class="first"><a href="index.html">Home</a></li>
<!-- Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li><a href="qtcore.html">QtCore</a></li>
<li>QTime</li>
</ul>
</div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#static-public-members">Static Public Members</a></li>
<li class="level1"><a href="#related-non-members">Related Non-Members</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QTime Class Reference</h1>
<!-- $$$QTime-brief -->
<p>The QTime class provides clock time functions. <a href="#details">More...</a></p>
<!-- @@@QTime -->
<pre class="cpp"> <span class="preprocessor">#include <QTime></span></pre><p><b>Note:</b> All functions in this class are <a href="threads-reentrancy.html#reentrant">reentrant</a>.</p>
<ul>
<li><a href="qtime-members.html">List of all members, including inherited members</a></li>
<li><a href="qtime-qt3.html">Qt 3 support members</a></li>
</ul>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qtime.html#QTime">QTime</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qtime.html#QTime-2">QTime</a></b> ( int <i>h</i>, int <i>m</i>, int <i>s</i> = 0, int <i>ms</i> = 0 )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QTime </td><td class="memItemRight bottomAlign"><b><a href="qtime.html#addMSecs">addMSecs</a></b> ( int <i>ms</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QTime </td><td class="memItemRight bottomAlign"><b><a href="qtime.html#addSecs">addSecs</a></b> ( int <i>s</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qtime.html#elapsed">elapsed</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qtime.html#hour">hour</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qtime.html#isNull">isNull</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qtime.html#isValid">isValid</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qtime.html#minute">minute</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qtime.html#msec">msec</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qtime.html#msecsTo">msecsTo</a></b> ( const QTime & <i>t</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qtime.html#restart">restart</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qtime.html#second">second</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qtime.html#secsTo">secsTo</a></b> ( const QTime & <i>t</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qtime.html#setHMS">setHMS</a></b> ( int <i>h</i>, int <i>m</i>, int <i>s</i>, int <i>ms</i> = 0 )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtime.html#start">start</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qtime.html#toString">toString</a></b> ( const QString & <i>format</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qtime.html#toString-2">toString</a></b> ( Qt::DateFormat <i>format</i> = Qt::TextDate ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qtime.html#operator-not-eq">operator!=</a></b> ( const QTime & <i>t</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qtime.html#operator-lt">operator<</a></b> ( const QTime & <i>t</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qtime.html#operator-lt-eq">operator<=</a></b> ( const QTime & <i>t</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qtime.html#operator-eq-eq">operator==</a></b> ( const QTime & <i>t</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qtime.html#operator-gt">operator></a></b> ( const QTime & <i>t</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qtime.html#operator-gt-eq">operator>=</a></b> ( const QTime & <i>t</i> ) const</td></tr>
</table>
<a name="static-public-members"></a>
<h2>Static Public Members</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> QTime </td><td class="memItemRight bottomAlign"><b><a href="qtime.html#currentTime">currentTime</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QTime </td><td class="memItemRight bottomAlign"><b><a href="qtime.html#fromString">fromString</a></b> ( const QString & <i>string</i>, Qt::DateFormat <i>format</i> = Qt::TextDate )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QTime </td><td class="memItemRight bottomAlign"><b><a href="qtime.html#fromString-2">fromString</a></b> ( const QString & <i>string</i>, const QString & <i>format</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qtime.html#isValid-2">isValid</a></b> ( int <i>h</i>, int <i>m</i>, int <i>s</i>, int <i>ms</i> = 0 )</td></tr>
</table>
<a name="related-non-members"></a>
<h2>Related Non-Members</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> QDataStream & </td><td class="memItemRight bottomAlign"><b><a href="qtime.html#operator-lt-lt-96">operator<<</a></b> ( QDataStream & <i>out</i>, const QTime & <i>time</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QDataStream & </td><td class="memItemRight bottomAlign"><b><a href="qtime.html#operator-gt-gt-50">operator>></a></b> ( QDataStream & <i>in</i>, QTime & <i>time</i> )</td></tr>
</table>
<a name="details"></a>
<!-- $$$QTime-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QTime class provides clock time functions.</p>
<p>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 milliseconds.</p>
<p>QTime uses the 24-hour clock format; it has no concept of AM/PM. Unlike <a href="qdatetime.html">QDateTime</a>, QTime knows nothing about time zones or daylight savings time (DST).</p>
<p>A QTime object is typically created either by giving the number of hours, minutes, seconds, and milliseconds explicitly, or by using the static function <a href="qtime.html#currentTime">currentTime</a>(), 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.</p>
<p>The <a href="qtime.html#hour">hour</a>(), <a href="qtime.html#minute">minute</a>(), <a href="qtime.html#second">second</a>(), and <a href="qtime.html#msec">msec</a>() 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 <a href="qtime.html#toString">toString</a>() function.</p>
<p>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.</p>
<p>The time a given number of seconds or milliseconds later than a given time can be found using the <a href="qtime.html#addSecs">addSecs</a>() or <a href="qtime.html#addMSecs">addMSecs</a>() functions. Correspondingly, the number of seconds or milliseconds between two times can be found using <a href="qtime.html#secsTo">secsTo</a>() or <a href="qtime.html#msecsTo">msecsTo</a>().</p>
<p>QTime can be used to measure a span of elapsed time using the <a href="qtime.html#start">start</a>(), <a href="qtime.html#restart">restart</a>(), and <a href="qtime.html#elapsed">elapsed</a>() functions.</p>
</div>
<p><b>See also </b><a href="qdate.html">QDate</a> and <a href="qdatetime.html">QDateTime</a>.</p>
<!-- @@@QTime -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QTime[overload1]$$$QTime -->
<h3 class="fn"><a name="QTime"></a>QTime::<span class="name">QTime</span> ()</h3>
<p>Constructs a null time object. A null time can be a <a href="qtime.html">QTime</a>(0, 0, 0, 0) (i.e., midnight) object, except that <a href="qtime.html#isNull">isNull</a>() returns true and <a href="qtime.html#isValid">isValid</a>() returns false.</p>
<p><b>See also </b><a href="qtime.html#isNull">isNull</a>() and <a href="qtime.html#isValid">isValid</a>().</p>
<!-- @@@QTime -->
<!-- $$$QTime$$$QTimeintintintint -->
<h3 class="fn"><a name="QTime-2"></a>QTime::<span class="name">QTime</span> ( <span class="type">int</span> <i>h</i>, <span class="type">int</span> <i>m</i>, <span class="type">int</span> <i>s</i> = 0, <span class="type">int</span> <i>ms</i> = 0 )</h3>
<p>Constructs a time with hour <i>h</i>, minute <i>m</i>, seconds <i>s</i> and milliseconds <i>ms</i>.</p>
<p><i>h</i> must be in the range 0 to 23, <i>m</i> and <i>s</i> must be in the range 0 to 59, and <i>ms</i> must be in the range 0 to 999.</p>
<p><b>See also </b><a href="qtime.html#isValid">isValid</a>().</p>
<!-- @@@QTime -->
<!-- $$$addMSecs[overload1]$$$addMSecsint -->
<h3 class="fn"><a name="addMSecs"></a><span class="type">QTime</span> QTime::<span class="name">addMSecs</span> ( <span class="type">int</span> <i>ms</i> ) const</h3>
<p>Returns a <a href="qtime.html">QTime</a> object containing a time <i>ms</i> milliseconds later than the time of this object (or earlier if <i>ms</i> is negative).</p>
<p>Note that the time will wrap if it passes midnight. See <a href="qtime.html#addSecs">addSecs</a>() for an example.</p>
<p><b>See also </b><a href="qtime.html#addSecs">addSecs</a>(), <a href="qtime.html#msecsTo">msecsTo</a>(), and <a href="qdatetime.html#addMSecs">QDateTime::addMSecs</a>().</p>
<!-- @@@addMSecs -->
<!-- $$$addSecs[overload1]$$$addSecsint -->
<h3 class="fn"><a name="addSecs"></a><span class="type">QTime</span> QTime::<span class="name">addSecs</span> ( <span class="type">int</span> <i>s</i> ) const</h3>
<p>Returns a <a href="qtime.html">QTime</a> object containing a time <i>s</i> seconds later than the time of this object (or earlier if <i>s</i> is negative).</p>
<p>Note that the time will wrap if it passes midnight.</p>
<p>Example:</p>
<pre class="cpp"> <span class="type"><a href="qtime.html">QTime</a></span> n(<span class="number">14</span><span class="operator">,</span> <span class="number">0</span><span class="operator">,</span> <span class="number">0</span>); <span class="comment">// n == 14:00:00</span>
<span class="type"><a href="qtime.html">QTime</a></span> t;
t <span class="operator">=</span> n<span class="operator">.</span>addSecs(<span class="number">70</span>); <span class="comment">// t == 14:01:10</span>
t <span class="operator">=</span> n<span class="operator">.</span>addSecs(<span class="operator">-</span><span class="number">70</span>); <span class="comment">// t == 13:58:50</span>
t <span class="operator">=</span> n<span class="operator">.</span>addSecs(<span class="number">10</span> <span class="operator">*</span> <span class="number">60</span> <span class="operator">*</span> <span class="number">60</span> <span class="operator">+</span> <span class="number">5</span>); <span class="comment">// t == 00:00:05</span>
t <span class="operator">=</span> n<span class="operator">.</span>addSecs(<span class="operator">-</span><span class="number">15</span> <span class="operator">*</span> <span class="number">60</span> <span class="operator">*</span> <span class="number">60</span>); <span class="comment">// t == 23:00:00</span></pre>
<p><b>See also </b><a href="qtime.html#addMSecs">addMSecs</a>(), <a href="qtime.html#secsTo">secsTo</a>(), and <a href="qdatetime.html#addSecs">QDateTime::addSecs</a>().</p>
<!-- @@@addSecs -->
<!-- $$$currentTime[overload1]$$$currentTime -->
<h3 class="fn"><a name="currentTime"></a><span class="type">QTime</span> QTime::<span class="name">currentTime</span> ()<tt> [static]</tt></h3>
<p>Returns the current time as reported by the system clock.</p>
<p>Note that the accuracy depends on the accuracy of the underlying operating system; not all systems provide 1-millisecond accuracy.</p>
<!-- @@@currentTime -->
<!-- $$$elapsed[overload1]$$$elapsed -->
<h3 class="fn"><a name="elapsed"></a><span class="type">int</span> QTime::<span class="name">elapsed</span> () const</h3>
<p>Returns the number of milliseconds that have elapsed since the last time <a href="qtime.html#start">start</a>() or <a href="qtime.html#restart">restart</a>() was called.</p>
<p>Note that the counter wraps to zero 24 hours after the last call to <a href="qtime.html#start">start</a>() or restart.</p>
<p>Note that the accuracy depends on the accuracy of the underlying operating system; not all systems provide 1-millisecond accuracy.</p>
<p><b>Warning:</b> If the system's clock setting has been changed since the last time <a href="qtime.html#start">start</a>() or <a href="qtime.html#restart">restart</a>() was called, the result is undefined. This can happen when daylight savings time is turned on or off.</p>
<p><b>See also </b><a href="qtime.html#start">start</a>() and <a href="qtime.html#restart">restart</a>().</p>
<!-- @@@elapsed -->
<!-- $$$fromString[overload1]$$$fromStringconstQString&Qt::DateFormat -->
<h3 class="fn"><a name="fromString"></a><span class="type">QTime</span> QTime::<span class="name">fromString</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>string</i>, <span class="type"><a href="qt.html#DateFormat-enum">Qt::DateFormat</a></span> <i>format</i> = Qt::TextDate )<tt> [static]</tt></h3>
<p>Returns the time represented in the <i>string</i> as a <a href="qtime.html">QTime</a> using the <i>format</i> given, or an invalid time if this is not possible.</p>
<p>Note that fromString() uses a "C" locale encoded string to convert milliseconds to a float value. If the default locale is not "C", this may result in two conversion attempts (if the conversion fails for the default locale). This should be considered an implementation detail.</p>
<!-- @@@fromString -->
<!-- $$$fromString$$$fromStringconstQString&constQString& -->
<h3 class="fn"><a name="fromString-2"></a><span class="type">QTime</span> QTime::<span class="name">fromString</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>string</i>, const <span class="type"><a href="qstring.html">QString</a></span> & <i>format</i> )<tt> [static]</tt></h3>
<p>Returns the <a href="qtime.html">QTime</a> represented by the <i>string</i>, using the <i>format</i> given, or an invalid time if the string cannot be parsed.</p>
<p>These expressions may be used for the format:</p>
<table class="generic">
<thead><tr class="qt-style"><th >Expression</th><th >Output</th></tr></thead>
<tr valign="top" class="odd"><td >h</td><td >the hour without a leading zero (0 to 23 or 1 to 12 if AM/PM display)</td></tr>
<tr valign="top" class="even"><td >hh</td><td >the hour with a leading zero (00 to 23 or 01 to 12 if AM/PM display)</td></tr>
<tr valign="top" class="odd"><td >m</td><td >the minute without a leading zero (0 to 59)</td></tr>
<tr valign="top" class="even"><td >mm</td><td >the minute with a leading zero (00 to 59)</td></tr>
<tr valign="top" class="odd"><td >s</td><td >the second without a leading zero (0 to 59)</td></tr>
<tr valign="top" class="even"><td >ss</td><td >the second with a leading zero (00 to 59)</td></tr>
<tr valign="top" class="odd"><td >z</td><td >the milliseconds without leading zeroes (0 to 999)</td></tr>
<tr valign="top" class="even"><td >zzz</td><td >the milliseconds with leading zeroes (000 to 999)</td></tr>
<tr valign="top" class="odd"><td >AP</td><td >interpret as an AM/PM time. <i>AP</i> must be either "AM" or "PM".</td></tr>
<tr valign="top" class="even"><td >ap</td><td >Interpret as an AM/PM time. <i>ap</i> must be either "am" or "pm".</td></tr>
</table>
<p>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.</p>
<pre class="cpp"> <span class="type"><a href="qtime.html">QTime</a></span> time <span class="operator">=</span> <span class="type"><a href="qtime.html">QTime</a></span><span class="operator">::</span><a href="qtime.html#fromString">fromString</a>(<span class="string">"1mm12car00"</span><span class="operator">,</span> <span class="string">"m'mm'hcarss"</span>);
<span class="comment">// time is 12:01.00</span></pre>
<p>If the format is not satisfied an invalid <a href="qtime.html">QTime</a> 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:</p>
<pre class="cpp"> <span class="type"><a href="qtime.html">QTime</a></span> time <span class="operator">=</span> <span class="type"><a href="qtime.html">QTime</a></span><span class="operator">::</span><a href="qtime.html#fromString">fromString</a>(<span class="string">"00:710"</span><span class="operator">,</span> <span class="string">"hh:ms"</span>); <span class="comment">// invalid</span></pre>
<p>Any field that is not represented in the format will be set to zero. For example:</p>
<pre class="cpp"> <span class="type"><a href="qtime.html">QTime</a></span> time <span class="operator">=</span> <span class="type"><a href="qtime.html">QTime</a></span><span class="operator">::</span><a href="qtime.html#fromString">fromString</a>(<span class="string">"1.30"</span><span class="operator">,</span> <span class="string">"m.s"</span>);
<span class="comment">// time is 00:01:30.000</span></pre>
<p><a href="qdatetime.html#toString">QDateTime::toString</a>() <a href="qtime.html#toString">QTime::toString</a>()</p>
<p><b>See also </b><a href="qdatetime.html#fromString">QDateTime::fromString</a>(), <a href="qdate.html#fromString">QDate::fromString</a>(), and <a href="qdate.html#toString">QDate::toString</a>().</p>
<!-- @@@fromString -->
<!-- $$$hour[overload1]$$$hour -->
<h3 class="fn"><a name="hour"></a><span class="type">int</span> QTime::<span class="name">hour</span> () const</h3>
<p>Returns the hour part (0 to 23) of the time.</p>
<p><b>See also </b><a href="qtime.html#minute">minute</a>(), <a href="qtime.html#second">second</a>(), and <a href="qtime.html#msec">msec</a>().</p>
<!-- @@@hour -->
<!-- $$$isNull[overload1]$$$isNull -->
<h3 class="fn"><a name="isNull"></a><span class="type">bool</span> QTime::<span class="name">isNull</span> () const</h3>
<p>Returns true if the time is null (i.e., the <a href="qtime.html">QTime</a> object was constructed using the default constructor); otherwise returns false. A null time is also an invalid time.</p>
<p><b>See also </b><a href="qtime.html#isValid">isValid</a>().</p>
<!-- @@@isNull -->
<!-- $$$isValid[overload1]$$$isValid -->
<h3 class="fn"><a name="isValid"></a><span class="type">bool</span> QTime::<span class="name">isValid</span> () const</h3>
<p>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.</p>
<p><b>See also </b><a href="qtime.html#isNull">isNull</a>().</p>
<!-- @@@isValid -->
<!-- $$$isValid$$$isValidintintintint -->
<h3 class="fn"><a name="isValid-2"></a><span class="type">bool</span> QTime::<span class="name">isValid</span> ( <span class="type">int</span> <i>h</i>, <span class="type">int</span> <i>m</i>, <span class="type">int</span> <i>s</i>, <span class="type">int</span> <i>ms</i> = 0 )<tt> [static]</tt></h3>
<p>This is an overloaded function.</p>
<p>Returns true if the specified time is valid; otherwise returns false.</p>
<p>The time is valid if <i>h</i> is in the range 0 to 23, <i>m</i> and <i>s</i> are in the range 0 to 59, and <i>ms</i> is in the range 0 to 999.</p>
<p>Example:</p>
<pre class="cpp"> <span class="type"><a href="qtime.html">QTime</a></span><span class="operator">::</span><a href="qtime.html#isValid">isValid</a>(<span class="number">21</span><span class="operator">,</span> <span class="number">10</span><span class="operator">,</span> <span class="number">30</span>); <span class="comment">// returns true</span>
<span class="type"><a href="qtime.html">QTime</a></span><span class="operator">::</span><a href="qtime.html#isValid">isValid</a>(<span class="number">22</span><span class="operator">,</span> <span class="number">5</span><span class="operator">,</span> <span class="number">62</span>); <span class="comment">// returns false</span></pre>
<!-- @@@isValid -->
<!-- $$$minute[overload1]$$$minute -->
<h3 class="fn"><a name="minute"></a><span class="type">int</span> QTime::<span class="name">minute</span> () const</h3>
<p>Returns the minute part (0 to 59) of the time.</p>
<p><b>See also </b><a href="qtime.html#hour">hour</a>(), <a href="qtime.html#second">second</a>(), and <a href="qtime.html#msec">msec</a>().</p>
<!-- @@@minute -->
<!-- $$$msec[overload1]$$$msec -->
<h3 class="fn"><a name="msec"></a><span class="type">int</span> QTime::<span class="name">msec</span> () const</h3>
<p>Returns the millisecond part (0 to 999) of the time.</p>
<p><b>See also </b><a href="qtime.html#hour">hour</a>(), <a href="qtime.html#minute">minute</a>(), and <a href="qtime.html#second">second</a>().</p>
<!-- @@@msec -->
<!-- $$$msecsTo[overload1]$$$msecsToconstQTime& -->
<h3 class="fn"><a name="msecsTo"></a><span class="type">int</span> QTime::<span class="name">msecsTo</span> ( const <span class="type">QTime</span> & <i>t</i> ) const</h3>
<p>Returns the number of milliseconds from this time to <i>t</i>. If <i>t</i> is earlier than this time, the number of milliseconds returned is negative.</p>
<p>Because <a href="qtime.html">QTime</a> measures time within a day and there are 86400 seconds in a day, the result is always between -86400000 and 86400000 ms.</p>
<p><b>See also </b><a href="qtime.html#secsTo">secsTo</a>(), <a href="qtime.html#addMSecs">addMSecs</a>(), and <a href="qdatetime.html#msecsTo">QDateTime::msecsTo</a>().</p>
<!-- @@@msecsTo -->
<!-- $$$restart[overload1]$$$restart -->
<h3 class="fn"><a name="restart"></a><span class="type">int</span> QTime::<span class="name">restart</span> ()</h3>
<p>Sets this time to the current time and returns the number of milliseconds that have elapsed since the last time <a href="qtime.html#start">start</a>() or restart() was called.</p>
<p>This function is guaranteed to be atomic and is thus very handy for repeated measurements. Call <a href="qtime.html#start">start</a>() to start the first measurement, and restart() for each later measurement.</p>
<p>Note that the counter wraps to zero 24 hours after the last call to <a href="qtime.html#start">start</a>() or restart().</p>
<p><b>Warning:</b> If the system's clock setting has been changed since the last time <a href="qtime.html#start">start</a>() or restart() was called, the result is undefined. This can happen when daylight savings time is turned on or off.</p>
<p><b>See also </b><a href="qtime.html#start">start</a>(), <a href="qtime.html#elapsed">elapsed</a>(), and <a href="qtime.html#currentTime">currentTime</a>().</p>
<!-- @@@restart -->
<!-- $$$second[overload1]$$$second -->
<h3 class="fn"><a name="second"></a><span class="type">int</span> QTime::<span class="name">second</span> () const</h3>
<p>Returns the second part (0 to 59) of the time.</p>
<p><b>See also </b><a href="qtime.html#hour">hour</a>(), <a href="qtime.html#minute">minute</a>(), and <a href="qtime.html#msec">msec</a>().</p>
<!-- @@@second -->
<!-- $$$secsTo[overload1]$$$secsToconstQTime& -->
<h3 class="fn"><a name="secsTo"></a><span class="type">int</span> QTime::<span class="name">secsTo</span> ( const <span class="type">QTime</span> & <i>t</i> ) const</h3>
<p>Returns the number of seconds from this time to <i>t</i>. If <i>t</i> is earlier than this time, the number of seconds returned is negative.</p>
<p>Because <a href="qtime.html">QTime</a> measures time within a day and there are 86400 seconds in a day, the result is always between -86400 and 86400.</p>
<p>secsTo() does not take into account any milliseconds.</p>
<p><b>See also </b><a href="qtime.html#addSecs">addSecs</a>() and <a href="qdatetime.html#secsTo">QDateTime::secsTo</a>().</p>
<!-- @@@secsTo -->
<!-- $$$setHMS[overload1]$$$setHMSintintintint -->
<h3 class="fn"><a name="setHMS"></a><span class="type">bool</span> QTime::<span class="name">setHMS</span> ( <span class="type">int</span> <i>h</i>, <span class="type">int</span> <i>m</i>, <span class="type">int</span> <i>s</i>, <span class="type">int</span> <i>ms</i> = 0 )</h3>
<p>Sets the time to hour <i>h</i>, minute <i>m</i>, seconds <i>s</i> and milliseconds <i>ms</i>.</p>
<p><i>h</i> must be in the range 0 to 23, <i>m</i> and <i>s</i> must be in the range 0 to 59, and <i>ms</i> must be in the range 0 to 999. Returns true if the set time is valid; otherwise returns false.</p>
<p><b>See also </b><a href="qtime.html#isValid">isValid</a>().</p>
<!-- @@@setHMS -->
<!-- $$$start[overload1]$$$start -->
<h3 class="fn"><a name="start"></a><span class="type">void</span> QTime::<span class="name">start</span> ()</h3>
<p>Sets this time to the current time. This is practical for timing:</p>
<pre class="cpp"> <span class="type"><a href="qtime.html">QTime</a></span> t;
t<span class="operator">.</span>start();
some_lengthy_task();
<a href="qtglobal.html#qDebug">qDebug</a>(<span class="string">"Time elapsed: %d ms"</span><span class="operator">,</span> t<span class="operator">.</span>elapsed());</pre>
<p><b>See also </b><a href="qtime.html#restart">restart</a>(), <a href="qtime.html#elapsed">elapsed</a>(), and <a href="qtime.html#currentTime">currentTime</a>().</p>
<!-- @@@start -->
<!-- $$$toString[overload1]$$$toStringconstQString& -->
<h3 class="fn"><a name="toString"></a><span class="type"><a href="qstring.html">QString</a></span> QTime::<span class="name">toString</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>format</i> ) const</h3>
<p>Returns the time as a string. The <i>format</i> parameter determines the format of the result string.</p>
<p>These expressions may be used:</p>
<table class="generic">
<thead><tr class="qt-style"><th >Expression</th><th >Output</th></tr></thead>
<tr valign="top" class="odd"><td >h</td><td >the hour without a leading zero (0 to 23 or 1 to 12 if AM/PM display)</td></tr>
<tr valign="top" class="even"><td >hh</td><td >the hour with a leading zero (00 to 23 or 01 to 12 if AM/PM display)</td></tr>
<tr valign="top" class="odd"><td >H</td><td >the hour without a leading zero (0 to 23, even with AM/PM display)</td></tr>
<tr valign="top" class="even"><td >HH</td><td >the hour with a leading zero (00 to 23, even with AM/PM display)</td></tr>
<tr valign="top" class="odd"><td >m</td><td >the minute without a leading zero (0 to 59)</td></tr>
<tr valign="top" class="even"><td >mm</td><td >the minute with a leading zero (00 to 59)</td></tr>
<tr valign="top" class="odd"><td >s</td><td >the second without a leading zero (0 to 59)</td></tr>
<tr valign="top" class="even"><td >ss</td><td >the second with a leading zero (00 to 59)</td></tr>
<tr valign="top" class="odd"><td >z</td><td >the milliseconds without leading zeroes (0 to 999)</td></tr>
<tr valign="top" class="even"><td >zzz</td><td >the milliseconds with leading zeroes (000 to 999)</td></tr>
<tr valign="top" class="odd"><td >AP or A</td><td >use AM/PM display. <i>AP</i> will be replaced by either "AM" or "PM".</td></tr>
<tr valign="top" class="even"><td >ap or a</td><td >use am/pm display. <i>ap</i> will be replaced by either "am" or "pm".</td></tr>
<tr valign="top" class="odd"><td >t</td><td >the timezone (for example "CEST")</td></tr>
</table>
<p>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.</p>
<p>Example format strings (assuming that the <a href="qtime.html">QTime</a> is 14:13:09.042)</p>
<table class="generic">
<thead><tr class="qt-style"><th >Format</th><th >Result</th></tr></thead>
<tr valign="top" class="odd"><td >hh:mm:ss.zzz</td><td >14:13:09.042</td></tr>
<tr valign="top" class="even"><td >h:m:s ap</td><td >2:13:9 pm</td></tr>
<tr valign="top" class="odd"><td >H:m:s a</td><td >14:13:9 pm</td></tr>
</table>
<p>If the datetime is invalid, an empty string will be returned. If <i>format</i> is empty, the default format "hh:mm:ss" is used.</p>
<p><b>See also </b><a href="qdate.html#toString">QDate::toString</a>() and <a href="qdatetime.html#toString">QDateTime::toString</a>().</p>
<!-- @@@toString -->
<!-- $$$toString$$$toStringQt::DateFormat -->
<h3 class="fn"><a name="toString-2"></a><span class="type"><a href="qstring.html">QString</a></span> QTime::<span class="name">toString</span> ( <span class="type"><a href="qt.html#DateFormat-enum">Qt::DateFormat</a></span> <i>format</i> = Qt::TextDate ) const</h3>
<p>This is an overloaded function.</p>
<p>Returns the time as a string. Milliseconds are not included. The <i>format</i> parameter determines the format of the string.</p>
<p>If <i>format</i> is <a href="qt.html#DateFormat-enum">Qt::TextDate</a>, the string format is HH:MM:SS; e.g. 1 second before midnight would be "23:59:59".</p>
<p>If <i>format</i> is <a href="qt.html#DateFormat-enum">Qt::ISODate</a>, the string format corresponds to the ISO 8601 extended specification for representations of dates, which is also HH:mm:ss. (However, contrary to ISO 8601, dates before 15 October 1582 are handled as Julian dates, not Gregorian dates. See <a href="qdate.html#qdate-g-and-j">Use of Gregorian and Julian Calendars</a>. This might change in a future version of Qt.)</p>
<p>If the <i>format</i> is <a href="qt.html#DateFormat-enum">Qt::SystemLocaleShortDate</a> or <a href="qt.html#DateFormat-enum">Qt::SystemLocaleLongDate</a>, the string format depends on the locale settings of the system. Identical to calling <a href="qlocale.html#system">QLocale::system</a>().toString(time, <a href="qlocale.html#FormatType-enum">QLocale::ShortFormat</a>) or <a href="qlocale.html#system">QLocale::system</a>().toString(time, <a href="qlocale.html#FormatType-enum">QLocale::LongFormat</a>).</p>
<p>If the <i>format</i> is <a href="qt.html#DateFormat-enum">Qt::DefaultLocaleShortDate</a> or <a href="qt.html#DateFormat-enum">Qt::DefaultLocaleLongDate</a>, the string format depends on the default application locale. This is the locale set with <a href="qlocale.html#setDefault">QLocale::setDefault</a>(), or the system locale if no default locale has been set. Identical to calling QLocale().toString(time, <a href="qlocale.html#FormatType-enum">QLocale::ShortFormat</a>) or QLocale().toString(time, <a href="qlocale.html#FormatType-enum">QLocale::LongFormat</a>).</p>
<p>If the time is invalid, an empty string will be returned.</p>
<!-- @@@toString -->
<!-- $$$operator!=[overload1]$$$operator!=constQTime& -->
<h3 class="fn"><a name="operator-not-eq"></a><span class="type">bool</span> QTime::<span class="name">operator!=</span> ( const <span class="type">QTime</span> & <i>t</i> ) const</h3>
<p>Returns true if this time is different from <i>t</i>; otherwise returns false.</p>
<!-- @@@operator!= -->
<!-- $$$operator<[overload1]$$$operator<constQTime& -->
<h3 class="fn"><a name="operator-lt"></a><span class="type">bool</span> QTime::<span class="name">operator<</span> ( const <span class="type">QTime</span> & <i>t</i> ) const</h3>
<p>Returns true if this time is earlier than <i>t</i>; otherwise returns false.</p>
<!-- @@@operator< -->
<!-- $$$operator<=[overload1]$$$operator<=constQTime& -->
<h3 class="fn"><a name="operator-lt-eq"></a><span class="type">bool</span> QTime::<span class="name">operator<=</span> ( const <span class="type">QTime</span> & <i>t</i> ) const</h3>
<p>Returns true if this time is earlier than or equal to <i>t</i>; otherwise returns false.</p>
<!-- @@@operator<= -->
<!-- $$$operator==[overload1]$$$operator==constQTime& -->
<h3 class="fn"><a name="operator-eq-eq"></a><span class="type">bool</span> QTime::<span class="name">operator==</span> ( const <span class="type">QTime</span> & <i>t</i> ) const</h3>
<p>Returns true if this time is equal to <i>t</i>; otherwise returns false.</p>
<!-- @@@operator== -->
<!-- $$$operator>[overload1]$$$operator>constQTime& -->
<h3 class="fn"><a name="operator-gt"></a><span class="type">bool</span> QTime::<span class="name">operator></span> ( const <span class="type">QTime</span> & <i>t</i> ) const</h3>
<p>Returns true if this time is later than <i>t</i>; otherwise returns false.</p>
<!-- @@@operator> -->
<!-- $$$operator>=[overload1]$$$operator>=constQTime& -->
<h3 class="fn"><a name="operator-gt-eq"></a><span class="type">bool</span> QTime::<span class="name">operator>=</span> ( const <span class="type">QTime</span> & <i>t</i> ) const</h3>
<p>Returns true if this time is later than or equal to <i>t</i>; otherwise returns false.</p>
<!-- @@@operator>= -->
</div>
<div class="relnonmem">
<h2>Related Non-Members</h2>
<!-- $$$operator<<$$$operator<<QDataStream&constQTime& -->
<h3 class="fn"><a name="operator-lt-lt-96"></a><span class="type"><a href="qdatastream.html">QDataStream</a></span> & <span class="name">operator<<</span> ( <span class="type"><a href="qdatastream.html">QDataStream</a></span> & <i>out</i>, const <span class="type">QTime</span> & <i>time</i> )</h3>
<p>Writes <i>time</i> to stream <i>out</i>.</p>
<p><b>See also </b><a href="datastreamformat.html">Serializing Qt Data Types</a>.</p>
<!-- @@@operator<< -->
<!-- $$$operator>>$$$operator>>QDataStream&QTime& -->
<h3 class="fn"><a name="operator-gt-gt-50"></a><span class="type"><a href="qdatastream.html">QDataStream</a></span> & <span class="name">operator>></span> ( <span class="type"><a href="qdatastream.html">QDataStream</a></span> & <i>in</i>, <span class="type">QTime</span> & <i>time</i> )</h3>
<p>Reads a time from stream <i>in</i> into the given <i>time</i>.</p>
<p><b>See also </b><a href="datastreamformat.html">Serializing Qt Data Types</a>.</p>
<!-- @@@operator>> -->
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2012 Nokia Corporation and/or its
subsidiaries. Documentation contributions included herein are the copyrights of
their respective owners.</p>
<br />
<p>
The documentation provided herein is licensed under the terms of the
<a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation
License version 1.3</a> as published by the Free Software Foundation.</p>
<p>
Documentation sources may be obtained from <a href="http://www.qt-project.org">
www.qt-project.org</a>.</p>
<br />
<p>
Nokia, Qt and their respective logos are trademarks of Nokia Corporation
in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. <a title="Privacy Policy"
href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p>
</div>
</body>
</html>
|
