Mercurial Repositories > eric / file comparison

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

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

branch
eric7
changeset 10479
856476537696
parent 10431
64157aeb0312
child 10692
9becf9ca115c
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.TaskViewer</h1> 9 <h1>eric7.Tasks.TaskViewer</h1>
10
11 <p> 10 <p>
12 Module implementing a task viewer and associated classes. 11 Module implementing a task viewer and associated classes.
13 </p> 12 </p>
14 <p> 13 <p>
15 Tasks can be defined manually or automatically. Automatically 14 Tasks can be defined manually or automatically. Automatically
16 generated tasks are derived from a comment with a special 15 generated tasks are derived from a comment with a special
17 introductory text. This text is configurable. 16 introductory text. This text is configurable.
18 </p> 17 </p>
18
19 <h3>Global Attributes</h3> 19 <h3>Global Attributes</h3>
20
21 <table> 20 <table>
22 <tr><td>None</td></tr> 21 <tr><td>None</td></tr>
23 </table> 22 </table>
23
24 <h3>Classes</h3> 24 <h3>Classes</h3>
25 25 <table>
26 <table>
27
28 <tr> 26 <tr>
29 <td><a href="#ProjectTaskExtractionThread">ProjectTaskExtractionThread</a></td> 27 <td><a href="#ProjectTaskExtractionThread">ProjectTaskExtractionThread</a></td>
30 <td>Class implementing a thread to extract tasks related to a project.</td> 28 <td>Class implementing a thread to extract tasks related to a project.</td>
31 </tr> 29 </tr>
32 <tr> 30 <tr>
33 <td><a href="#TaskViewer">TaskViewer</a></td> 31 <td><a href="#TaskViewer">TaskViewer</a></td>
34 <td>Class implementing the task viewer.</td> 32 <td>Class implementing the task viewer.</td>
35 </tr> 33 </tr>
36 </table> 34 </table>
35
37 <h3>Functions</h3> 36 <h3>Functions</h3>
38
39 <table> 37 <table>
40 <tr><td>None</td></tr> 38 <tr><td>None</td></tr>
41 </table> 39 </table>
40
42 <hr /> 41 <hr />
43 <hr /> 42 <hr />
44 <a NAME="ProjectTaskExtractionThread" ID="ProjectTaskExtractionThread"></a> 43 <a NAME="ProjectTaskExtractionThread" ID="ProjectTaskExtractionThread"></a>
45 <h2>ProjectTaskExtractionThread</h2> 44 <h2>ProjectTaskExtractionThread</h2>
46
47 <p> 45 <p>
48 Class implementing a thread to extract tasks related to a project. 46 Class implementing a thread to extract tasks related to a project.
49 </p> 47 </p>
48
50 <h3>Signals</h3> 49 <h3>Signals</h3>
51 <dl> 50 <dl>
52 51
53 <dt>taskFound(str, str, int, TaskType)</dt> 52 <dt>taskFound(str, str, int, TaskType)</dt>
54 <dd> 53 <dd>
58 </dd> 57 </dd>
59 </dl> 58 </dl>
60 <h3>Derived from</h3> 59 <h3>Derived from</h3>
61 QThread 60 QThread
62 <h3>Class Attributes</h3> 61 <h3>Class Attributes</h3>
63
64 <table> 62 <table>
65 <tr><td>None</td></tr> 63 <tr><td>None</td></tr>
66 </table> 64 </table>
65
67 <h3>Class Methods</h3> 66 <h3>Class Methods</h3>
68
69 <table> 67 <table>
70 <tr><td>None</td></tr> 68 <tr><td>None</td></tr>
71 </table> 69 </table>
70
72 <h3>Methods</h3> 71 <h3>Methods</h3>
73 72 <table>
74 <table>
75
76 <tr> 73 <tr>
77 <td><a href="#ProjectTaskExtractionThread.__init__">ProjectTaskExtractionThread</a></td> 74 <td><a href="#ProjectTaskExtractionThread.__init__">ProjectTaskExtractionThread</a></td>
78 <td>Constructor</td> 75 <td>Constructor</td>
79 </tr> 76 </tr>
80 <tr> 77 <tr>
88 <tr> 85 <tr>
89 <td><a href="#ProjectTaskExtractionThread.scan">scan</a></td> 86 <td><a href="#ProjectTaskExtractionThread.scan">scan</a></td>
90 <td>Public method to scan the given list of files for tasks.</td> 87 <td>Public method to scan the given list of files for tasks.</td>
91 </tr> 88 </tr>
92 </table> 89 </table>
90
93 <h3>Static Methods</h3> 91 <h3>Static Methods</h3>
94
95 <table> 92 <table>
96 <tr><td>None</td></tr> 93 <tr><td>None</td></tr>
97 </table> 94 </table>
95
98 96
99 <a NAME="ProjectTaskExtractionThread.__init__" ID="ProjectTaskExtractionThread.__init__"></a> 97 <a NAME="ProjectTaskExtractionThread.__init__" ID="ProjectTaskExtractionThread.__init__"></a>
100 <h4>ProjectTaskExtractionThread (Constructor)</h4> 98 <h4>ProjectTaskExtractionThread (Constructor)</h4>
101 <b>ProjectTaskExtractionThread</b>(<i>parent=None</i>) 99 <b>ProjectTaskExtractionThread</b>(<i>parent=None</i>)
102
103 <p> 100 <p>
104 Constructor 101 Constructor
105 </p> 102 </p>
103
106 <dl> 104 <dl>
107 105
108 <dt><i>parent</i> (QObject)</dt> 106 <dt><i>parent</i> (QObject)</dt>
109 <dd> 107 <dd>
110 reference to the parent object 108 reference to the parent object
111 </dd> 109 </dd>
112 </dl> 110 </dl>
113 <a NAME="ProjectTaskExtractionThread.requestInterrupt" ID="ProjectTaskExtractionThread.requestInterrupt"></a> 111 <a NAME="ProjectTaskExtractionThread.requestInterrupt" ID="ProjectTaskExtractionThread.requestInterrupt"></a>
114 <h4>ProjectTaskExtractionThread.requestInterrupt</h4> 112 <h4>ProjectTaskExtractionThread.requestInterrupt</h4>
115 <b>requestInterrupt</b>(<i></i>) 113 <b>requestInterrupt</b>(<i></i>)
116
117 <p> 114 <p>
118 Public method to request iterruption of the thread. 115 Public method to request iterruption of the thread.
119 </p> 116 </p>
117
120 <a NAME="ProjectTaskExtractionThread.run" ID="ProjectTaskExtractionThread.run"></a> 118 <a NAME="ProjectTaskExtractionThread.run" ID="ProjectTaskExtractionThread.run"></a>
121 <h4>ProjectTaskExtractionThread.run</h4> 119 <h4>ProjectTaskExtractionThread.run</h4>
122 <b>run</b>(<i></i>) 120 <b>run</b>(<i></i>)
123
124 <p> 121 <p>
125 Public thread method to scan the given files. 122 Public thread method to scan the given files.
126 </p> 123 </p>
124
127 <a NAME="ProjectTaskExtractionThread.scan" ID="ProjectTaskExtractionThread.scan"></a> 125 <a NAME="ProjectTaskExtractionThread.scan" ID="ProjectTaskExtractionThread.scan"></a>
128 <h4>ProjectTaskExtractionThread.scan</h4> 126 <h4>ProjectTaskExtractionThread.scan</h4>
129 <b>scan</b>(<i>markers, files</i>) 127 <b>scan</b>(<i>markers, files</i>)
130
131 <p> 128 <p>
132 Public method to scan the given list of files for tasks. 129 Public method to scan the given list of files for tasks.
133 </p> 130 </p>
131
134 <dl> 132 <dl>
135 133
136 <dt><i>markers</i> (dict of lists of str)</dt> 134 <dt><i>markers</i> (dict of lists of str)</dt>
137 <dd> 135 <dd>
138 dictionary of defined task markers 136 dictionary of defined task markers
145 <div align="right"><a href="#top">Up</a></div> 143 <div align="right"><a href="#top">Up</a></div>
146 <hr /> 144 <hr />
147 <hr /> 145 <hr />
148 <a NAME="TaskViewer" ID="TaskViewer"></a> 146 <a NAME="TaskViewer" ID="TaskViewer"></a>
149 <h2>TaskViewer</h2> 147 <h2>TaskViewer</h2>
150
151 <p> 148 <p>
152 Class implementing the task viewer. 149 Class implementing the task viewer.
153 </p> 150 </p>
151
154 <h3>Signals</h3> 152 <h3>Signals</h3>
155 <dl> 153 <dl>
156 154
157 <dt>displayFile(str, int)</dt> 155 <dt>displayFile(str, int)</dt>
158 <dd> 156 <dd>
160 </dd> 158 </dd>
161 </dl> 159 </dl>
162 <h3>Derived from</h3> 160 <h3>Derived from</h3>
163 QTreeWidget 161 QTreeWidget
164 <h3>Class Attributes</h3> 162 <h3>Class Attributes</h3>
165
166 <table> 163 <table>
167 <tr><td>None</td></tr> 164 <tr><td>None</td></tr>
168 </table> 165 </table>
166
169 <h3>Class Methods</h3> 167 <h3>Class Methods</h3>
170
171 <table> 168 <table>
172 <tr><td>None</td></tr> 169 <tr><td>None</td></tr>
173 </table> 170 </table>
171
174 <h3>Methods</h3> 172 <h3>Methods</h3>
175 173 <table>
176 <table>
177
178 <tr> 174 <tr>
179 <td><a href="#TaskViewer.__init__">TaskViewer</a></td> 175 <td><a href="#TaskViewer.__init__">TaskViewer</a></td>
180 <td>Constructor</td> 176 <td>Constructor</td>
181 </tr> 177 </tr>
182 <tr> 178 <tr>
330 <tr> 326 <tr>
331 <td><a href="#TaskViewer.stopProjectTaskExtraction">stopProjectTaskExtraction</a></td> 327 <td><a href="#TaskViewer.stopProjectTaskExtraction">stopProjectTaskExtraction</a></td>
332 <td>Public method to stop the project task extraction thread.</td> 328 <td>Public method to stop the project task extraction thread.</td>
333 </tr> 329 </tr>
334 </table> 330 </table>
331
335 <h3>Static Methods</h3> 332 <h3>Static Methods</h3>
336
337 <table> 333 <table>
338 <tr><td>None</td></tr> 334 <tr><td>None</td></tr>
339 </table> 335 </table>
336
340 337
341 <a NAME="TaskViewer.__init__" ID="TaskViewer.__init__"></a> 338 <a NAME="TaskViewer.__init__" ID="TaskViewer.__init__"></a>
342 <h4>TaskViewer (Constructor)</h4> 339 <h4>TaskViewer (Constructor)</h4>
343 <b>TaskViewer</b>(<i>parent, project</i>) 340 <b>TaskViewer</b>(<i>parent, project</i>)
344
345 <p> 341 <p>
346 Constructor 342 Constructor
347 </p> 343 </p>
344
348 <dl> 345 <dl>
349 346
350 <dt><i>parent</i> (QWidget)</dt> 347 <dt><i>parent</i> (QWidget)</dt>
351 <dd> 348 <dd>
352 the parent 349 the parent
357 </dd> 354 </dd>
358 </dl> 355 </dl>
359 <a NAME="TaskViewer.__activateFilter" ID="TaskViewer.__activateFilter"></a> 356 <a NAME="TaskViewer.__activateFilter" ID="TaskViewer.__activateFilter"></a>
360 <h4>TaskViewer.__activateFilter</h4> 357 <h4>TaskViewer.__activateFilter</h4>
361 <b>__activateFilter</b>(<i>on</i>) 358 <b>__activateFilter</b>(<i>on</i>)
362
363 <p> 359 <p>
364 Private slot to handle the "Filtered display" context menu entry. 360 Private slot to handle the "Filtered display" context menu entry.
365 </p> 361 </p>
362
366 <dl> 363 <dl>
367 364
368 <dt><i>on</i> (bool)</dt> 365 <dt><i>on</i> (bool)</dt>
369 <dd> 366 <dd>
370 flag indicating the filter state 367 flag indicating the filter state
371 </dd> 368 </dd>
372 </dl> 369 </dl>
373 <a NAME="TaskViewer.__checkTopLevelItems" ID="TaskViewer.__checkTopLevelItems"></a> 370 <a NAME="TaskViewer.__checkTopLevelItems" ID="TaskViewer.__checkTopLevelItems"></a>
374 <h4>TaskViewer.__checkTopLevelItems</h4> 371 <h4>TaskViewer.__checkTopLevelItems</h4>
375 <b>__checkTopLevelItems</b>(<i></i>) 372 <b>__checkTopLevelItems</b>(<i></i>)
376
377 <p> 373 <p>
378 Private slot to check the 'Extracted Tasks' item for children. 374 Private slot to check the 'Extracted Tasks' item for children.
379 </p> 375 </p>
376
380 <a NAME="TaskViewer.__configure" ID="TaskViewer.__configure"></a> 377 <a NAME="TaskViewer.__configure" ID="TaskViewer.__configure"></a>
381 <h4>TaskViewer.__configure</h4> 378 <h4>TaskViewer.__configure</h4>
382 <b>__configure</b>(<i></i>) 379 <b>__configure</b>(<i></i>)
383
384 <p> 380 <p>
385 Private method to open the configuration dialog. 381 Private method to open the configuration dialog.
386 </p> 382 </p>
383
387 <a NAME="TaskViewer.__configureFilter" ID="TaskViewer.__configureFilter"></a> 384 <a NAME="TaskViewer.__configureFilter" ID="TaskViewer.__configureFilter"></a>
388 <h4>TaskViewer.__configureFilter</h4> 385 <h4>TaskViewer.__configureFilter</h4>
389 <b>__configureFilter</b>(<i></i>) 386 <b>__configureFilter</b>(<i></i>)
390
391 <p> 387 <p>
392 Private slot to handle the "Configure filter" context menu entry. 388 Private slot to handle the "Configure filter" context menu entry.
393 </p> 389 </p>
390
394 <a NAME="TaskViewer.__configureProjectTasksScanOptions" ID="TaskViewer.__configureProjectTasksScanOptions"></a> 391 <a NAME="TaskViewer.__configureProjectTasksScanOptions" ID="TaskViewer.__configureProjectTasksScanOptions"></a>
395 <h4>TaskViewer.__configureProjectTasksScanOptions</h4> 392 <h4>TaskViewer.__configureProjectTasksScanOptions</h4>
396 <b>__configureProjectTasksScanOptions</b>(<i></i>) 393 <b>__configureProjectTasksScanOptions</b>(<i></i>)
397
398 <p> 394 <p>
399 Private slot to configure scan options for project tasks. 395 Private slot to configure scan options for project tasks.
400 </p> 396 </p>
397
401 <a NAME="TaskViewer.__copyTask" ID="TaskViewer.__copyTask"></a> 398 <a NAME="TaskViewer.__copyTask" ID="TaskViewer.__copyTask"></a>
402 <h4>TaskViewer.__copyTask</h4> 399 <h4>TaskViewer.__copyTask</h4>
403 <b>__copyTask</b>(<i></i>) 400 <b>__copyTask</b>(<i></i>)
404
405 <p> 401 <p>
406 Private slot to handle the "Copy" context menu entry. 402 Private slot to handle the "Copy" context menu entry.
407 </p> 403 </p>
404
408 <a NAME="TaskViewer.__deleteCompleted" ID="TaskViewer.__deleteCompleted"></a> 405 <a NAME="TaskViewer.__deleteCompleted" ID="TaskViewer.__deleteCompleted"></a>
409 <h4>TaskViewer.__deleteCompleted</h4> 406 <h4>TaskViewer.__deleteCompleted</h4>
410 <b>__deleteCompleted</b>(<i></i>) 407 <b>__deleteCompleted</b>(<i></i>)
411
412 <p> 408 <p>
413 Private slot to handle the "Delete Completed Tasks" context menu entry. 409 Private slot to handle the "Delete Completed Tasks" context menu entry.
414 </p> 410 </p>
411
415 <a NAME="TaskViewer.__deleteSubTasks" ID="TaskViewer.__deleteSubTasks"></a> 412 <a NAME="TaskViewer.__deleteSubTasks" ID="TaskViewer.__deleteSubTasks"></a>
416 <h4>TaskViewer.__deleteSubTasks</h4> 413 <h4>TaskViewer.__deleteSubTasks</h4>
417 <b>__deleteSubTasks</b>(<i>task</i>) 414 <b>__deleteSubTasks</b>(<i>task</i>)
418
419 <p> 415 <p>
420 Private method to delete all sub-tasks. 416 Private method to delete all sub-tasks.
421 </p> 417 </p>
418
422 <dl> 419 <dl>
423 420
424 <dt><i>task</i> (Task)</dt> 421 <dt><i>task</i> (Task)</dt>
425 <dd> 422 <dd>
426 task to delete sub-tasks of 423 task to delete sub-tasks of
427 </dd> 424 </dd>
428 </dl> 425 </dl>
429 <a NAME="TaskViewer.__deleteTask" ID="TaskViewer.__deleteTask"></a> 426 <a NAME="TaskViewer.__deleteTask" ID="TaskViewer.__deleteTask"></a>
430 <h4>TaskViewer.__deleteTask</h4> 427 <h4>TaskViewer.__deleteTask</h4>
431 <b>__deleteTask</b>(<i>task=None</i>) 428 <b>__deleteTask</b>(<i>task=None</i>)
432
433 <p> 429 <p>
434 Private slot to delete a task. 430 Private slot to delete a task.
435 </p> 431 </p>
432
436 <dl> 433 <dl>
437 434
438 <dt><i>task</i> (Task)</dt> 435 <dt><i>task</i> (Task)</dt>
439 <dd> 436 <dd>
440 task to be deleted 437 task to be deleted
441 </dd> 438 </dd>
442 </dl> 439 </dl>
443 <a NAME="TaskViewer.__editTaskProperties" ID="TaskViewer.__editTaskProperties"></a> 440 <a NAME="TaskViewer.__editTaskProperties" ID="TaskViewer.__editTaskProperties"></a>
444 <h4>TaskViewer.__editTaskProperties</h4> 441 <h4>TaskViewer.__editTaskProperties</h4>
445 <b>__editTaskProperties</b>(<i></i>) 442 <b>__editTaskProperties</b>(<i></i>)
446
447 <p> 443 <p>
448 Private slot to handle the "Properties" context menu entry. 444 Private slot to handle the "Properties" context menu entry.
449 </p> 445 </p>
446
450 <a NAME="TaskViewer.__generateTopLevelItems" ID="TaskViewer.__generateTopLevelItems"></a> 447 <a NAME="TaskViewer.__generateTopLevelItems" ID="TaskViewer.__generateTopLevelItems"></a>
451 <h4>TaskViewer.__generateTopLevelItems</h4> 448 <h4>TaskViewer.__generateTopLevelItems</h4>
452 <b>__generateTopLevelItems</b>(<i></i>) 449 <b>__generateTopLevelItems</b>(<i></i>)
453
454 <p> 450 <p>
455 Private method to generate the 'Extracted Tasks' item. 451 Private method to generate the 'Extracted Tasks' item.
456 </p> 452 </p>
453
457 <a NAME="TaskViewer.__goToTask" ID="TaskViewer.__goToTask"></a> 454 <a NAME="TaskViewer.__goToTask" ID="TaskViewer.__goToTask"></a>
458 <h4>TaskViewer.__goToTask</h4> 455 <h4>TaskViewer.__goToTask</h4>
459 <b>__goToTask</b>(<i></i>) 456 <b>__goToTask</b>(<i></i>)
460
461 <p> 457 <p>
462 Private slot to handle the "Go To" context menu entry. 458 Private slot to handle the "Go To" context menu entry.
463 </p> 459 </p>
460
464 <a NAME="TaskViewer.__markCompleted" ID="TaskViewer.__markCompleted"></a> 461 <a NAME="TaskViewer.__markCompleted" ID="TaskViewer.__markCompleted"></a>
465 <h4>TaskViewer.__markCompleted</h4> 462 <h4>TaskViewer.__markCompleted</h4>
466 <b>__markCompleted</b>(<i></i>) 463 <b>__markCompleted</b>(<i></i>)
467
468 <p> 464 <p>
469 Private slot to handle the "Mark Completed" context menu entry. 465 Private slot to handle the "Mark Completed" context menu entry.
470 </p> 466 </p>
467
471 <a NAME="TaskViewer.__newSubTask" ID="TaskViewer.__newSubTask"></a> 468 <a NAME="TaskViewer.__newSubTask" ID="TaskViewer.__newSubTask"></a>
472 <h4>TaskViewer.__newSubTask</h4> 469 <h4>TaskViewer.__newSubTask</h4>
473 <b>__newSubTask</b>(<i></i>) 470 <b>__newSubTask</b>(<i></i>)
474
475 <p> 471 <p>
476 Private slot to handle the "New Sub-Task" context menu entry. 472 Private slot to handle the "New Sub-Task" context menu entry.
477 </p> 473 </p>
474
478 <a NAME="TaskViewer.__newTask" ID="TaskViewer.__newTask"></a> 475 <a NAME="TaskViewer.__newTask" ID="TaskViewer.__newTask"></a>
479 <h4>TaskViewer.__newTask</h4> 476 <h4>TaskViewer.__newTask</h4>
480 <b>__newTask</b>(<i></i>) 477 <b>__newTask</b>(<i></i>)
481
482 <p> 478 <p>
483 Private slot to handle the "New Task" context menu entry. 479 Private slot to handle the "New Task" context menu entry.
484 </p> 480 </p>
481
485 <a NAME="TaskViewer.__pasteMainTask" ID="TaskViewer.__pasteMainTask"></a> 482 <a NAME="TaskViewer.__pasteMainTask" ID="TaskViewer.__pasteMainTask"></a>
486 <h4>TaskViewer.__pasteMainTask</h4> 483 <h4>TaskViewer.__pasteMainTask</h4>
487 <b>__pasteMainTask</b>(<i></i>) 484 <b>__pasteMainTask</b>(<i></i>)
488
489 <p> 485 <p>
490 Private slot to handle the "Paste as Main Task" context menu entry. 486 Private slot to handle the "Paste as Main Task" context menu entry.
491 </p> 487 </p>
488
492 <a NAME="TaskViewer.__pasteTask" ID="TaskViewer.__pasteTask"></a> 489 <a NAME="TaskViewer.__pasteTask" ID="TaskViewer.__pasteTask"></a>
493 <h4>TaskViewer.__pasteTask</h4> 490 <h4>TaskViewer.__pasteTask</h4>
494 <b>__pasteTask</b>(<i></i>) 491 <b>__pasteTask</b>(<i></i>)
495
496 <p> 492 <p>
497 Private slot to handle the "Paste" context menu entry. 493 Private slot to handle the "Paste" context menu entry.
498 </p> 494 </p>
495
499 <a NAME="TaskViewer.__refreshDisplay" ID="TaskViewer.__refreshDisplay"></a> 496 <a NAME="TaskViewer.__refreshDisplay" ID="TaskViewer.__refreshDisplay"></a>
500 <h4>TaskViewer.__refreshDisplay</h4> 497 <h4>TaskViewer.__refreshDisplay</h4>
501 <b>__refreshDisplay</b>(<i></i>) 498 <b>__refreshDisplay</b>(<i></i>)
502
503 <p> 499 <p>
504 Private method to refresh the display. 500 Private method to refresh the display.
505 </p> 501 </p>
502
506 <a NAME="TaskViewer.__resizeColumns" ID="TaskViewer.__resizeColumns"></a> 503 <a NAME="TaskViewer.__resizeColumns" ID="TaskViewer.__resizeColumns"></a>
507 <h4>TaskViewer.__resizeColumns</h4> 504 <h4>TaskViewer.__resizeColumns</h4>
508 <b>__resizeColumns</b>(<i></i>) 505 <b>__resizeColumns</b>(<i></i>)
509
510 <p> 506 <p>
511 Private method to resize the list columns. 507 Private method to resize the list columns.
512 </p> 508 </p>
509
513 <a NAME="TaskViewer.__resort" ID="TaskViewer.__resort"></a> 510 <a NAME="TaskViewer.__resort" ID="TaskViewer.__resort"></a>
514 <h4>TaskViewer.__resort</h4> 511 <h4>TaskViewer.__resort</h4>
515 <b>__resort</b>(<i></i>) 512 <b>__resort</b>(<i></i>)
516
517 <p> 513 <p>
518 Private method to resort the tree. 514 Private method to resort the tree.
519 </p> 515 </p>
516
520 <a NAME="TaskViewer.__showContextMenu" ID="TaskViewer.__showContextMenu"></a> 517 <a NAME="TaskViewer.__showContextMenu" ID="TaskViewer.__showContextMenu"></a>
521 <h4>TaskViewer.__showContextMenu</h4> 518 <h4>TaskViewer.__showContextMenu</h4>
522 <b>__showContextMenu</b>(<i>coord</i>) 519 <b>__showContextMenu</b>(<i>coord</i>)
523
524 <p> 520 <p>
525 Private slot to show the context menu of the list. 521 Private slot to show the context menu of the list.
526 </p> 522 </p>
523
527 <dl> 524 <dl>
528 525
529 <dt><i>coord</i> (QPoint)</dt> 526 <dt><i>coord</i> (QPoint)</dt>
530 <dd> 527 <dd>
531 the position of the mouse pointer 528 the position of the mouse pointer
532 </dd> 529 </dd>
533 </dl> 530 </dl>
534 <a NAME="TaskViewer.__taskItemActivated" ID="TaskViewer.__taskItemActivated"></a> 531 <a NAME="TaskViewer.__taskItemActivated" ID="TaskViewer.__taskItemActivated"></a>
535 <h4>TaskViewer.__taskItemActivated</h4> 532 <h4>TaskViewer.__taskItemActivated</h4>
536 <b>__taskItemActivated</b>(<i>itm, col</i>) 533 <b>__taskItemActivated</b>(<i>itm, col</i>)
537
538 <p> 534 <p>
539 Private slot to handle the activation of an item. 535 Private slot to handle the activation of an item.
540 </p> 536 </p>
537
541 <dl> 538 <dl>
542 539
543 <dt><i>itm</i> (QTreeWidgetItem)</dt> 540 <dt><i>itm</i> (QTreeWidgetItem)</dt>
544 <dd> 541 <dd>
545 reference to the activated item 542 reference to the activated item
550 </dd> 547 </dd>
551 </dl> 548 </dl>
552 <a NAME="TaskViewer.addFileTask" ID="TaskViewer.addFileTask"></a> 549 <a NAME="TaskViewer.addFileTask" ID="TaskViewer.addFileTask"></a>
553 <h4>TaskViewer.addFileTask</h4> 550 <h4>TaskViewer.addFileTask</h4>
554 <b>addFileTask</b>(<i>summary, filename, lineno, taskType=TaskType.TODO, description=""</i>) 551 <b>addFileTask</b>(<i>summary, filename, lineno, taskType=TaskType.TODO, description=""</i>)
555
556 <p> 552 <p>
557 Public slot to add a file related task. 553 Public slot to add a file related task.
558 </p> 554 </p>
555
559 <dl> 556 <dl>
560 557
561 <dt><i>summary</i> (str)</dt> 558 <dt><i>summary</i> (str)</dt>
562 <dd> 559 <dd>
563 summary text of the task 560 summary text of the task
580 </dd> 577 </dd>
581 </dl> 578 </dl>
582 <a NAME="TaskViewer.addTask" ID="TaskViewer.addTask"></a> 579 <a NAME="TaskViewer.addTask" ID="TaskViewer.addTask"></a>
583 <h4>TaskViewer.addTask</h4> 580 <h4>TaskViewer.addTask</h4>
584 <b>addTask</b>(<i>summary, priority=TaskPriority.NORMAL, filename="", lineno=0, completed=False, _time=0, isProjectTask=False, taskType=TaskType.TODO, description="", uid="", parentTask=None, </i>) 581 <b>addTask</b>(<i>summary, priority=TaskPriority.NORMAL, filename="", lineno=0, completed=False, _time=0, isProjectTask=False, taskType=TaskType.TODO, description="", uid="", parentTask=None, </i>)
585
586 <p> 582 <p>
587 Public slot to add a task. 583 Public slot to add a task.
588 </p> 584 </p>
585
589 <dl> 586 <dl>
590 587
591 <dt><i>summary</i> (str)</dt> 588 <dt><i>summary</i> (str)</dt>
592 <dd> 589 <dd>
593 summary text of the task 590 summary text of the task
648 </dd> 645 </dd>
649 </dl> 646 </dl>
650 <a NAME="TaskViewer.clearFileTasks" ID="TaskViewer.clearFileTasks"></a> 647 <a NAME="TaskViewer.clearFileTasks" ID="TaskViewer.clearFileTasks"></a>
651 <h4>TaskViewer.clearFileTasks</h4> 648 <h4>TaskViewer.clearFileTasks</h4>
652 <b>clearFileTasks</b>(<i>filename, conditionally=False</i>) 649 <b>clearFileTasks</b>(<i>filename, conditionally=False</i>)
653
654 <p> 650 <p>
655 Public slot to clear all tasks related to a file. 651 Public slot to clear all tasks related to a file.
656 </p> 652 </p>
653
657 <dl> 654 <dl>
658 655
659 <dt><i>filename</i> (str)</dt> 656 <dt><i>filename</i> (str)</dt>
660 <dd> 657 <dd>
661 name of the file 658 name of the file
667 </dd> 664 </dd>
668 </dl> 665 </dl>
669 <a NAME="TaskViewer.clearProjectTasks" ID="TaskViewer.clearProjectTasks"></a> 666 <a NAME="TaskViewer.clearProjectTasks" ID="TaskViewer.clearProjectTasks"></a>
670 <h4>TaskViewer.clearProjectTasks</h4> 667 <h4>TaskViewer.clearProjectTasks</h4>
671 <b>clearProjectTasks</b>(<i>fileOnly=False</i>) 668 <b>clearProjectTasks</b>(<i>fileOnly=False</i>)
672
673 <p> 669 <p>
674 Public slot to clear project related tasks. 670 Public slot to clear project related tasks.
675 </p> 671 </p>
672
676 <dl> 673 <dl>
677 674
678 <dt><i>fileOnly</i> (bool)</dt> 675 <dt><i>fileOnly</i> (bool)</dt>
679 <dd> 676 <dd>
680 flag indicating to clear only file related project tasks 677 flag indicating to clear only file related project tasks
681 </dd> 678 </dd>
682 </dl> 679 </dl>
683 <a NAME="TaskViewer.clearTasks" ID="TaskViewer.clearTasks"></a> 680 <a NAME="TaskViewer.clearTasks" ID="TaskViewer.clearTasks"></a>
684 <h4>TaskViewer.clearTasks</h4> 681 <h4>TaskViewer.clearTasks</h4>
685 <b>clearTasks</b>(<i></i>) 682 <b>clearTasks</b>(<i></i>)
686
687 <p> 683 <p>
688 Public slot to clear all tasks from display. 684 Public slot to clear all tasks from display.
689 </p> 685 </p>
686
690 <a NAME="TaskViewer.containsTask" ID="TaskViewer.containsTask"></a> 687 <a NAME="TaskViewer.containsTask" ID="TaskViewer.containsTask"></a>
691 <h4>TaskViewer.containsTask</h4> 688 <h4>TaskViewer.containsTask</h4>
692 <b>containsTask</b>(<i>taskToTest</i>) 689 <b>containsTask</b>(<i>taskToTest</i>)
693
694 <p> 690 <p>
695 Public method to test, if a task is already in the tasks list. 691 Public method to test, if a task is already in the tasks list.
696 </p> 692 </p>
693
697 <dl> 694 <dl>
698 695
699 <dt><i>taskToTest</i> (Task)</dt> 696 <dt><i>taskToTest</i> (Task)</dt>
700 <dd> 697 <dd>
701 task to look for 698 task to look for
714 </dd> 711 </dd>
715 </dl> 712 </dl>
716 <a NAME="TaskViewer.findParentTask" ID="TaskViewer.findParentTask"></a> 713 <a NAME="TaskViewer.findParentTask" ID="TaskViewer.findParentTask"></a>
717 <h4>TaskViewer.findParentTask</h4> 714 <h4>TaskViewer.findParentTask</h4>
718 <b>findParentTask</b>(<i>parentUid</i>) 715 <b>findParentTask</b>(<i>parentUid</i>)
719
720 <p> 716 <p>
721 Public method to find a parent task by its ID. 717 Public method to find a parent task by its ID.
722 </p> 718 </p>
719
723 <dl> 720 <dl>
724 721
725 <dt><i>parentUid</i> (str)</dt> 722 <dt><i>parentUid</i> (str)</dt>
726 <dd> 723 <dd>
727 uid of the parent task 724 uid of the parent task
740 </dd> 737 </dd>
741 </dl> 738 </dl>
742 <a NAME="TaskViewer.getGlobalTasks" ID="TaskViewer.getGlobalTasks"></a> 739 <a NAME="TaskViewer.getGlobalTasks" ID="TaskViewer.getGlobalTasks"></a>
743 <h4>TaskViewer.getGlobalTasks</h4> 740 <h4>TaskViewer.getGlobalTasks</h4>
744 <b>getGlobalTasks</b>(<i></i>) 741 <b>getGlobalTasks</b>(<i></i>)
745
746 <p> 742 <p>
747 Public method to retrieve all non project related tasks. 743 Public method to retrieve all non project related tasks.
748 </p> 744 </p>
745
749 <dl> 746 <dl>
750 <dt>Return:</dt> 747 <dt>Return:</dt>
751 <dd> 748 <dd>
752 copy of tasks 749 copy of tasks
753 </dd> 750 </dd>
759 </dd> 756 </dd>
760 </dl> 757 </dl>
761 <a NAME="TaskViewer.getProjectTasks" ID="TaskViewer.getProjectTasks"></a> 758 <a NAME="TaskViewer.getProjectTasks" ID="TaskViewer.getProjectTasks"></a>
762 <h4>TaskViewer.getProjectTasks</h4> 759 <h4>TaskViewer.getProjectTasks</h4>
763 <b>getProjectTasks</b>(<i></i>) 760 <b>getProjectTasks</b>(<i></i>)
764
765 <p> 761 <p>
766 Public method to retrieve all project related tasks. 762 Public method to retrieve all project related tasks.
767 </p> 763 </p>
764
768 <dl> 765 <dl>
769 <dt>Return:</dt> 766 <dt>Return:</dt>
770 <dd> 767 <dd>
771 copy of tasks 768 copy of tasks
772 </dd> 769 </dd>
778 </dd> 775 </dd>
779 </dl> 776 </dl>
780 <a NAME="TaskViewer.getTasksScanFilter" ID="TaskViewer.getTasksScanFilter"></a> 777 <a NAME="TaskViewer.getTasksScanFilter" ID="TaskViewer.getTasksScanFilter"></a>
781 <h4>TaskViewer.getTasksScanFilter</h4> 778 <h4>TaskViewer.getTasksScanFilter</h4>
782 <b>getTasksScanFilter</b>(<i></i>) 779 <b>getTasksScanFilter</b>(<i></i>)
783
784 <p> 780 <p>
785 Public method to get the project scan filter. 781 Public method to get the project scan filter.
786 </p> 782 </p>
783
787 <dl> 784 <dl>
788 <dt>Return:</dt> 785 <dt>Return:</dt>
789 <dd> 786 <dd>
790 project scan filter 787 project scan filter
791 </dd> 788 </dd>
797 </dd> 794 </dd>
798 </dl> 795 </dl>
799 <a NAME="TaskViewer.handlePreferencesChanged" ID="TaskViewer.handlePreferencesChanged"></a> 796 <a NAME="TaskViewer.handlePreferencesChanged" ID="TaskViewer.handlePreferencesChanged"></a>
800 <h4>TaskViewer.handlePreferencesChanged</h4> 797 <h4>TaskViewer.handlePreferencesChanged</h4>
801 <b>handlePreferencesChanged</b>(<i></i>) 798 <b>handlePreferencesChanged</b>(<i></i>)
802
803 <p> 799 <p>
804 Public slot to react to changes of the preferences. 800 Public slot to react to changes of the preferences.
805 </p> 801 </p>
802
806 <a NAME="TaskViewer.regenerateProjectTasks" ID="TaskViewer.regenerateProjectTasks"></a> 803 <a NAME="TaskViewer.regenerateProjectTasks" ID="TaskViewer.regenerateProjectTasks"></a>
807 <h4>TaskViewer.regenerateProjectTasks</h4> 804 <h4>TaskViewer.regenerateProjectTasks</h4>
808 <b>regenerateProjectTasks</b>(<i>quiet=False</i>) 805 <b>regenerateProjectTasks</b>(<i>quiet=False</i>)
809
810 <p> 806 <p>
811 Public slot to regenerate project related tasks. 807 Public slot to regenerate project related tasks.
812 </p> 808 </p>
809
813 <dl> 810 <dl>
814 811
815 <dt><i>quiet</i> (bool)</dt> 812 <dt><i>quiet</i> (bool)</dt>
816 <dd> 813 <dd>
817 flag indicating quiet operation 814 flag indicating quiet operation
818 </dd> 815 </dd>
819 </dl> 816 </dl>
820 <a NAME="TaskViewer.saveProjectTasks" ID="TaskViewer.saveProjectTasks"></a> 817 <a NAME="TaskViewer.saveProjectTasks" ID="TaskViewer.saveProjectTasks"></a>
821 <h4>TaskViewer.saveProjectTasks</h4> 818 <h4>TaskViewer.saveProjectTasks</h4>
822 <b>saveProjectTasks</b>(<i></i>) 819 <b>saveProjectTasks</b>(<i></i>)
823
824 <p> 820 <p>
825 Public method to write the project tasks. 821 Public method to write the project tasks.
826 </p> 822 </p>
823
827 <a NAME="TaskViewer.setProjectOpen" ID="TaskViewer.setProjectOpen"></a> 824 <a NAME="TaskViewer.setProjectOpen" ID="TaskViewer.setProjectOpen"></a>
828 <h4>TaskViewer.setProjectOpen</h4> 825 <h4>TaskViewer.setProjectOpen</h4>
829 <b>setProjectOpen</b>(<i>o=False</i>) 826 <b>setProjectOpen</b>(<i>o=False</i>)
830
831 <p> 827 <p>
832 Public slot to set the project status. 828 Public slot to set the project status.
833 </p> 829 </p>
830
834 <dl> 831 <dl>
835 832
836 <dt><i>o</i> (bool)</dt> 833 <dt><i>o</i> (bool)</dt>
837 <dd> 834 <dd>
838 flag indicating the project status 835 flag indicating the project status
839 </dd> 836 </dd>
840 </dl> 837 </dl>
841 <a NAME="TaskViewer.setTasksScanFilter" ID="TaskViewer.setTasksScanFilter"></a> 838 <a NAME="TaskViewer.setTasksScanFilter" ID="TaskViewer.setTasksScanFilter"></a>
842 <h4>TaskViewer.setTasksScanFilter</h4> 839 <h4>TaskViewer.setTasksScanFilter</h4>
843 <b>setTasksScanFilter</b>(<i>filterStr: str</i>) 840 <b>setTasksScanFilter</b>(<i>filterStr: str</i>)
844
845 <p> 841 <p>
846 Public method to set the project scan filter. 842 Public method to set the project scan filter.
847 </p> 843 </p>
844
848 <dl> 845 <dl>
849 846
850 <dt><i>filterStr</i> (str)</dt> 847 <dt><i>filterStr</i> (str)</dt>
851 <dd> 848 <dd>
852 project scan filter 849 project scan filter
853 </dd> 850 </dd>
854 </dl> 851 </dl>
855 <a NAME="TaskViewer.stopProjectTaskExtraction" ID="TaskViewer.stopProjectTaskExtraction"></a> 852 <a NAME="TaskViewer.stopProjectTaskExtraction" ID="TaskViewer.stopProjectTaskExtraction"></a>
856 <h4>TaskViewer.stopProjectTaskExtraction</h4> 853 <h4>TaskViewer.stopProjectTaskExtraction</h4>
857 <b>stopProjectTaskExtraction</b>(<i></i>) 854 <b>stopProjectTaskExtraction</b>(<i></i>)
858
859 <p> 855 <p>
860 Public method to stop the project task extraction thread. 856 Public method to stop the project task extraction thread.
861 </p> 857 </p>
858
862 <div align="right"><a href="#top">Up</a></div> 859 <div align="right"><a href="#top">Up</a></div>
863 <hr /> 860 <hr />
864 </body></html> 861 </body></html>

Mercurial Repository: eric

eric ide

mercurial