Mercurial Repositories > eric / file comparison

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

eric6/Documentation/Source/eric6.Tasks.TaskViewer.html

changeset 6942
2602857055c5
parent 5851
8f8b264e5d5f
child 7273
391d6b7b1eff
equal deleted inserted replaced
6941:f99d60d6b59b 6942:2602857055c5
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.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><a NAME="top" ID="top"></a>
22 <h1>eric6.Tasks.TaskViewer</h1>
23 <p>
24 Module implementing a task viewer and associated classes.
25 </p><p>
26 Tasks can be defined manually or automatically. Automatically
27 generated tasks are derived from a comment with a special
28 introductory text. This text is configurable.
29 </p>
30 <h3>Global Attributes</h3>
31 <table>
32 <tr><td>None</td></tr>
33 </table>
34 <h3>Classes</h3>
35 <table>
36 <tr>
37 <td><a href="#ProjectTaskExtractionThread">ProjectTaskExtractionThread</a></td>
38 <td>Class implementing a thread to extract tasks related to a project.</td>
39 </tr><tr>
40 <td><a href="#TaskViewer">TaskViewer</a></td>
41 <td>Class implementing the task viewer.</td>
42 </tr>
43 </table>
44 <h3>Functions</h3>
45 <table>
46 <tr><td>None</td></tr>
47 </table>
48 <hr /><hr />
49 <a NAME="ProjectTaskExtractionThread" ID="ProjectTaskExtractionThread"></a>
50 <h2>ProjectTaskExtractionThread</h2>
51 <p>
52 Class implementing a thread to extract tasks related to a project.
53 </p><h3>Signals</h3>
54 <dl>
55 <dt>taskFound(str, str, int, int)</dt>
56 <dd>
57 emitted with the task description,
58 the file name, the line number and task type to signal the presence of
59 a task
60 </dd>
61 </dl>
62 <h3>Derived from</h3>
63 QThread
64 <h3>Class Attributes</h3>
65 <table>
66 <tr><td>None</td></tr>
67 </table>
68 <h3>Class Methods</h3>
69 <table>
70 <tr><td>None</td></tr>
71 </table>
72 <h3>Methods</h3>
73 <table>
74 <tr>
75 <td><a href="#ProjectTaskExtractionThread.__init__">ProjectTaskExtractionThread</a></td>
76 <td>Constructor</td>
77 </tr><tr>
78 <td><a href="#ProjectTaskExtractionThread.requestInterrupt">requestInterrupt</a></td>
79 <td>Public method to request iterruption of the thread.</td>
80 </tr><tr>
81 <td><a href="#ProjectTaskExtractionThread.run">run</a></td>
82 <td>Public thread method to scan the given files.</td>
83 </tr><tr>
84 <td><a href="#ProjectTaskExtractionThread.scan">scan</a></td>
85 <td>Public method to scan the given list of files for tasks.</td>
86 </tr>
87 </table>
88 <h3>Static Methods</h3>
89 <table>
90 <tr><td>None</td></tr>
91 </table>
92 <a NAME="ProjectTaskExtractionThread.__init__" ID="ProjectTaskExtractionThread.__init__"></a>
93 <h4>ProjectTaskExtractionThread (Constructor)</h4>
94 <b>ProjectTaskExtractionThread</b>(<i>parent=None</i>)
95 <p>
96 Constructor
97 </p><dl>
98 <dt><i>parent</i></dt>
99 <dd>
100 reference to the parent object (QObject)
101 </dd>
102 </dl><a NAME="ProjectTaskExtractionThread.requestInterrupt" ID="ProjectTaskExtractionThread.requestInterrupt"></a>
103 <h4>ProjectTaskExtractionThread.requestInterrupt</h4>
104 <b>requestInterrupt</b>(<i></i>)
105 <p>
106 Public method to request iterruption of the thread.
107 </p><a NAME="ProjectTaskExtractionThread.run" ID="ProjectTaskExtractionThread.run"></a>
108 <h4>ProjectTaskExtractionThread.run</h4>
109 <b>run</b>(<i></i>)
110 <p>
111 Public thread method to scan the given files.
112 </p><a NAME="ProjectTaskExtractionThread.scan" ID="ProjectTaskExtractionThread.scan"></a>
113 <h4>ProjectTaskExtractionThread.scan</h4>
114 <b>scan</b>(<i>markers, files</i>)
115 <p>
116 Public method to scan the given list of files for tasks.
117 </p><dl>
118 <dt><i>markers</i> (dict of lists of str)</dt>
119 <dd>
120 dictionary of defined task markers
121 </dd><dt><i>files</i> (list of str)</dt>
122 <dd>
123 list of file names to be scanned
124 </dd>
125 </dl>
126 <div align="right"><a href="#top">Up</a></div>
127 <hr /><hr />
128 <a NAME="TaskViewer" ID="TaskViewer"></a>
129 <h2>TaskViewer</h2>
130 <p>
131 Class implementing the task viewer.
132 </p><h3>Signals</h3>
133 <dl>
134 <dt>displayFile(str, int)</dt>
135 <dd>
136 emitted to go to a file task
137 </dd>
138 </dl>
139 <h3>Derived from</h3>
140 QTreeWidget
141 <h3>Class Attributes</h3>
142 <table>
143 <tr><td>None</td></tr>
144 </table>
145 <h3>Class Methods</h3>
146 <table>
147 <tr><td>None</td></tr>
148 </table>
149 <h3>Methods</h3>
150 <table>
151 <tr>
152 <td><a href="#TaskViewer.__init__">TaskViewer</a></td>
153 <td>Constructor</td>
154 </tr><tr>
155 <td><a href="#TaskViewer.__activateFilter">__activateFilter</a></td>
156 <td>Private slot to handle the "Filtered display" context menu entry.</td>
157 </tr><tr>
158 <td><a href="#TaskViewer.__checkTopLevelItems">__checkTopLevelItems</a></td>
159 <td>Private slot to check the 'Extracted Tasks' item for children.</td>
160 </tr><tr>
161 <td><a href="#TaskViewer.__configure">__configure</a></td>
162 <td>Private method to open the configuration dialog.</td>
163 </tr><tr>
164 <td><a href="#TaskViewer.__configureFilter">__configureFilter</a></td>
165 <td>Private slot to handle the "Configure filter" context menu entry.</td>
166 </tr><tr>
167 <td><a href="#TaskViewer.__configureProjectTasksScanOptions">__configureProjectTasksScanOptions</a></td>
168 <td>Private slot to configure scan options for project tasks.</td>
169 </tr><tr>
170 <td><a href="#TaskViewer.__copyTask">__copyTask</a></td>
171 <td>Private slot to handle the "Copy" context menu entry.</td>
172 </tr><tr>
173 <td><a href="#TaskViewer.__deleteCompleted">__deleteCompleted</a></td>
174 <td>Private slot to handle the "Delete Completed Tasks" context menu entry.</td>
175 </tr><tr>
176 <td><a href="#TaskViewer.__deleteSubTasks">__deleteSubTasks</a></td>
177 <td>Private method to delete all sub-tasks.</td>
178 </tr><tr>
179 <td><a href="#TaskViewer.__deleteTask">__deleteTask</a></td>
180 <td>Private slot to delete a task.</td>
181 </tr><tr>
182 <td><a href="#TaskViewer.__editTaskProperties">__editTaskProperties</a></td>
183 <td>Private slot to handle the "Properties" context menu entry.</td>
184 </tr><tr>
185 <td><a href="#TaskViewer.__generateTopLevelItems">__generateTopLevelItems</a></td>
186 <td>Private method to generate the 'Extracted Tasks' item.</td>
187 </tr><tr>
188 <td><a href="#TaskViewer.__goToTask">__goToTask</a></td>
189 <td>Private slot to handle the "Go To" context menu entry.</td>
190 </tr><tr>
191 <td><a href="#TaskViewer.__markCompleted">__markCompleted</a></td>
192 <td>Private slot to handle the "Mark Completed" context menu entry.</td>
193 </tr><tr>
194 <td><a href="#TaskViewer.__newSubTask">__newSubTask</a></td>
195 <td>Private slot to handle the "New Sub-Task" context menu entry.</td>
196 </tr><tr>
197 <td><a href="#TaskViewer.__newTask">__newTask</a></td>
198 <td>Private slot to handle the "New Task" context menu entry.</td>
199 </tr><tr>
200 <td><a href="#TaskViewer.__pasteMainTask">__pasteMainTask</a></td>
201 <td>Private slot to handle the "Paste as Main Task" context menu entry.</td>
202 </tr><tr>
203 <td><a href="#TaskViewer.__pasteTask">__pasteTask</a></td>
204 <td>Private slot to handle the "Paste" context menu entry.</td>
205 </tr><tr>
206 <td><a href="#TaskViewer.__refreshDisplay">__refreshDisplay</a></td>
207 <td>Private method to refresh the display.</td>
208 </tr><tr>
209 <td><a href="#TaskViewer.__resizeColumns">__resizeColumns</a></td>
210 <td>Private method to resize the list columns.</td>
211 </tr><tr>
212 <td><a href="#TaskViewer.__resort">__resort</a></td>
213 <td>Private method to resort the tree.</td>
214 </tr><tr>
215 <td><a href="#TaskViewer.__showContextMenu">__showContextMenu</a></td>
216 <td>Private slot to show the context menu of the list.</td>
217 </tr><tr>
218 <td><a href="#TaskViewer.__taskItemActivated">__taskItemActivated</a></td>
219 <td>Private slot to handle the activation of an item.</td>
220 </tr><tr>
221 <td><a href="#TaskViewer.addFileTask">addFileTask</a></td>
222 <td>Public slot to add a file related task.</td>
223 </tr><tr>
224 <td><a href="#TaskViewer.addTask">addTask</a></td>
225 <td>Public slot to add a task.</td>
226 </tr><tr>
227 <td><a href="#TaskViewer.clearFileTasks">clearFileTasks</a></td>
228 <td>Public slot to clear all tasks related to a file.</td>
229 </tr><tr>
230 <td><a href="#TaskViewer.clearProjectTasks">clearProjectTasks</a></td>
231 <td>Public slot to clear project related tasks.</td>
232 </tr><tr>
233 <td><a href="#TaskViewer.clearTasks">clearTasks</a></td>
234 <td>Public slot to clear all tasks from display.</td>
235 </tr><tr>
236 <td><a href="#TaskViewer.findParentTask">findParentTask</a></td>
237 <td>Public method to find a parent task by its ID.</td>
238 </tr><tr>
239 <td><a href="#TaskViewer.getGlobalTasks">getGlobalTasks</a></td>
240 <td>Public method to retrieve all non project related tasks.</td>
241 </tr><tr>
242 <td><a href="#TaskViewer.getProjectTasks">getProjectTasks</a></td>
243 <td>Public method to retrieve all project related tasks.</td>
244 </tr><tr>
245 <td><a href="#TaskViewer.handlePreferencesChanged">handlePreferencesChanged</a></td>
246 <td>Public slot to react to changes of the preferences.</td>
247 </tr><tr>
248 <td><a href="#TaskViewer.regenerateProjectTasks">regenerateProjectTasks</a></td>
249 <td>Public slot to regenerate project related tasks.</td>
250 </tr><tr>
251 <td><a href="#TaskViewer.saveProjectTasks">saveProjectTasks</a></td>
252 <td>Public method to write the project tasks.</td>
253 </tr><tr>
254 <td><a href="#TaskViewer.setProjectOpen">setProjectOpen</a></td>
255 <td>Public slot to set the project status.</td>
256 </tr><tr>
257 <td><a href="#TaskViewer.stopProjectTaskExtraction">stopProjectTaskExtraction</a></td>
258 <td>Public method to stop the project task extraction thread.</td>
259 </tr>
260 </table>
261 <h3>Static Methods</h3>
262 <table>
263 <tr><td>None</td></tr>
264 </table>
265 <a NAME="TaskViewer.__init__" ID="TaskViewer.__init__"></a>
266 <h4>TaskViewer (Constructor)</h4>
267 <b>TaskViewer</b>(<i>parent, project</i>)
268 <p>
269 Constructor
270 </p><dl>
271 <dt><i>parent</i></dt>
272 <dd>
273 the parent (QWidget)
274 </dd><dt><i>project</i></dt>
275 <dd>
276 reference to the project object
277 </dd>
278 </dl><a NAME="TaskViewer.__activateFilter" ID="TaskViewer.__activateFilter"></a>
279 <h4>TaskViewer.__activateFilter</h4>
280 <b>__activateFilter</b>(<i>on</i>)
281 <p>
282 Private slot to handle the "Filtered display" context menu entry.
283 </p><dl>
284 <dt><i>on</i></dt>
285 <dd>
286 flag indicating the filter state (boolean)
287 </dd>
288 </dl><a NAME="TaskViewer.__checkTopLevelItems" ID="TaskViewer.__checkTopLevelItems"></a>
289 <h4>TaskViewer.__checkTopLevelItems</h4>
290 <b>__checkTopLevelItems</b>(<i></i>)
291 <p>
292 Private slot to check the 'Extracted Tasks' item for children.
293 </p><a NAME="TaskViewer.__configure" ID="TaskViewer.__configure"></a>
294 <h4>TaskViewer.__configure</h4>
295 <b>__configure</b>(<i></i>)
296 <p>
297 Private method to open the configuration dialog.
298 </p><a NAME="TaskViewer.__configureFilter" ID="TaskViewer.__configureFilter"></a>
299 <h4>TaskViewer.__configureFilter</h4>
300 <b>__configureFilter</b>(<i></i>)
301 <p>
302 Private slot to handle the "Configure filter" context menu entry.
303 </p><a NAME="TaskViewer.__configureProjectTasksScanOptions" ID="TaskViewer.__configureProjectTasksScanOptions"></a>
304 <h4>TaskViewer.__configureProjectTasksScanOptions</h4>
305 <b>__configureProjectTasksScanOptions</b>(<i></i>)
306 <p>
307 Private slot to configure scan options for project tasks.
308 </p><a NAME="TaskViewer.__copyTask" ID="TaskViewer.__copyTask"></a>
309 <h4>TaskViewer.__copyTask</h4>
310 <b>__copyTask</b>(<i></i>)
311 <p>
312 Private slot to handle the "Copy" context menu entry.
313 </p><a NAME="TaskViewer.__deleteCompleted" ID="TaskViewer.__deleteCompleted"></a>
314 <h4>TaskViewer.__deleteCompleted</h4>
315 <b>__deleteCompleted</b>(<i></i>)
316 <p>
317 Private slot to handle the "Delete Completed Tasks" context menu entry.
318 </p><a NAME="TaskViewer.__deleteSubTasks" ID="TaskViewer.__deleteSubTasks"></a>
319 <h4>TaskViewer.__deleteSubTasks</h4>
320 <b>__deleteSubTasks</b>(<i>task</i>)
321 <p>
322 Private method to delete all sub-tasks.
323 </p><dl>
324 <dt><i>task</i></dt>
325 <dd>
326 task to delete sub-tasks of (Task)
327 </dd>
328 </dl><a NAME="TaskViewer.__deleteTask" ID="TaskViewer.__deleteTask"></a>
329 <h4>TaskViewer.__deleteTask</h4>
330 <b>__deleteTask</b>(<i>task=None</i>)
331 <p>
332 Private slot to delete a task.
333 </p><dl>
334 <dt><i>task</i> (Task)</dt>
335 <dd>
336 task to be deleted
337 </dd>
338 </dl><a NAME="TaskViewer.__editTaskProperties" ID="TaskViewer.__editTaskProperties"></a>
339 <h4>TaskViewer.__editTaskProperties</h4>
340 <b>__editTaskProperties</b>(<i></i>)
341 <p>
342 Private slot to handle the "Properties" context menu entry.
343 </p><a NAME="TaskViewer.__generateTopLevelItems" ID="TaskViewer.__generateTopLevelItems"></a>
344 <h4>TaskViewer.__generateTopLevelItems</h4>
345 <b>__generateTopLevelItems</b>(<i></i>)
346 <p>
347 Private method to generate the 'Extracted Tasks' item.
348 </p><a NAME="TaskViewer.__goToTask" ID="TaskViewer.__goToTask"></a>
349 <h4>TaskViewer.__goToTask</h4>
350 <b>__goToTask</b>(<i></i>)
351 <p>
352 Private slot to handle the "Go To" context menu entry.
353 </p><a NAME="TaskViewer.__markCompleted" ID="TaskViewer.__markCompleted"></a>
354 <h4>TaskViewer.__markCompleted</h4>
355 <b>__markCompleted</b>(<i></i>)
356 <p>
357 Private slot to handle the "Mark Completed" context menu entry.
358 </p><a NAME="TaskViewer.__newSubTask" ID="TaskViewer.__newSubTask"></a>
359 <h4>TaskViewer.__newSubTask</h4>
360 <b>__newSubTask</b>(<i></i>)
361 <p>
362 Private slot to handle the "New Sub-Task" context menu entry.
363 </p><a NAME="TaskViewer.__newTask" ID="TaskViewer.__newTask"></a>
364 <h4>TaskViewer.__newTask</h4>
365 <b>__newTask</b>(<i></i>)
366 <p>
367 Private slot to handle the "New Task" context menu entry.
368 </p><a NAME="TaskViewer.__pasteMainTask" ID="TaskViewer.__pasteMainTask"></a>
369 <h4>TaskViewer.__pasteMainTask</h4>
370 <b>__pasteMainTask</b>(<i></i>)
371 <p>
372 Private slot to handle the "Paste as Main Task" context menu entry.
373 </p><a NAME="TaskViewer.__pasteTask" ID="TaskViewer.__pasteTask"></a>
374 <h4>TaskViewer.__pasteTask</h4>
375 <b>__pasteTask</b>(<i></i>)
376 <p>
377 Private slot to handle the "Paste" context menu entry.
378 </p><a NAME="TaskViewer.__refreshDisplay" ID="TaskViewer.__refreshDisplay"></a>
379 <h4>TaskViewer.__refreshDisplay</h4>
380 <b>__refreshDisplay</b>(<i></i>)
381 <p>
382 Private method to refresh the display.
383 </p><a NAME="TaskViewer.__resizeColumns" ID="TaskViewer.__resizeColumns"></a>
384 <h4>TaskViewer.__resizeColumns</h4>
385 <b>__resizeColumns</b>(<i></i>)
386 <p>
387 Private method to resize the list columns.
388 </p><a NAME="TaskViewer.__resort" ID="TaskViewer.__resort"></a>
389 <h4>TaskViewer.__resort</h4>
390 <b>__resort</b>(<i></i>)
391 <p>
392 Private method to resort the tree.
393 </p><a NAME="TaskViewer.__showContextMenu" ID="TaskViewer.__showContextMenu"></a>
394 <h4>TaskViewer.__showContextMenu</h4>
395 <b>__showContextMenu</b>(<i>coord</i>)
396 <p>
397 Private slot to show the context menu of the list.
398 </p><dl>
399 <dt><i>coord</i></dt>
400 <dd>
401 the position of the mouse pointer (QPoint)
402 </dd>
403 </dl><a NAME="TaskViewer.__taskItemActivated" ID="TaskViewer.__taskItemActivated"></a>
404 <h4>TaskViewer.__taskItemActivated</h4>
405 <b>__taskItemActivated</b>(<i>itm, col</i>)
406 <p>
407 Private slot to handle the activation of an item.
408 </p><dl>
409 <dt><i>itm</i></dt>
410 <dd>
411 reference to the activated item (QTreeWidgetItem)
412 </dd><dt><i>col</i></dt>
413 <dd>
414 column the item was activated in (integer)
415 </dd>
416 </dl><a NAME="TaskViewer.addFileTask" ID="TaskViewer.addFileTask"></a>
417 <h4>TaskViewer.addFileTask</h4>
418 <b>addFileTask</b>(<i>summary, filename, lineno, taskType=Task.TypeTodo, description=""</i>)
419 <p>
420 Public slot to add a file related task.
421 </p><dl>
422 <dt><i>summary</i></dt>
423 <dd>
424 summary text of the task (string)
425 </dd><dt><i>filename</i></dt>
426 <dd>
427 filename containing the task (string)
428 </dd><dt><i>lineno</i></dt>
429 <dd>
430 line number containing the task (integer)
431 </dd><dt><i>taskType</i></dt>
432 <dd>
433 type of the task (one of Task.TypeFixme, Task.TypeTodo,
434 Task.TypeWarning, Task.TypeNote)
435 </dd><dt><i>description</i></dt>
436 <dd>
437 explanatory text of the task (string)
438 </dd>
439 </dl><a NAME="TaskViewer.addTask" ID="TaskViewer.addTask"></a>
440 <h4>TaskViewer.addTask</h4>
441 <b>addTask</b>(<i>summary, priority=1, filename="", lineno=0, completed=False, _time=0, isProjectTask=False, taskType=Task.TypeTodo, description="", uid="", parentTask=None</i>)
442 <p>
443 Public slot to add a task.
444 </p><dl>
445 <dt><i>summary</i></dt>
446 <dd>
447 summary text of the task (string)
448 </dd><dt><i>priority</i></dt>
449 <dd>
450 priority of the task (0=high, 1=normal, 2=low)
451 </dd><dt><i>filename</i></dt>
452 <dd>
453 filename containing the task (string)
454 </dd><dt><i>lineno</i></dt>
455 <dd>
456 line number containing the task (integer)
457 </dd><dt><i>completed</i></dt>
458 <dd>
459 flag indicating completion status (boolean)
460 </dd><dt><i>_time</i></dt>
461 <dd>
462 creation time of the task (float, if 0 use current time)
463 </dd><dt><i>isProjectTask</i></dt>
464 <dd>
465 flag indicating a task related to the current
466 project (boolean)
467 </dd><dt><i>taskType</i></dt>
468 <dd>
469 type of the task (one of Task.TypeFixme, Task.TypeTodo,
470 Task.TypeWarning, Task.TypeNote)
471 </dd><dt><i>description</i></dt>
472 <dd>
473 explanatory text of the task (string)
474 </dd><dt><i>uid</i></dt>
475 <dd>
476 unique id of the task (string)
477 </dd><dt><i>parentTask</i></dt>
478 <dd>
479 reference to the parent task item (Task)
480 </dd>
481 </dl><dl>
482 <dt>Returns:</dt>
483 <dd>
484 reference to the task item (Task)
485 </dd>
486 </dl><a NAME="TaskViewer.clearFileTasks" ID="TaskViewer.clearFileTasks"></a>
487 <h4>TaskViewer.clearFileTasks</h4>
488 <b>clearFileTasks</b>(<i>filename, conditionally=False</i>)
489 <p>
490 Public slot to clear all tasks related to a file.
491 </p><dl>
492 <dt><i>filename</i></dt>
493 <dd>
494 name of the file (string)
495 </dd><dt><i>conditionally</i></dt>
496 <dd>
497 flag indicating to clear the tasks of the file
498 checking some conditions (boolean)
499 </dd>
500 </dl><a NAME="TaskViewer.clearProjectTasks" ID="TaskViewer.clearProjectTasks"></a>
501 <h4>TaskViewer.clearProjectTasks</h4>
502 <b>clearProjectTasks</b>(<i>fileOnly=False</i>)
503 <p>
504 Public slot to clear project related tasks.
505 </p><dl>
506 <dt><i>fileOnly=</i></dt>
507 <dd>
508 flag indicating to clear only file related
509 project tasks (boolean)
510 </dd>
511 </dl><a NAME="TaskViewer.clearTasks" ID="TaskViewer.clearTasks"></a>
512 <h4>TaskViewer.clearTasks</h4>
513 <b>clearTasks</b>(<i></i>)
514 <p>
515 Public slot to clear all tasks from display.
516 </p><a NAME="TaskViewer.findParentTask" ID="TaskViewer.findParentTask"></a>
517 <h4>TaskViewer.findParentTask</h4>
518 <b>findParentTask</b>(<i>parentUid</i>)
519 <p>
520 Public method to find a parent task by its ID.
521 </p><dl>
522 <dt><i>parentUid</i></dt>
523 <dd>
524 uid of the parent task (string)
525 </dd>
526 </dl><dl>
527 <dt>Returns:</dt>
528 <dd>
529 reference to the task (Task)
530 </dd>
531 </dl><a NAME="TaskViewer.getGlobalTasks" ID="TaskViewer.getGlobalTasks"></a>
532 <h4>TaskViewer.getGlobalTasks</h4>
533 <b>getGlobalTasks</b>(<i></i>)
534 <p>
535 Public method to retrieve all non project related tasks.
536 </p><dl>
537 <dt>Returns:</dt>
538 <dd>
539 copy of tasks (list of Task)
540 </dd>
541 </dl><a NAME="TaskViewer.getProjectTasks" ID="TaskViewer.getProjectTasks"></a>
542 <h4>TaskViewer.getProjectTasks</h4>
543 <b>getProjectTasks</b>(<i></i>)
544 <p>
545 Public method to retrieve all project related tasks.
546 </p><dl>
547 <dt>Returns:</dt>
548 <dd>
549 copy of tasks (list of Task)
550 </dd>
551 </dl><a NAME="TaskViewer.handlePreferencesChanged" ID="TaskViewer.handlePreferencesChanged"></a>
552 <h4>TaskViewer.handlePreferencesChanged</h4>
553 <b>handlePreferencesChanged</b>(<i></i>)
554 <p>
555 Public slot to react to changes of the preferences.
556 </p><a NAME="TaskViewer.regenerateProjectTasks" ID="TaskViewer.regenerateProjectTasks"></a>
557 <h4>TaskViewer.regenerateProjectTasks</h4>
558 <b>regenerateProjectTasks</b>(<i>quiet=False</i>)
559 <p>
560 Public slot to regenerate project related tasks.
561 </p><dl>
562 <dt><i>quiet</i> (bool)</dt>
563 <dd>
564 flag indicating quiet operation
565 </dd>
566 </dl><a NAME="TaskViewer.saveProjectTasks" ID="TaskViewer.saveProjectTasks"></a>
567 <h4>TaskViewer.saveProjectTasks</h4>
568 <b>saveProjectTasks</b>(<i></i>)
569 <p>
570 Public method to write the project tasks.
571 </p><a NAME="TaskViewer.setProjectOpen" ID="TaskViewer.setProjectOpen"></a>
572 <h4>TaskViewer.setProjectOpen</h4>
573 <b>setProjectOpen</b>(<i>o=False</i>)
574 <p>
575 Public slot to set the project status.
576 </p><dl>
577 <dt><i>o</i></dt>
578 <dd>
579 flag indicating the project status
580 </dd>
581 </dl><a NAME="TaskViewer.stopProjectTaskExtraction" ID="TaskViewer.stopProjectTaskExtraction"></a>
582 <h4>TaskViewer.stopProjectTaskExtraction</h4>
583 <b>stopProjectTaskExtraction</b>(<i></i>)
584 <p>
585 Public method to stop the project task extraction thread.
586 </p>
587 <div align="right"><a href="#top">Up</a></div>
588 <hr />
589 </body></html>

Mercurial Repository: eric

eric ide

mercurial