Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Tasks.TaskViewer.html
src/eric7/Documentation/Source/eric7.Tasks.TaskViewer.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8664
- 5aa1070daa48
- child 9236
- db53a9efe7ef
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.Tasks.TaskViewer</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.Tasks.TaskViewer</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a task viewer and associated classes. | |
| 13 </p> | |
| 14 <p> | |
| 15 Tasks can be defined manually or automatically. Automatically | |
| 16 generated tasks are derived from a comment with a special | |
| 17 introductory text. This text is configurable. | |
| 18 </p> | |
| 19 <h3>Global Attributes</h3> | |
| 20 | |
| 21 <table> | |
| 22 <tr><td>None</td></tr> | |
| 23 </table> | |
| 24 <h3>Classes</h3> | |
| 25 | |
| 26 <table> | |
| 27 | |
| 28 <tr> | |
| 29 <td><a href="#ProjectTaskExtractionThread">ProjectTaskExtractionThread</a></td> | |
| 30 <td>Class implementing a thread to extract tasks related to a project.</td> | |
| 31 </tr> | |
| 32 <tr> | |
| 33 <td><a href="#TaskViewer">TaskViewer</a></td> | |
| 34 <td>Class implementing the task viewer.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <h3>Functions</h3> | |
| 38 | |
| 39 <table> | |
| 40 <tr><td>None</td></tr> | |
| 41 </table> | |
| 42 <hr /> | |
| 43 <hr /> | |
| 44 <a NAME="ProjectTaskExtractionThread" ID="ProjectTaskExtractionThread"></a> | |
| 45 <h2>ProjectTaskExtractionThread</h2> | |
| 46 | |
| 47 <p> | |
| 48 Class implementing a thread to extract tasks related to a project. | |
| 49 </p> | |
| 50 <h3>Signals</h3> | |
| 51 <dl> | |
| 52 | |
| 53 <dt>taskFound(str, str, int, TaskType)</dt> | |
| 54 <dd> | |
| 55 emitted with the task | |
| 56 description, the file name, the line number and task type to signal | |
| 57 the presence of a task | |
| 58 </dd> | |
| 59 </dl> | |
| 60 <h3>Derived from</h3> | |
| 61 QThread | |
| 62 <h3>Class Attributes</h3> | |
| 63 | |
| 64 <table> | |
| 65 <tr><td>None</td></tr> | |
| 66 </table> | |
| 67 <h3>Class Methods</h3> | |
| 68 | |
| 69 <table> | |
| 70 <tr><td>None</td></tr> | |
| 71 </table> | |
| 72 <h3>Methods</h3> | |
| 73 | |
| 74 <table> | |
| 75 | |
| 76 <tr> | |
| 77 <td><a href="#ProjectTaskExtractionThread.__init__">ProjectTaskExtractionThread</a></td> | |
| 78 <td>Constructor</td> | |
| 79 </tr> | |
| 80 <tr> | |
| 81 <td><a href="#ProjectTaskExtractionThread.requestInterrupt">requestInterrupt</a></td> | |
| 82 <td>Public method to request iterruption of the thread.</td> | |
| 83 </tr> | |
| 84 <tr> | |
| 85 <td><a href="#ProjectTaskExtractionThread.run">run</a></td> | |
| 86 <td>Public thread method to scan the given files.</td> | |
| 87 </tr> | |
| 88 <tr> | |
| 89 <td><a href="#ProjectTaskExtractionThread.scan">scan</a></td> | |
| 90 <td>Public method to scan the given list of files for tasks.</td> | |
| 91 </tr> | |
| 92 </table> | |
| 93 <h3>Static Methods</h3> | |
| 94 | |
| 95 <table> | |
| 96 <tr><td>None</td></tr> | |
| 97 </table> | |
| 98 | |
| 99 <a NAME="ProjectTaskExtractionThread.__init__" ID="ProjectTaskExtractionThread.__init__"></a> | |
| 100 <h4>ProjectTaskExtractionThread (Constructor)</h4> | |
| 101 <b>ProjectTaskExtractionThread</b>(<i>parent=None</i>) | |
| 102 | |
| 103 <p> | |
| 104 Constructor | |
| 105 </p> | |
| 106 <dl> | |
| 107 | |
| 108 <dt><i>parent</i></dt> | |
| 109 <dd> | |
| 110 reference to the parent object (QObject) | |
| 111 </dd> | |
| 112 </dl> | |
| 113 <a NAME="ProjectTaskExtractionThread.requestInterrupt" ID="ProjectTaskExtractionThread.requestInterrupt"></a> | |
| 114 <h4>ProjectTaskExtractionThread.requestInterrupt</h4> | |
| 115 <b>requestInterrupt</b>(<i></i>) | |
| 116 | |
| 117 <p> | |
| 118 Public method to request iterruption of the thread. | |
| 119 </p> | |
| 120 <a NAME="ProjectTaskExtractionThread.run" ID="ProjectTaskExtractionThread.run"></a> | |
| 121 <h4>ProjectTaskExtractionThread.run</h4> | |
| 122 <b>run</b>(<i></i>) | |
| 123 | |
| 124 <p> | |
| 125 Public thread method to scan the given files. | |
| 126 </p> | |
| 127 <a NAME="ProjectTaskExtractionThread.scan" ID="ProjectTaskExtractionThread.scan"></a> | |
| 128 <h4>ProjectTaskExtractionThread.scan</h4> | |
| 129 <b>scan</b>(<i>markers, files</i>) | |
| 130 | |
| 131 <p> | |
| 132 Public method to scan the given list of files for tasks. | |
| 133 </p> | |
| 134 <dl> | |
| 135 | |
| 136 <dt><i>markers</i> (dict of lists of str)</dt> | |
| 137 <dd> | |
| 138 dictionary of defined task markers | |
| 139 </dd> | |
| 140 <dt><i>files</i> (list of str)</dt> | |
| 141 <dd> | |
| 142 list of file names to be scanned | |
| 143 </dd> | |
| 144 </dl> | |
| 145 <div align="right"><a href="#top">Up</a></div> | |
| 146 <hr /> | |
| 147 <hr /> | |
| 148 <a NAME="TaskViewer" ID="TaskViewer"></a> | |
| 149 <h2>TaskViewer</h2> | |
| 150 | |
| 151 <p> | |
| 152 Class implementing the task viewer. | |
| 153 </p> | |
| 154 <h3>Signals</h3> | |
| 155 <dl> | |
| 156 | |
| 157 <dt>displayFile(str, int)</dt> | |
| 158 <dd> | |
| 159 emitted to go to a file task | |
| 160 </dd> | |
| 161 </dl> | |
| 162 <h3>Derived from</h3> | |
| 163 QTreeWidget | |
| 164 <h3>Class Attributes</h3> | |
| 165 | |
| 166 <table> | |
| 167 <tr><td>None</td></tr> | |
| 168 </table> | |
| 169 <h3>Class Methods</h3> | |
| 170 | |
| 171 <table> | |
| 172 <tr><td>None</td></tr> | |
| 173 </table> | |
| 174 <h3>Methods</h3> | |
| 175 | |
| 176 <table> | |
| 177 | |
| 178 <tr> | |
| 179 <td><a href="#TaskViewer.__init__">TaskViewer</a></td> | |
| 180 <td>Constructor</td> | |
| 181 </tr> | |
| 182 <tr> | |
| 183 <td><a href="#TaskViewer.__activateFilter">__activateFilter</a></td> | |
| 184 <td>Private slot to handle the "Filtered display" context menu entry.</td> | |
| 185 </tr> | |
| 186 <tr> | |
| 187 <td><a href="#TaskViewer.__checkTopLevelItems">__checkTopLevelItems</a></td> | |
| 188 <td>Private slot to check the 'Extracted Tasks' item for children.</td> | |
| 189 </tr> | |
| 190 <tr> | |
| 191 <td><a href="#TaskViewer.__configure">__configure</a></td> | |
| 192 <td>Private method to open the configuration dialog.</td> | |
| 193 </tr> | |
| 194 <tr> | |
| 195 <td><a href="#TaskViewer.__configureFilter">__configureFilter</a></td> | |
| 196 <td>Private slot to handle the "Configure filter" context menu entry.</td> | |
| 197 </tr> | |
| 198 <tr> | |
| 199 <td><a href="#TaskViewer.__configureProjectTasksScanOptions">__configureProjectTasksScanOptions</a></td> | |
| 200 <td>Private slot to configure scan options for project tasks.</td> | |
| 201 </tr> | |
| 202 <tr> | |
| 203 <td><a href="#TaskViewer.__copyTask">__copyTask</a></td> | |
| 204 <td>Private slot to handle the "Copy" context menu entry.</td> | |
| 205 </tr> | |
| 206 <tr> | |
| 207 <td><a href="#TaskViewer.__deleteCompleted">__deleteCompleted</a></td> | |
| 208 <td>Private slot to handle the "Delete Completed Tasks" context menu entry.</td> | |
| 209 </tr> | |
| 210 <tr> | |
| 211 <td><a href="#TaskViewer.__deleteSubTasks">__deleteSubTasks</a></td> | |
| 212 <td>Private method to delete all sub-tasks.</td> | |
| 213 </tr> | |
| 214 <tr> | |
| 215 <td><a href="#TaskViewer.__deleteTask">__deleteTask</a></td> | |
| 216 <td>Private slot to delete a task.</td> | |
| 217 </tr> | |
| 218 <tr> | |
| 219 <td><a href="#TaskViewer.__editTaskProperties">__editTaskProperties</a></td> | |
| 220 <td>Private slot to handle the "Properties" context menu entry.</td> | |
| 221 </tr> | |
| 222 <tr> | |
| 223 <td><a href="#TaskViewer.__generateTopLevelItems">__generateTopLevelItems</a></td> | |
| 224 <td>Private method to generate the 'Extracted Tasks' item.</td> | |
| 225 </tr> | |
| 226 <tr> | |
| 227 <td><a href="#TaskViewer.__goToTask">__goToTask</a></td> | |
| 228 <td>Private slot to handle the "Go To" context menu entry.</td> | |
| 229 </tr> | |
| 230 <tr> | |
| 231 <td><a href="#TaskViewer.__markCompleted">__markCompleted</a></td> | |
| 232 <td>Private slot to handle the "Mark Completed" context menu entry.</td> | |
| 233 </tr> | |
| 234 <tr> | |
| 235 <td><a href="#TaskViewer.__newSubTask">__newSubTask</a></td> | |
| 236 <td>Private slot to handle the "New Sub-Task" context menu entry.</td> | |
| 237 </tr> | |
| 238 <tr> | |
| 239 <td><a href="#TaskViewer.__newTask">__newTask</a></td> | |
| 240 <td>Private slot to handle the "New Task" context menu entry.</td> | |
| 241 </tr> | |
| 242 <tr> | |
| 243 <td><a href="#TaskViewer.__pasteMainTask">__pasteMainTask</a></td> | |
| 244 <td>Private slot to handle the "Paste as Main Task" context menu entry.</td> | |
| 245 </tr> | |
| 246 <tr> | |
| 247 <td><a href="#TaskViewer.__pasteTask">__pasteTask</a></td> | |
| 248 <td>Private slot to handle the "Paste" context menu entry.</td> | |
| 249 </tr> | |
| 250 <tr> | |
| 251 <td><a href="#TaskViewer.__refreshDisplay">__refreshDisplay</a></td> | |
| 252 <td>Private method to refresh the display.</td> | |
| 253 </tr> | |
| 254 <tr> | |
| 255 <td><a href="#TaskViewer.__resizeColumns">__resizeColumns</a></td> | |
| 256 <td>Private method to resize the list columns.</td> | |
| 257 </tr> | |
| 258 <tr> | |
| 259 <td><a href="#TaskViewer.__resort">__resort</a></td> | |
| 260 <td>Private method to resort the tree.</td> | |
| 261 </tr> | |
| 262 <tr> | |
| 263 <td><a href="#TaskViewer.__showContextMenu">__showContextMenu</a></td> | |
| 264 <td>Private slot to show the context menu of the list.</td> | |
| 265 </tr> | |
| 266 <tr> | |
| 267 <td><a href="#TaskViewer.__taskItemActivated">__taskItemActivated</a></td> | |
| 268 <td>Private slot to handle the activation of an item.</td> | |
| 269 </tr> | |
| 270 <tr> | |
| 271 <td><a href="#TaskViewer.addFileTask">addFileTask</a></td> | |
| 272 <td>Public slot to add a file related task.</td> | |
| 273 </tr> | |
| 274 <tr> | |
| 275 <td><a href="#TaskViewer.addTask">addTask</a></td> | |
| 276 <td>Public slot to add a task.</td> | |
| 277 </tr> | |
| 278 <tr> | |
| 279 <td><a href="#TaskViewer.clearFileTasks">clearFileTasks</a></td> | |
| 280 <td>Public slot to clear all tasks related to a file.</td> | |
| 281 </tr> | |
| 282 <tr> | |
| 283 <td><a href="#TaskViewer.clearProjectTasks">clearProjectTasks</a></td> | |
| 284 <td>Public slot to clear project related tasks.</td> | |
| 285 </tr> | |
| 286 <tr> | |
| 287 <td><a href="#TaskViewer.clearTasks">clearTasks</a></td> | |
| 288 <td>Public slot to clear all tasks from display.</td> | |
| 289 </tr> | |
| 290 <tr> | |
| 291 <td><a href="#TaskViewer.containsTask">containsTask</a></td> | |
| 292 <td>Public method to test, if a task is already in the tasks list.</td> | |
| 293 </tr> | |
| 294 <tr> | |
| 295 <td><a href="#TaskViewer.findParentTask">findParentTask</a></td> | |
| 296 <td>Public method to find a parent task by its ID.</td> | |
| 297 </tr> | |
| 298 <tr> | |
| 299 <td><a href="#TaskViewer.getGlobalTasks">getGlobalTasks</a></td> | |
| 300 <td>Public method to retrieve all non project related tasks.</td> | |
| 301 </tr> | |
| 302 <tr> | |
| 303 <td><a href="#TaskViewer.getProjectTasks">getProjectTasks</a></td> | |
| 304 <td>Public method to retrieve all project related tasks.</td> | |
| 305 </tr> | |
| 306 <tr> | |
| 307 <td><a href="#TaskViewer.getTasksScanFilter">getTasksScanFilter</a></td> | |
| 308 <td>Public method to get the project scan filter.</td> | |
| 309 </tr> | |
| 310 <tr> | |
| 311 <td><a href="#TaskViewer.handlePreferencesChanged">handlePreferencesChanged</a></td> | |
| 312 <td>Public slot to react to changes of the preferences.</td> | |
| 313 </tr> | |
| 314 <tr> | |
| 315 <td><a href="#TaskViewer.regenerateProjectTasks">regenerateProjectTasks</a></td> | |
| 316 <td>Public slot to regenerate project related tasks.</td> | |
| 317 </tr> | |
| 318 <tr> | |
| 319 <td><a href="#TaskViewer.saveProjectTasks">saveProjectTasks</a></td> | |
| 320 <td>Public method to write the project tasks.</td> | |
| 321 </tr> | |
| 322 <tr> | |
| 323 <td><a href="#TaskViewer.setProjectOpen">setProjectOpen</a></td> | |
| 324 <td>Public slot to set the project status.</td> | |
| 325 </tr> | |
| 326 <tr> | |
| 327 <td><a href="#TaskViewer.setTasksScanFilter">setTasksScanFilter</a></td> | |
| 328 <td>Public method to set the project scan filter.</td> | |
| 329 </tr> | |
| 330 <tr> | |
| 331 <td><a href="#TaskViewer.stopProjectTaskExtraction">stopProjectTaskExtraction</a></td> | |
| 332 <td>Public method to stop the project task extraction thread.</td> | |
| 333 </tr> | |
| 334 </table> | |
| 335 <h3>Static Methods</h3> | |
| 336 | |
| 337 <table> | |
| 338 <tr><td>None</td></tr> | |
| 339 </table> | |
| 340 | |
| 341 <a NAME="TaskViewer.__init__" ID="TaskViewer.__init__"></a> | |
| 342 <h4>TaskViewer (Constructor)</h4> | |
| 343 <b>TaskViewer</b>(<i>parent, project</i>) | |
| 344 | |
| 345 <p> | |
| 346 Constructor | |
| 347 </p> | |
| 348 <dl> | |
| 349 | |
| 350 <dt><i>parent</i></dt> | |
| 351 <dd> | |
| 352 the parent (QWidget) | |
| 353 </dd> | |
| 354 <dt><i>project</i></dt> | |
| 355 <dd> | |
| 356 reference to the project object | |
| 357 </dd> | |
| 358 </dl> | |
| 359 <a NAME="TaskViewer.__activateFilter" ID="TaskViewer.__activateFilter"></a> | |
| 360 <h4>TaskViewer.__activateFilter</h4> | |
| 361 <b>__activateFilter</b>(<i>on</i>) | |
| 362 | |
| 363 <p> | |
| 364 Private slot to handle the "Filtered display" context menu entry. | |
| 365 </p> | |
| 366 <dl> | |
| 367 | |
| 368 <dt><i>on</i></dt> | |
| 369 <dd> | |
| 370 flag indicating the filter state (boolean) | |
| 371 </dd> | |
| 372 </dl> | |
| 373 <a NAME="TaskViewer.__checkTopLevelItems" ID="TaskViewer.__checkTopLevelItems"></a> | |
| 374 <h4>TaskViewer.__checkTopLevelItems</h4> | |
| 375 <b>__checkTopLevelItems</b>(<i></i>) | |
| 376 | |
| 377 <p> | |
| 378 Private slot to check the 'Extracted Tasks' item for children. | |
| 379 </p> | |
| 380 <a NAME="TaskViewer.__configure" ID="TaskViewer.__configure"></a> | |
| 381 <h4>TaskViewer.__configure</h4> | |
| 382 <b>__configure</b>(<i></i>) | |
| 383 | |
| 384 <p> | |
| 385 Private method to open the configuration dialog. | |
| 386 </p> | |
| 387 <a NAME="TaskViewer.__configureFilter" ID="TaskViewer.__configureFilter"></a> | |
| 388 <h4>TaskViewer.__configureFilter</h4> | |
| 389 <b>__configureFilter</b>(<i></i>) | |
| 390 | |
| 391 <p> | |
| 392 Private slot to handle the "Configure filter" context menu entry. | |
| 393 </p> | |
| 394 <a NAME="TaskViewer.__configureProjectTasksScanOptions" ID="TaskViewer.__configureProjectTasksScanOptions"></a> | |
| 395 <h4>TaskViewer.__configureProjectTasksScanOptions</h4> | |
| 396 <b>__configureProjectTasksScanOptions</b>(<i></i>) | |
| 397 | |
| 398 <p> | |
| 399 Private slot to configure scan options for project tasks. | |
| 400 </p> | |
| 401 <a NAME="TaskViewer.__copyTask" ID="TaskViewer.__copyTask"></a> | |
| 402 <h4>TaskViewer.__copyTask</h4> | |
| 403 <b>__copyTask</b>(<i></i>) | |
| 404 | |
| 405 <p> | |
| 406 Private slot to handle the "Copy" context menu entry. | |
| 407 </p> | |
| 408 <a NAME="TaskViewer.__deleteCompleted" ID="TaskViewer.__deleteCompleted"></a> | |
| 409 <h4>TaskViewer.__deleteCompleted</h4> | |
| 410 <b>__deleteCompleted</b>(<i></i>) | |
| 411 | |
| 412 <p> | |
| 413 Private slot to handle the "Delete Completed Tasks" context menu entry. | |
| 414 </p> | |
| 415 <a NAME="TaskViewer.__deleteSubTasks" ID="TaskViewer.__deleteSubTasks"></a> | |
| 416 <h4>TaskViewer.__deleteSubTasks</h4> | |
| 417 <b>__deleteSubTasks</b>(<i>task</i>) | |
| 418 | |
| 419 <p> | |
| 420 Private method to delete all sub-tasks. | |
| 421 </p> | |
| 422 <dl> | |
| 423 | |
| 424 <dt><i>task</i></dt> | |
| 425 <dd> | |
| 426 task to delete sub-tasks of (Task) | |
| 427 </dd> | |
| 428 </dl> | |
| 429 <a NAME="TaskViewer.__deleteTask" ID="TaskViewer.__deleteTask"></a> | |
| 430 <h4>TaskViewer.__deleteTask</h4> | |
| 431 <b>__deleteTask</b>(<i>task=None</i>) | |
| 432 | |
| 433 <p> | |
| 434 Private slot to delete a task. | |
| 435 </p> | |
| 436 <dl> | |
| 437 | |
| 438 <dt><i>task</i> (Task)</dt> | |
| 439 <dd> | |
| 440 task to be deleted | |
| 441 </dd> | |
| 442 </dl> | |
| 443 <a NAME="TaskViewer.__editTaskProperties" ID="TaskViewer.__editTaskProperties"></a> | |
| 444 <h4>TaskViewer.__editTaskProperties</h4> | |
| 445 <b>__editTaskProperties</b>(<i></i>) | |
| 446 | |
| 447 <p> | |
| 448 Private slot to handle the "Properties" context menu entry. | |
| 449 </p> | |
| 450 <a NAME="TaskViewer.__generateTopLevelItems" ID="TaskViewer.__generateTopLevelItems"></a> | |
| 451 <h4>TaskViewer.__generateTopLevelItems</h4> | |
| 452 <b>__generateTopLevelItems</b>(<i></i>) | |
| 453 | |
| 454 <p> | |
| 455 Private method to generate the 'Extracted Tasks' item. | |
| 456 </p> | |
| 457 <a NAME="TaskViewer.__goToTask" ID="TaskViewer.__goToTask"></a> | |
| 458 <h4>TaskViewer.__goToTask</h4> | |
| 459 <b>__goToTask</b>(<i></i>) | |
| 460 | |
| 461 <p> | |
| 462 Private slot to handle the "Go To" context menu entry. | |
| 463 </p> | |
| 464 <a NAME="TaskViewer.__markCompleted" ID="TaskViewer.__markCompleted"></a> | |
| 465 <h4>TaskViewer.__markCompleted</h4> | |
| 466 <b>__markCompleted</b>(<i></i>) | |
| 467 | |
| 468 <p> | |
| 469 Private slot to handle the "Mark Completed" context menu entry. | |
| 470 </p> | |
| 471 <a NAME="TaskViewer.__newSubTask" ID="TaskViewer.__newSubTask"></a> | |
| 472 <h4>TaskViewer.__newSubTask</h4> | |
| 473 <b>__newSubTask</b>(<i></i>) | |
| 474 | |
| 475 <p> | |
| 476 Private slot to handle the "New Sub-Task" context menu entry. | |
| 477 </p> | |
| 478 <a NAME="TaskViewer.__newTask" ID="TaskViewer.__newTask"></a> | |
| 479 <h4>TaskViewer.__newTask</h4> | |
| 480 <b>__newTask</b>(<i></i>) | |
| 481 | |
| 482 <p> | |
| 483 Private slot to handle the "New Task" context menu entry. | |
| 484 </p> | |
| 485 <a NAME="TaskViewer.__pasteMainTask" ID="TaskViewer.__pasteMainTask"></a> | |
| 486 <h4>TaskViewer.__pasteMainTask</h4> | |
| 487 <b>__pasteMainTask</b>(<i></i>) | |
| 488 | |
| 489 <p> | |
| 490 Private slot to handle the "Paste as Main Task" context menu entry. | |
| 491 </p> | |
| 492 <a NAME="TaskViewer.__pasteTask" ID="TaskViewer.__pasteTask"></a> | |
| 493 <h4>TaskViewer.__pasteTask</h4> | |
| 494 <b>__pasteTask</b>(<i></i>) | |
| 495 | |
| 496 <p> | |
| 497 Private slot to handle the "Paste" context menu entry. | |
| 498 </p> | |
| 499 <a NAME="TaskViewer.__refreshDisplay" ID="TaskViewer.__refreshDisplay"></a> | |
| 500 <h4>TaskViewer.__refreshDisplay</h4> | |
| 501 <b>__refreshDisplay</b>(<i></i>) | |
| 502 | |
| 503 <p> | |
| 504 Private method to refresh the display. | |
| 505 </p> | |
| 506 <a NAME="TaskViewer.__resizeColumns" ID="TaskViewer.__resizeColumns"></a> | |
| 507 <h4>TaskViewer.__resizeColumns</h4> | |
| 508 <b>__resizeColumns</b>(<i></i>) | |
| 509 | |
| 510 <p> | |
| 511 Private method to resize the list columns. | |
| 512 </p> | |
| 513 <a NAME="TaskViewer.__resort" ID="TaskViewer.__resort"></a> | |
| 514 <h4>TaskViewer.__resort</h4> | |
| 515 <b>__resort</b>(<i></i>) | |
| 516 | |
| 517 <p> | |
| 518 Private method to resort the tree. | |
| 519 </p> | |
| 520 <a NAME="TaskViewer.__showContextMenu" ID="TaskViewer.__showContextMenu"></a> | |
| 521 <h4>TaskViewer.__showContextMenu</h4> | |
| 522 <b>__showContextMenu</b>(<i>coord</i>) | |
| 523 | |
| 524 <p> | |
| 525 Private slot to show the context menu of the list. | |
| 526 </p> | |
| 527 <dl> | |
| 528 | |
| 529 <dt><i>coord</i></dt> | |
| 530 <dd> | |
| 531 the position of the mouse pointer (QPoint) | |
| 532 </dd> | |
| 533 </dl> | |
| 534 <a NAME="TaskViewer.__taskItemActivated" ID="TaskViewer.__taskItemActivated"></a> | |
| 535 <h4>TaskViewer.__taskItemActivated</h4> | |
| 536 <b>__taskItemActivated</b>(<i>itm, col</i>) | |
| 537 | |
| 538 <p> | |
| 539 Private slot to handle the activation of an item. | |
| 540 </p> | |
| 541 <dl> | |
| 542 | |
| 543 <dt><i>itm</i></dt> | |
| 544 <dd> | |
| 545 reference to the activated item (QTreeWidgetItem) | |
| 546 </dd> | |
| 547 <dt><i>col</i></dt> | |
| 548 <dd> | |
| 549 column the item was activated in (integer) | |
| 550 </dd> | |
| 551 </dl> | |
| 552 <a NAME="TaskViewer.addFileTask" ID="TaskViewer.addFileTask"></a> | |
| 553 <h4>TaskViewer.addFileTask</h4> | |
| 554 <b>addFileTask</b>(<i>summary, filename, lineno, taskType=TaskType.TODO, description=""</i>) | |
| 555 | |
| 556 <p> | |
| 557 Public slot to add a file related task. | |
| 558 </p> | |
| 559 <dl> | |
| 560 | |
| 561 <dt><i>summary</i> (str)</dt> | |
| 562 <dd> | |
| 563 summary text of the task | |
| 564 </dd> | |
| 565 <dt><i>filename</i> (str)</dt> | |
| 566 <dd> | |
| 567 filename containing the task | |
| 568 </dd> | |
| 569 <dt><i>lineno</i> (int)</dt> | |
| 570 <dd> | |
| 571 line number containing the task | |
| 572 </dd> | |
| 573 <dt><i>taskType</i> (TaskType)</dt> | |
| 574 <dd> | |
| 575 type of the task | |
| 576 </dd> | |
| 577 <dt><i>description</i> (str)</dt> | |
| 578 <dd> | |
| 579 explanatory text of the task | |
| 580 </dd> | |
| 581 </dl> | |
| 582 <a NAME="TaskViewer.addTask" ID="TaskViewer.addTask"></a> | |
| 583 <h4>TaskViewer.addTask</h4> | |
| 584 <b>addTask</b>(<i>summary, priority=TaskPriority.NORMAL, filename="", lineno=0, completed=False, _time=0, isProjectTask=False, taskType=TaskType.TODO, description="", uid="", parentTask=None</i>) | |
| 585 | |
| 586 <p> | |
| 587 Public slot to add a task. | |
| 588 </p> | |
| 589 <dl> | |
| 590 | |
| 591 <dt><i>summary</i> (str)</dt> | |
| 592 <dd> | |
| 593 summary text of the task | |
| 594 </dd> | |
| 595 <dt><i>priority</i> (TaskPriority)</dt> | |
| 596 <dd> | |
| 597 priority of the task | |
| 598 </dd> | |
| 599 <dt><i>filename</i> (str)</dt> | |
| 600 <dd> | |
| 601 filename containing the task | |
| 602 </dd> | |
| 603 <dt><i>lineno</i> (int)</dt> | |
| 604 <dd> | |
| 605 line number containing the task | |
| 606 </dd> | |
| 607 <dt><i>completed</i> (bool)</dt> | |
| 608 <dd> | |
| 609 flag indicating completion status | |
| 610 </dd> | |
| 611 <dt><i>_time</i> (float)</dt> | |
| 612 <dd> | |
| 613 creation time of the task (if 0 use current time) | |
| 614 </dd> | |
| 615 <dt><i>isProjectTask</i> (bool)</dt> | |
| 616 <dd> | |
| 617 flag indicating a task related to the current | |
| 618 project | |
| 619 </dd> | |
| 620 <dt><i>taskType</i> (TaskType)</dt> | |
| 621 <dd> | |
| 622 type of the task | |
| 623 </dd> | |
| 624 <dt><i>description</i> (str)</dt> | |
| 625 <dd> | |
| 626 explanatory text of the task | |
| 627 </dd> | |
| 628 <dt><i>uid</i> (str)</dt> | |
| 629 <dd> | |
| 630 unique id of the task | |
| 631 </dd> | |
| 632 <dt><i>parentTask</i> (Task or str)</dt> | |
| 633 <dd> | |
| 634 reference to the parent task item or the UID of the | |
| 635 parent task | |
| 636 </dd> | |
| 637 </dl> | |
| 638 <dl> | |
| 639 <dt>Return:</dt> | |
| 640 <dd> | |
| 641 reference to the task item | |
| 642 </dd> | |
| 643 </dl> | |
| 644 <dl> | |
| 645 <dt>Return Type:</dt> | |
| 646 <dd> | |
| 647 Task | |
| 648 </dd> | |
| 649 </dl> | |
| 650 <a NAME="TaskViewer.clearFileTasks" ID="TaskViewer.clearFileTasks"></a> | |
| 651 <h4>TaskViewer.clearFileTasks</h4> | |
| 652 <b>clearFileTasks</b>(<i>filename, conditionally=False</i>) | |
| 653 | |
| 654 <p> | |
| 655 Public slot to clear all tasks related to a file. | |
| 656 </p> | |
| 657 <dl> | |
| 658 | |
| 659 <dt><i>filename</i></dt> | |
| 660 <dd> | |
| 661 name of the file (string) | |
| 662 </dd> | |
| 663 <dt><i>conditionally</i></dt> | |
| 664 <dd> | |
| 665 flag indicating to clear the tasks of the file | |
| 666 checking some conditions (boolean) | |
| 667 </dd> | |
| 668 </dl> | |
| 669 <a NAME="TaskViewer.clearProjectTasks" ID="TaskViewer.clearProjectTasks"></a> | |
| 670 <h4>TaskViewer.clearProjectTasks</h4> | |
| 671 <b>clearProjectTasks</b>(<i>fileOnly=False</i>) | |
| 672 | |
| 673 <p> | |
| 674 Public slot to clear project related tasks. | |
| 675 </p> | |
| 676 <dl> | |
| 677 | |
| 678 <dt><i>fileOnly</i></dt> | |
| 679 <dd> | |
| 680 flag indicating to clear only file related | |
| 681 project tasks (boolean) | |
| 682 </dd> | |
| 683 </dl> | |
| 684 <a NAME="TaskViewer.clearTasks" ID="TaskViewer.clearTasks"></a> | |
| 685 <h4>TaskViewer.clearTasks</h4> | |
| 686 <b>clearTasks</b>(<i></i>) | |
| 687 | |
| 688 <p> | |
| 689 Public slot to clear all tasks from display. | |
| 690 </p> | |
| 691 <a NAME="TaskViewer.containsTask" ID="TaskViewer.containsTask"></a> | |
| 692 <h4>TaskViewer.containsTask</h4> | |
| 693 <b>containsTask</b>(<i>taskToTest</i>) | |
| 694 | |
| 695 <p> | |
| 696 Public method to test, if a task is already in the tasks list. | |
| 697 </p> | |
| 698 <dl> | |
| 699 | |
| 700 <dt><i>taskToTest</i> (Task)</dt> | |
| 701 <dd> | |
| 702 task to look for | |
| 703 </dd> | |
| 704 </dl> | |
| 705 <dl> | |
| 706 <dt>Return:</dt> | |
| 707 <dd> | |
| 708 flag indicating the existence of the task | |
| 709 </dd> | |
| 710 </dl> | |
| 711 <dl> | |
| 712 <dt>Return Type:</dt> | |
| 713 <dd> | |
| 714 bool | |
| 715 </dd> | |
| 716 </dl> | |
| 717 <a NAME="TaskViewer.findParentTask" ID="TaskViewer.findParentTask"></a> | |
| 718 <h4>TaskViewer.findParentTask</h4> | |
| 719 <b>findParentTask</b>(<i>parentUid</i>) | |
| 720 | |
| 721 <p> | |
| 722 Public method to find a parent task by its ID. | |
| 723 </p> | |
| 724 <dl> | |
| 725 | |
| 726 <dt><i>parentUid</i></dt> | |
| 727 <dd> | |
| 728 uid of the parent task (string) | |
| 729 </dd> | |
| 730 </dl> | |
| 731 <dl> | |
| 732 <dt>Return:</dt> | |
| 733 <dd> | |
| 734 reference to the task (Task) | |
| 735 </dd> | |
| 736 </dl> | |
| 737 <a NAME="TaskViewer.getGlobalTasks" ID="TaskViewer.getGlobalTasks"></a> | |
| 738 <h4>TaskViewer.getGlobalTasks</h4> | |
| 739 <b>getGlobalTasks</b>(<i></i>) | |
| 740 | |
| 741 <p> | |
| 742 Public method to retrieve all non project related tasks. | |
| 743 </p> | |
| 744 <dl> | |
| 745 <dt>Return:</dt> | |
| 746 <dd> | |
| 747 copy of tasks (list of Task) | |
| 748 </dd> | |
| 749 </dl> | |
| 750 <a NAME="TaskViewer.getProjectTasks" ID="TaskViewer.getProjectTasks"></a> | |
| 751 <h4>TaskViewer.getProjectTasks</h4> | |
| 752 <b>getProjectTasks</b>(<i></i>) | |
| 753 | |
| 754 <p> | |
| 755 Public method to retrieve all project related tasks. | |
| 756 </p> | |
| 757 <dl> | |
| 758 <dt>Return:</dt> | |
| 759 <dd> | |
| 760 copy of tasks (list of Task) | |
| 761 </dd> | |
| 762 </dl> | |
| 763 <a NAME="TaskViewer.getTasksScanFilter" ID="TaskViewer.getTasksScanFilter"></a> | |
| 764 <h4>TaskViewer.getTasksScanFilter</h4> | |
| 765 <b>getTasksScanFilter</b>(<i></i>) | |
| 766 | |
| 767 <p> | |
| 768 Public method to get the project scan filter. | |
| 769 </p> | |
| 770 <dl> | |
| 771 <dt>Return:</dt> | |
| 772 <dd> | |
| 773 project scan filter | |
| 774 </dd> | |
| 775 </dl> | |
| 776 <dl> | |
| 777 <dt>Return Type:</dt> | |
| 778 <dd> | |
| 779 str | |
| 780 </dd> | |
| 781 </dl> | |
| 782 <a NAME="TaskViewer.handlePreferencesChanged" ID="TaskViewer.handlePreferencesChanged"></a> | |
| 783 <h4>TaskViewer.handlePreferencesChanged</h4> | |
| 784 <b>handlePreferencesChanged</b>(<i></i>) | |
| 785 | |
| 786 <p> | |
| 787 Public slot to react to changes of the preferences. | |
| 788 </p> | |
| 789 <a NAME="TaskViewer.regenerateProjectTasks" ID="TaskViewer.regenerateProjectTasks"></a> | |
| 790 <h4>TaskViewer.regenerateProjectTasks</h4> | |
| 791 <b>regenerateProjectTasks</b>(<i>quiet=False</i>) | |
| 792 | |
| 793 <p> | |
| 794 Public slot to regenerate project related tasks. | |
| 795 </p> | |
| 796 <dl> | |
| 797 | |
| 798 <dt><i>quiet</i> (bool)</dt> | |
| 799 <dd> | |
| 800 flag indicating quiet operation | |
| 801 </dd> | |
| 802 </dl> | |
| 803 <a NAME="TaskViewer.saveProjectTasks" ID="TaskViewer.saveProjectTasks"></a> | |
| 804 <h4>TaskViewer.saveProjectTasks</h4> | |
| 805 <b>saveProjectTasks</b>(<i></i>) | |
| 806 | |
| 807 <p> | |
| 808 Public method to write the project tasks. | |
| 809 </p> | |
| 810 <a NAME="TaskViewer.setProjectOpen" ID="TaskViewer.setProjectOpen"></a> | |
| 811 <h4>TaskViewer.setProjectOpen</h4> | |
| 812 <b>setProjectOpen</b>(<i>o=False</i>) | |
| 813 | |
| 814 <p> | |
| 815 Public slot to set the project status. | |
| 816 </p> | |
| 817 <dl> | |
| 818 | |
| 819 <dt><i>o</i></dt> | |
| 820 <dd> | |
| 821 flag indicating the project status | |
| 822 </dd> | |
| 823 </dl> | |
| 824 <a NAME="TaskViewer.setTasksScanFilter" ID="TaskViewer.setTasksScanFilter"></a> | |
| 825 <h4>TaskViewer.setTasksScanFilter</h4> | |
| 826 <b>setTasksScanFilter</b>(<i>filterStr: str</i>) | |
| 827 | |
| 828 <p> | |
| 829 Public method to set the project scan filter. | |
| 830 </p> | |
| 831 <dl> | |
| 832 | |
| 833 <dt><i>filterStr</i> (str)</dt> | |
| 834 <dd> | |
| 835 project scan filter | |
| 836 </dd> | |
| 837 </dl> | |
| 838 <a NAME="TaskViewer.stopProjectTaskExtraction" ID="TaskViewer.stopProjectTaskExtraction"></a> | |
| 839 <h4>TaskViewer.stopProjectTaskExtraction</h4> | |
| 840 <b>stopProjectTaskExtraction</b>(<i></i>) | |
| 841 | |
| 842 <p> | |
| 843 Public method to stop the project task extraction thread. | |
| 844 </p> | |
| 845 <div align="right"><a href="#top">Up</a></div> | |
| 846 <hr /> | |
| 847 </body></html> |
