Mercurial Repositories > eric / file comparison

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

eric6/Documentation/Source/eric6.Tasks.Task.html

changeset 8281
184ece570a2b
parent 8049
af58c1d47e5e
equal deleted inserted replaced
8280:17d03699f151 8281:184ece570a2b
36 36
37 <tr> 37 <tr>
38 <td><a href="#Task">Task</a></td> 38 <td><a href="#Task">Task</a></td>
39 <td>Class implementing the task data structure.</td> 39 <td>Class implementing the task data structure.</td>
40 </tr> 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>
41 </table> 49 </table>
42 <h3>Functions</h3> 50 <h3>Functions</h3>
43 51
44 <table> 52 <table>
45 <tr><td>None</td></tr> 53 <tr><td>None</td></tr>
55 <h3>Derived from</h3> 63 <h3>Derived from</h3>
56 QTreeWidgetItem 64 QTreeWidgetItem
57 <h3>Class Attributes</h3> 65 <h3>Class Attributes</h3>
58 66
59 <table> 67 <table>
60 <tr><td>TaskType2ColorName</td></tr><tr><td>TaskType2IconName</td></tr><tr><td>TaskType2MarkersName</td></tr><tr><td>TypeDocu</td></tr><tr><td>TypeFixme</td></tr><tr><td>TypeNone</td></tr><tr><td>TypeNote</td></tr><tr><td>TypeTest</td></tr><tr><td>TypeTodo</td></tr><tr><td>TypeWarning</td></tr> 68 <tr><td>TaskType2ColorName</td></tr><tr><td>TaskType2IconName</td></tr><tr><td>TaskType2MarkersName</td></tr>
61 </table> 69 </table>
62 <h3>Class Methods</h3> 70 <h3>Class Methods</h3>
63 71
64 <table> 72 <table>
65 <tr><td>None</td></tr> 73 <tr><td>None</td></tr>
127 <tr> 135 <tr>
128 <td><a href="#Task.setSummary">setSummary</a></td> 136 <td><a href="#Task.setSummary">setSummary</a></td>
129 <td>Public slot to update the description.</td> 137 <td>Public slot to update the description.</td>
130 </tr> 138 </tr>
131 <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>
132 <td><a href="#Task.toDict">toDict</a></td> 144 <td><a href="#Task.toDict">toDict</a></td>
133 <td>Public method to convert the task data to a dictionary.</td> 145 <td>Public method to convert the task data to a dictionary.</td>
134 </tr> 146 </tr>
135 </table> 147 </table>
136 <h3>Static Methods</h3> 148 <h3>Static Methods</h3>
139 <tr><td>None</td></tr> 151 <tr><td>None</td></tr>
140 </table> 152 </table>
141 153
142 <a NAME="Task.__init__" ID="Task.__init__"></a> 154 <a NAME="Task.__init__" ID="Task.__init__"></a>
143 <h4>Task (Constructor)</h4> 155 <h4>Task (Constructor)</h4>
144 <b>Task</b>(<i>summary, priority=1, filename="", lineno=0, completed=False, _time=0, isProjectTask=False, taskType=TypeTodo, project=None, description="", uid="", parentUid=""</i>) 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>)
145 157
146 <p> 158 <p>
147 Constructor 159 Constructor
148 </p> 160 </p>
149 <dl> 161 <dl>
150 162
151 <dt><i>summary</i></dt> 163 <dt><i>summary</i> (str)</dt>
152 <dd> 164 <dd>
153 summary text of the task (string) 165 summary text of the task
154 </dd> 166 </dd>
155 <dt><i>priority</i></dt> 167 <dt><i>priority</i> (TaskPriority)</dt>
156 <dd> 168 <dd>
157 priority of the task (0=high, 1=normal, 2=low) 169 priority of the task
158 </dd> 170 </dd>
159 <dt><i>filename</i></dt> 171 <dt><i>filename</i> (str)</dt>
160 <dd> 172 <dd>
161 filename containing the task (string) 173 filename containing the task
162 </dd> 174 </dd>
163 <dt><i>lineno</i></dt> 175 <dt><i>lineno</i> (int)</dt>
164 <dd> 176 <dd>
165 line number containing the task (integer) 177 line number containing the task
166 </dd> 178 </dd>
167 <dt><i>completed</i></dt> 179 <dt><i>completed</i> (bool)</dt>
168 <dd> 180 <dd>
169 flag indicating completion status (boolean) 181 flag indicating completion status
170 </dd> 182 </dd>
171 <dt><i>_time</i></dt> 183 <dt><i>_time</i> (float)</dt>
172 <dd> 184 <dd>
173 creation time of the task (float, if 0 use current time) 185 creation time of the task (if 0 use current time)
174 </dd> 186 </dd>
175 <dt><i>isProjectTask</i></dt> 187 <dt><i>isProjectTask</i> (bool)</dt>
176 <dd> 188 <dd>
177 flag indicating a task related to the current 189 flag indicating a task related to the current
178 project (boolean) 190 project
179 </dd> 191 </dd>
180 <dt><i>taskType</i></dt> 192 <dt><i>taskType</i> (TaskType)</dt>
181 <dd> 193 <dd>
182 type of the task (one of TypeFixme, TypeTodo, 194 type of the task
183 TypeWarning, TypeNote, TypeTest, TypeDocu) 195 </dd>
184 </dd> 196 <dt><i>project</i> (Project)</dt>
185 <dt><i>project</i></dt> 197 <dd>
186 <dd> 198 reference to the project object
187 reference to the project object (Project) 199 </dd>
188 </dd> 200 <dt><i>description</i> (str)</dt>
189 <dt><i>description</i></dt> 201 <dd>
190 <dd> 202 explanatory text of the task
191 explanatory text of the task (string) 203 </dd>
192 </dd> 204 <dt><i>uid</i> (str)</dt>
193 <dt><i>uid</i></dt> 205 <dd>
194 <dd> 206 unique id of the task
195 unique id of the task (string) 207 </dd>
196 </dd> 208 <dt><i>parentUid</i> (str)</dt>
197 <dt><i>parentUid</i></dt> 209 <dd>
198 <dd> 210 unique id of the parent task
199 unique id of the parent task (string)
200 </dd> 211 </dd>
201 </dl> 212 </dl>
202 <a NAME="Task.colorizeTask" ID="Task.colorizeTask"></a> 213 <a NAME="Task.colorizeTask" ID="Task.colorizeTask"></a>
203 <h4>Task.colorizeTask</h4> 214 <h4>Task.colorizeTask</h4>
204 <b>colorizeTask</b>(<i></i>) 215 <b>colorizeTask</b>(<i></i>)
332 <p> 343 <p>
333 Public slot to update the description field. 344 Public slot to update the description field.
334 </p> 345 </p>
335 <dl> 346 <dl>
336 347
337 <dt><i>description</i></dt> 348 <dt><i>description</i> (str)</dt>
338 <dd> 349 <dd>
339 descriptive text of the task (string) 350 descriptive text of the task
340 </dd> 351 </dd>
341 </dl> 352 </dl>
342 <a NAME="Task.setPriority" ID="Task.setPriority"></a> 353 <a NAME="Task.setPriority" ID="Task.setPriority"></a>
343 <h4>Task.setPriority</h4> 354 <h4>Task.setPriority</h4>
344 <b>setPriority</b>(<i>priority</i>) 355 <b>setPriority</b>(<i>priority</i>)
346 <p> 357 <p>
347 Public slot to update the priority. 358 Public slot to update the priority.
348 </p> 359 </p>
349 <dl> 360 <dl>
350 361
351 <dt><i>priority</i></dt> 362 <dt><i>priority</i> (TaskPriority)</dt>
352 <dd> 363 <dd>
353 priority of the task (0=high, 1=normal, 2=low) 364 priority of the task
354 </dd> 365 </dd>
355 </dl> 366 </dl>
356 <a NAME="Task.setProjectTask" ID="Task.setProjectTask"></a> 367 <a NAME="Task.setProjectTask" ID="Task.setProjectTask"></a>
357 <h4>Task.setProjectTask</h4> 368 <h4>Task.setProjectTask</h4>
358 <b>setProjectTask</b>(<i>pt</i>) 369 <b>setProjectTask</b>(<i>pt</i>)
379 <dt><i>summary</i></dt> 390 <dt><i>summary</i></dt>
380 <dd> 391 <dd>
381 summary text of the task (string) 392 summary text of the task (string)
382 </dd> 393 </dd>
383 </dl> 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>
384 <a NAME="Task.toDict" ID="Task.toDict"></a> 409 <a NAME="Task.toDict" ID="Task.toDict"></a>
385 <h4>Task.toDict</h4> 410 <h4>Task.toDict</h4>
386 <b>toDict</b>(<i></i>) 411 <b>toDict</b>(<i></i>)
387 412
388 <p> 413 <p>
400 dict 425 dict
401 </dd> 426 </dd>
402 </dl> 427 </dl>
403 <div align="right"><a href="#top">Up</a></div> 428 <div align="right"><a href="#top">Up</a></div>
404 <hr /> 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 />
405 </body></html> 494 </body></html>

Mercurial Repository: eric

eric ide

mercurial