Mercurial Repositories > eric / file comparison

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

Documentation/Source/eric5.Tasks.TaskViewer.html

changeset 1819
cfcfd617216a
parent 1653
fed1920ff53b
child 2001
92a4e822aefe
equal deleted inserted replaced
1818:a5e4cb4bed43 1819:cfcfd617216a
33 <tr><td>None</td></tr> 33 <tr><td>None</td></tr>
34 </table> 34 </table>
35 <h3>Classes</h3> 35 <h3>Classes</h3>
36 <table> 36 <table>
37 <tr> 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> 38 <td><a href="#TaskViewer">TaskViewer</a></td>
45 <td>Class implementing the task viewer.</td> 39 <td>Class implementing the task viewer.</td>
46 </tr> 40 </tr>
47 </table> 41 </table>
48 <h3>Functions</h3> 42 <h3>Functions</h3>
49 <table> 43 <table>
50 <tr><td>None</td></tr> 44 <tr><td>None</td></tr>
51 </table> 45 </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>Class Methods</h3>
65 <table>
66 <tr><td>None</td></tr>
67 </table>
68 <h3>Methods</h3>
69 <table>
70 <tr>
71 <td><a href="#Task.__init__">Task</a></td>
72 <td>Constructor</td>
73 </tr><tr>
74 <td><a href="#Task.colorizeTask">colorizeTask</a></td>
75 <td>Public slot to set the colors of the task item.</td>
76 </tr><tr>
77 <td><a href="#Task.getFilename">getFilename</a></td>
78 <td>Public method to retrieve the tasks filename.</td>
79 </tr><tr>
80 <td><a href="#Task.getLineno">getLineno</a></td>
81 <td>Public method to retrieve the tasks linenumber.</td>
82 </tr><tr>
83 <td><a href="#Task.isCompleted">isCompleted</a></td>
84 <td>Public slot to return the completion status.</td>
85 </tr><tr>
86 <td><a href="#Task.isProjectTask">isProjectTask</a></td>
87 <td>Public slot to return the project relation status.</td>
88 </tr><tr>
89 <td><a href="#Task.setCompleted">setCompleted</a></td>
90 <td>Public slot to update the completed flag.</td>
91 </tr><tr>
92 <td><a href="#Task.setDescription">setDescription</a></td>
93 <td>Public slot to update the description.</td>
94 </tr><tr>
95 <td><a href="#Task.setLongText">setLongText</a></td>
96 <td>Public slot to update the longtext field.</td>
97 </tr><tr>
98 <td><a href="#Task.setPriority">setPriority</a></td>
99 <td>Public slot to update the priority.</td>
100 </tr><tr>
101 <td><a href="#Task.setProjectTask">setProjectTask</a></td>
102 <td>Public method to set the project relation flag.</td>
103 </tr>
104 </table>
105 <h3>Static Methods</h3>
106 <table>
107 <tr><td>None</td></tr>
108 </table>
109 <a NAME="Task.__init__" ID="Task.__init__"></a>
110 <h4>Task (Constructor)</h4>
111 <b>Task</b>(<i>description, priority=1, filename="", lineno=0, completed=False, _time=0, isProjectTask=False, isBugfixTask=False, project=None, longtext=""</i>)
112 <p>
113 Constructor
114 </p><dl>
115 <dt><i>parent</i></dt>
116 <dd>
117 parent widget of the task (QWidget)
118 </dd><dt><i>description</i></dt>
119 <dd>
120 descriptive text of the task (string)
121 </dd><dt><i>priority</i></dt>
122 <dd>
123 priority of the task (0=high, 1=normal, 2=low)
124 </dd><dt><i>filename</i></dt>
125 <dd>
126 filename containing the task (string)
127 </dd><dt><i>lineno</i></dt>
128 <dd>
129 line number containing the task (integer)
130 </dd><dt><i>completed</i></dt>
131 <dd>
132 flag indicating completion status (boolean)
133 </dd><dt><i>_time</i></dt>
134 <dd>
135 creation time of the task (float, if 0 use current time)
136 </dd><dt><i>isProjectTask</i></dt>
137 <dd>
138 flag indicating a task related to the current project
139 (boolean)
140 </dd><dt><i>isBugfixTask</i></dt>
141 <dd>
142 flag indicating a bugfix task (boolean)
143 </dd><dt><i>project</i></dt>
144 <dd>
145 reference to the project object (Project)
146 </dd><dt><i>longtext</i></dt>
147 <dd>
148 explanatory text of the task (string)
149 </dd>
150 </dl><a NAME="Task.colorizeTask" ID="Task.colorizeTask"></a>
151 <h4>Task.colorizeTask</h4>
152 <b>colorizeTask</b>(<i></i>)
153 <p>
154 Public slot to set the colors of the task item.
155 </p><a NAME="Task.getFilename" ID="Task.getFilename"></a>
156 <h4>Task.getFilename</h4>
157 <b>getFilename</b>(<i></i>)
158 <p>
159 Public method to retrieve the tasks filename.
160 </p><dl>
161 <dt>Returns:</dt>
162 <dd>
163 filename (string)
164 </dd>
165 </dl><a NAME="Task.getLineno" ID="Task.getLineno"></a>
166 <h4>Task.getLineno</h4>
167 <b>getLineno</b>(<i></i>)
168 <p>
169 Public method to retrieve the tasks linenumber.
170 </p><dl>
171 <dt>Returns:</dt>
172 <dd>
173 linenumber (integer)
174 </dd>
175 </dl><a NAME="Task.isCompleted" ID="Task.isCompleted"></a>
176 <h4>Task.isCompleted</h4>
177 <b>isCompleted</b>(<i></i>)
178 <p>
179 Public slot to return the completion status.
180 </p><dl>
181 <dt>Returns:</dt>
182 <dd>
183 flag indicating the completion status (boolean)
184 </dd>
185 </dl><a NAME="Task.isProjectTask" ID="Task.isProjectTask"></a>
186 <h4>Task.isProjectTask</h4>
187 <b>isProjectTask</b>(<i></i>)
188 <p>
189 Public slot to return the project relation status.
190 </p><dl>
191 <dt>Returns:</dt>
192 <dd>
193 flag indicating the project relation status (boolean)
194 </dd>
195 </dl><a NAME="Task.setCompleted" ID="Task.setCompleted"></a>
196 <h4>Task.setCompleted</h4>
197 <b>setCompleted</b>(<i>completed</i>)
198 <p>
199 Public slot to update the completed flag.
200 </p><dl>
201 <dt><i>completed</i></dt>
202 <dd>
203 flag indicating completion status (boolean)
204 </dd>
205 </dl><a NAME="Task.setDescription" ID="Task.setDescription"></a>
206 <h4>Task.setDescription</h4>
207 <b>setDescription</b>(<i>description</i>)
208 <p>
209 Public slot to update the description.
210 </p><dl>
211 <dt><i>longtext</i></dt>
212 <dd>
213 explanatory text of the task (string)
214 </dd>
215 </dl><a NAME="Task.setLongText" ID="Task.setLongText"></a>
216 <h4>Task.setLongText</h4>
217 <b>setLongText</b>(<i>longtext</i>)
218 <p>
219 Public slot to update the longtext field.
220 </p><dl>
221 <dt><i>longtext</i></dt>
222 <dd>
223 descriptive text of the task (string)
224 </dd>
225 </dl><a NAME="Task.setPriority" ID="Task.setPriority"></a>
226 <h4>Task.setPriority</h4>
227 <b>setPriority</b>(<i>priority</i>)
228 <p>
229 Public slot to update the priority.
230 </p><dl>
231 <dt><i>priority</i></dt>
232 <dd>
233 priority of the task (0=high, 1=normal, 2=low)
234 </dd>
235 </dl><a NAME="Task.setProjectTask" ID="Task.setProjectTask"></a>
236 <h4>Task.setProjectTask</h4>
237 <b>setProjectTask</b>(<i>pt</i>)
238 <p>
239 Public method to set the project relation flag.
240 </p><dl>
241 <dt><i>pt</i></dt>
242 <dd>
243 flag indicating a project task (boolean)
244 </dd>
245 </dl>
246 <div align="right"><a href="#top">Up</a></div>
247 <hr /><hr />
248 <a NAME="TaskFilter" ID="TaskFilter"></a>
249 <h2>TaskFilter</h2>
250 <p>
251 Class implementing a filter for tasks.
252 </p>
253 <h3>Derived from</h3>
254 object
255 <h3>Class Attributes</h3>
256 <table>
257 <tr><td>None</td></tr>
258 </table>
259 <h3>Class Methods</h3>
260 <table>
261 <tr><td>None</td></tr>
262 </table>
263 <h3>Methods</h3>
264 <table>
265 <tr>
266 <td><a href="#TaskFilter.__init__">TaskFilter</a></td>
267 <td>Constructor</td>
268 </tr><tr>
269 <td><a href="#TaskFilter.hasActiveFilter">hasActiveFilter</a></td>
270 <td>Public method to check for active filters.</td>
271 </tr><tr>
272 <td><a href="#TaskFilter.setActive">setActive</a></td>
273 <td>Public method to activate the filter.</td>
274 </tr><tr>
275 <td><a href="#TaskFilter.setDescriptionFilter">setDescriptionFilter</a></td>
276 <td>Public method to set the description filter.</td>
277 </tr><tr>
278 <td><a href="#TaskFilter.setFileNameFilter">setFileNameFilter</a></td>
279 <td>Public method to set the filename filter.</td>
280 </tr><tr>
281 <td><a href="#TaskFilter.setPrioritiesFilter">setPrioritiesFilter</a></td>
282 <td>Public method to set the priorities filter.</td>
283 </tr><tr>
284 <td><a href="#TaskFilter.setScopeFilter">setScopeFilter</a></td>
285 <td>Public method to set the scope filter.</td>
286 </tr><tr>
287 <td><a href="#TaskFilter.setStatusFilter">setStatusFilter</a></td>
288 <td>Public method to set the status filter.</td>
289 </tr><tr>
290 <td><a href="#TaskFilter.setTypeFilter">setTypeFilter</a></td>
291 <td>Public method to set the type filter.</td>
292 </tr><tr>
293 <td><a href="#TaskFilter.showTask">showTask</a></td>
294 <td>Public method to check, if a task should be shown.</td>
295 </tr>
296 </table>
297 <h3>Static Methods</h3>
298 <table>
299 <tr><td>None</td></tr>
300 </table>
301 <a NAME="TaskFilter.__init__" ID="TaskFilter.__init__"></a>
302 <h4>TaskFilter (Constructor)</h4>
303 <b>TaskFilter</b>(<i></i>)
304 <p>
305 Constructor
306 </p><a NAME="TaskFilter.hasActiveFilter" ID="TaskFilter.hasActiveFilter"></a>
307 <h4>TaskFilter.hasActiveFilter</h4>
308 <b>hasActiveFilter</b>(<i></i>)
309 <p>
310 Public method to check for active filters.
311 </p><dl>
312 <dt>Returns:</dt>
313 <dd>
314 flag indicating an active filter was found (boolean)
315 </dd>
316 </dl><a NAME="TaskFilter.setActive" ID="TaskFilter.setActive"></a>
317 <h4>TaskFilter.setActive</h4>
318 <b>setActive</b>(<i>enabled</i>)
319 <p>
320 Public method to activate the filter.
321 </p><dl>
322 <dt><i>enabled</i></dt>
323 <dd>
324 flag indicating the activation state (boolean)
325 </dd>
326 </dl><a NAME="TaskFilter.setDescriptionFilter" ID="TaskFilter.setDescriptionFilter"></a>
327 <h4>TaskFilter.setDescriptionFilter</h4>
328 <b>setDescriptionFilter</b>(<i>filter</i>)
329 <p>
330 Public method to set the description filter.
331 </p><dl>
332 <dt><i>filter</i></dt>
333 <dd>
334 a regular expression for the description filter
335 to set (string) or None
336 </dd>
337 </dl><a NAME="TaskFilter.setFileNameFilter" ID="TaskFilter.setFileNameFilter"></a>
338 <h4>TaskFilter.setFileNameFilter</h4>
339 <b>setFileNameFilter</b>(<i>filter</i>)
340 <p>
341 Public method to set the filename filter.
342 </p><dl>
343 <dt><i>filter</i></dt>
344 <dd>
345 a wildcard expression for the filename filter
346 to set (string) or None
347 </dd>
348 </dl><a NAME="TaskFilter.setPrioritiesFilter" ID="TaskFilter.setPrioritiesFilter"></a>
349 <h4>TaskFilter.setPrioritiesFilter</h4>
350 <b>setPrioritiesFilter</b>(<i>priorities</i>)
351 <p>
352 Public method to set the priorities filter.
353 </p><dl>
354 <dt><i>priorities</i></dt>
355 <dd>
356 list of task priorities (list of integer) or None
357 </dd>
358 </dl><a NAME="TaskFilter.setScopeFilter" ID="TaskFilter.setScopeFilter"></a>
359 <h4>TaskFilter.setScopeFilter</h4>
360 <b>setScopeFilter</b>(<i>scope</i>)
361 <p>
362 Public method to set the scope filter.
363 </p><dl>
364 <dt><i>scope</i></dt>
365 <dd>
366 flag indicating a project task (boolean) or None
367 </dd>
368 </dl><a NAME="TaskFilter.setStatusFilter" ID="TaskFilter.setStatusFilter"></a>
369 <h4>TaskFilter.setStatusFilter</h4>
370 <b>setStatusFilter</b>(<i>status</i>)
371 <p>
372 Public method to set the status filter.
373 </p><dl>
374 <dt><i>status</i></dt>
375 <dd>
376 flag indicating a completed task (boolean) or None
377 </dd>
378 </dl><a NAME="TaskFilter.setTypeFilter" ID="TaskFilter.setTypeFilter"></a>
379 <h4>TaskFilter.setTypeFilter</h4>
380 <b>setTypeFilter</b>(<i>type_</i>)
381 <p>
382 Public method to set the type filter.
383 </p><dl>
384 <dt><i>type_</i></dt>
385 <dd>
386 flag indicating a bugfix task (boolean) or None
387 </dd>
388 </dl><a NAME="TaskFilter.showTask" ID="TaskFilter.showTask"></a>
389 <h4>TaskFilter.showTask</h4>
390 <b>showTask</b>(<i>task</i>)
391 <p>
392 Public method to check, if a task should be shown.
393 </p><dl>
394 <dt><i>task</i></dt>
395 <dd>
396 reference to the task object to check (Task)
397 </dd>
398 </dl><dl>
399 <dt>Returns:</dt>
400 <dd>
401 flag indicating whether the task should be shown (boolean)
402 </dd>
403 </dl>
404 <div align="right"><a href="#top">Up</a></div>
405 <hr /><hr /> 46 <hr /><hr />
406 <a NAME="TaskViewer" ID="TaskViewer"></a> 47 <a NAME="TaskViewer" ID="TaskViewer"></a>
407 <h2>TaskViewer</h2> 48 <h2>TaskViewer</h2>
408 <p> 49 <p>
409 Class implementing the task viewer. 50 Class implementing the task viewer.
640 <dd> 281 <dd>
641 column the item was activated in (integer) 282 column the item was activated in (integer)
642 </dd> 283 </dd>
643 </dl><a NAME="TaskViewer.addFileTask" ID="TaskViewer.addFileTask"></a> 284 </dl><a NAME="TaskViewer.addFileTask" ID="TaskViewer.addFileTask"></a>
644 <h4>TaskViewer.addFileTask</h4> 285 <h4>TaskViewer.addFileTask</h4>
645 <b>addFileTask</b>(<i>description, filename, lineno, isBugfixTask=False, longtext=""</i>) 286 <b>addFileTask</b>(<i>description, filename, lineno, taskType=Task.TypeTodo, longtext=""</i>)
646 <p> 287 <p>
647 Public slot to add a file related task. 288 Public slot to add a file related task.
648 </p><dl> 289 </p><dl>
649 <dt><i>description</i></dt> 290 <dt><i>description</i></dt>
650 <dd> 291 <dd>
653 <dd> 294 <dd>
654 filename containing the task (string) 295 filename containing the task (string)
655 </dd><dt><i>lineno</i></dt> 296 </dd><dt><i>lineno</i></dt>
656 <dd> 297 <dd>
657 line number containing the task (integer) 298 line number containing the task (integer)
658 </dd><dt><i>isBugfixTask</i></dt> 299 </dd><dt><i>taskType</i></dt>
659 <dd> 300 <dd>
660 flag indicating a bugfix task (boolean) 301 type of the task (one of Task.TypeFixme, Task.TypeTodo,
302 Task.TypeWarning, Task.TypeNote)
661 </dd><dt><i>longtext</i></dt> 303 </dd><dt><i>longtext</i></dt>
662 <dd> 304 <dd>
663 explanatory text of the task (string) 305 explanatory text of the task (string)
664 </dd> 306 </dd>
665 </dl><a NAME="TaskViewer.addTask" ID="TaskViewer.addTask"></a> 307 </dl><a NAME="TaskViewer.addTask" ID="TaskViewer.addTask"></a>
666 <h4>TaskViewer.addTask</h4> 308 <h4>TaskViewer.addTask</h4>
667 <b>addTask</b>(<i>description, priority=1, filename="", lineno=0, completed=False, _time=0, isProjectTask=False, isBugfixTask=False, longtext=""</i>) 309 <b>addTask</b>(<i>description, priority=1, filename="", lineno=0, completed=False, _time=0, isProjectTask=False, taskType=Task.TypeTodo, longtext=""</i>)
668 <p> 310 <p>
669 Public slot to add a task. 311 Public slot to add a task.
670 </p><dl> 312 </p><dl>
671 <dt><i>description</i></dt> 313 <dt><i>description</i></dt>
672 <dd> 314 <dd>
688 creation time of the task (float, if 0 use current time) 330 creation time of the task (float, if 0 use current time)
689 </dd><dt><i>isProjectTask</i></dt> 331 </dd><dt><i>isProjectTask</i></dt>
690 <dd> 332 <dd>
691 flag indicating a task related to the current 333 flag indicating a task related to the current
692 project (boolean) 334 project (boolean)
693 </dd><dt><i>isBugfixTask</i></dt> 335 </dd><dt><i>taskType</i></dt>
694 <dd> 336 <dd>
695 flag indicating a bugfix task (boolean) 337 type of the task (one of Task.TypeFixme, Task.TypeTodo,
338 Task.TypeWarning, Task.TypeNote)
696 </dd><dt><i>longtext</i></dt> 339 </dd><dt><i>longtext</i></dt>
697 <dd> 340 <dd>
698 explanatory text of the task (string) 341 explanatory text of the task (string)
699 </dd> 342 </dd>
700 </dl><a NAME="TaskViewer.clearFileTasks" ID="TaskViewer.clearFileTasks"></a> 343 </dl><a NAME="TaskViewer.clearFileTasks" ID="TaskViewer.clearFileTasks"></a>

Mercurial Repository: eric

eric ide

mercurial