Mercurial Repositories > eric / file comparison

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

Documentation/Source/eric4.Tasks.TaskViewer.html

changeset 3
0d9daebf5b8c
equal deleted inserted replaced
2:bc6196164237 3:0d9daebf5b8c
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
4 <html><head>
5 <title>eric4.Tasks.TaskViewer</title>
6 <style>
7 body {
8 background:white;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #4FA4FF; }
14 h2 { color: white; background: #4FA4FF; }
15 h3 { color: white; background: #00557F; }
16 h4 { color: white; background: #00557F; }
17
18 a { color: #AA5500; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>eric4.Tasks.TaskViewer</h1>
24 <p>
25 Module implementing a task viewer and associated classes.
26 </p><p>
27 Tasks can be defined manually or automatically. Automatically
28 generated tasks are derived from a comment with a special
29 introductory text. This text is configurable.
30 </p>
31 <h3>Global Attributes</h3>
32 <table>
33 <tr><td>None</td></tr>
34 </table>
35 <h3>Classes</h3>
36 <table>
37 <tr>
38 <td><a href="#Task">Task</a></td>
39 <td>Class implementing the task data structure.</td>
40 </tr><tr>
41 <td><a href="#TaskFilter">TaskFilter</a></td>
42 <td>Class implementing a filter for tasks.</td>
43 </tr><tr>
44 <td><a href="#TaskViewer">TaskViewer</a></td>
45 <td>Class implementing the task viewer.</td>
46 </tr>
47 </table>
48 <h3>Functions</h3>
49 <table>
50 <tr><td>None</td></tr>
51 </table>
52 <hr /><hr />
53 <a NAME="Task" ID="Task"></a>
54 <h2>Task</h2>
55 <p>
56 Class implementing the task data structure.
57 </p>
58 <h3>Derived from</h3>
59 QTreeWidgetItem
60 <h3>Class Attributes</h3>
61 <table>
62 <tr><td>None</td></tr>
63 </table>
64 <h3>Methods</h3>
65 <table>
66 <tr>
67 <td><a href="#Task.__init__">Task</a></td>
68 <td>Constructor</td>
69 </tr><tr>
70 <td><a href="#Task.colorizeTask">colorizeTask</a></td>
71 <td>Public slot to set the colors of the task item.</td>
72 </tr><tr>
73 <td><a href="#Task.getFilename">getFilename</a></td>
74 <td>Public method to retrieve the tasks filename.</td>
75 </tr><tr>
76 <td><a href="#Task.getLineno">getLineno</a></td>
77 <td>Public method to retrieve the tasks linenumber.</td>
78 </tr><tr>
79 <td><a href="#Task.isCompleted">isCompleted</a></td>
80 <td>Public slot to return the completion status.</td>
81 </tr><tr>
82 <td><a href="#Task.isProjectTask">isProjectTask</a></td>
83 <td>Public slot to return the project relation status.</td>
84 </tr><tr>
85 <td><a href="#Task.setCompleted">setCompleted</a></td>
86 <td>Public slot to update the completed flag.</td>
87 </tr><tr>
88 <td><a href="#Task.setDescription">setDescription</a></td>
89 <td>Public slot to update the description.</td>
90 </tr><tr>
91 <td><a href="#Task.setLongText">setLongText</a></td>
92 <td>Public slot to update the longtext field.</td>
93 </tr><tr>
94 <td><a href="#Task.setPriority">setPriority</a></td>
95 <td>Public slot to update the priority.</td>
96 </tr><tr>
97 <td><a href="#Task.setProjectTask">setProjectTask</a></td>
98 <td>Public method to set the project relation flag.</td>
99 </tr>
100 </table>
101 <a NAME="Task.__init__" ID="Task.__init__"></a>
102 <h4>Task (Constructor)</h4>
103 <b>Task</b>(<i>description, priority = 1, filename = "", lineno = 0, completed = False, _time = 0, isProjectTask = False, isBugfixTask = False, ppath = "", longtext = ""</i>)
104 <p>
105 Constructor
106 </p><dl>
107 <dt><i>parent</i></dt>
108 <dd>
109 parent widget of the task (QWidget)
110 </dd><dt><i>description</i></dt>
111 <dd>
112 descriptive text of the task (string)
113 </dd><dt><i>priority</i></dt>
114 <dd>
115 priority of the task (0=high, 1=normal, 2=low)
116 </dd><dt><i>filename</i></dt>
117 <dd>
118 filename containing the task (string)
119 </dd><dt><i>lineno</i></dt>
120 <dd>
121 line number containing the task (integer)
122 </dd><dt><i>completed</i></dt>
123 <dd>
124 flag indicating completion status (boolean)
125 </dd><dt><i>_time</i></dt>
126 <dd>
127 creation time of the task (float, if 0 use current time)
128 </dd><dt><i>isProjectTask</i></dt>
129 <dd>
130 flag indicating a task related to the current project
131 (boolean)
132 </dd><dt><i>isBugfixTask</i></dt>
133 <dd>
134 flag indicating a bugfix task (boolean)
135 </dd><dt><i>ppath</i></dt>
136 <dd>
137 the project path (string)
138 </dd><dt><i>longtext</i></dt>
139 <dd>
140 explanatory text of the task (string)
141 </dd>
142 </dl><a NAME="Task.colorizeTask" ID="Task.colorizeTask"></a>
143 <h4>Task.colorizeTask</h4>
144 <b>colorizeTask</b>(<i></i>)
145 <p>
146 Public slot to set the colors of the task item.
147 </p><a NAME="Task.getFilename" ID="Task.getFilename"></a>
148 <h4>Task.getFilename</h4>
149 <b>getFilename</b>(<i></i>)
150 <p>
151 Public method to retrieve the tasks filename.
152 </p><dl>
153 <dt>Returns:</dt>
154 <dd>
155 filename (string)
156 </dd>
157 </dl><a NAME="Task.getLineno" ID="Task.getLineno"></a>
158 <h4>Task.getLineno</h4>
159 <b>getLineno</b>(<i></i>)
160 <p>
161 Public method to retrieve the tasks linenumber.
162 </p><dl>
163 <dt>Returns:</dt>
164 <dd>
165 linenumber (integer)
166 </dd>
167 </dl><a NAME="Task.isCompleted" ID="Task.isCompleted"></a>
168 <h4>Task.isCompleted</h4>
169 <b>isCompleted</b>(<i></i>)
170 <p>
171 Public slot to return the completion status.
172 </p><dl>
173 <dt>Returns:</dt>
174 <dd>
175 flag indicating the completion status (boolean)
176 </dd>
177 </dl><a NAME="Task.isProjectTask" ID="Task.isProjectTask"></a>
178 <h4>Task.isProjectTask</h4>
179 <b>isProjectTask</b>(<i></i>)
180 <p>
181 Public slot to return the project relation status.
182 </p><dl>
183 <dt>Returns:</dt>
184 <dd>
185 flag indicating the project relation status (boolean)
186 </dd>
187 </dl><a NAME="Task.setCompleted" ID="Task.setCompleted"></a>
188 <h4>Task.setCompleted</h4>
189 <b>setCompleted</b>(<i>completed</i>)
190 <p>
191 Public slot to update the completed flag.
192 </p><dl>
193 <dt><i>completed</i></dt>
194 <dd>
195 flag indicating completion status (boolean)
196 </dd>
197 </dl><a NAME="Task.setDescription" ID="Task.setDescription"></a>
198 <h4>Task.setDescription</h4>
199 <b>setDescription</b>(<i>description</i>)
200 <p>
201 Public slot to update the description.
202 </p><dl>
203 <dt><i>longtext</i></dt>
204 <dd>
205 explanatory text of the task (string)
206 </dd>
207 </dl><a NAME="Task.setLongText" ID="Task.setLongText"></a>
208 <h4>Task.setLongText</h4>
209 <b>setLongText</b>(<i>longtext</i>)
210 <p>
211 Public slot to update the longtext field.
212 </p><dl>
213 <dt><i>longtext</i></dt>
214 <dd>
215 descriptive text of the task (string)
216 </dd>
217 </dl><a NAME="Task.setPriority" ID="Task.setPriority"></a>
218 <h4>Task.setPriority</h4>
219 <b>setPriority</b>(<i>priority</i>)
220 <p>
221 Public slot to update the priority.
222 </p><dl>
223 <dt><i>priority</i></dt>
224 <dd>
225 priority of the task (0=high, 1=normal, 2=low)
226 </dd>
227 </dl><a NAME="Task.setProjectTask" ID="Task.setProjectTask"></a>
228 <h4>Task.setProjectTask</h4>
229 <b>setProjectTask</b>(<i>pt</i>)
230 <p>
231 Public method to set the project relation flag.
232 </p><dl>
233 <dt><i>pt</i></dt>
234 <dd>
235 flag indicating a project task (boolean)
236 </dd>
237 </dl>
238 <div align="right"><a href="#top">Up</a></div>
239 <hr /><hr />
240 <a NAME="TaskFilter" ID="TaskFilter"></a>
241 <h2>TaskFilter</h2>
242 <p>
243 Class implementing a filter for tasks.
244 </p>
245 <h3>Derived from</h3>
246 object
247 <h3>Class Attributes</h3>
248 <table>
249 <tr><td>None</td></tr>
250 </table>
251 <h3>Methods</h3>
252 <table>
253 <tr>
254 <td><a href="#TaskFilter.__init__">TaskFilter</a></td>
255 <td>Constructor</td>
256 </tr><tr>
257 <td><a href="#TaskFilter.hasActiveFilter">hasActiveFilter</a></td>
258 <td>Public method to check for active filters.</td>
259 </tr><tr>
260 <td><a href="#TaskFilter.setActive">setActive</a></td>
261 <td>Public method to activate the filter.</td>
262 </tr><tr>
263 <td><a href="#TaskFilter.setDescriptionFilter">setDescriptionFilter</a></td>
264 <td>Public method to set the description filter.</td>
265 </tr><tr>
266 <td><a href="#TaskFilter.setFileNameFilter">setFileNameFilter</a></td>
267 <td>Public method to set the filename filter.</td>
268 </tr><tr>
269 <td><a href="#TaskFilter.setPrioritiesFilter">setPrioritiesFilter</a></td>
270 <td>Public method to set the priorities filter.</td>
271 </tr><tr>
272 <td><a href="#TaskFilter.setScopeFilter">setScopeFilter</a></td>
273 <td>Public method to set the scope filter.</td>
274 </tr><tr>
275 <td><a href="#TaskFilter.setStatusFilter">setStatusFilter</a></td>
276 <td>Public method to set the status filter.</td>
277 </tr><tr>
278 <td><a href="#TaskFilter.setTypeFilter">setTypeFilter</a></td>
279 <td>Public method to set the type filter.</td>
280 </tr><tr>
281 <td><a href="#TaskFilter.showTask">showTask</a></td>
282 <td>Public method to check, if a task should be shown.</td>
283 </tr>
284 </table>
285 <a NAME="TaskFilter.__init__" ID="TaskFilter.__init__"></a>
286 <h4>TaskFilter (Constructor)</h4>
287 <b>TaskFilter</b>(<i></i>)
288 <p>
289 Constructor
290 </p><a NAME="TaskFilter.hasActiveFilter" ID="TaskFilter.hasActiveFilter"></a>
291 <h4>TaskFilter.hasActiveFilter</h4>
292 <b>hasActiveFilter</b>(<i></i>)
293 <p>
294 Public method to check for active filters.
295 </p><dl>
296 <dt>Returns:</dt>
297 <dd>
298 flag indicating an active filter was found (boolean)
299 </dd>
300 </dl><a NAME="TaskFilter.setActive" ID="TaskFilter.setActive"></a>
301 <h4>TaskFilter.setActive</h4>
302 <b>setActive</b>(<i>enabled</i>)
303 <p>
304 Public method to activate the filter.
305 </p><dl>
306 <dt><i>enabled</i></dt>
307 <dd>
308 flag indicating the activation state (boolean)
309 </dd>
310 </dl><a NAME="TaskFilter.setDescriptionFilter" ID="TaskFilter.setDescriptionFilter"></a>
311 <h4>TaskFilter.setDescriptionFilter</h4>
312 <b>setDescriptionFilter</b>(<i>filter</i>)
313 <p>
314 Public method to set the description filter.
315 </p><dl>
316 <dt><i>filter</i></dt>
317 <dd>
318 a regular expression for the description filter
319 to set (string) or None
320 </dd>
321 </dl><a NAME="TaskFilter.setFileNameFilter" ID="TaskFilter.setFileNameFilter"></a>
322 <h4>TaskFilter.setFileNameFilter</h4>
323 <b>setFileNameFilter</b>(<i>filter</i>)
324 <p>
325 Public method to set the filename filter.
326 </p><dl>
327 <dt><i>filter</i></dt>
328 <dd>
329 a wildcard expression for the filename filter
330 to set (string) or None
331 </dd>
332 </dl><a NAME="TaskFilter.setPrioritiesFilter" ID="TaskFilter.setPrioritiesFilter"></a>
333 <h4>TaskFilter.setPrioritiesFilter</h4>
334 <b>setPrioritiesFilter</b>(<i>priorities</i>)
335 <p>
336 Public method to set the priorities filter.
337 </p><dl>
338 <dt><i>priorities</i></dt>
339 <dd>
340 list of task priorities (list of integer) or None
341 </dd>
342 </dl><a NAME="TaskFilter.setScopeFilter" ID="TaskFilter.setScopeFilter"></a>
343 <h4>TaskFilter.setScopeFilter</h4>
344 <b>setScopeFilter</b>(<i>scope</i>)
345 <p>
346 Public method to set the scope filter.
347 </p><dl>
348 <dt><i>scope</i></dt>
349 <dd>
350 flag indicating a project task (boolean) or None
351 </dd>
352 </dl><a NAME="TaskFilter.setStatusFilter" ID="TaskFilter.setStatusFilter"></a>
353 <h4>TaskFilter.setStatusFilter</h4>
354 <b>setStatusFilter</b>(<i>status</i>)
355 <p>
356 Public method to set the status filter.
357 </p><dl>
358 <dt><i>status</i></dt>
359 <dd>
360 flag indicating a completed task (boolean) or None
361 </dd>
362 </dl><a NAME="TaskFilter.setTypeFilter" ID="TaskFilter.setTypeFilter"></a>
363 <h4>TaskFilter.setTypeFilter</h4>
364 <b>setTypeFilter</b>(<i>type_</i>)
365 <p>
366 Public method to set the type filter.
367 </p><dl>
368 <dt><i>type_</i></dt>
369 <dd>
370 flag indicating a bugfix task (boolean) or None
371 </dd>
372 </dl><a NAME="TaskFilter.showTask" ID="TaskFilter.showTask"></a>
373 <h4>TaskFilter.showTask</h4>
374 <b>showTask</b>(<i>task</i>)
375 <p>
376 Public method to check, if a task should be shown.
377 </p><dl>
378 <dt><i>task</i></dt>
379 <dd>
380 reference to the task object to check (Task)
381 </dd>
382 </dl><dl>
383 <dt>Returns:</dt>
384 <dd>
385 flag indicating whether the task should be shown (boolean)
386 </dd>
387 </dl>
388 <div align="right"><a href="#top">Up</a></div>
389 <hr /><hr />
390 <a NAME="TaskViewer" ID="TaskViewer"></a>
391 <h2>TaskViewer</h2>
392 <p>
393 Class implementing the task viewer.
394 </p><h4>Signals</h4>
395 <dl>
396 <dt>displayFile(string, integer)</dt>
397 <dd>
398 emitted to go to a file task
399 </dd>
400 </dl>
401 <h3>Derived from</h3>
402 QTreeWidget
403 <h3>Class Attributes</h3>
404 <table>
405 <tr><td>None</td></tr>
406 </table>
407 <h3>Methods</h3>
408 <table>
409 <tr>
410 <td><a href="#TaskViewer.__init__">TaskViewer</a></td>
411 <td>Constructor</td>
412 </tr><tr>
413 <td><a href="#TaskViewer.__activateFilter">__activateFilter</a></td>
414 <td>Private slot to handle the "Filtered display" context menu entry.</td>
415 </tr><tr>
416 <td><a href="#TaskViewer.__configure">__configure</a></td>
417 <td>Private method to open the configuration dialog.</td>
418 </tr><tr>
419 <td><a href="#TaskViewer.__configureFilter">__configureFilter</a></td>
420 <td>Private slot to handle the "Configure filter" context menu entry.</td>
421 </tr><tr>
422 <td><a href="#TaskViewer.__copyTask">__copyTask</a></td>
423 <td>Private slot to handle the "Copy" context menu entry.</td>
424 </tr><tr>
425 <td><a href="#TaskViewer.__deleteCompleted">__deleteCompleted</a></td>
426 <td>Private slot to handle the "Delete Completed Tasks" context menu entry.</td>
427 </tr><tr>
428 <td><a href="#TaskViewer.__deleteTask">__deleteTask</a></td>
429 <td>Private slot to handle the "Delete Task" context menu entry.</td>
430 </tr><tr>
431 <td><a href="#TaskViewer.__editTaskProperties">__editTaskProperties</a></td>
432 <td>Private slot to handle the "Properties" context menu entry</td>
433 </tr><tr>
434 <td><a href="#TaskViewer.__goToTask">__goToTask</a></td>
435 <td>Private slot to handle the "Go To" context menu entry.</td>
436 </tr><tr>
437 <td><a href="#TaskViewer.__markCompleted">__markCompleted</a></td>
438 <td>Private slot to handle the "Mark Completed" context menu entry.</td>
439 </tr><tr>
440 <td><a href="#TaskViewer.__newTask">__newTask</a></td>
441 <td>Private slot to handle the "New Task" context menu entry.</td>
442 </tr><tr>
443 <td><a href="#TaskViewer.__pasteTask">__pasteTask</a></td>
444 <td>Private slot to handle the "Paste" context menu entry.</td>
445 </tr><tr>
446 <td><a href="#TaskViewer.__refreshDisplay">__refreshDisplay</a></td>
447 <td>Private method to refresh the display.</td>
448 </tr><tr>
449 <td><a href="#TaskViewer.__regenerateProjectTasks">__regenerateProjectTasks</a></td>
450 <td>Private slot to handle the "Regenerated project tasks" context menu entry.</td>
451 </tr><tr>
452 <td><a href="#TaskViewer.__resizeColumns">__resizeColumns</a></td>
453 <td>Private method to resize the list columns.</td>
454 </tr><tr>
455 <td><a href="#TaskViewer.__resort">__resort</a></td>
456 <td>Private method to resort the tree.</td>
457 </tr><tr>
458 <td><a href="#TaskViewer.__showContextMenu">__showContextMenu</a></td>
459 <td>Private slot to show the context menu of the list.</td>
460 </tr><tr>
461 <td><a href="#TaskViewer.__taskItemActivated">__taskItemActivated</a></td>
462 <td>Private slot to handle the activation of an item.</td>
463 </tr><tr>
464 <td><a href="#TaskViewer.addFileTask">addFileTask</a></td>
465 <td>Public slot to add a file related task.</td>
466 </tr><tr>
467 <td><a href="#TaskViewer.addTask">addTask</a></td>
468 <td>Public slot to add a task.</td>
469 </tr><tr>
470 <td><a href="#TaskViewer.clearFileTasks">clearFileTasks</a></td>
471 <td>Public slot to clear all tasks related to a file.</td>
472 </tr><tr>
473 <td><a href="#TaskViewer.clearProjectTasks">clearProjectTasks</a></td>
474 <td>Public slot to clear project related tasks.</td>
475 </tr><tr>
476 <td><a href="#TaskViewer.clearTasks">clearTasks</a></td>
477 <td>Public slot to clear all tasks from display.</td>
478 </tr><tr>
479 <td><a href="#TaskViewer.getGlobalTasks">getGlobalTasks</a></td>
480 <td>Public method to retrieve all non project related tasks.</td>
481 </tr><tr>
482 <td><a href="#TaskViewer.getProjectTasks">getProjectTasks</a></td>
483 <td>Public method to retrieve all project related tasks.</td>
484 </tr><tr>
485 <td><a href="#TaskViewer.handlePreferencesChanged">handlePreferencesChanged</a></td>
486 <td>Public slot to react to changes of the preferences.</td>
487 </tr><tr>
488 <td><a href="#TaskViewer.setProjectOpen">setProjectOpen</a></td>
489 <td>Public slot to set the project status.</td>
490 </tr>
491 </table>
492 <a NAME="TaskViewer.__init__" ID="TaskViewer.__init__"></a>
493 <h4>TaskViewer (Constructor)</h4>
494 <b>TaskViewer</b>(<i>parent, project</i>)
495 <p>
496 Constructor
497 </p><dl>
498 <dt><i>parent</i></dt>
499 <dd>
500 the parent (QWidget)
501 </dd><dt><i>project</i></dt>
502 <dd>
503 reference to the project object
504 </dd>
505 </dl><a NAME="TaskViewer.__activateFilter" ID="TaskViewer.__activateFilter"></a>
506 <h4>TaskViewer.__activateFilter</h4>
507 <b>__activateFilter</b>(<i>on</i>)
508 <p>
509 Private slot to handle the "Filtered display" context menu entry.
510 </p><dl>
511 <dt><i>on</i></dt>
512 <dd>
513 flag indicating the filter state (boolean)
514 </dd>
515 </dl><a NAME="TaskViewer.__configure" ID="TaskViewer.__configure"></a>
516 <h4>TaskViewer.__configure</h4>
517 <b>__configure</b>(<i></i>)
518 <p>
519 Private method to open the configuration dialog.
520 </p><a NAME="TaskViewer.__configureFilter" ID="TaskViewer.__configureFilter"></a>
521 <h4>TaskViewer.__configureFilter</h4>
522 <b>__configureFilter</b>(<i></i>)
523 <p>
524 Private slot to handle the "Configure filter" context menu entry.
525 </p><a NAME="TaskViewer.__copyTask" ID="TaskViewer.__copyTask"></a>
526 <h4>TaskViewer.__copyTask</h4>
527 <b>__copyTask</b>(<i></i>)
528 <p>
529 Private slot to handle the "Copy" context menu entry.
530 </p><a NAME="TaskViewer.__deleteCompleted" ID="TaskViewer.__deleteCompleted"></a>
531 <h4>TaskViewer.__deleteCompleted</h4>
532 <b>__deleteCompleted</b>(<i></i>)
533 <p>
534 Private slot to handle the "Delete Completed Tasks" context menu entry.
535 </p><a NAME="TaskViewer.__deleteTask" ID="TaskViewer.__deleteTask"></a>
536 <h4>TaskViewer.__deleteTask</h4>
537 <b>__deleteTask</b>(<i></i>)
538 <p>
539 Private slot to handle the "Delete Task" context menu entry.
540 </p><a NAME="TaskViewer.__editTaskProperties" ID="TaskViewer.__editTaskProperties"></a>
541 <h4>TaskViewer.__editTaskProperties</h4>
542 <b>__editTaskProperties</b>(<i></i>)
543 <p>
544 Private slot to handle the "Properties" context menu entry
545 </p><a NAME="TaskViewer.__goToTask" ID="TaskViewer.__goToTask"></a>
546 <h4>TaskViewer.__goToTask</h4>
547 <b>__goToTask</b>(<i></i>)
548 <p>
549 Private slot to handle the "Go To" context menu entry.
550 </p><a NAME="TaskViewer.__markCompleted" ID="TaskViewer.__markCompleted"></a>
551 <h4>TaskViewer.__markCompleted</h4>
552 <b>__markCompleted</b>(<i></i>)
553 <p>
554 Private slot to handle the "Mark Completed" context menu entry.
555 </p><a NAME="TaskViewer.__newTask" ID="TaskViewer.__newTask"></a>
556 <h4>TaskViewer.__newTask</h4>
557 <b>__newTask</b>(<i></i>)
558 <p>
559 Private slot to handle the "New Task" context menu entry.
560 </p><a NAME="TaskViewer.__pasteTask" ID="TaskViewer.__pasteTask"></a>
561 <h4>TaskViewer.__pasteTask</h4>
562 <b>__pasteTask</b>(<i></i>)
563 <p>
564 Private slot to handle the "Paste" context menu entry.
565 </p><a NAME="TaskViewer.__refreshDisplay" ID="TaskViewer.__refreshDisplay"></a>
566 <h4>TaskViewer.__refreshDisplay</h4>
567 <b>__refreshDisplay</b>(<i></i>)
568 <p>
569 Private method to refresh the display.
570 </p><a NAME="TaskViewer.__regenerateProjectTasks" ID="TaskViewer.__regenerateProjectTasks"></a>
571 <h4>TaskViewer.__regenerateProjectTasks</h4>
572 <b>__regenerateProjectTasks</b>(<i></i>)
573 <p>
574 Private slot to handle the "Regenerated project tasks" context menu entry.
575 </p><a NAME="TaskViewer.__resizeColumns" ID="TaskViewer.__resizeColumns"></a>
576 <h4>TaskViewer.__resizeColumns</h4>
577 <b>__resizeColumns</b>(<i></i>)
578 <p>
579 Private method to resize the list columns.
580 </p><a NAME="TaskViewer.__resort" ID="TaskViewer.__resort"></a>
581 <h4>TaskViewer.__resort</h4>
582 <b>__resort</b>(<i></i>)
583 <p>
584 Private method to resort the tree.
585 </p><a NAME="TaskViewer.__showContextMenu" ID="TaskViewer.__showContextMenu"></a>
586 <h4>TaskViewer.__showContextMenu</h4>
587 <b>__showContextMenu</b>(<i>coord</i>)
588 <p>
589 Private slot to show the context menu of the list.
590 </p><dl>
591 <dt><i>coord</i></dt>
592 <dd>
593 the position of the mouse pointer (QPoint)
594 </dd>
595 </dl><a NAME="TaskViewer.__taskItemActivated" ID="TaskViewer.__taskItemActivated"></a>
596 <h4>TaskViewer.__taskItemActivated</h4>
597 <b>__taskItemActivated</b>(<i>itm, col</i>)
598 <p>
599 Private slot to handle the activation of an item.
600 </p><dl>
601 <dt><i>itm</i></dt>
602 <dd>
603 reference to the activated item (QTreeWidgetItem)
604 </dd><dt><i>col</i></dt>
605 <dd>
606 column the item was activated in (integer)
607 </dd>
608 </dl><a NAME="TaskViewer.addFileTask" ID="TaskViewer.addFileTask"></a>
609 <h4>TaskViewer.addFileTask</h4>
610 <b>addFileTask</b>(<i>description, filename, lineno, isBugfixTask = False, longtext = ""</i>)
611 <p>
612 Public slot to add a file related task.
613 </p><dl>
614 <dt><i>description</i></dt>
615 <dd>
616 descriptive text of the task (string)
617 </dd><dt><i>filename</i></dt>
618 <dd>
619 filename containing the task (string)
620 </dd><dt><i>lineno</i></dt>
621 <dd>
622 line number containing the task (integer)
623 </dd><dt><i>isBugfixTask</i></dt>
624 <dd>
625 flag indicating a bugfix task (boolean)
626 </dd><dt><i>longtext</i></dt>
627 <dd>
628 explanatory text of the task (string)
629 </dd>
630 </dl><a NAME="TaskViewer.addTask" ID="TaskViewer.addTask"></a>
631 <h4>TaskViewer.addTask</h4>
632 <b>addTask</b>(<i>description, priority = 1, filename = "", lineno = 0, completed = False, _time = 0, isProjectTask = False, isBugfixTask = False, longtext = ""</i>)
633 <p>
634 Public slot to add a task.
635 </p><dl>
636 <dt><i>description</i></dt>
637 <dd>
638 descriptive text of the task (string)
639 </dd><dt><i>priority</i></dt>
640 <dd>
641 priority of the task (0=high, 1=normal, 2=low)
642 </dd><dt><i>filename</i></dt>
643 <dd>
644 filename containing the task (string)
645 </dd><dt><i>lineno</i></dt>
646 <dd>
647 line number containing the task (integer)
648 </dd><dt><i>completed</i></dt>
649 <dd>
650 flag indicating completion status (boolean)
651 </dd><dt><i>_time</i></dt>
652 <dd>
653 creation time of the task (float, if 0 use current time)
654 </dd><dt><i>isProjectTask</i></dt>
655 <dd>
656 flag indicating a task related to the current
657 project (boolean)
658 </dd><dt><i>isBugfixTask</i></dt>
659 <dd>
660 flag indicating a bugfix task (boolean)
661 </dd><dt><i>longtext</i></dt>
662 <dd>
663 explanatory text of the task (string)
664 </dd>
665 </dl><a NAME="TaskViewer.clearFileTasks" ID="TaskViewer.clearFileTasks"></a>
666 <h4>TaskViewer.clearFileTasks</h4>
667 <b>clearFileTasks</b>(<i>filename</i>)
668 <p>
669 Public slot to clear all tasks related to a file.
670 </p><dl>
671 <dt><i>filename</i></dt>
672 <dd>
673 name of the file (string)
674 </dd>
675 </dl><a NAME="TaskViewer.clearProjectTasks" ID="TaskViewer.clearProjectTasks"></a>
676 <h4>TaskViewer.clearProjectTasks</h4>
677 <b>clearProjectTasks</b>(<i></i>)
678 <p>
679 Public slot to clear project related tasks.
680 </p><a NAME="TaskViewer.clearTasks" ID="TaskViewer.clearTasks"></a>
681 <h4>TaskViewer.clearTasks</h4>
682 <b>clearTasks</b>(<i></i>)
683 <p>
684 Public slot to clear all tasks from display.
685 </p><a NAME="TaskViewer.getGlobalTasks" ID="TaskViewer.getGlobalTasks"></a>
686 <h4>TaskViewer.getGlobalTasks</h4>
687 <b>getGlobalTasks</b>(<i></i>)
688 <p>
689 Public method to retrieve all non project related tasks.
690 </p><dl>
691 <dt>Returns:</dt>
692 <dd>
693 copy of tasks (list of Task)
694 </dd>
695 </dl><a NAME="TaskViewer.getProjectTasks" ID="TaskViewer.getProjectTasks"></a>
696 <h4>TaskViewer.getProjectTasks</h4>
697 <b>getProjectTasks</b>(<i></i>)
698 <p>
699 Public method to retrieve all project related tasks.
700 </p><dl>
701 <dt>Returns:</dt>
702 <dd>
703 copy of tasks (list of Task)
704 </dd>
705 </dl><a NAME="TaskViewer.handlePreferencesChanged" ID="TaskViewer.handlePreferencesChanged"></a>
706 <h4>TaskViewer.handlePreferencesChanged</h4>
707 <b>handlePreferencesChanged</b>(<i></i>)
708 <p>
709 Public slot to react to changes of the preferences.
710 </p><a NAME="TaskViewer.setProjectOpen" ID="TaskViewer.setProjectOpen"></a>
711 <h4>TaskViewer.setProjectOpen</h4>
712 <b>setProjectOpen</b>(<i>o = False</i>)
713 <p>
714 Public slot to set the project status.
715 </p><dl>
716 <dt><i>o</i></dt>
717 <dd>
718 flag indicating the project status
719 </dd>
720 </dl>
721 <div align="right"><a href="#top">Up</a></div>
722 <hr />
723 </body></html>

Mercurial Repository: eric

eric ide

mercurial