Mercurial Repositories > eric / file comparison

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

eric7/Documentation/Source/eric7.Tasks.Task.html

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
equal deleted inserted replaced
8371:d6062691d424 8372:e0227a7c850e
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Tasks.Task</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body>
22 <a NAME="top" ID="top"></a>
23 <h1>eric7.Tasks.Task</h1>
24
25 <p>
26 Module implementing a class to store task data.
27 </p>
28 <h3>Global Attributes</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <h3>Classes</h3>
34
35 <table>
36
37 <tr>
38 <td><a href="#Task">Task</a></td>
39 <td>Class implementing the task data structure.</td>
40 </tr>
41 <tr>
42 <td><a href="#TaskPriority">TaskPriority</a></td>
43 <td>Class defining the task priorities.</td>
44 </tr>
45 <tr>
46 <td><a href="#TaskType">TaskType</a></td>
47 <td>Class defining the task types.</td>
48 </tr>
49 </table>
50 <h3>Functions</h3>
51
52 <table>
53 <tr><td>None</td></tr>
54 </table>
55 <hr />
56 <hr />
57 <a NAME="Task" ID="Task"></a>
58 <h2>Task</h2>
59
60 <p>
61 Class implementing the task data structure.
62 </p>
63 <h3>Derived from</h3>
64 QTreeWidgetItem
65 <h3>Class Attributes</h3>
66
67 <table>
68 <tr><td>TaskType2ColorName</td></tr><tr><td>TaskType2IconName</td></tr><tr><td>TaskType2MarkersName</td></tr>
69 </table>
70 <h3>Class Methods</h3>
71
72 <table>
73 <tr><td>None</td></tr>
74 </table>
75 <h3>Methods</h3>
76
77 <table>
78
79 <tr>
80 <td><a href="#Task.__init__">Task</a></td>
81 <td>Constructor</td>
82 </tr>
83 <tr>
84 <td><a href="#Task.colorizeTask">colorizeTask</a></td>
85 <td>Public slot to set the colors of the task item.</td>
86 </tr>
87 <tr>
88 <td><a href="#Task.getFilename">getFilename</a></td>
89 <td>Public method to retrieve the task's filename.</td>
90 </tr>
91 <tr>
92 <td><a href="#Task.getLineno">getLineno</a></td>
93 <td>Public method to retrieve the task's linenumber.</td>
94 </tr>
95 <tr>
96 <td><a href="#Task.getParentUuid">getParentUuid</a></td>
97 <td>Public method to get the parent task's uid.</td>
98 </tr>
99 <tr>
100 <td><a href="#Task.getUuid">getUuid</a></td>
101 <td>Public method to get the task's uid.</td>
102 </tr>
103 <tr>
104 <td><a href="#Task.isCompleted">isCompleted</a></td>
105 <td>Public slot to return the completion status.</td>
106 </tr>
107 <tr>
108 <td><a href="#Task.isFileTask">isFileTask</a></td>
109 <td>Public slot to get an indication, if this task is related to a file.</td>
110 </tr>
111 <tr>
112 <td><a href="#Task.isProjectFileTask">isProjectFileTask</a></td>
113 <td>Public slot to get an indication, if this task is related to a project file.</td>
114 </tr>
115 <tr>
116 <td><a href="#Task.isProjectTask">isProjectTask</a></td>
117 <td>Public slot to return the project relation status.</td>
118 </tr>
119 <tr>
120 <td><a href="#Task.setCompleted">setCompleted</a></td>
121 <td>Public slot to update the completed flag.</td>
122 </tr>
123 <tr>
124 <td><a href="#Task.setDescription">setDescription</a></td>
125 <td>Public slot to update the description field.</td>
126 </tr>
127 <tr>
128 <td><a href="#Task.setPriority">setPriority</a></td>
129 <td>Public slot to update the priority.</td>
130 </tr>
131 <tr>
132 <td><a href="#Task.setProjectTask">setProjectTask</a></td>
133 <td>Public method to set the project relation flag.</td>
134 </tr>
135 <tr>
136 <td><a href="#Task.setSummary">setSummary</a></td>
137 <td>Public slot to update the description.</td>
138 </tr>
139 <tr>
140 <td><a href="#Task.setTaskType">setTaskType</a></td>
141 <td>Public method to update the task type.</td>
142 </tr>
143 <tr>
144 <td><a href="#Task.toDict">toDict</a></td>
145 <td>Public method to convert the task data to a dictionary.</td>
146 </tr>
147 </table>
148 <h3>Static Methods</h3>
149
150 <table>
151 <tr><td>None</td></tr>
152 </table>
153
154 <a NAME="Task.__init__" ID="Task.__init__"></a>
155 <h4>Task (Constructor)</h4>
156 <b>Task</b>(<i>summary, priority=TaskPriority.NORMAL, filename="", lineno=0, completed=False, _time=0, isProjectTask=False, taskType=TaskType.TODO, project=None, description="", uid="", parentUid=""</i>)
157
158 <p>
159 Constructor
160 </p>
161 <dl>
162
163 <dt><i>summary</i> (str)</dt>
164 <dd>
165 summary text of the task
166 </dd>
167 <dt><i>priority</i> (TaskPriority)</dt>
168 <dd>
169 priority of the task
170 </dd>
171 <dt><i>filename</i> (str)</dt>
172 <dd>
173 filename containing the task
174 </dd>
175 <dt><i>lineno</i> (int)</dt>
176 <dd>
177 line number containing the task
178 </dd>
179 <dt><i>completed</i> (bool)</dt>
180 <dd>
181 flag indicating completion status
182 </dd>
183 <dt><i>_time</i> (float)</dt>
184 <dd>
185 creation time of the task (if 0 use current time)
186 </dd>
187 <dt><i>isProjectTask</i> (bool)</dt>
188 <dd>
189 flag indicating a task related to the current
190 project
191 </dd>
192 <dt><i>taskType</i> (TaskType)</dt>
193 <dd>
194 type of the task
195 </dd>
196 <dt><i>project</i> (Project)</dt>
197 <dd>
198 reference to the project object
199 </dd>
200 <dt><i>description</i> (str)</dt>
201 <dd>
202 explanatory text of the task
203 </dd>
204 <dt><i>uid</i> (str)</dt>
205 <dd>
206 unique id of the task
207 </dd>
208 <dt><i>parentUid</i> (str)</dt>
209 <dd>
210 unique id of the parent task
211 </dd>
212 </dl>
213 <a NAME="Task.colorizeTask" ID="Task.colorizeTask"></a>
214 <h4>Task.colorizeTask</h4>
215 <b>colorizeTask</b>(<i></i>)
216
217 <p>
218 Public slot to set the colors of the task item.
219 </p>
220 <a NAME="Task.getFilename" ID="Task.getFilename"></a>
221 <h4>Task.getFilename</h4>
222 <b>getFilename</b>(<i></i>)
223
224 <p>
225 Public method to retrieve the task's filename.
226 </p>
227 <dl>
228 <dt>Return:</dt>
229 <dd>
230 filename (string)
231 </dd>
232 </dl>
233 <a NAME="Task.getLineno" ID="Task.getLineno"></a>
234 <h4>Task.getLineno</h4>
235 <b>getLineno</b>(<i></i>)
236
237 <p>
238 Public method to retrieve the task's linenumber.
239 </p>
240 <dl>
241 <dt>Return:</dt>
242 <dd>
243 linenumber (integer)
244 </dd>
245 </dl>
246 <a NAME="Task.getParentUuid" ID="Task.getParentUuid"></a>
247 <h4>Task.getParentUuid</h4>
248 <b>getParentUuid</b>(<i></i>)
249
250 <p>
251 Public method to get the parent task's uid.
252 </p>
253 <dl>
254 <dt>Return:</dt>
255 <dd>
256 parent uid (string)
257 </dd>
258 </dl>
259 <a NAME="Task.getUuid" ID="Task.getUuid"></a>
260 <h4>Task.getUuid</h4>
261 <b>getUuid</b>(<i></i>)
262
263 <p>
264 Public method to get the task's uid.
265 </p>
266 <dl>
267 <dt>Return:</dt>
268 <dd>
269 uid (string)
270 </dd>
271 </dl>
272 <a NAME="Task.isCompleted" ID="Task.isCompleted"></a>
273 <h4>Task.isCompleted</h4>
274 <b>isCompleted</b>(<i></i>)
275
276 <p>
277 Public slot to return the completion status.
278 </p>
279 <dl>
280 <dt>Return:</dt>
281 <dd>
282 flag indicating the completion status (boolean)
283 </dd>
284 </dl>
285 <a NAME="Task.isFileTask" ID="Task.isFileTask"></a>
286 <h4>Task.isFileTask</h4>
287 <b>isFileTask</b>(<i></i>)
288
289 <p>
290 Public slot to get an indication, if this task is related to a file.
291 </p>
292 <dl>
293 <dt>Return:</dt>
294 <dd>
295 flag indicating a file task (boolean)
296 </dd>
297 </dl>
298 <a NAME="Task.isProjectFileTask" ID="Task.isProjectFileTask"></a>
299 <h4>Task.isProjectFileTask</h4>
300 <b>isProjectFileTask</b>(<i></i>)
301
302 <p>
303 Public slot to get an indication, if this task is related to a
304 project file.
305 </p>
306 <dl>
307 <dt>Return:</dt>
308 <dd>
309 flag indicating a project file task (boolean)
310 </dd>
311 </dl>
312 <a NAME="Task.isProjectTask" ID="Task.isProjectTask"></a>
313 <h4>Task.isProjectTask</h4>
314 <b>isProjectTask</b>(<i></i>)
315
316 <p>
317 Public slot to return the project relation status.
318 </p>
319 <dl>
320 <dt>Return:</dt>
321 <dd>
322 flag indicating the project relation status (boolean)
323 </dd>
324 </dl>
325 <a NAME="Task.setCompleted" ID="Task.setCompleted"></a>
326 <h4>Task.setCompleted</h4>
327 <b>setCompleted</b>(<i>completed</i>)
328
329 <p>
330 Public slot to update the completed flag.
331 </p>
332 <dl>
333
334 <dt><i>completed</i></dt>
335 <dd>
336 flag indicating completion status (boolean)
337 </dd>
338 </dl>
339 <a NAME="Task.setDescription" ID="Task.setDescription"></a>
340 <h4>Task.setDescription</h4>
341 <b>setDescription</b>(<i>description</i>)
342
343 <p>
344 Public slot to update the description field.
345 </p>
346 <dl>
347
348 <dt><i>description</i> (str)</dt>
349 <dd>
350 descriptive text of the task
351 </dd>
352 </dl>
353 <a NAME="Task.setPriority" ID="Task.setPriority"></a>
354 <h4>Task.setPriority</h4>
355 <b>setPriority</b>(<i>priority</i>)
356
357 <p>
358 Public slot to update the priority.
359 </p>
360 <dl>
361
362 <dt><i>priority</i> (TaskPriority)</dt>
363 <dd>
364 priority of the task
365 </dd>
366 </dl>
367 <a NAME="Task.setProjectTask" ID="Task.setProjectTask"></a>
368 <h4>Task.setProjectTask</h4>
369 <b>setProjectTask</b>(<i>pt</i>)
370
371 <p>
372 Public method to set the project relation flag.
373 </p>
374 <dl>
375
376 <dt><i>pt</i></dt>
377 <dd>
378 flag indicating a project task (boolean)
379 </dd>
380 </dl>
381 <a NAME="Task.setSummary" ID="Task.setSummary"></a>
382 <h4>Task.setSummary</h4>
383 <b>setSummary</b>(<i>summary</i>)
384
385 <p>
386 Public slot to update the description.
387 </p>
388 <dl>
389
390 <dt><i>summary</i></dt>
391 <dd>
392 summary text of the task (string)
393 </dd>
394 </dl>
395 <a NAME="Task.setTaskType" ID="Task.setTaskType"></a>
396 <h4>Task.setTaskType</h4>
397 <b>setTaskType</b>(<i>taskType</i>)
398
399 <p>
400 Public method to update the task type.
401 </p>
402 <dl>
403
404 <dt><i>taskType</i> (TaskType)</dt>
405 <dd>
406 type of the task
407 </dd>
408 </dl>
409 <a NAME="Task.toDict" ID="Task.toDict"></a>
410 <h4>Task.toDict</h4>
411 <b>toDict</b>(<i></i>)
412
413 <p>
414 Public method to convert the task data to a dictionary.
415 </p>
416 <dl>
417 <dt>Return:</dt>
418 <dd>
419 dictionary containing the task data
420 </dd>
421 </dl>
422 <dl>
423 <dt>Return Type:</dt>
424 <dd>
425 dict
426 </dd>
427 </dl>
428 <div align="right"><a href="#top">Up</a></div>
429 <hr />
430 <hr />
431 <a NAME="TaskPriority" ID="TaskPriority"></a>
432 <h2>TaskPriority</h2>
433
434 <p>
435 Class defining the task priorities.
436 </p>
437 <h3>Derived from</h3>
438 enum.IntEnum
439 <h3>Class Attributes</h3>
440
441 <table>
442 <tr><td>HIGH</td></tr><tr><td>LOW</td></tr><tr><td>NORMAL</td></tr>
443 </table>
444 <h3>Class Methods</h3>
445
446 <table>
447 <tr><td>None</td></tr>
448 </table>
449 <h3>Methods</h3>
450
451 <table>
452 <tr><td>None</td></tr>
453 </table>
454 <h3>Static Methods</h3>
455
456 <table>
457 <tr><td>None</td></tr>
458 </table>
459
460 <div align="right"><a href="#top">Up</a></div>
461 <hr />
462 <hr />
463 <a NAME="TaskType" ID="TaskType"></a>
464 <h2>TaskType</h2>
465
466 <p>
467 Class defining the task types.
468 </p>
469 <h3>Derived from</h3>
470 enum.IntEnum
471 <h3>Class Attributes</h3>
472
473 <table>
474 <tr><td>DOCU</td></tr><tr><td>FIXME</td></tr><tr><td>NONE</td></tr><tr><td>NOTE</td></tr><tr><td>TEST</td></tr><tr><td>TODO</td></tr><tr><td>WARNING</td></tr>
475 </table>
476 <h3>Class Methods</h3>
477
478 <table>
479 <tr><td>None</td></tr>
480 </table>
481 <h3>Methods</h3>
482
483 <table>
484 <tr><td>None</td></tr>
485 </table>
486 <h3>Static Methods</h3>
487
488 <table>
489 <tr><td>None</td></tr>
490 </table>
491
492 <div align="right"><a href="#top">Up</a></div>
493 <hr />
494 </body></html>

Mercurial Repository: eric

eric ide

mercurial