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

branch
eric7
changeset 10431
64157aeb0312
parent 9236
db53a9efe7ef
child 10479
856476537696
equal deleted inserted replaced
10430:e440aaf179ce 10431:64157aeb0312
211 Public method to retrieve the task's filename. 211 Public method to retrieve the task's filename.
212 </p> 212 </p>
213 <dl> 213 <dl>
214 <dt>Return:</dt> 214 <dt>Return:</dt>
215 <dd> 215 <dd>
216 filename (string) 216 filename
217 </dd>
218 </dl>
219 <dl>
220 <dt>Return Type:</dt>
221 <dd>
222 str
217 </dd> 223 </dd>
218 </dl> 224 </dl>
219 <a NAME="Task.getLineno" ID="Task.getLineno"></a> 225 <a NAME="Task.getLineno" ID="Task.getLineno"></a>
220 <h4>Task.getLineno</h4> 226 <h4>Task.getLineno</h4>
221 <b>getLineno</b>(<i></i>) 227 <b>getLineno</b>(<i></i>)
224 Public method to retrieve the task's linenumber. 230 Public method to retrieve the task's linenumber.
225 </p> 231 </p>
226 <dl> 232 <dl>
227 <dt>Return:</dt> 233 <dt>Return:</dt>
228 <dd> 234 <dd>
229 linenumber (integer) 235 linenumber
236 </dd>
237 </dl>
238 <dl>
239 <dt>Return Type:</dt>
240 <dd>
241 int
230 </dd> 242 </dd>
231 </dl> 243 </dl>
232 <a NAME="Task.getParentUuid" ID="Task.getParentUuid"></a> 244 <a NAME="Task.getParentUuid" ID="Task.getParentUuid"></a>
233 <h4>Task.getParentUuid</h4> 245 <h4>Task.getParentUuid</h4>
234 <b>getParentUuid</b>(<i></i>) 246 <b>getParentUuid</b>(<i></i>)
237 Public method to get the parent task's uid. 249 Public method to get the parent task's uid.
238 </p> 250 </p>
239 <dl> 251 <dl>
240 <dt>Return:</dt> 252 <dt>Return:</dt>
241 <dd> 253 <dd>
242 parent uid (string) 254 parent uid
255 </dd>
256 </dl>
257 <dl>
258 <dt>Return Type:</dt>
259 <dd>
260 str
243 </dd> 261 </dd>
244 </dl> 262 </dl>
245 <a NAME="Task.getUuid" ID="Task.getUuid"></a> 263 <a NAME="Task.getUuid" ID="Task.getUuid"></a>
246 <h4>Task.getUuid</h4> 264 <h4>Task.getUuid</h4>
247 <b>getUuid</b>(<i></i>) 265 <b>getUuid</b>(<i></i>)
250 Public method to get the task's uid. 268 Public method to get the task's uid.
251 </p> 269 </p>
252 <dl> 270 <dl>
253 <dt>Return:</dt> 271 <dt>Return:</dt>
254 <dd> 272 <dd>
255 uid (string) 273 uid
274 </dd>
275 </dl>
276 <dl>
277 <dt>Return Type:</dt>
278 <dd>
279 str
256 </dd> 280 </dd>
257 </dl> 281 </dl>
258 <a NAME="Task.isCompleted" ID="Task.isCompleted"></a> 282 <a NAME="Task.isCompleted" ID="Task.isCompleted"></a>
259 <h4>Task.isCompleted</h4> 283 <h4>Task.isCompleted</h4>
260 <b>isCompleted</b>(<i></i>) 284 <b>isCompleted</b>(<i></i>)
263 Public slot to return the completion status. 287 Public slot to return the completion status.
264 </p> 288 </p>
265 <dl> 289 <dl>
266 <dt>Return:</dt> 290 <dt>Return:</dt>
267 <dd> 291 <dd>
268 flag indicating the completion status (boolean) 292 flag indicating the completion status
293 </dd>
294 </dl>
295 <dl>
296 <dt>Return Type:</dt>
297 <dd>
298 bool
269 </dd> 299 </dd>
270 </dl> 300 </dl>
271 <a NAME="Task.isFileTask" ID="Task.isFileTask"></a> 301 <a NAME="Task.isFileTask" ID="Task.isFileTask"></a>
272 <h4>Task.isFileTask</h4> 302 <h4>Task.isFileTask</h4>
273 <b>isFileTask</b>(<i></i>) 303 <b>isFileTask</b>(<i></i>)
276 Public slot to get an indication, if this task is related to a file. 306 Public slot to get an indication, if this task is related to a file.
277 </p> 307 </p>
278 <dl> 308 <dl>
279 <dt>Return:</dt> 309 <dt>Return:</dt>
280 <dd> 310 <dd>
281 flag indicating a file task (boolean) 311 flag indicating a file task
312 </dd>
313 </dl>
314 <dl>
315 <dt>Return Type:</dt>
316 <dd>
317 bool
282 </dd> 318 </dd>
283 </dl> 319 </dl>
284 <a NAME="Task.isProjectFileTask" ID="Task.isProjectFileTask"></a> 320 <a NAME="Task.isProjectFileTask" ID="Task.isProjectFileTask"></a>
285 <h4>Task.isProjectFileTask</h4> 321 <h4>Task.isProjectFileTask</h4>
286 <b>isProjectFileTask</b>(<i></i>) 322 <b>isProjectFileTask</b>(<i></i>)
290 project file. 326 project file.
291 </p> 327 </p>
292 <dl> 328 <dl>
293 <dt>Return:</dt> 329 <dt>Return:</dt>
294 <dd> 330 <dd>
295 flag indicating a project file task (boolean) 331 flag indicating a project file task
332 </dd>
333 </dl>
334 <dl>
335 <dt>Return Type:</dt>
336 <dd>
337 bool
296 </dd> 338 </dd>
297 </dl> 339 </dl>
298 <a NAME="Task.isProjectTask" ID="Task.isProjectTask"></a> 340 <a NAME="Task.isProjectTask" ID="Task.isProjectTask"></a>
299 <h4>Task.isProjectTask</h4> 341 <h4>Task.isProjectTask</h4>
300 <b>isProjectTask</b>(<i></i>) 342 <b>isProjectTask</b>(<i></i>)
303 Public slot to return the project relation status. 345 Public slot to return the project relation status.
304 </p> 346 </p>
305 <dl> 347 <dl>
306 <dt>Return:</dt> 348 <dt>Return:</dt>
307 <dd> 349 <dd>
308 flag indicating the project relation status (boolean) 350 flag indicating the project relation status
351 </dd>
352 </dl>
353 <dl>
354 <dt>Return Type:</dt>
355 <dd>
356 bool
309 </dd> 357 </dd>
310 </dl> 358 </dl>
311 <a NAME="Task.setCompleted" ID="Task.setCompleted"></a> 359 <a NAME="Task.setCompleted" ID="Task.setCompleted"></a>
312 <h4>Task.setCompleted</h4> 360 <h4>Task.setCompleted</h4>
313 <b>setCompleted</b>(<i>completed</i>) 361 <b>setCompleted</b>(<i>completed</i>)
315 <p> 363 <p>
316 Public slot to update the completed flag. 364 Public slot to update the completed flag.
317 </p> 365 </p>
318 <dl> 366 <dl>
319 367
320 <dt><i>completed</i></dt> 368 <dt><i>completed</i> (bool)</dt>
321 <dd> 369 <dd>
322 flag indicating completion status (boolean) 370 flag indicating completion status
323 </dd> 371 </dd>
324 </dl> 372 </dl>
325 <a NAME="Task.setDescription" ID="Task.setDescription"></a> 373 <a NAME="Task.setDescription" ID="Task.setDescription"></a>
326 <h4>Task.setDescription</h4> 374 <h4>Task.setDescription</h4>
327 <b>setDescription</b>(<i>description</i>) 375 <b>setDescription</b>(<i>description</i>)
357 <p> 405 <p>
358 Public method to set the project relation flag. 406 Public method to set the project relation flag.
359 </p> 407 </p>
360 <dl> 408 <dl>
361 409
362 <dt><i>pt</i></dt> 410 <dt><i>pt</i> (bool)</dt>
363 <dd> 411 <dd>
364 flag indicating a project task (boolean) 412 flag indicating a project task
365 </dd> 413 </dd>
366 </dl> 414 </dl>
367 <a NAME="Task.setSummary" ID="Task.setSummary"></a> 415 <a NAME="Task.setSummary" ID="Task.setSummary"></a>
368 <h4>Task.setSummary</h4> 416 <h4>Task.setSummary</h4>
369 <b>setSummary</b>(<i>summary</i>) 417 <b>setSummary</b>(<i>summary</i>)
371 <p> 419 <p>
372 Public slot to update the description. 420 Public slot to update the description.
373 </p> 421 </p>
374 <dl> 422 <dl>
375 423
376 <dt><i>summary</i></dt> 424 <dt><i>summary</i> (str)</dt>
377 <dd> 425 <dd>
378 summary text of the task (string) 426 summary text of the task
379 </dd> 427 </dd>
380 </dl> 428 </dl>
381 <a NAME="Task.setTaskType" ID="Task.setTaskType"></a> 429 <a NAME="Task.setTaskType" ID="Task.setTaskType"></a>
382 <h4>Task.setTaskType</h4> 430 <h4>Task.setTaskType</h4>
383 <b>setTaskType</b>(<i>taskType</i>) 431 <b>setTaskType</b>(<i>taskType</i>)

eric ide

mercurial