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