Mercurial Repositories > eric / file comparison

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

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

changeset 7273
391d6b7b1eff
parent 6942
2602857055c5
child 7665
fbca6677b2a9
equal deleted inserted replaced
7272:1779dc278077 7273:391d6b7b1eff
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.Task</h1> 23 <h1>eric6.Tasks.Task</h1>
24
23 <p> 25 <p>
24 Module implementing a class to store task data. 26 Module implementing a class to store task data.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>None</td></tr> 31 <tr><td>None</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
31 <table> 34
35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#Task">Task</a></td> 38 <td><a href="#Task">Task</a></td>
34 <td>Class implementing the task data structure.</td> 39 <td>Class implementing the task data structure.</td>
35 </tr> 40 </tr>
36 </table> 41 </table>
37 <h3>Functions</h3> 42 <h3>Functions</h3>
43
38 <table> 44 <table>
39 <tr><td>None</td></tr> 45 <tr><td>None</td></tr>
40 </table> 46 </table>
41 <hr /><hr /> 47 <hr />
48 <hr />
42 <a NAME="Task" ID="Task"></a> 49 <a NAME="Task" ID="Task"></a>
43 <h2>Task</h2> 50 <h2>Task</h2>
51
44 <p> 52 <p>
45 Class implementing the task data structure. 53 Class implementing the task data structure.
46 </p> 54 </p>
47 <h3>Derived from</h3> 55 <h3>Derived from</h3>
48 QTreeWidgetItem 56 QTreeWidgetItem
49 <h3>Class Attributes</h3> 57 <h3>Class Attributes</h3>
58
50 <table> 59 <table>
51 <tr><td>TypeFixme</td></tr><tr><td>TypeNone</td></tr><tr><td>TypeNote</td></tr><tr><td>TypeTodo</td></tr><tr><td>TypeWarning</td></tr> 60 <tr><td>TypeFixme</td></tr><tr><td>TypeNone</td></tr><tr><td>TypeNote</td></tr><tr><td>TypeTodo</td></tr><tr><td>TypeWarning</td></tr>
52 </table> 61 </table>
53 <h3>Class Methods</h3> 62 <h3>Class Methods</h3>
63
54 <table> 64 <table>
55 <tr><td>None</td></tr> 65 <tr><td>None</td></tr>
56 </table> 66 </table>
57 <h3>Methods</h3> 67 <h3>Methods</h3>
58 <table> 68
69 <table>
70
59 <tr> 71 <tr>
60 <td><a href="#Task.__init__">Task</a></td> 72 <td><a href="#Task.__init__">Task</a></td>
61 <td>Constructor</td> 73 <td>Constructor</td>
62 </tr><tr> 74 </tr>
75 <tr>
63 <td><a href="#Task.colorizeTask">colorizeTask</a></td> 76 <td><a href="#Task.colorizeTask">colorizeTask</a></td>
64 <td>Public slot to set the colors of the task item.</td> 77 <td>Public slot to set the colors of the task item.</td>
65 </tr><tr> 78 </tr>
79 <tr>
66 <td><a href="#Task.getFilename">getFilename</a></td> 80 <td><a href="#Task.getFilename">getFilename</a></td>
67 <td>Public method to retrieve the task's filename.</td> 81 <td>Public method to retrieve the task's filename.</td>
68 </tr><tr> 82 </tr>
83 <tr>
69 <td><a href="#Task.getLineno">getLineno</a></td> 84 <td><a href="#Task.getLineno">getLineno</a></td>
70 <td>Public method to retrieve the task's linenumber.</td> 85 <td>Public method to retrieve the task's linenumber.</td>
71 </tr><tr> 86 </tr>
87 <tr>
72 <td><a href="#Task.getParentUuid">getParentUuid</a></td> 88 <td><a href="#Task.getParentUuid">getParentUuid</a></td>
73 <td>Public method to get the parent task's uid.</td> 89 <td>Public method to get the parent task's uid.</td>
74 </tr><tr> 90 </tr>
91 <tr>
75 <td><a href="#Task.getUuid">getUuid</a></td> 92 <td><a href="#Task.getUuid">getUuid</a></td>
76 <td>Public method to get the task's uid.</td> 93 <td>Public method to get the task's uid.</td>
77 </tr><tr> 94 </tr>
95 <tr>
78 <td><a href="#Task.isCompleted">isCompleted</a></td> 96 <td><a href="#Task.isCompleted">isCompleted</a></td>
79 <td>Public slot to return the completion status.</td> 97 <td>Public slot to return the completion status.</td>
80 </tr><tr> 98 </tr>
99 <tr>
81 <td><a href="#Task.isFileTask">isFileTask</a></td> 100 <td><a href="#Task.isFileTask">isFileTask</a></td>
82 <td>Public slot to get an indication, if this task is related to a file.</td> 101 <td>Public slot to get an indication, if this task is related to a file.</td>
83 </tr><tr> 102 </tr>
103 <tr>
84 <td><a href="#Task.isProjectFileTask">isProjectFileTask</a></td> 104 <td><a href="#Task.isProjectFileTask">isProjectFileTask</a></td>
85 <td>Public slot to get an indication, if this task is related to a project file.</td> 105 <td>Public slot to get an indication, if this task is related to a project file.</td>
86 </tr><tr> 106 </tr>
107 <tr>
87 <td><a href="#Task.isProjectTask">isProjectTask</a></td> 108 <td><a href="#Task.isProjectTask">isProjectTask</a></td>
88 <td>Public slot to return the project relation status.</td> 109 <td>Public slot to return the project relation status.</td>
89 </tr><tr> 110 </tr>
111 <tr>
90 <td><a href="#Task.setCompleted">setCompleted</a></td> 112 <td><a href="#Task.setCompleted">setCompleted</a></td>
91 <td>Public slot to update the completed flag.</td> 113 <td>Public slot to update the completed flag.</td>
92 </tr><tr> 114 </tr>
115 <tr>
93 <td><a href="#Task.setDescription">setDescription</a></td> 116 <td><a href="#Task.setDescription">setDescription</a></td>
94 <td>Public slot to update the description field.</td> 117 <td>Public slot to update the description field.</td>
95 </tr><tr> 118 </tr>
119 <tr>
96 <td><a href="#Task.setPriority">setPriority</a></td> 120 <td><a href="#Task.setPriority">setPriority</a></td>
97 <td>Public slot to update the priority.</td> 121 <td>Public slot to update the priority.</td>
98 </tr><tr> 122 </tr>
123 <tr>
99 <td><a href="#Task.setProjectTask">setProjectTask</a></td> 124 <td><a href="#Task.setProjectTask">setProjectTask</a></td>
100 <td>Public method to set the project relation flag.</td> 125 <td>Public method to set the project relation flag.</td>
101 </tr><tr> 126 </tr>
127 <tr>
102 <td><a href="#Task.setSummary">setSummary</a></td> 128 <td><a href="#Task.setSummary">setSummary</a></td>
103 <td>Public slot to update the description.</td> 129 <td>Public slot to update the description.</td>
104 </tr> 130 </tr>
105 </table> 131 </table>
106 <h3>Static Methods</h3> 132 <h3>Static Methods</h3>
133
107 <table> 134 <table>
108 <tr><td>None</td></tr> 135 <tr><td>None</td></tr>
109 </table> 136 </table>
137
110 <a NAME="Task.__init__" ID="Task.__init__"></a> 138 <a NAME="Task.__init__" ID="Task.__init__"></a>
111 <h4>Task (Constructor)</h4> 139 <h4>Task (Constructor)</h4>
112 <b>Task</b>(<i>summary, priority=1, filename="", lineno=0, completed=False, _time=0, isProjectTask=False, taskType=TypeTodo, project=None, description="", uid="", parentUid=""</i>) 140 <b>Task</b>(<i>summary, priority=1, filename="", lineno=0, completed=False, _time=0, isProjectTask=False, taskType=TypeTodo, project=None, description="", uid="", parentUid=""</i>)
141
113 <p> 142 <p>
114 Constructor 143 Constructor
115 </p><dl> 144 </p>
145 <dl>
146
116 <dt><i>summary</i></dt> 147 <dt><i>summary</i></dt>
117 <dd> 148 <dd>
118 summary text of the task (string) 149 summary text of the task (string)
119 </dd><dt><i>priority</i></dt> 150 </dd>
151 <dt><i>priority</i></dt>
120 <dd> 152 <dd>
121 priority of the task (0=high, 1=normal, 2=low) 153 priority of the task (0=high, 1=normal, 2=low)
122 </dd><dt><i>filename</i></dt> 154 </dd>
155 <dt><i>filename</i></dt>
123 <dd> 156 <dd>
124 filename containing the task (string) 157 filename containing the task (string)
125 </dd><dt><i>lineno</i></dt> 158 </dd>
159 <dt><i>lineno</i></dt>
126 <dd> 160 <dd>
127 line number containing the task (integer) 161 line number containing the task (integer)
128 </dd><dt><i>completed</i></dt> 162 </dd>
163 <dt><i>completed</i></dt>
129 <dd> 164 <dd>
130 flag indicating completion status (boolean) 165 flag indicating completion status (boolean)
131 </dd><dt><i>_time</i></dt> 166 </dd>
167 <dt><i>_time</i></dt>
132 <dd> 168 <dd>
133 creation time of the task (float, if 0 use current time) 169 creation time of the task (float, if 0 use current time)
134 </dd><dt><i>isProjectTask</i></dt> 170 </dd>
171 <dt><i>isProjectTask</i></dt>
135 <dd> 172 <dd>
136 flag indicating a task related to the current 173 flag indicating a task related to the current
137 project (boolean) 174 project (boolean)
138 </dd><dt><i>taskType</i></dt> 175 </dd>
176 <dt><i>taskType</i></dt>
139 <dd> 177 <dd>
140 type of the task (one of TypeFixme, TypeTodo, 178 type of the task (one of TypeFixme, TypeTodo,
141 TypeWarning, TypeNote) 179 TypeWarning, TypeNote)
142 </dd><dt><i>project</i></dt> 180 </dd>
181 <dt><i>project</i></dt>
143 <dd> 182 <dd>
144 reference to the project object (Project) 183 reference to the project object (Project)
145 </dd><dt><i>description</i></dt> 184 </dd>
185 <dt><i>description</i></dt>
146 <dd> 186 <dd>
147 explanatory text of the task (string) 187 explanatory text of the task (string)
148 </dd><dt><i>uid</i></dt> 188 </dd>
189 <dt><i>uid</i></dt>
149 <dd> 190 <dd>
150 unique id of the task (string) 191 unique id of the task (string)
151 </dd><dt><i>parentUid</i></dt> 192 </dd>
193 <dt><i>parentUid</i></dt>
152 <dd> 194 <dd>
153 unique id of the parent task (string) 195 unique id of the parent task (string)
154 </dd> 196 </dd>
155 </dl><a NAME="Task.colorizeTask" ID="Task.colorizeTask"></a> 197 </dl>
198 <a NAME="Task.colorizeTask" ID="Task.colorizeTask"></a>
156 <h4>Task.colorizeTask</h4> 199 <h4>Task.colorizeTask</h4>
157 <b>colorizeTask</b>(<i></i>) 200 <b>colorizeTask</b>(<i></i>)
201
158 <p> 202 <p>
159 Public slot to set the colors of the task item. 203 Public slot to set the colors of the task item.
160 </p><a NAME="Task.getFilename" ID="Task.getFilename"></a> 204 </p>
205 <a NAME="Task.getFilename" ID="Task.getFilename"></a>
161 <h4>Task.getFilename</h4> 206 <h4>Task.getFilename</h4>
162 <b>getFilename</b>(<i></i>) 207 <b>getFilename</b>(<i></i>)
208
163 <p> 209 <p>
164 Public method to retrieve the task's filename. 210 Public method to retrieve the task's filename.
165 </p><dl> 211 </p>
212 <dl>
166 <dt>Returns:</dt> 213 <dt>Returns:</dt>
167 <dd> 214 <dd>
168 filename (string) 215 filename (string)
169 </dd> 216 </dd>
170 </dl><a NAME="Task.getLineno" ID="Task.getLineno"></a> 217 </dl>
218 <a NAME="Task.getLineno" ID="Task.getLineno"></a>
171 <h4>Task.getLineno</h4> 219 <h4>Task.getLineno</h4>
172 <b>getLineno</b>(<i></i>) 220 <b>getLineno</b>(<i></i>)
221
173 <p> 222 <p>
174 Public method to retrieve the task's linenumber. 223 Public method to retrieve the task's linenumber.
175 </p><dl> 224 </p>
225 <dl>
176 <dt>Returns:</dt> 226 <dt>Returns:</dt>
177 <dd> 227 <dd>
178 linenumber (integer) 228 linenumber (integer)
179 </dd> 229 </dd>
180 </dl><a NAME="Task.getParentUuid" ID="Task.getParentUuid"></a> 230 </dl>
231 <a NAME="Task.getParentUuid" ID="Task.getParentUuid"></a>
181 <h4>Task.getParentUuid</h4> 232 <h4>Task.getParentUuid</h4>
182 <b>getParentUuid</b>(<i></i>) 233 <b>getParentUuid</b>(<i></i>)
234
183 <p> 235 <p>
184 Public method to get the parent task's uid. 236 Public method to get the parent task's uid.
185 </p><dl> 237 </p>
238 <dl>
186 <dt>Returns:</dt> 239 <dt>Returns:</dt>
187 <dd> 240 <dd>
188 parent uid (string) 241 parent uid (string)
189 </dd> 242 </dd>
190 </dl><a NAME="Task.getUuid" ID="Task.getUuid"></a> 243 </dl>
244 <a NAME="Task.getUuid" ID="Task.getUuid"></a>
191 <h4>Task.getUuid</h4> 245 <h4>Task.getUuid</h4>
192 <b>getUuid</b>(<i></i>) 246 <b>getUuid</b>(<i></i>)
247
193 <p> 248 <p>
194 Public method to get the task's uid. 249 Public method to get the task's uid.
195 </p><dl> 250 </p>
251 <dl>
196 <dt>Returns:</dt> 252 <dt>Returns:</dt>
197 <dd> 253 <dd>
198 uid (string) 254 uid (string)
199 </dd> 255 </dd>
200 </dl><a NAME="Task.isCompleted" ID="Task.isCompleted"></a> 256 </dl>
257 <a NAME="Task.isCompleted" ID="Task.isCompleted"></a>
201 <h4>Task.isCompleted</h4> 258 <h4>Task.isCompleted</h4>
202 <b>isCompleted</b>(<i></i>) 259 <b>isCompleted</b>(<i></i>)
260
203 <p> 261 <p>
204 Public slot to return the completion status. 262 Public slot to return the completion status.
205 </p><dl> 263 </p>
264 <dl>
206 <dt>Returns:</dt> 265 <dt>Returns:</dt>
207 <dd> 266 <dd>
208 flag indicating the completion status (boolean) 267 flag indicating the completion status (boolean)
209 </dd> 268 </dd>
210 </dl><a NAME="Task.isFileTask" ID="Task.isFileTask"></a> 269 </dl>
270 <a NAME="Task.isFileTask" ID="Task.isFileTask"></a>
211 <h4>Task.isFileTask</h4> 271 <h4>Task.isFileTask</h4>
212 <b>isFileTask</b>(<i></i>) 272 <b>isFileTask</b>(<i></i>)
273
213 <p> 274 <p>
214 Public slot to get an indication, if this task is related to a file. 275 Public slot to get an indication, if this task is related to a file.
215 </p><dl> 276 </p>
277 <dl>
216 <dt>Returns:</dt> 278 <dt>Returns:</dt>
217 <dd> 279 <dd>
218 flag indicating a file task (boolean) 280 flag indicating a file task (boolean)
219 </dd> 281 </dd>
220 </dl><a NAME="Task.isProjectFileTask" ID="Task.isProjectFileTask"></a> 282 </dl>
283 <a NAME="Task.isProjectFileTask" ID="Task.isProjectFileTask"></a>
221 <h4>Task.isProjectFileTask</h4> 284 <h4>Task.isProjectFileTask</h4>
222 <b>isProjectFileTask</b>(<i></i>) 285 <b>isProjectFileTask</b>(<i></i>)
286
223 <p> 287 <p>
224 Public slot to get an indication, if this task is related to a 288 Public slot to get an indication, if this task is related to a
225 project file. 289 project file.
226 </p><dl> 290 </p>
291 <dl>
227 <dt>Returns:</dt> 292 <dt>Returns:</dt>
228 <dd> 293 <dd>
229 flag indicating a project file task (boolean) 294 flag indicating a project file task (boolean)
230 </dd> 295 </dd>
231 </dl><a NAME="Task.isProjectTask" ID="Task.isProjectTask"></a> 296 </dl>
297 <a NAME="Task.isProjectTask" ID="Task.isProjectTask"></a>
232 <h4>Task.isProjectTask</h4> 298 <h4>Task.isProjectTask</h4>
233 <b>isProjectTask</b>(<i></i>) 299 <b>isProjectTask</b>(<i></i>)
300
234 <p> 301 <p>
235 Public slot to return the project relation status. 302 Public slot to return the project relation status.
236 </p><dl> 303 </p>
304 <dl>
237 <dt>Returns:</dt> 305 <dt>Returns:</dt>
238 <dd> 306 <dd>
239 flag indicating the project relation status (boolean) 307 flag indicating the project relation status (boolean)
240 </dd> 308 </dd>
241 </dl><a NAME="Task.setCompleted" ID="Task.setCompleted"></a> 309 </dl>
310 <a NAME="Task.setCompleted" ID="Task.setCompleted"></a>
242 <h4>Task.setCompleted</h4> 311 <h4>Task.setCompleted</h4>
243 <b>setCompleted</b>(<i>completed</i>) 312 <b>setCompleted</b>(<i>completed</i>)
313
244 <p> 314 <p>
245 Public slot to update the completed flag. 315 Public slot to update the completed flag.
246 </p><dl> 316 </p>
317 <dl>
318
247 <dt><i>completed</i></dt> 319 <dt><i>completed</i></dt>
248 <dd> 320 <dd>
249 flag indicating completion status (boolean) 321 flag indicating completion status (boolean)
250 </dd> 322 </dd>
251 </dl><a NAME="Task.setDescription" ID="Task.setDescription"></a> 323 </dl>
324 <a NAME="Task.setDescription" ID="Task.setDescription"></a>
252 <h4>Task.setDescription</h4> 325 <h4>Task.setDescription</h4>
253 <b>setDescription</b>(<i>description</i>) 326 <b>setDescription</b>(<i>description</i>)
327
254 <p> 328 <p>
255 Public slot to update the description field. 329 Public slot to update the description field.
256 </p><dl> 330 </p>
331 <dl>
332
257 <dt><i>description</i></dt> 333 <dt><i>description</i></dt>
258 <dd> 334 <dd>
259 descriptive text of the task (string) 335 descriptive text of the task (string)
260 </dd> 336 </dd>
261 </dl><a NAME="Task.setPriority" ID="Task.setPriority"></a> 337 </dl>
338 <a NAME="Task.setPriority" ID="Task.setPriority"></a>
262 <h4>Task.setPriority</h4> 339 <h4>Task.setPriority</h4>
263 <b>setPriority</b>(<i>priority</i>) 340 <b>setPriority</b>(<i>priority</i>)
341
264 <p> 342 <p>
265 Public slot to update the priority. 343 Public slot to update the priority.
266 </p><dl> 344 </p>
345 <dl>
346
267 <dt><i>priority</i></dt> 347 <dt><i>priority</i></dt>
268 <dd> 348 <dd>
269 priority of the task (0=high, 1=normal, 2=low) 349 priority of the task (0=high, 1=normal, 2=low)
270 </dd> 350 </dd>
271 </dl><a NAME="Task.setProjectTask" ID="Task.setProjectTask"></a> 351 </dl>
352 <a NAME="Task.setProjectTask" ID="Task.setProjectTask"></a>
272 <h4>Task.setProjectTask</h4> 353 <h4>Task.setProjectTask</h4>
273 <b>setProjectTask</b>(<i>pt</i>) 354 <b>setProjectTask</b>(<i>pt</i>)
355
274 <p> 356 <p>
275 Public method to set the project relation flag. 357 Public method to set the project relation flag.
276 </p><dl> 358 </p>
359 <dl>
360
277 <dt><i>pt</i></dt> 361 <dt><i>pt</i></dt>
278 <dd> 362 <dd>
279 flag indicating a project task (boolean) 363 flag indicating a project task (boolean)
280 </dd> 364 </dd>
281 </dl><a NAME="Task.setSummary" ID="Task.setSummary"></a> 365 </dl>
366 <a NAME="Task.setSummary" ID="Task.setSummary"></a>
282 <h4>Task.setSummary</h4> 367 <h4>Task.setSummary</h4>
283 <b>setSummary</b>(<i>summary</i>) 368 <b>setSummary</b>(<i>summary</i>)
369
284 <p> 370 <p>
285 Public slot to update the description. 371 Public slot to update the description.
286 </p><dl> 372 </p>
373 <dl>
374
287 <dt><i>summary</i></dt> 375 <dt><i>summary</i></dt>
288 <dd> 376 <dd>
289 summary text of the task (string) 377 summary text of the task (string)
290 </dd> 378 </dd>
291 </dl> 379 </dl>

Mercurial Repository: eric

eric ide

mercurial