Mercurial Repositories > eric / file comparison

comparison: src/eric7/Documentation/Source/eric7.Tasks.Task.html

src/eric7/Documentation/Source/eric7.Tasks.Task.html

branch
eric7
changeset 10479
856476537696
parent 10431
64157aeb0312
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
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>eric7.Tasks.Task</h1> 9 <h1>eric7.Tasks.Task</h1>
10
11 <p> 10 <p>
12 Module implementing a class to store task data. 11 Module implementing a class to store task data.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15 15 <table>
16 <table> 16 <tr><td>None</td></tr>
17 <tr><td>None</td></tr> 17 </table>
18 </table> 18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#Task">Task</a></td> 22 <td><a href="#Task">Task</a></td>
25 <td>Class implementing the task data structure.</td> 23 <td>Class implementing the task data structure.</td>
26 </tr> 24 </tr>
27 <tr> 25 <tr>
31 <tr> 29 <tr>
32 <td><a href="#TaskType">TaskType</a></td> 30 <td><a href="#TaskType">TaskType</a></td>
33 <td>Class defining the task types.</td> 31 <td>Class defining the task types.</td>
34 </tr> 32 </tr>
35 </table> 33 </table>
34
36 <h3>Functions</h3> 35 <h3>Functions</h3>
37 36 <table>
38 <table> 37 <tr><td>None</td></tr>
39 <tr><td>None</td></tr> 38 </table>
40 </table> 39
41 <hr /> 40 <hr />
42 <hr /> 41 <hr />
43 <a NAME="Task" ID="Task"></a> 42 <a NAME="Task" ID="Task"></a>
44 <h2>Task</h2> 43 <h2>Task</h2>
45
46 <p> 44 <p>
47 Class implementing the task data structure. 45 Class implementing the task data structure.
48 </p> 46 </p>
47
49 <h3>Derived from</h3> 48 <h3>Derived from</h3>
50 QTreeWidgetItem 49 QTreeWidgetItem
51 <h3>Class Attributes</h3> 50 <h3>Class Attributes</h3>
52 51 <table>
53 <table> 52 <tr><td>TaskType2ColorName</td></tr>
54 <tr><td>TaskType2ColorName</td></tr><tr><td>TaskType2IconName</td></tr><tr><td>TaskType2MarkersName</td></tr> 53 <tr><td>TaskType2IconName</td></tr>
55 </table> 54 <tr><td>TaskType2MarkersName</td></tr>
55 </table>
56
56 <h3>Class Methods</h3> 57 <h3>Class Methods</h3>
57 58 <table>
58 <table> 59 <tr><td>None</td></tr>
59 <tr><td>None</td></tr> 60 </table>
60 </table> 61
61 <h3>Methods</h3> 62 <h3>Methods</h3>
62 63 <table>
63 <table>
64
65 <tr> 64 <tr>
66 <td><a href="#Task.__init__">Task</a></td> 65 <td><a href="#Task.__init__">Task</a></td>
67 <td>Constructor</td> 66 <td>Constructor</td>
68 </tr> 67 </tr>
69 <tr> 68 <tr>
129 <tr> 128 <tr>
130 <td><a href="#Task.toDict">toDict</a></td> 129 <td><a href="#Task.toDict">toDict</a></td>
131 <td>Public method to convert the task data to a dictionary.</td> 130 <td>Public method to convert the task data to a dictionary.</td>
132 </tr> 131 </tr>
133 </table> 132 </table>
133
134 <h3>Static Methods</h3> 134 <h3>Static Methods</h3>
135 135 <table>
136 <table> 136 <tr><td>None</td></tr>
137 <tr><td>None</td></tr> 137 </table>
138 </table> 138
139 139
140 <a NAME="Task.__init__" ID="Task.__init__"></a> 140 <a NAME="Task.__init__" ID="Task.__init__"></a>
141 <h4>Task (Constructor)</h4> 141 <h4>Task (Constructor)</h4>
142 <b>Task</b>(<i>summary, priority=TaskPriority.NORMAL, filename="", lineno=0, completed=False, _time=0, isProjectTask=False, taskType=TaskType.TODO, project=None, description="", uid="", parentUid="", </i>) 142 <b>Task</b>(<i>summary, priority=TaskPriority.NORMAL, filename="", lineno=0, completed=False, _time=0, isProjectTask=False, taskType=TaskType.TODO, project=None, description="", uid="", parentUid="", </i>)
143
144 <p> 143 <p>
145 Constructor 144 Constructor
146 </p> 145 </p>
146
147 <dl> 147 <dl>
148 148
149 <dt><i>summary</i> (str)</dt> 149 <dt><i>summary</i> (str)</dt>
150 <dd> 150 <dd>
151 summary text of the task 151 summary text of the task
197 </dd> 197 </dd>
198 </dl> 198 </dl>
199 <a NAME="Task.colorizeTask" ID="Task.colorizeTask"></a> 199 <a NAME="Task.colorizeTask" ID="Task.colorizeTask"></a>
200 <h4>Task.colorizeTask</h4> 200 <h4>Task.colorizeTask</h4>
201 <b>colorizeTask</b>(<i></i>) 201 <b>colorizeTask</b>(<i></i>)
202
203 <p> 202 <p>
204 Public slot to set the colors of the task item. 203 Public slot to set the colors of the task item.
205 </p> 204 </p>
205
206 <a NAME="Task.getFilename" ID="Task.getFilename"></a> 206 <a NAME="Task.getFilename" ID="Task.getFilename"></a>
207 <h4>Task.getFilename</h4> 207 <h4>Task.getFilename</h4>
208 <b>getFilename</b>(<i></i>) 208 <b>getFilename</b>(<i></i>)
209
210 <p> 209 <p>
211 Public method to retrieve the task's filename. 210 Public method to retrieve the task's filename.
212 </p> 211 </p>
212
213 <dl> 213 <dl>
214 <dt>Return:</dt> 214 <dt>Return:</dt>
215 <dd> 215 <dd>
216 filename 216 filename
217 </dd> 217 </dd>
223 </dd> 223 </dd>
224 </dl> 224 </dl>
225 <a NAME="Task.getLineno" ID="Task.getLineno"></a> 225 <a NAME="Task.getLineno" ID="Task.getLineno"></a>
226 <h4>Task.getLineno</h4> 226 <h4>Task.getLineno</h4>
227 <b>getLineno</b>(<i></i>) 227 <b>getLineno</b>(<i></i>)
228
229 <p> 228 <p>
230 Public method to retrieve the task's linenumber. 229 Public method to retrieve the task's linenumber.
231 </p> 230 </p>
231
232 <dl> 232 <dl>
233 <dt>Return:</dt> 233 <dt>Return:</dt>
234 <dd> 234 <dd>
235 linenumber 235 linenumber
236 </dd> 236 </dd>
242 </dd> 242 </dd>
243 </dl> 243 </dl>
244 <a NAME="Task.getParentUuid" ID="Task.getParentUuid"></a> 244 <a NAME="Task.getParentUuid" ID="Task.getParentUuid"></a>
245 <h4>Task.getParentUuid</h4> 245 <h4>Task.getParentUuid</h4>
246 <b>getParentUuid</b>(<i></i>) 246 <b>getParentUuid</b>(<i></i>)
247
248 <p> 247 <p>
249 Public method to get the parent task's uid. 248 Public method to get the parent task's uid.
250 </p> 249 </p>
250
251 <dl> 251 <dl>
252 <dt>Return:</dt> 252 <dt>Return:</dt>
253 <dd> 253 <dd>
254 parent uid 254 parent uid
255 </dd> 255 </dd>
261 </dd> 261 </dd>
262 </dl> 262 </dl>
263 <a NAME="Task.getUuid" ID="Task.getUuid"></a> 263 <a NAME="Task.getUuid" ID="Task.getUuid"></a>
264 <h4>Task.getUuid</h4> 264 <h4>Task.getUuid</h4>
265 <b>getUuid</b>(<i></i>) 265 <b>getUuid</b>(<i></i>)
266
267 <p> 266 <p>
268 Public method to get the task's uid. 267 Public method to get the task's uid.
269 </p> 268 </p>
269
270 <dl> 270 <dl>
271 <dt>Return:</dt> 271 <dt>Return:</dt>
272 <dd> 272 <dd>
273 uid 273 uid
274 </dd> 274 </dd>
280 </dd> 280 </dd>
281 </dl> 281 </dl>
282 <a NAME="Task.isCompleted" ID="Task.isCompleted"></a> 282 <a NAME="Task.isCompleted" ID="Task.isCompleted"></a>
283 <h4>Task.isCompleted</h4> 283 <h4>Task.isCompleted</h4>
284 <b>isCompleted</b>(<i></i>) 284 <b>isCompleted</b>(<i></i>)
285
286 <p> 285 <p>
287 Public slot to return the completion status. 286 Public slot to return the completion status.
288 </p> 287 </p>
288
289 <dl> 289 <dl>
290 <dt>Return:</dt> 290 <dt>Return:</dt>
291 <dd> 291 <dd>
292 flag indicating the completion status 292 flag indicating the completion status
293 </dd> 293 </dd>
299 </dd> 299 </dd>
300 </dl> 300 </dl>
301 <a NAME="Task.isFileTask" ID="Task.isFileTask"></a> 301 <a NAME="Task.isFileTask" ID="Task.isFileTask"></a>
302 <h4>Task.isFileTask</h4> 302 <h4>Task.isFileTask</h4>
303 <b>isFileTask</b>(<i></i>) 303 <b>isFileTask</b>(<i></i>)
304
305 <p> 304 <p>
306 Public slot to get an indication, if this task is related to a file. 305 Public slot to get an indication, if this task is related to a file.
307 </p> 306 </p>
307
308 <dl> 308 <dl>
309 <dt>Return:</dt> 309 <dt>Return:</dt>
310 <dd> 310 <dd>
311 flag indicating a file task 311 flag indicating a file task
312 </dd> 312 </dd>
318 </dd> 318 </dd>
319 </dl> 319 </dl>
320 <a NAME="Task.isProjectFileTask" ID="Task.isProjectFileTask"></a> 320 <a NAME="Task.isProjectFileTask" ID="Task.isProjectFileTask"></a>
321 <h4>Task.isProjectFileTask</h4> 321 <h4>Task.isProjectFileTask</h4>
322 <b>isProjectFileTask</b>(<i></i>) 322 <b>isProjectFileTask</b>(<i></i>)
323
324 <p> 323 <p>
325 Public slot to get an indication, if this task is related to a 324 Public slot to get an indication, if this task is related to a
326 project file. 325 project file.
327 </p> 326 </p>
327
328 <dl> 328 <dl>
329 <dt>Return:</dt> 329 <dt>Return:</dt>
330 <dd> 330 <dd>
331 flag indicating a project file task 331 flag indicating a project file task
332 </dd> 332 </dd>
338 </dd> 338 </dd>
339 </dl> 339 </dl>
340 <a NAME="Task.isProjectTask" ID="Task.isProjectTask"></a> 340 <a NAME="Task.isProjectTask" ID="Task.isProjectTask"></a>
341 <h4>Task.isProjectTask</h4> 341 <h4>Task.isProjectTask</h4>
342 <b>isProjectTask</b>(<i></i>) 342 <b>isProjectTask</b>(<i></i>)
343
344 <p> 343 <p>
345 Public slot to return the project relation status. 344 Public slot to return the project relation status.
346 </p> 345 </p>
346
347 <dl> 347 <dl>
348 <dt>Return:</dt> 348 <dt>Return:</dt>
349 <dd> 349 <dd>
350 flag indicating the project relation status 350 flag indicating the project relation status
351 </dd> 351 </dd>
357 </dd> 357 </dd>
358 </dl> 358 </dl>
359 <a NAME="Task.setCompleted" ID="Task.setCompleted"></a> 359 <a NAME="Task.setCompleted" ID="Task.setCompleted"></a>
360 <h4>Task.setCompleted</h4> 360 <h4>Task.setCompleted</h4>
361 <b>setCompleted</b>(<i>completed</i>) 361 <b>setCompleted</b>(<i>completed</i>)
362
363 <p> 362 <p>
364 Public slot to update the completed flag. 363 Public slot to update the completed flag.
365 </p> 364 </p>
365
366 <dl> 366 <dl>
367 367
368 <dt><i>completed</i> (bool)</dt> 368 <dt><i>completed</i> (bool)</dt>
369 <dd> 369 <dd>
370 flag indicating completion status 370 flag indicating completion status
371 </dd> 371 </dd>
372 </dl> 372 </dl>
373 <a NAME="Task.setDescription" ID="Task.setDescription"></a> 373 <a NAME="Task.setDescription" ID="Task.setDescription"></a>
374 <h4>Task.setDescription</h4> 374 <h4>Task.setDescription</h4>
375 <b>setDescription</b>(<i>description</i>) 375 <b>setDescription</b>(<i>description</i>)
376
377 <p> 376 <p>
378 Public slot to update the description field. 377 Public slot to update the description field.
379 </p> 378 </p>
379
380 <dl> 380 <dl>
381 381
382 <dt><i>description</i> (str)</dt> 382 <dt><i>description</i> (str)</dt>
383 <dd> 383 <dd>
384 descriptive text of the task 384 descriptive text of the task
385 </dd> 385 </dd>
386 </dl> 386 </dl>
387 <a NAME="Task.setPriority" ID="Task.setPriority"></a> 387 <a NAME="Task.setPriority" ID="Task.setPriority"></a>
388 <h4>Task.setPriority</h4> 388 <h4>Task.setPriority</h4>
389 <b>setPriority</b>(<i>priority</i>) 389 <b>setPriority</b>(<i>priority</i>)
390
391 <p> 390 <p>
392 Public slot to update the priority. 391 Public slot to update the priority.
393 </p> 392 </p>
393
394 <dl> 394 <dl>
395 395
396 <dt><i>priority</i> (TaskPriority)</dt> 396 <dt><i>priority</i> (TaskPriority)</dt>
397 <dd> 397 <dd>
398 priority of the task 398 priority of the task
399 </dd> 399 </dd>
400 </dl> 400 </dl>
401 <a NAME="Task.setProjectTask" ID="Task.setProjectTask"></a> 401 <a NAME="Task.setProjectTask" ID="Task.setProjectTask"></a>
402 <h4>Task.setProjectTask</h4> 402 <h4>Task.setProjectTask</h4>
403 <b>setProjectTask</b>(<i>pt</i>) 403 <b>setProjectTask</b>(<i>pt</i>)
404
405 <p> 404 <p>
406 Public method to set the project relation flag. 405 Public method to set the project relation flag.
407 </p> 406 </p>
407
408 <dl> 408 <dl>
409 409
410 <dt><i>pt</i> (bool)</dt> 410 <dt><i>pt</i> (bool)</dt>
411 <dd> 411 <dd>
412 flag indicating a project task 412 flag indicating a project task
413 </dd> 413 </dd>
414 </dl> 414 </dl>
415 <a NAME="Task.setSummary" ID="Task.setSummary"></a> 415 <a NAME="Task.setSummary" ID="Task.setSummary"></a>
416 <h4>Task.setSummary</h4> 416 <h4>Task.setSummary</h4>
417 <b>setSummary</b>(<i>summary</i>) 417 <b>setSummary</b>(<i>summary</i>)
418
419 <p> 418 <p>
420 Public slot to update the description. 419 Public slot to update the description.
421 </p> 420 </p>
421
422 <dl> 422 <dl>
423 423
424 <dt><i>summary</i> (str)</dt> 424 <dt><i>summary</i> (str)</dt>
425 <dd> 425 <dd>
426 summary text of the task 426 summary text of the task
427 </dd> 427 </dd>
428 </dl> 428 </dl>
429 <a NAME="Task.setTaskType" ID="Task.setTaskType"></a> 429 <a NAME="Task.setTaskType" ID="Task.setTaskType"></a>
430 <h4>Task.setTaskType</h4> 430 <h4>Task.setTaskType</h4>
431 <b>setTaskType</b>(<i>taskType</i>) 431 <b>setTaskType</b>(<i>taskType</i>)
432
433 <p> 432 <p>
434 Public method to update the task type. 433 Public method to update the task type.
435 </p> 434 </p>
435
436 <dl> 436 <dl>
437 437
438 <dt><i>taskType</i> (TaskType)</dt> 438 <dt><i>taskType</i> (TaskType)</dt>
439 <dd> 439 <dd>
440 type of the task 440 type of the task
441 </dd> 441 </dd>
442 </dl> 442 </dl>
443 <a NAME="Task.toDict" ID="Task.toDict"></a> 443 <a NAME="Task.toDict" ID="Task.toDict"></a>
444 <h4>Task.toDict</h4> 444 <h4>Task.toDict</h4>
445 <b>toDict</b>(<i></i>) 445 <b>toDict</b>(<i></i>)
446
447 <p> 446 <p>
448 Public method to convert the task data to a dictionary. 447 Public method to convert the task data to a dictionary.
449 </p> 448 </p>
449
450 <dl> 450 <dl>
451 <dt>Return:</dt> 451 <dt>Return:</dt>
452 <dd> 452 <dd>
453 dictionary containing the task data 453 dictionary containing the task data
454 </dd> 454 </dd>
462 <div align="right"><a href="#top">Up</a></div> 462 <div align="right"><a href="#top">Up</a></div>
463 <hr /> 463 <hr />
464 <hr /> 464 <hr />
465 <a NAME="TaskPriority" ID="TaskPriority"></a> 465 <a NAME="TaskPriority" ID="TaskPriority"></a>
466 <h2>TaskPriority</h2> 466 <h2>TaskPriority</h2>
467
468 <p> 467 <p>
469 Class defining the task priorities. 468 Class defining the task priorities.
470 </p> 469 </p>
470
471 <h3>Derived from</h3> 471 <h3>Derived from</h3>
472 enum.IntEnum 472 enum.IntEnum
473 <h3>Class Attributes</h3> 473 <h3>Class Attributes</h3>
474 474 <table>
475 <table> 475 <tr><td>HIGH</td></tr>
476 <tr><td>HIGH</td></tr><tr><td>LOW</td></tr><tr><td>NORMAL</td></tr> 476 <tr><td>LOW</td></tr>
477 </table> 477 <tr><td>NORMAL</td></tr>
478 </table>
479
478 <h3>Class Methods</h3> 480 <h3>Class Methods</h3>
479 481 <table>
480 <table> 482 <tr><td>None</td></tr>
481 <tr><td>None</td></tr> 483 </table>
482 </table> 484
483 <h3>Methods</h3> 485 <h3>Methods</h3>
484 486 <table>
485 <table> 487 <tr><td>None</td></tr>
486 <tr><td>None</td></tr> 488 </table>
487 </table> 489
488 <h3>Static Methods</h3> 490 <h3>Static Methods</h3>
489 491 <table>
490 <table> 492 <tr><td>None</td></tr>
491 <tr><td>None</td></tr> 493 </table>
492 </table> 494
493 495
494 <div align="right"><a href="#top">Up</a></div> 496 <div align="right"><a href="#top">Up</a></div>
495 <hr /> 497 <hr />
496 <hr /> 498 <hr />
497 <a NAME="TaskType" ID="TaskType"></a> 499 <a NAME="TaskType" ID="TaskType"></a>
498 <h2>TaskType</h2> 500 <h2>TaskType</h2>
499
500 <p> 501 <p>
501 Class defining the task types. 502 Class defining the task types.
502 </p> 503 </p>
504
503 <h3>Derived from</h3> 505 <h3>Derived from</h3>
504 enum.IntEnum 506 enum.IntEnum
505 <h3>Class Attributes</h3> 507 <h3>Class Attributes</h3>
506 508 <table>
507 <table> 509 <tr><td>DOCU</td></tr>
508 <tr><td>DOCU</td></tr><tr><td>FIXME</td></tr><tr><td>NONE</td></tr><tr><td>NOTE</td></tr><tr><td>TEST</td></tr><tr><td>TODO</td></tr><tr><td>WARNING</td></tr> 510 <tr><td>FIXME</td></tr>
509 </table> 511 <tr><td>NONE</td></tr>
512 <tr><td>NOTE</td></tr>
513 <tr><td>TEST</td></tr>
514 <tr><td>TODO</td></tr>
515 <tr><td>WARNING</td></tr>
516 </table>
517
510 <h3>Class Methods</h3> 518 <h3>Class Methods</h3>
511 519 <table>
512 <table> 520 <tr><td>None</td></tr>
513 <tr><td>None</td></tr> 521 </table>
514 </table> 522
515 <h3>Methods</h3> 523 <h3>Methods</h3>
516 524 <table>
517 <table> 525 <tr><td>None</td></tr>
518 <tr><td>None</td></tr> 526 </table>
519 </table> 527
520 <h3>Static Methods</h3> 528 <h3>Static Methods</h3>
521 529 <table>
522 <table> 530 <tr><td>None</td></tr>
523 <tr><td>None</td></tr> 531 </table>
524 </table> 532
525 533
526 <div align="right"><a href="#top">Up</a></div> 534 <div align="right"><a href="#top">Up</a></div>
527 <hr /> 535 <hr />
528 </body></html> 536 </body></html>

Mercurial Repository: eric

eric ide

mercurial