TimeTracker/Documentation/source/Plugin_Time_Tracker.TimeTracker.TimeTrackEntry.html

branch
eric7
changeset 116
e8b0641eba15
parent 106
6deb942739dc
equal deleted inserted replaced
115:859d59103f9f 116:e8b0641eba15
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>Plugin_Time_Tracker.TimeTracker.TimeTrackEntry</h1> 9 <h1>Plugin_Time_Tracker.TimeTracker.TimeTrackEntry</h1>
10
11 <p> 10 <p>
12 Module implementing the time track entry class. 11 Module implementing the time track entry class.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15
16 <table> 15 <table>
17 <tr><td>None</td></tr> 16 <tr><td>None</td></tr>
18 </table> 17 </table>
18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#TimeTrackEntry">TimeTrackEntry</a></td> 22 <td><a href="#TimeTrackEntry">TimeTrackEntry</a></td>
25 <td>Class implementing the time track entry.</td> 23 <td>Class implementing the time track entry.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29
30 <table> 28 <table>
31 <tr><td>None</td></tr> 29 <tr><td>None</td></tr>
32 </table> 30 </table>
31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="TimeTrackEntry" ID="TimeTrackEntry"></a> 34 <a NAME="TimeTrackEntry" ID="TimeTrackEntry"></a>
36 <h2>TimeTrackEntry</h2> 35 <h2>TimeTrackEntry</h2>
37
38 <p> 36 <p>
39 Class implementing the time track entry. 37 Class implementing the time track entry.
40 </p> 38 </p>
39
41 <h3>Derived from</h3> 40 <h3>Derived from</h3>
42 None 41 None
43 <h3>Class Attributes</h3> 42 <h3>Class Attributes</h3>
44 43 <table>
45 <table> 44 <tr><td>LineMarker</td></tr>
46 <tr><td>LineMarker</td></tr><tr><td>Separator</td></tr> 45 <tr><td>Separator</td></tr>
47 </table> 46 </table>
47
48 <h3>Class Methods</h3> 48 <h3>Class Methods</h3>
49
50 <table> 49 <table>
51 <tr><td>None</td></tr> 50 <tr><td>None</td></tr>
52 </table> 51 </table>
52
53 <h3>Methods</h3> 53 <h3>Methods</h3>
54 54 <table>
55 <table>
56
57 <tr> 55 <tr>
58 <td><a href="#TimeTrackEntry.__init__">TimeTrackEntry</a></td> 56 <td><a href="#TimeTrackEntry.__init__">TimeTrackEntry</a></td>
59 <td>Constructor</td> 57 <td>Constructor</td>
60 </tr> 58 </tr>
61 <tr> 59 <tr>
149 <tr> 147 <tr>
150 <td><a href="#TimeTrackEntry.toDict">toDict</a></td> 148 <td><a href="#TimeTrackEntry.toDict">toDict</a></td>
151 <td>Public method to convert the time track entry into a dictionary.</td> 149 <td>Public method to convert the time track entry into a dictionary.</td>
152 </tr> 150 </tr>
153 </table> 151 </table>
152
154 <h3>Static Methods</h3> 153 <h3>Static Methods</h3>
155
156 <table> 154 <table>
157 <tr><td>None</td></tr> 155 <tr><td>None</td></tr>
158 </table> 156 </table>
157
159 158
160 <a NAME="TimeTrackEntry.__init__" ID="TimeTrackEntry.__init__"></a> 159 <a NAME="TimeTrackEntry.__init__" ID="TimeTrackEntry.__init__"></a>
161 <h4>TimeTrackEntry (Constructor)</h4> 160 <h4>TimeTrackEntry (Constructor)</h4>
162 <b>TimeTrackEntry</b>(<i>plugin</i>) 161 <b>TimeTrackEntry</b>(<i>plugin</i>)
163
164 <p> 162 <p>
165 Constructor 163 Constructor
166 </p> 164 </p>
165
167 <dl> 166 <dl>
168 167
169 <dt><i>plugin</i> (TimeTrackerPlugin)</dt> 168 <dt><i>plugin</i> (TimeTrackerPlugin)</dt>
170 <dd> 169 <dd>
171 reference to the plugin object 170 reference to the plugin object
172 </dd> 171 </dd>
173 </dl> 172 </dl>
174 <a NAME="TimeTrackEntry.__calculateDuration" ID="TimeTrackEntry.__calculateDuration"></a> 173 <a NAME="TimeTrackEntry.__calculateDuration" ID="TimeTrackEntry.__calculateDuration"></a>
175 <h4>TimeTrackEntry.__calculateDuration</h4> 174 <h4>TimeTrackEntry.__calculateDuration</h4>
176 <b>__calculateDuration</b>(<i>start, stop</i>) 175 <b>__calculateDuration</b>(<i>start, stop</i>)
177
178 <p> 176 <p>
179 Private method to calculate the duration in minutes. 177 Private method to calculate the duration in minutes.
180 </p> 178 </p>
179
181 <dl> 180 <dl>
182 181
183 <dt><i>start</i> (QDateTime)</dt> 182 <dt><i>start</i> (QDateTime)</dt>
184 <dd> 183 <dd>
185 start date and time 184 start date and time
202 </dd> 201 </dd>
203 </dl> 202 </dl>
204 <a NAME="TimeTrackEntry.__currentDateTime" ID="TimeTrackEntry.__currentDateTime"></a> 203 <a NAME="TimeTrackEntry.__currentDateTime" ID="TimeTrackEntry.__currentDateTime"></a>
205 <h4>TimeTrackEntry.__currentDateTime</h4> 204 <h4>TimeTrackEntry.__currentDateTime</h4>
206 <b>__currentDateTime</b>(<i></i>) 205 <b>__currentDateTime</b>(<i></i>)
207
208 <p> 206 <p>
209 Private method to get the current date and time without milliseconds. 207 Private method to get the current date and time without milliseconds.
210 </p> 208 </p>
209
211 <dl> 210 <dl>
212 <dt>Return:</dt> 211 <dt>Return:</dt>
213 <dd> 212 <dd>
214 current date and time 213 current date and time
215 </dd> 214 </dd>
221 </dd> 220 </dd>
222 </dl> 221 </dl>
223 <a NAME="TimeTrackEntry.__lt__" ID="TimeTrackEntry.__lt__"></a> 222 <a NAME="TimeTrackEntry.__lt__" ID="TimeTrackEntry.__lt__"></a>
224 <h4>TimeTrackEntry.__lt__</h4> 223 <h4>TimeTrackEntry.__lt__</h4>
225 <b>__lt__</b>(<i>other</i>) 224 <b>__lt__</b>(<i>other</i>)
226
227 <p> 225 <p>
228 Special method implementing the less than function. 226 Special method implementing the less than function.
229 </p> 227 </p>
228
230 <dl> 229 <dl>
231 230
232 <dt><i>other</i> (TimeTrackEntry)</dt> 231 <dt><i>other</i> (TimeTrackEntry)</dt>
233 <dd> 232 <dd>
234 reference to the other object 233 reference to the other object
247 </dd> 246 </dd>
248 </dl> 247 </dl>
249 <a NAME="TimeTrackEntry.addDuration" ID="TimeTrackEntry.addDuration"></a> 248 <a NAME="TimeTrackEntry.addDuration" ID="TimeTrackEntry.addDuration"></a>
250 <h4>TimeTrackEntry.addDuration</h4> 249 <h4>TimeTrackEntry.addDuration</h4>
251 <b>addDuration</b>(<i>duration</i>) 250 <b>addDuration</b>(<i>duration</i>)
252
253 <p> 251 <p>
254 Public method to add a duration. 252 Public method to add a duration.
255 </p> 253 </p>
254
256 <dl> 255 <dl>
257 256
258 <dt><i>duration</i> (int)</dt> 257 <dt><i>duration</i> (int)</dt>
259 <dd> 258 <dd>
260 duration to be added in minutes. Negative values are 259 duration to be added in minutes. Negative values are
262 </dd> 261 </dd>
263 </dl> 262 </dl>
264 <a NAME="TimeTrackEntry.continue_" ID="TimeTrackEntry.continue_"></a> 263 <a NAME="TimeTrackEntry.continue_" ID="TimeTrackEntry.continue_"></a>
265 <h4>TimeTrackEntry.continue_</h4> 264 <h4>TimeTrackEntry.continue_</h4>
266 <b>continue_</b>(<i></i>) 265 <b>continue_</b>(<i></i>)
267
268 <p> 266 <p>
269 Public method to continue the entry. 267 Public method to continue the entry.
270 </p> 268 </p>
269
271 <a NAME="TimeTrackEntry.fromDict" ID="TimeTrackEntry.fromDict"></a> 270 <a NAME="TimeTrackEntry.fromDict" ID="TimeTrackEntry.fromDict"></a>
272 <h4>TimeTrackEntry.fromDict</h4> 271 <h4>TimeTrackEntry.fromDict</h4>
273 <b>fromDict</b>(<i>data</i>) 272 <b>fromDict</b>(<i>data</i>)
274
275 <p> 273 <p>
276 Public method to populate the time track entry from a dictionary. 274 Public method to populate the time track entry from a dictionary.
277 </p> 275 </p>
276
278 <dl> 277 <dl>
279 278
280 <dt><i>data</i> (dict)</dt> 279 <dt><i>data</i> (dict)</dt>
281 <dd> 280 <dd>
282 dictionary containing the time track entry data 281 dictionary containing the time track entry data
295 </dd> 294 </dd>
296 </dl> 295 </dl>
297 <a NAME="TimeTrackEntry.getComment" ID="TimeTrackEntry.getComment"></a> 296 <a NAME="TimeTrackEntry.getComment" ID="TimeTrackEntry.getComment"></a>
298 <h4>TimeTrackEntry.getComment</h4> 297 <h4>TimeTrackEntry.getComment</h4>
299 <b>getComment</b>(<i></i>) 298 <b>getComment</b>(<i></i>)
300
301 <p> 299 <p>
302 Public method to get the comment. 300 Public method to get the comment.
303 </p> 301 </p>
302
304 <dl> 303 <dl>
305 <dt>Return:</dt> 304 <dt>Return:</dt>
306 <dd> 305 <dd>
307 comment 306 comment
308 </dd> 307 </dd>
314 </dd> 313 </dd>
315 </dl> 314 </dl>
316 <a NAME="TimeTrackEntry.getDuration" ID="TimeTrackEntry.getDuration"></a> 315 <a NAME="TimeTrackEntry.getDuration" ID="TimeTrackEntry.getDuration"></a>
317 <h4>TimeTrackEntry.getDuration</h4> 316 <h4>TimeTrackEntry.getDuration</h4>
318 <b>getDuration</b>(<i></i>) 317 <b>getDuration</b>(<i></i>)
319
320 <p> 318 <p>
321 Public slot to get the duration. 319 Public slot to get the duration.
322 </p> 320 </p>
321
323 <dl> 322 <dl>
324 <dt>Return:</dt> 323 <dt>Return:</dt>
325 <dd> 324 <dd>
326 duration 325 duration
327 </dd> 326 </dd>
333 </dd> 332 </dd>
334 </dl> 333 </dl>
335 <a NAME="TimeTrackEntry.getEntryData" ID="TimeTrackEntry.getEntryData"></a> 334 <a NAME="TimeTrackEntry.getEntryData" ID="TimeTrackEntry.getEntryData"></a>
336 <h4>TimeTrackEntry.getEntryData</h4> 335 <h4>TimeTrackEntry.getEntryData</h4>
337 <b>getEntryData</b>(<i></i>) 336 <b>getEntryData</b>(<i></i>)
338
339 <p> 337 <p>
340 Public method to get the entry data. 338 Public method to get the entry data.
341 </p> 339 </p>
340
342 <dl> 341 <dl>
343 <dt>Return:</dt> 342 <dt>Return:</dt>
344 <dd> 343 <dd>
345 entry data as a dictionary with keys 'id', 'paused', 344 entry data as a dictionary with keys 'id', 'paused',
346 'start_date', 'start_time', 'duration', 'task' and 'comment' 345 'start_date', 'start_time', 'duration', 'task' and 'comment'
356 </dd> 355 </dd>
357 </dl> 356 </dl>
358 <a NAME="TimeTrackEntry.getID" ID="TimeTrackEntry.getID"></a> 357 <a NAME="TimeTrackEntry.getID" ID="TimeTrackEntry.getID"></a>
359 <h4>TimeTrackEntry.getID</h4> 358 <h4>TimeTrackEntry.getID</h4>
360 <b>getID</b>(<i></i>) 359 <b>getID</b>(<i></i>)
361
362 <p> 360 <p>
363 Public method to get the ID of the entry. 361 Public method to get the ID of the entry.
364 </p> 362 </p>
363
365 <dl> 364 <dl>
366 <dt>Return:</dt> 365 <dt>Return:</dt>
367 <dd> 366 <dd>
368 ID of the entry 367 ID of the entry
369 </dd> 368 </dd>
375 </dd> 374 </dd>
376 </dl> 375 </dl>
377 <a NAME="TimeTrackEntry.getStartDateTime" ID="TimeTrackEntry.getStartDateTime"></a> 376 <a NAME="TimeTrackEntry.getStartDateTime" ID="TimeTrackEntry.getStartDateTime"></a>
378 <h4>TimeTrackEntry.getStartDateTime</h4> 377 <h4>TimeTrackEntry.getStartDateTime</h4>
379 <b>getStartDateTime</b>(<i></i>) 378 <b>getStartDateTime</b>(<i></i>)
380
381 <p> 379 <p>
382 Public method to get the start date and time. 380 Public method to get the start date and time.
383 </p> 381 </p>
382
384 <dl> 383 <dl>
385 <dt>Return:</dt> 384 <dt>Return:</dt>
386 <dd> 385 <dd>
387 start date and time 386 start date and time
388 </dd> 387 </dd>
394 </dd> 393 </dd>
395 </dl> 394 </dl>
396 <a NAME="TimeTrackEntry.getTask" ID="TimeTrackEntry.getTask"></a> 395 <a NAME="TimeTrackEntry.getTask" ID="TimeTrackEntry.getTask"></a>
397 <h4>TimeTrackEntry.getTask</h4> 396 <h4>TimeTrackEntry.getTask</h4>
398 <b>getTask</b>(<i></i>) 397 <b>getTask</b>(<i></i>)
399
400 <p> 398 <p>
401 Public method to get the task description. 399 Public method to get the task description.
402 </p> 400 </p>
401
403 <dl> 402 <dl>
404 <dt>Return:</dt> 403 <dt>Return:</dt>
405 <dd> 404 <dd>
406 task description 405 task description
407 </dd> 406 </dd>
413 </dd> 412 </dd>
414 </dl> 413 </dl>
415 <a NAME="TimeTrackEntry.isPaused" ID="TimeTrackEntry.isPaused"></a> 414 <a NAME="TimeTrackEntry.isPaused" ID="TimeTrackEntry.isPaused"></a>
416 <h4>TimeTrackEntry.isPaused</h4> 415 <h4>TimeTrackEntry.isPaused</h4>
417 <b>isPaused</b>(<i></i>) 416 <b>isPaused</b>(<i></i>)
418
419 <p> 417 <p>
420 Public method to check for a paused state. 418 Public method to check for a paused state.
421 </p> 419 </p>
420
422 <dl> 421 <dl>
423 <dt>Return:</dt> 422 <dt>Return:</dt>
424 <dd> 423 <dd>
425 flag indicating a paused state 424 flag indicating a paused state
426 </dd> 425 </dd>
432 </dd> 431 </dd>
433 </dl> 432 </dl>
434 <a NAME="TimeTrackEntry.isValid" ID="TimeTrackEntry.isValid"></a> 433 <a NAME="TimeTrackEntry.isValid" ID="TimeTrackEntry.isValid"></a>
435 <h4>TimeTrackEntry.isValid</h4> 434 <h4>TimeTrackEntry.isValid</h4>
436 <b>isValid</b>(<i></i>) 435 <b>isValid</b>(<i></i>)
437
438 <p> 436 <p>
439 Public method to check the validity of the entry. 437 Public method to check the validity of the entry.
440 </p> 438 </p>
439
441 <dl> 440 <dl>
442 <dt>Return:</dt> 441 <dt>Return:</dt>
443 <dd> 442 <dd>
444 validity of the entry 443 validity of the entry
445 </dd> 444 </dd>
451 </dd> 450 </dd>
452 </dl> 451 </dl>
453 <a NAME="TimeTrackEntry.pause" ID="TimeTrackEntry.pause"></a> 452 <a NAME="TimeTrackEntry.pause" ID="TimeTrackEntry.pause"></a>
454 <h4>TimeTrackEntry.pause</h4> 453 <h4>TimeTrackEntry.pause</h4>
455 <b>pause</b>(<i></i>) 454 <b>pause</b>(<i></i>)
456
457 <p> 455 <p>
458 Public method to pause the entry. 456 Public method to pause the entry.
459 </p> 457 </p>
458
460 <a NAME="TimeTrackEntry.setComment" ID="TimeTrackEntry.setComment"></a> 459 <a NAME="TimeTrackEntry.setComment" ID="TimeTrackEntry.setComment"></a>
461 <h4>TimeTrackEntry.setComment</h4> 460 <h4>TimeTrackEntry.setComment</h4>
462 <b>setComment</b>(<i>comment</i>) 461 <b>setComment</b>(<i>comment</i>)
463
464 <p> 462 <p>
465 Public method to set a comment. 463 Public method to set a comment.
466 </p> 464 </p>
465
467 <dl> 466 <dl>
468 467
469 <dt><i>comment</i> (str)</dt> 468 <dt><i>comment</i> (str)</dt>
470 <dd> 469 <dd>
471 comment to set 470 comment to set
472 </dd> 471 </dd>
473 </dl> 472 </dl>
474 <a NAME="TimeTrackEntry.setDuration" ID="TimeTrackEntry.setDuration"></a> 473 <a NAME="TimeTrackEntry.setDuration" ID="TimeTrackEntry.setDuration"></a>
475 <h4>TimeTrackEntry.setDuration</h4> 474 <h4>TimeTrackEntry.setDuration</h4>
476 <b>setDuration</b>(<i>duration</i>) 475 <b>setDuration</b>(<i>duration</i>)
477
478 <p> 476 <p>
479 Public method to set the duration. 477 Public method to set the duration.
480 </p> 478 </p>
479
481 <dl> 480 <dl>
482 481
483 <dt><i>duration</i> (int)</dt> 482 <dt><i>duration</i> (int)</dt>
484 <dd> 483 <dd>
485 duration in minutes 484 duration in minutes
486 </dd> 485 </dd>
487 </dl> 486 </dl>
488 <a NAME="TimeTrackEntry.setID" ID="TimeTrackEntry.setID"></a> 487 <a NAME="TimeTrackEntry.setID" ID="TimeTrackEntry.setID"></a>
489 <h4>TimeTrackEntry.setID</h4> 488 <h4>TimeTrackEntry.setID</h4>
490 <b>setID</b>(<i>eid</i>) 489 <b>setID</b>(<i>eid</i>)
491
492 <p> 490 <p>
493 Public method to assign an ID to the entry. 491 Public method to assign an ID to the entry.
494 </p> 492 </p>
493
495 <dl> 494 <dl>
496 495
497 <dt><i>eid</i> (int)</dt> 496 <dt><i>eid</i> (int)</dt>
498 <dd> 497 <dd>
499 ID for the entry 498 ID for the entry
500 </dd> 499 </dd>
501 </dl> 500 </dl>
502 <a NAME="TimeTrackEntry.setStartDateTime" ID="TimeTrackEntry.setStartDateTime"></a> 501 <a NAME="TimeTrackEntry.setStartDateTime" ID="TimeTrackEntry.setStartDateTime"></a>
503 <h4>TimeTrackEntry.setStartDateTime</h4> 502 <h4>TimeTrackEntry.setStartDateTime</h4>
504 <b>setStartDateTime</b>(<i>startDateTime</i>) 503 <b>setStartDateTime</b>(<i>startDateTime</i>)
505
506 <p> 504 <p>
507 Public method to set the start date and time. 505 Public method to set the start date and time.
508 </p> 506 </p>
507
509 <dl> 508 <dl>
510 509
511 <dt><i>startDateTime</i> (QDateTime)</dt> 510 <dt><i>startDateTime</i> (QDateTime)</dt>
512 <dd> 511 <dd>
513 start date and time 512 start date and time
514 </dd> 513 </dd>
515 </dl> 514 </dl>
516 <a NAME="TimeTrackEntry.setTask" ID="TimeTrackEntry.setTask"></a> 515 <a NAME="TimeTrackEntry.setTask" ID="TimeTrackEntry.setTask"></a>
517 <h4>TimeTrackEntry.setTask</h4> 516 <h4>TimeTrackEntry.setTask</h4>
518 <b>setTask</b>(<i>description</i>) 517 <b>setTask</b>(<i>description</i>)
519
520 <p> 518 <p>
521 Public method to set the task description. 519 Public method to set the task description.
522 </p> 520 </p>
521
523 <dl> 522 <dl>
524 523
525 <dt><i>description</i> (str)</dt> 524 <dt><i>description</i> (str)</dt>
526 <dd> 525 <dd>
527 task description 526 task description
528 </dd> 527 </dd>
529 </dl> 528 </dl>
530 <a NAME="TimeTrackEntry.start" ID="TimeTrackEntry.start"></a> 529 <a NAME="TimeTrackEntry.start" ID="TimeTrackEntry.start"></a>
531 <h4>TimeTrackEntry.start</h4> 530 <h4>TimeTrackEntry.start</h4>
532 <b>start</b>(<i></i>) 531 <b>start</b>(<i></i>)
533
534 <p> 532 <p>
535 Public method to set the start time of this entry. 533 Public method to set the start time of this entry.
536 </p> 534 </p>
535
537 <a NAME="TimeTrackEntry.stop" ID="TimeTrackEntry.stop"></a> 536 <a NAME="TimeTrackEntry.stop" ID="TimeTrackEntry.stop"></a>
538 <h4>TimeTrackEntry.stop</h4> 537 <h4>TimeTrackEntry.stop</h4>
539 <b>stop</b>(<i></i>) 538 <b>stop</b>(<i></i>)
540
541 <p> 539 <p>
542 Public method to stop this entry. 540 Public method to stop this entry.
543 </p> 541 </p>
542
544 <a NAME="TimeTrackEntry.toDict" ID="TimeTrackEntry.toDict"></a> 543 <a NAME="TimeTrackEntry.toDict" ID="TimeTrackEntry.toDict"></a>
545 <h4>TimeTrackEntry.toDict</h4> 544 <h4>TimeTrackEntry.toDict</h4>
546 <b>toDict</b>(<i></i>) 545 <b>toDict</b>(<i></i>)
547
548 <p> 546 <p>
549 Public method to convert the time track entry into a dictionary. 547 Public method to convert the time track entry into a dictionary.
550 </p> 548 </p>
549
551 <dl> 550 <dl>
552 <dt>Return:</dt> 551 <dt>Return:</dt>
553 <dd> 552 <dd>
554 dictionary containing the time track entry data 553 dictionary containing the time track entry data
555 </dd> 554 </dd>

eric ide

mercurial