Mercurial Repositories > eric / file comparison

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

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

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
equal deleted inserted replaced
8371:d6062691d424 8372:e0227a7c850e
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Tasks.TaskViewer</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body>
22 <a NAME="top" ID="top"></a>
23 <h1>eric7.Tasks.TaskViewer</h1>
24
25 <p>
26 Module implementing a task viewer and associated classes.
27 </p>
28 <p>
29 Tasks can be defined manually or automatically. Automatically
30 generated tasks are derived from a comment with a special
31 introductory text. This text is configurable.
32 </p>
33 <h3>Global Attributes</h3>
34
35 <table>
36 <tr><td>None</td></tr>
37 </table>
38 <h3>Classes</h3>
39
40 <table>
41
42 <tr>
43 <td><a href="#ProjectTaskExtractionThread">ProjectTaskExtractionThread</a></td>
44 <td>Class implementing a thread to extract tasks related to a project.</td>
45 </tr>
46 <tr>
47 <td><a href="#TaskViewer">TaskViewer</a></td>
48 <td>Class implementing the task viewer.</td>
49 </tr>
50 </table>
51 <h3>Functions</h3>
52
53 <table>
54 <tr><td>None</td></tr>
55 </table>
56 <hr />
57 <hr />
58 <a NAME="ProjectTaskExtractionThread" ID="ProjectTaskExtractionThread"></a>
59 <h2>ProjectTaskExtractionThread</h2>
60
61 <p>
62 Class implementing a thread to extract tasks related to a project.
63 </p>
64 <h3>Signals</h3>
65 <dl>
66
67 <dt>taskFound(str, str, int, TaskType)</dt>
68 <dd>
69 emitted with the task
70 description, the file name, the line number and task type to signal
71 the presence of a task
72 </dd>
73 </dl>
74 <h3>Derived from</h3>
75 QThread
76 <h3>Class Attributes</h3>
77
78 <table>
79 <tr><td>None</td></tr>
80 </table>
81 <h3>Class Methods</h3>
82
83 <table>
84 <tr><td>None</td></tr>
85 </table>
86 <h3>Methods</h3>
87
88 <table>
89
90 <tr>
91 <td><a href="#ProjectTaskExtractionThread.__init__">ProjectTaskExtractionThread</a></td>
92 <td>Constructor</td>
93 </tr>
94 <tr>
95 <td><a href="#ProjectTaskExtractionThread.requestInterrupt">requestInterrupt</a></td>
96 <td>Public method to request iterruption of the thread.</td>
97 </tr>
98 <tr>
99 <td><a href="#ProjectTaskExtractionThread.run">run</a></td>
100 <td>Public thread method to scan the given files.</td>
101 </tr>
102 <tr>
103 <td><a href="#ProjectTaskExtractionThread.scan">scan</a></td>
104 <td>Public method to scan the given list of files for tasks.</td>
105 </tr>
106 </table>
107 <h3>Static Methods</h3>
108
109 <table>
110 <tr><td>None</td></tr>
111 </table>
112
113 <a NAME="ProjectTaskExtractionThread.__init__" ID="ProjectTaskExtractionThread.__init__"></a>
114 <h4>ProjectTaskExtractionThread (Constructor)</h4>
115 <b>ProjectTaskExtractionThread</b>(<i>parent=None</i>)
116
117 <p>
118 Constructor
119 </p>
120 <dl>
121
122 <dt><i>parent</i></dt>
123 <dd>
124 reference to the parent object (QObject)
125 </dd>
126 </dl>
127 <a NAME="ProjectTaskExtractionThread.requestInterrupt" ID="ProjectTaskExtractionThread.requestInterrupt"></a>
128 <h4>ProjectTaskExtractionThread.requestInterrupt</h4>
129 <b>requestInterrupt</b>(<i></i>)
130
131 <p>
132 Public method to request iterruption of the thread.
133 </p>
134 <a NAME="ProjectTaskExtractionThread.run" ID="ProjectTaskExtractionThread.run"></a>
135 <h4>ProjectTaskExtractionThread.run</h4>
136 <b>run</b>(<i></i>)
137
138 <p>
139 Public thread method to scan the given files.
140 </p>
141 <a NAME="ProjectTaskExtractionThread.scan" ID="ProjectTaskExtractionThread.scan"></a>
142 <h4>ProjectTaskExtractionThread.scan</h4>
143 <b>scan</b>(<i>markers, files</i>)
144
145 <p>
146 Public method to scan the given list of files for tasks.
147 </p>
148 <dl>
149
150 <dt><i>markers</i> (dict of lists of str)</dt>
151 <dd>
152 dictionary of defined task markers
153 </dd>
154 <dt><i>files</i> (list of str)</dt>
155 <dd>
156 list of file names to be scanned
157 </dd>
158 </dl>
159 <div align="right"><a href="#top">Up</a></div>
160 <hr />
161 <hr />
162 <a NAME="TaskViewer" ID="TaskViewer"></a>
163 <h2>TaskViewer</h2>
164
165 <p>
166 Class implementing the task viewer.
167 </p>
168 <h3>Signals</h3>
169 <dl>
170
171 <dt>displayFile(str, int)</dt>
172 <dd>
173 emitted to go to a file task
174 </dd>
175 </dl>
176 <h3>Derived from</h3>
177 QTreeWidget
178 <h3>Class Attributes</h3>
179
180 <table>
181 <tr><td>None</td></tr>
182 </table>
183 <h3>Class Methods</h3>
184
185 <table>
186 <tr><td>None</td></tr>
187 </table>
188 <h3>Methods</h3>
189
190 <table>
191
192 <tr>
193 <td><a href="#TaskViewer.__init__">TaskViewer</a></td>
194 <td>Constructor</td>
195 </tr>
196 <tr>
197 <td><a href="#TaskViewer.__activateFilter">__activateFilter</a></td>
198 <td>Private slot to handle the "Filtered display" context menu entry.</td>
199 </tr>
200 <tr>
201 <td><a href="#TaskViewer.__checkTopLevelItems">__checkTopLevelItems</a></td>
202 <td>Private slot to check the 'Extracted Tasks' item for children.</td>
203 </tr>
204 <tr>
205 <td><a href="#TaskViewer.__configure">__configure</a></td>
206 <td>Private method to open the configuration dialog.</td>
207 </tr>
208 <tr>
209 <td><a href="#TaskViewer.__configureFilter">__configureFilter</a></td>
210 <td>Private slot to handle the "Configure filter" context menu entry.</td>
211 </tr>
212 <tr>
213 <td><a href="#TaskViewer.__configureProjectTasksScanOptions">__configureProjectTasksScanOptions</a></td>
214 <td>Private slot to configure scan options for project tasks.</td>
215 </tr>
216 <tr>
217 <td><a href="#TaskViewer.__copyTask">__copyTask</a></td>
218 <td>Private slot to handle the "Copy" context menu entry.</td>
219 </tr>
220 <tr>
221 <td><a href="#TaskViewer.__deleteCompleted">__deleteCompleted</a></td>
222 <td>Private slot to handle the "Delete Completed Tasks" context menu entry.</td>
223 </tr>
224 <tr>
225 <td><a href="#TaskViewer.__deleteSubTasks">__deleteSubTasks</a></td>
226 <td>Private method to delete all sub-tasks.</td>
227 </tr>
228 <tr>
229 <td><a href="#TaskViewer.__deleteTask">__deleteTask</a></td>
230 <td>Private slot to delete a task.</td>
231 </tr>
232 <tr>
233 <td><a href="#TaskViewer.__editTaskProperties">__editTaskProperties</a></td>
234 <td>Private slot to handle the "Properties" context menu entry.</td>
235 </tr>
236 <tr>
237 <td><a href="#TaskViewer.__generateTopLevelItems">__generateTopLevelItems</a></td>
238 <td>Private method to generate the 'Extracted Tasks' item.</td>
239 </tr>
240 <tr>
241 <td><a href="#TaskViewer.__goToTask">__goToTask</a></td>
242 <td>Private slot to handle the "Go To" context menu entry.</td>
243 </tr>
244 <tr>
245 <td><a href="#TaskViewer.__markCompleted">__markCompleted</a></td>
246 <td>Private slot to handle the "Mark Completed" context menu entry.</td>
247 </tr>
248 <tr>
249 <td><a href="#TaskViewer.__newSubTask">__newSubTask</a></td>
250 <td>Private slot to handle the "New Sub-Task" context menu entry.</td>
251 </tr>
252 <tr>
253 <td><a href="#TaskViewer.__newTask">__newTask</a></td>
254 <td>Private slot to handle the "New Task" context menu entry.</td>
255 </tr>
256 <tr>
257 <td><a href="#TaskViewer.__pasteMainTask">__pasteMainTask</a></td>
258 <td>Private slot to handle the "Paste as Main Task" context menu entry.</td>
259 </tr>
260 <tr>
261 <td><a href="#TaskViewer.__pasteTask">__pasteTask</a></td>
262 <td>Private slot to handle the "Paste" context menu entry.</td>
263 </tr>
264 <tr>
265 <td><a href="#TaskViewer.__refreshDisplay">__refreshDisplay</a></td>
266 <td>Private method to refresh the display.</td>
267 </tr>
268 <tr>
269 <td><a href="#TaskViewer.__resizeColumns">__resizeColumns</a></td>
270 <td>Private method to resize the list columns.</td>
271 </tr>
272 <tr>
273 <td><a href="#TaskViewer.__resort">__resort</a></td>
274 <td>Private method to resort the tree.</td>
275 </tr>
276 <tr>
277 <td><a href="#TaskViewer.__showContextMenu">__showContextMenu</a></td>
278 <td>Private slot to show the context menu of the list.</td>
279 </tr>
280 <tr>
281 <td><a href="#TaskViewer.__taskItemActivated">__taskItemActivated</a></td>
282 <td>Private slot to handle the activation of an item.</td>
283 </tr>
284 <tr>
285 <td><a href="#TaskViewer.addFileTask">addFileTask</a></td>
286 <td>Public slot to add a file related task.</td>
287 </tr>
288 <tr>
289 <td><a href="#TaskViewer.addTask">addTask</a></td>
290 <td>Public slot to add a task.</td>
291 </tr>
292 <tr>
293 <td><a href="#TaskViewer.clearFileTasks">clearFileTasks</a></td>
294 <td>Public slot to clear all tasks related to a file.</td>
295 </tr>
296 <tr>
297 <td><a href="#TaskViewer.clearProjectTasks">clearProjectTasks</a></td>
298 <td>Public slot to clear project related tasks.</td>
299 </tr>
300 <tr>
301 <td><a href="#TaskViewer.clearTasks">clearTasks</a></td>
302 <td>Public slot to clear all tasks from display.</td>
303 </tr>
304 <tr>
305 <td><a href="#TaskViewer.findParentTask">findParentTask</a></td>
306 <td>Public method to find a parent task by its ID.</td>
307 </tr>
308 <tr>
309 <td><a href="#TaskViewer.getGlobalTasks">getGlobalTasks</a></td>
310 <td>Public method to retrieve all non project related tasks.</td>
311 </tr>
312 <tr>
313 <td><a href="#TaskViewer.getProjectTasks">getProjectTasks</a></td>
314 <td>Public method to retrieve all project related tasks.</td>
315 </tr>
316 <tr>
317 <td><a href="#TaskViewer.getTasksScanFilter">getTasksScanFilter</a></td>
318 <td>Public method to get the project scan filter.</td>
319 </tr>
320 <tr>
321 <td><a href="#TaskViewer.handlePreferencesChanged">handlePreferencesChanged</a></td>
322 <td>Public slot to react to changes of the preferences.</td>
323 </tr>
324 <tr>
325 <td><a href="#TaskViewer.regenerateProjectTasks">regenerateProjectTasks</a></td>
326 <td>Public slot to regenerate project related tasks.</td>
327 </tr>
328 <tr>
329 <td><a href="#TaskViewer.saveProjectTasks">saveProjectTasks</a></td>
330 <td>Public method to write the project tasks.</td>
331 </tr>
332 <tr>
333 <td><a href="#TaskViewer.setProjectOpen">setProjectOpen</a></td>
334 <td>Public slot to set the project status.</td>
335 </tr>
336 <tr>
337 <td><a href="#TaskViewer.setTasksScanFilter">setTasksScanFilter</a></td>
338 <td>Public method to set the project scan filter.</td>
339 </tr>
340 <tr>
341 <td><a href="#TaskViewer.stopProjectTaskExtraction">stopProjectTaskExtraction</a></td>
342 <td>Public method to stop the project task extraction thread.</td>
343 </tr>
344 </table>
345 <h3>Static Methods</h3>
346
347 <table>
348 <tr><td>None</td></tr>
349 </table>
350
351 <a NAME="TaskViewer.__init__" ID="TaskViewer.__init__"></a>
352 <h4>TaskViewer (Constructor)</h4>
353 <b>TaskViewer</b>(<i>parent, project</i>)
354
355 <p>
356 Constructor
357 </p>
358 <dl>
359
360 <dt><i>parent</i></dt>
361 <dd>
362 the parent (QWidget)
363 </dd>
364 <dt><i>project</i></dt>
365 <dd>
366 reference to the project object
367 </dd>
368 </dl>
369 <a NAME="TaskViewer.__activateFilter" ID="TaskViewer.__activateFilter"></a>
370 <h4>TaskViewer.__activateFilter</h4>
371 <b>__activateFilter</b>(<i>on</i>)
372
373 <p>
374 Private slot to handle the "Filtered display" context menu entry.
375 </p>
376 <dl>
377
378 <dt><i>on</i></dt>
379 <dd>
380 flag indicating the filter state (boolean)
381 </dd>
382 </dl>
383 <a NAME="TaskViewer.__checkTopLevelItems" ID="TaskViewer.__checkTopLevelItems"></a>
384 <h4>TaskViewer.__checkTopLevelItems</h4>
385 <b>__checkTopLevelItems</b>(<i></i>)
386
387 <p>
388 Private slot to check the 'Extracted Tasks' item for children.
389 </p>
390 <a NAME="TaskViewer.__configure" ID="TaskViewer.__configure"></a>
391 <h4>TaskViewer.__configure</h4>
392 <b>__configure</b>(<i></i>)
393
394 <p>
395 Private method to open the configuration dialog.
396 </p>
397 <a NAME="TaskViewer.__configureFilter" ID="TaskViewer.__configureFilter"></a>
398 <h4>TaskViewer.__configureFilter</h4>
399 <b>__configureFilter</b>(<i></i>)
400
401 <p>
402 Private slot to handle the "Configure filter" context menu entry.
403 </p>
404 <a NAME="TaskViewer.__configureProjectTasksScanOptions" ID="TaskViewer.__configureProjectTasksScanOptions"></a>
405 <h4>TaskViewer.__configureProjectTasksScanOptions</h4>
406 <b>__configureProjectTasksScanOptions</b>(<i></i>)
407
408 <p>
409 Private slot to configure scan options for project tasks.
410 </p>
411 <a NAME="TaskViewer.__copyTask" ID="TaskViewer.__copyTask"></a>
412 <h4>TaskViewer.__copyTask</h4>
413 <b>__copyTask</b>(<i></i>)
414
415 <p>
416 Private slot to handle the "Copy" context menu entry.
417 </p>
418 <a NAME="TaskViewer.__deleteCompleted" ID="TaskViewer.__deleteCompleted"></a>
419 <h4>TaskViewer.__deleteCompleted</h4>
420 <b>__deleteCompleted</b>(<i></i>)
421
422 <p>
423 Private slot to handle the "Delete Completed Tasks" context menu entry.
424 </p>
425 <a NAME="TaskViewer.__deleteSubTasks" ID="TaskViewer.__deleteSubTasks"></a>
426 <h4>TaskViewer.__deleteSubTasks</h4>
427 <b>__deleteSubTasks</b>(<i>task</i>)
428
429 <p>
430 Private method to delete all sub-tasks.
431 </p>
432 <dl>
433
434 <dt><i>task</i></dt>
435 <dd>
436 task to delete sub-tasks of (Task)
437 </dd>
438 </dl>
439 <a NAME="TaskViewer.__deleteTask" ID="TaskViewer.__deleteTask"></a>
440 <h4>TaskViewer.__deleteTask</h4>
441 <b>__deleteTask</b>(<i>task=None</i>)
442
443 <p>
444 Private slot to delete a task.
445 </p>
446 <dl>
447
448 <dt><i>task</i> (Task)</dt>
449 <dd>
450 task to be deleted
451 </dd>
452 </dl>
453 <a NAME="TaskViewer.__editTaskProperties" ID="TaskViewer.__editTaskProperties"></a>
454 <h4>TaskViewer.__editTaskProperties</h4>
455 <b>__editTaskProperties</b>(<i></i>)
456
457 <p>
458 Private slot to handle the "Properties" context menu entry.
459 </p>
460 <a NAME="TaskViewer.__generateTopLevelItems" ID="TaskViewer.__generateTopLevelItems"></a>
461 <h4>TaskViewer.__generateTopLevelItems</h4>
462 <b>__generateTopLevelItems</b>(<i></i>)
463
464 <p>
465 Private method to generate the 'Extracted Tasks' item.
466 </p>
467 <a NAME="TaskViewer.__goToTask" ID="TaskViewer.__goToTask"></a>
468 <h4>TaskViewer.__goToTask</h4>
469 <b>__goToTask</b>(<i></i>)
470
471 <p>
472 Private slot to handle the "Go To" context menu entry.
473 </p>
474 <a NAME="TaskViewer.__markCompleted" ID="TaskViewer.__markCompleted"></a>
475 <h4>TaskViewer.__markCompleted</h4>
476 <b>__markCompleted</b>(<i></i>)
477
478 <p>
479 Private slot to handle the "Mark Completed" context menu entry.
480 </p>
481 <a NAME="TaskViewer.__newSubTask" ID="TaskViewer.__newSubTask"></a>
482 <h4>TaskViewer.__newSubTask</h4>
483 <b>__newSubTask</b>(<i></i>)
484
485 <p>
486 Private slot to handle the "New Sub-Task" context menu entry.
487 </p>
488 <a NAME="TaskViewer.__newTask" ID="TaskViewer.__newTask"></a>
489 <h4>TaskViewer.__newTask</h4>
490 <b>__newTask</b>(<i></i>)
491
492 <p>
493 Private slot to handle the "New Task" context menu entry.
494 </p>
495 <a NAME="TaskViewer.__pasteMainTask" ID="TaskViewer.__pasteMainTask"></a>
496 <h4>TaskViewer.__pasteMainTask</h4>
497 <b>__pasteMainTask</b>(<i></i>)
498
499 <p>
500 Private slot to handle the "Paste as Main Task" context menu entry.
501 </p>
502 <a NAME="TaskViewer.__pasteTask" ID="TaskViewer.__pasteTask"></a>
503 <h4>TaskViewer.__pasteTask</h4>
504 <b>__pasteTask</b>(<i></i>)
505
506 <p>
507 Private slot to handle the "Paste" context menu entry.
508 </p>
509 <a NAME="TaskViewer.__refreshDisplay" ID="TaskViewer.__refreshDisplay"></a>
510 <h4>TaskViewer.__refreshDisplay</h4>
511 <b>__refreshDisplay</b>(<i></i>)
512
513 <p>
514 Private method to refresh the display.
515 </p>
516 <a NAME="TaskViewer.__resizeColumns" ID="TaskViewer.__resizeColumns"></a>
517 <h4>TaskViewer.__resizeColumns</h4>
518 <b>__resizeColumns</b>(<i></i>)
519
520 <p>
521 Private method to resize the list columns.
522 </p>
523 <a NAME="TaskViewer.__resort" ID="TaskViewer.__resort"></a>
524 <h4>TaskViewer.__resort</h4>
525 <b>__resort</b>(<i></i>)
526
527 <p>
528 Private method to resort the tree.
529 </p>
530 <a NAME="TaskViewer.__showContextMenu" ID="TaskViewer.__showContextMenu"></a>
531 <h4>TaskViewer.__showContextMenu</h4>
532 <b>__showContextMenu</b>(<i>coord</i>)
533
534 <p>
535 Private slot to show the context menu of the list.
536 </p>
537 <dl>
538
539 <dt><i>coord</i></dt>
540 <dd>
541 the position of the mouse pointer (QPoint)
542 </dd>
543 </dl>
544 <a NAME="TaskViewer.__taskItemActivated" ID="TaskViewer.__taskItemActivated"></a>
545 <h4>TaskViewer.__taskItemActivated</h4>
546 <b>__taskItemActivated</b>(<i>itm, col</i>)
547
548 <p>
549 Private slot to handle the activation of an item.
550 </p>
551 <dl>
552
553 <dt><i>itm</i></dt>
554 <dd>
555 reference to the activated item (QTreeWidgetItem)
556 </dd>
557 <dt><i>col</i></dt>
558 <dd>
559 column the item was activated in (integer)
560 </dd>
561 </dl>
562 <a NAME="TaskViewer.addFileTask" ID="TaskViewer.addFileTask"></a>
563 <h4>TaskViewer.addFileTask</h4>
564 <b>addFileTask</b>(<i>summary, filename, lineno, taskType=TaskType.TODO, description=""</i>)
565
566 <p>
567 Public slot to add a file related task.
568 </p>
569 <dl>
570
571 <dt><i>summary</i> (str)</dt>
572 <dd>
573 summary text of the task
574 </dd>
575 <dt><i>filename</i> (str)</dt>
576 <dd>
577 filename containing the task
578 </dd>
579 <dt><i>lineno</i> (int)</dt>
580 <dd>
581 line number containing the task
582 </dd>
583 <dt><i>taskType</i> (TaskType)</dt>
584 <dd>
585 type of the task
586 </dd>
587 <dt><i>description</i> (str)</dt>
588 <dd>
589 explanatory text of the task
590 </dd>
591 </dl>
592 <a NAME="TaskViewer.addTask" ID="TaskViewer.addTask"></a>
593 <h4>TaskViewer.addTask</h4>
594 <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>)
595
596 <p>
597 Public slot to add a task.
598 </p>
599 <dl>
600
601 <dt><i>summary</i> (str)</dt>
602 <dd>
603 summary text of the task
604 </dd>
605 <dt><i>priority</i> (TaskPriority)</dt>
606 <dd>
607 priority of the task
608 </dd>
609 <dt><i>filename</i> (str)</dt>
610 <dd>
611 filename containing the task
612 </dd>
613 <dt><i>lineno</i> (int)</dt>
614 <dd>
615 line number containing the task
616 </dd>
617 <dt><i>completed</i> (bool)</dt>
618 <dd>
619 flag indicating completion status
620 </dd>
621 <dt><i>_time</i> (float)</dt>
622 <dd>
623 creation time of the task (if 0 use current time)
624 </dd>
625 <dt><i>isProjectTask</i> (bool)</dt>
626 <dd>
627 flag indicating a task related to the current
628 project
629 </dd>
630 <dt><i>taskType</i> (TaskType)</dt>
631 <dd>
632 type of the task
633 </dd>
634 <dt><i>description</i> (str)</dt>
635 <dd>
636 explanatory text of the task
637 </dd>
638 <dt><i>uid</i> (str)</dt>
639 <dd>
640 unique id of the task
641 </dd>
642 <dt><i>parentTask</i> (Task or str)</dt>
643 <dd>
644 reference to the parent task item or the UID of the
645 parent task
646 </dd>
647 </dl>
648 <dl>
649 <dt>Return:</dt>
650 <dd>
651 reference to the task item
652 </dd>
653 </dl>
654 <dl>
655 <dt>Return Type:</dt>
656 <dd>
657 Task
658 </dd>
659 </dl>
660 <a NAME="TaskViewer.clearFileTasks" ID="TaskViewer.clearFileTasks"></a>
661 <h4>TaskViewer.clearFileTasks</h4>
662 <b>clearFileTasks</b>(<i>filename, conditionally=False</i>)
663
664 <p>
665 Public slot to clear all tasks related to a file.
666 </p>
667 <dl>
668
669 <dt><i>filename</i></dt>
670 <dd>
671 name of the file (string)
672 </dd>
673 <dt><i>conditionally</i></dt>
674 <dd>
675 flag indicating to clear the tasks of the file
676 checking some conditions (boolean)
677 </dd>
678 </dl>
679 <a NAME="TaskViewer.clearProjectTasks" ID="TaskViewer.clearProjectTasks"></a>
680 <h4>TaskViewer.clearProjectTasks</h4>
681 <b>clearProjectTasks</b>(<i>fileOnly=False</i>)
682
683 <p>
684 Public slot to clear project related tasks.
685 </p>
686 <dl>
687
688 <dt><i>fileOnly</i></dt>
689 <dd>
690 flag indicating to clear only file related
691 project tasks (boolean)
692 </dd>
693 </dl>
694 <a NAME="TaskViewer.clearTasks" ID="TaskViewer.clearTasks"></a>
695 <h4>TaskViewer.clearTasks</h4>
696 <b>clearTasks</b>(<i></i>)
697
698 <p>
699 Public slot to clear all tasks from display.
700 </p>
701 <a NAME="TaskViewer.findParentTask" ID="TaskViewer.findParentTask"></a>
702 <h4>TaskViewer.findParentTask</h4>
703 <b>findParentTask</b>(<i>parentUid</i>)
704
705 <p>
706 Public method to find a parent task by its ID.
707 </p>
708 <dl>
709
710 <dt><i>parentUid</i></dt>
711 <dd>
712 uid of the parent task (string)
713 </dd>
714 </dl>
715 <dl>
716 <dt>Return:</dt>
717 <dd>
718 reference to the task (Task)
719 </dd>
720 </dl>
721 <a NAME="TaskViewer.getGlobalTasks" ID="TaskViewer.getGlobalTasks"></a>
722 <h4>TaskViewer.getGlobalTasks</h4>
723 <b>getGlobalTasks</b>(<i></i>)
724
725 <p>
726 Public method to retrieve all non project related tasks.
727 </p>
728 <dl>
729 <dt>Return:</dt>
730 <dd>
731 copy of tasks (list of Task)
732 </dd>
733 </dl>
734 <a NAME="TaskViewer.getProjectTasks" ID="TaskViewer.getProjectTasks"></a>
735 <h4>TaskViewer.getProjectTasks</h4>
736 <b>getProjectTasks</b>(<i></i>)
737
738 <p>
739 Public method to retrieve all project related tasks.
740 </p>
741 <dl>
742 <dt>Return:</dt>
743 <dd>
744 copy of tasks (list of Task)
745 </dd>
746 </dl>
747 <a NAME="TaskViewer.getTasksScanFilter" ID="TaskViewer.getTasksScanFilter"></a>
748 <h4>TaskViewer.getTasksScanFilter</h4>
749 <b>getTasksScanFilter</b>(<i></i>)
750
751 <p>
752 Public method to get the project scan filter.
753 </p>
754 <dl>
755 <dt>Return:</dt>
756 <dd>
757 project scan filter
758 </dd>
759 </dl>
760 <dl>
761 <dt>Return Type:</dt>
762 <dd>
763 str
764 </dd>
765 </dl>
766 <a NAME="TaskViewer.handlePreferencesChanged" ID="TaskViewer.handlePreferencesChanged"></a>
767 <h4>TaskViewer.handlePreferencesChanged</h4>
768 <b>handlePreferencesChanged</b>(<i></i>)
769
770 <p>
771 Public slot to react to changes of the preferences.
772 </p>
773 <a NAME="TaskViewer.regenerateProjectTasks" ID="TaskViewer.regenerateProjectTasks"></a>
774 <h4>TaskViewer.regenerateProjectTasks</h4>
775 <b>regenerateProjectTasks</b>(<i>quiet=False</i>)
776
777 <p>
778 Public slot to regenerate project related tasks.
779 </p>
780 <dl>
781
782 <dt><i>quiet</i> (bool)</dt>
783 <dd>
784 flag indicating quiet operation
785 </dd>
786 </dl>
787 <a NAME="TaskViewer.saveProjectTasks" ID="TaskViewer.saveProjectTasks"></a>
788 <h4>TaskViewer.saveProjectTasks</h4>
789 <b>saveProjectTasks</b>(<i></i>)
790
791 <p>
792 Public method to write the project tasks.
793 </p>
794 <a NAME="TaskViewer.setProjectOpen" ID="TaskViewer.setProjectOpen"></a>
795 <h4>TaskViewer.setProjectOpen</h4>
796 <b>setProjectOpen</b>(<i>o=False</i>)
797
798 <p>
799 Public slot to set the project status.
800 </p>
801 <dl>
802
803 <dt><i>o</i></dt>
804 <dd>
805 flag indicating the project status
806 </dd>
807 </dl>
808 <a NAME="TaskViewer.setTasksScanFilter" ID="TaskViewer.setTasksScanFilter"></a>
809 <h4>TaskViewer.setTasksScanFilter</h4>
810 <b>setTasksScanFilter</b>(<i>filterStr: str</i>)
811
812 <p>
813 Public method to set the project scan filter.
814 </p>
815 <dl>
816
817 <dt><i>filterStr</i> (str)</dt>
818 <dd>
819 project scan filter
820 </dd>
821 </dl>
822 <a NAME="TaskViewer.stopProjectTaskExtraction" ID="TaskViewer.stopProjectTaskExtraction"></a>
823 <h4>TaskViewer.stopProjectTaskExtraction</h4>
824 <b>stopProjectTaskExtraction</b>(<i></i>)
825
826 <p>
827 Public method to stop the project task extraction thread.
828 </p>
829 <div align="right"><a href="#top">Up</a></div>
830 <hr />
831 </body></html>

Mercurial Repository: eric

eric ide

mercurial