Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.Tasks.TaskViewer.html
Documentation/Source/eric5.Tasks.TaskViewer.html
- changeset 17
- edde1fe80b3e
- child 21
- b88a0e6268bd
equal
deleted
inserted
replaced
| 16:892c1787d666 | 17:edde1fe80b3e |
|---|---|
| 1 <?xml version="1.0" encoding="utf-8"?> | |
| 2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' | |
| 3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> | |
| 4 <html><head> | |
| 5 <title>eric5.Tasks.TaskViewer</title> | |
| 6 <style> | |
| 7 b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' | |
| 8 </style> | |
| 9 </head> | |
| 10 <body><a NAME="top" ID="top"></a> | |
| 11 <h1>eric5.Tasks.TaskViewer</h1> | |
| 12 <p> | |
| 13 Module implementing a task viewer and associated classes. | |
| 14 </p><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 <table> | |
| 21 <tr><td>None</td></tr> | |
| 22 </table> | |
| 23 <h3>Classes</h3> | |
| 24 <table> | |
| 25 <tr> | |
| 26 <td><a href="#Task">Task</a></td> | |
| 27 <td>Class implementing the task data structure.</td> | |
| 28 </tr><tr> | |
| 29 <td><a href="#TaskFilter">TaskFilter</a></td> | |
| 30 <td>Class implementing a filter for tasks.</td> | |
| 31 </tr><tr> | |
| 32 <td><a href="#TaskViewer">TaskViewer</a></td> | |
| 33 <td>Class implementing the task viewer.</td> | |
| 34 </tr> | |
| 35 </table> | |
| 36 <h3>Functions</h3> | |
| 37 <table> | |
| 38 <tr><td>None</td></tr> | |
| 39 </table> | |
| 40 <hr /><hr /> | |
| 41 <a NAME="Task" ID="Task"></a> | |
| 42 <h2>Task</h2> | |
| 43 <p> | |
| 44 Class implementing the task data structure. | |
| 45 </p> | |
| 46 <h3>Derived from</h3> | |
| 47 QTreeWidgetItem | |
| 48 <h3>Class Attributes</h3> | |
| 49 <table> | |
| 50 <tr><td>None</td></tr> | |
| 51 </table> | |
| 52 <h3>Methods</h3> | |
| 53 <table> | |
| 54 <tr> | |
| 55 <td><a href="#Task.__init__">Task</a></td> | |
| 56 <td>Constructor</td> | |
| 57 </tr><tr> | |
| 58 <td><a href="#Task.colorizeTask">colorizeTask</a></td> | |
| 59 <td>Public slot to set the colors of the task item.</td> | |
| 60 </tr><tr> | |
| 61 <td><a href="#Task.getFilename">getFilename</a></td> | |
| 62 <td>Public method to retrieve the tasks filename.</td> | |
| 63 </tr><tr> | |
| 64 <td><a href="#Task.getLineno">getLineno</a></td> | |
| 65 <td>Public method to retrieve the tasks linenumber.</td> | |
| 66 </tr><tr> | |
| 67 <td><a href="#Task.isCompleted">isCompleted</a></td> | |
| 68 <td>Public slot to return the completion status.</td> | |
| 69 </tr><tr> | |
| 70 <td><a href="#Task.isProjectTask">isProjectTask</a></td> | |
| 71 <td>Public slot to return the project relation status.</td> | |
| 72 </tr><tr> | |
| 73 <td><a href="#Task.setCompleted">setCompleted</a></td> | |
| 74 <td>Public slot to update the completed flag.</td> | |
| 75 </tr><tr> | |
| 76 <td><a href="#Task.setDescription">setDescription</a></td> | |
| 77 <td>Public slot to update the description.</td> | |
| 78 </tr><tr> | |
| 79 <td><a href="#Task.setLongText">setLongText</a></td> | |
| 80 <td>Public slot to update the longtext field.</td> | |
| 81 </tr><tr> | |
| 82 <td><a href="#Task.setPriority">setPriority</a></td> | |
| 83 <td>Public slot to update the priority.</td> | |
| 84 </tr><tr> | |
| 85 <td><a href="#Task.setProjectTask">setProjectTask</a></td> | |
| 86 <td>Public method to set the project relation flag.</td> | |
| 87 </tr> | |
| 88 </table> | |
| 89 <a NAME="Task.__init__" ID="Task.__init__"></a> | |
| 90 <h4>Task (Constructor)</h4> | |
| 91 <b>Task</b>(<i>description, priority = 1, filename = "", lineno = 0, completed = False, _time = 0, isProjectTask = False, isBugfixTask = False, ppath = "", longtext = ""</i>) | |
| 92 <p> | |
| 93 Constructor | |
| 94 </p><dl> | |
| 95 <dt><i>parent</i></dt> | |
| 96 <dd> | |
| 97 parent widget of the task (QWidget) | |
| 98 </dd><dt><i>description</i></dt> | |
| 99 <dd> | |
| 100 descriptive text of the task (string) | |
| 101 </dd><dt><i>priority</i></dt> | |
| 102 <dd> | |
| 103 priority of the task (0=high, 1=normal, 2=low) | |
| 104 </dd><dt><i>filename</i></dt> | |
| 105 <dd> | |
| 106 filename containing the task (string) | |
| 107 </dd><dt><i>lineno</i></dt> | |
| 108 <dd> | |
| 109 line number containing the task (integer) | |
| 110 </dd><dt><i>completed</i></dt> | |
| 111 <dd> | |
| 112 flag indicating completion status (boolean) | |
| 113 </dd><dt><i>_time</i></dt> | |
| 114 <dd> | |
| 115 creation time of the task (float, if 0 use current time) | |
| 116 </dd><dt><i>isProjectTask</i></dt> | |
| 117 <dd> | |
| 118 flag indicating a task related to the current project | |
| 119 (boolean) | |
| 120 </dd><dt><i>isBugfixTask</i></dt> | |
| 121 <dd> | |
| 122 flag indicating a bugfix task (boolean) | |
| 123 </dd><dt><i>ppath</i></dt> | |
| 124 <dd> | |
| 125 the project path (string) | |
| 126 </dd><dt><i>longtext</i></dt> | |
| 127 <dd> | |
| 128 explanatory text of the task (string) | |
| 129 </dd> | |
| 130 </dl><a NAME="Task.colorizeTask" ID="Task.colorizeTask"></a> | |
| 131 <h4>Task.colorizeTask</h4> | |
| 132 <b>colorizeTask</b>(<i></i>) | |
| 133 <p> | |
| 134 Public slot to set the colors of the task item. | |
| 135 </p><a NAME="Task.getFilename" ID="Task.getFilename"></a> | |
| 136 <h4>Task.getFilename</h4> | |
| 137 <b>getFilename</b>(<i></i>) | |
| 138 <p> | |
| 139 Public method to retrieve the tasks filename. | |
| 140 </p><dl> | |
| 141 <dt>Returns:</dt> | |
| 142 <dd> | |
| 143 filename (string) | |
| 144 </dd> | |
| 145 </dl><a NAME="Task.getLineno" ID="Task.getLineno"></a> | |
| 146 <h4>Task.getLineno</h4> | |
| 147 <b>getLineno</b>(<i></i>) | |
| 148 <p> | |
| 149 Public method to retrieve the tasks linenumber. | |
| 150 </p><dl> | |
| 151 <dt>Returns:</dt> | |
| 152 <dd> | |
| 153 linenumber (integer) | |
| 154 </dd> | |
| 155 </dl><a NAME="Task.isCompleted" ID="Task.isCompleted"></a> | |
| 156 <h4>Task.isCompleted</h4> | |
| 157 <b>isCompleted</b>(<i></i>) | |
| 158 <p> | |
| 159 Public slot to return the completion status. | |
| 160 </p><dl> | |
| 161 <dt>Returns:</dt> | |
| 162 <dd> | |
| 163 flag indicating the completion status (boolean) | |
| 164 </dd> | |
| 165 </dl><a NAME="Task.isProjectTask" ID="Task.isProjectTask"></a> | |
| 166 <h4>Task.isProjectTask</h4> | |
| 167 <b>isProjectTask</b>(<i></i>) | |
| 168 <p> | |
| 169 Public slot to return the project relation status. | |
| 170 </p><dl> | |
| 171 <dt>Returns:</dt> | |
| 172 <dd> | |
| 173 flag indicating the project relation status (boolean) | |
| 174 </dd> | |
| 175 </dl><a NAME="Task.setCompleted" ID="Task.setCompleted"></a> | |
| 176 <h4>Task.setCompleted</h4> | |
| 177 <b>setCompleted</b>(<i>completed</i>) | |
| 178 <p> | |
| 179 Public slot to update the completed flag. | |
| 180 </p><dl> | |
| 181 <dt><i>completed</i></dt> | |
| 182 <dd> | |
| 183 flag indicating completion status (boolean) | |
| 184 </dd> | |
| 185 </dl><a NAME="Task.setDescription" ID="Task.setDescription"></a> | |
| 186 <h4>Task.setDescription</h4> | |
| 187 <b>setDescription</b>(<i>description</i>) | |
| 188 <p> | |
| 189 Public slot to update the description. | |
| 190 </p><dl> | |
| 191 <dt><i>longtext</i></dt> | |
| 192 <dd> | |
| 193 explanatory text of the task (string) | |
| 194 </dd> | |
| 195 </dl><a NAME="Task.setLongText" ID="Task.setLongText"></a> | |
| 196 <h4>Task.setLongText</h4> | |
| 197 <b>setLongText</b>(<i>longtext</i>) | |
| 198 <p> | |
| 199 Public slot to update the longtext field. | |
| 200 </p><dl> | |
| 201 <dt><i>longtext</i></dt> | |
| 202 <dd> | |
| 203 descriptive text of the task (string) | |
| 204 </dd> | |
| 205 </dl><a NAME="Task.setPriority" ID="Task.setPriority"></a> | |
| 206 <h4>Task.setPriority</h4> | |
| 207 <b>setPriority</b>(<i>priority</i>) | |
| 208 <p> | |
| 209 Public slot to update the priority. | |
| 210 </p><dl> | |
| 211 <dt><i>priority</i></dt> | |
| 212 <dd> | |
| 213 priority of the task (0=high, 1=normal, 2=low) | |
| 214 </dd> | |
| 215 </dl><a NAME="Task.setProjectTask" ID="Task.setProjectTask"></a> | |
| 216 <h4>Task.setProjectTask</h4> | |
| 217 <b>setProjectTask</b>(<i>pt</i>) | |
| 218 <p> | |
| 219 Public method to set the project relation flag. | |
| 220 </p><dl> | |
| 221 <dt><i>pt</i></dt> | |
| 222 <dd> | |
| 223 flag indicating a project task (boolean) | |
| 224 </dd> | |
| 225 </dl> | |
| 226 <div align="right"><a href="#top">Up</a></div> | |
| 227 <hr /><hr /> | |
| 228 <a NAME="TaskFilter" ID="TaskFilter"></a> | |
| 229 <h2>TaskFilter</h2> | |
| 230 <p> | |
| 231 Class implementing a filter for tasks. | |
| 232 </p> | |
| 233 <h3>Derived from</h3> | |
| 234 object | |
| 235 <h3>Class Attributes</h3> | |
| 236 <table> | |
| 237 <tr><td>None</td></tr> | |
| 238 </table> | |
| 239 <h3>Methods</h3> | |
| 240 <table> | |
| 241 <tr> | |
| 242 <td><a href="#TaskFilter.__init__">TaskFilter</a></td> | |
| 243 <td>Constructor</td> | |
| 244 </tr><tr> | |
| 245 <td><a href="#TaskFilter.hasActiveFilter">hasActiveFilter</a></td> | |
| 246 <td>Public method to check for active filters.</td> | |
| 247 </tr><tr> | |
| 248 <td><a href="#TaskFilter.setActive">setActive</a></td> | |
| 249 <td>Public method to activate the filter.</td> | |
| 250 </tr><tr> | |
| 251 <td><a href="#TaskFilter.setDescriptionFilter">setDescriptionFilter</a></td> | |
| 252 <td>Public method to set the description filter.</td> | |
| 253 </tr><tr> | |
| 254 <td><a href="#TaskFilter.setFileNameFilter">setFileNameFilter</a></td> | |
| 255 <td>Public method to set the filename filter.</td> | |
| 256 </tr><tr> | |
| 257 <td><a href="#TaskFilter.setPrioritiesFilter">setPrioritiesFilter</a></td> | |
| 258 <td>Public method to set the priorities filter.</td> | |
| 259 </tr><tr> | |
| 260 <td><a href="#TaskFilter.setScopeFilter">setScopeFilter</a></td> | |
| 261 <td>Public method to set the scope filter.</td> | |
| 262 </tr><tr> | |
| 263 <td><a href="#TaskFilter.setStatusFilter">setStatusFilter</a></td> | |
| 264 <td>Public method to set the status filter.</td> | |
| 265 </tr><tr> | |
| 266 <td><a href="#TaskFilter.setTypeFilter">setTypeFilter</a></td> | |
| 267 <td>Public method to set the type filter.</td> | |
| 268 </tr><tr> | |
| 269 <td><a href="#TaskFilter.showTask">showTask</a></td> | |
| 270 <td>Public method to check, if a task should be shown.</td> | |
| 271 </tr> | |
| 272 </table> | |
| 273 <a NAME="TaskFilter.__init__" ID="TaskFilter.__init__"></a> | |
| 274 <h4>TaskFilter (Constructor)</h4> | |
| 275 <b>TaskFilter</b>(<i></i>) | |
| 276 <p> | |
| 277 Constructor | |
| 278 </p><a NAME="TaskFilter.hasActiveFilter" ID="TaskFilter.hasActiveFilter"></a> | |
| 279 <h4>TaskFilter.hasActiveFilter</h4> | |
| 280 <b>hasActiveFilter</b>(<i></i>) | |
| 281 <p> | |
| 282 Public method to check for active filters. | |
| 283 </p><dl> | |
| 284 <dt>Returns:</dt> | |
| 285 <dd> | |
| 286 flag indicating an active filter was found (boolean) | |
| 287 </dd> | |
| 288 </dl><a NAME="TaskFilter.setActive" ID="TaskFilter.setActive"></a> | |
| 289 <h4>TaskFilter.setActive</h4> | |
| 290 <b>setActive</b>(<i>enabled</i>) | |
| 291 <p> | |
| 292 Public method to activate the filter. | |
| 293 </p><dl> | |
| 294 <dt><i>enabled</i></dt> | |
| 295 <dd> | |
| 296 flag indicating the activation state (boolean) | |
| 297 </dd> | |
| 298 </dl><a NAME="TaskFilter.setDescriptionFilter" ID="TaskFilter.setDescriptionFilter"></a> | |
| 299 <h4>TaskFilter.setDescriptionFilter</h4> | |
| 300 <b>setDescriptionFilter</b>(<i>filter</i>) | |
| 301 <p> | |
| 302 Public method to set the description filter. | |
| 303 </p><dl> | |
| 304 <dt><i>filter</i></dt> | |
| 305 <dd> | |
| 306 a regular expression for the description filter | |
| 307 to set (string) or None | |
| 308 </dd> | |
| 309 </dl><a NAME="TaskFilter.setFileNameFilter" ID="TaskFilter.setFileNameFilter"></a> | |
| 310 <h4>TaskFilter.setFileNameFilter</h4> | |
| 311 <b>setFileNameFilter</b>(<i>filter</i>) | |
| 312 <p> | |
| 313 Public method to set the filename filter. | |
| 314 </p><dl> | |
| 315 <dt><i>filter</i></dt> | |
| 316 <dd> | |
| 317 a wildcard expression for the filename filter | |
| 318 to set (string) or None | |
| 319 </dd> | |
| 320 </dl><a NAME="TaskFilter.setPrioritiesFilter" ID="TaskFilter.setPrioritiesFilter"></a> | |
| 321 <h4>TaskFilter.setPrioritiesFilter</h4> | |
| 322 <b>setPrioritiesFilter</b>(<i>priorities</i>) | |
| 323 <p> | |
| 324 Public method to set the priorities filter. | |
| 325 </p><dl> | |
| 326 <dt><i>priorities</i></dt> | |
| 327 <dd> | |
| 328 list of task priorities (list of integer) or None | |
| 329 </dd> | |
| 330 </dl><a NAME="TaskFilter.setScopeFilter" ID="TaskFilter.setScopeFilter"></a> | |
| 331 <h4>TaskFilter.setScopeFilter</h4> | |
| 332 <b>setScopeFilter</b>(<i>scope</i>) | |
| 333 <p> | |
| 334 Public method to set the scope filter. | |
| 335 </p><dl> | |
| 336 <dt><i>scope</i></dt> | |
| 337 <dd> | |
| 338 flag indicating a project task (boolean) or None | |
| 339 </dd> | |
| 340 </dl><a NAME="TaskFilter.setStatusFilter" ID="TaskFilter.setStatusFilter"></a> | |
| 341 <h4>TaskFilter.setStatusFilter</h4> | |
| 342 <b>setStatusFilter</b>(<i>status</i>) | |
| 343 <p> | |
| 344 Public method to set the status filter. | |
| 345 </p><dl> | |
| 346 <dt><i>status</i></dt> | |
| 347 <dd> | |
| 348 flag indicating a completed task (boolean) or None | |
| 349 </dd> | |
| 350 </dl><a NAME="TaskFilter.setTypeFilter" ID="TaskFilter.setTypeFilter"></a> | |
| 351 <h4>TaskFilter.setTypeFilter</h4> | |
| 352 <b>setTypeFilter</b>(<i>type_</i>) | |
| 353 <p> | |
| 354 Public method to set the type filter. | |
| 355 </p><dl> | |
| 356 <dt><i>type_</i></dt> | |
| 357 <dd> | |
| 358 flag indicating a bugfix task (boolean) or None | |
| 359 </dd> | |
| 360 </dl><a NAME="TaskFilter.showTask" ID="TaskFilter.showTask"></a> | |
| 361 <h4>TaskFilter.showTask</h4> | |
| 362 <b>showTask</b>(<i>task</i>) | |
| 363 <p> | |
| 364 Public method to check, if a task should be shown. | |
| 365 </p><dl> | |
| 366 <dt><i>task</i></dt> | |
| 367 <dd> | |
| 368 reference to the task object to check (Task) | |
| 369 </dd> | |
| 370 </dl><dl> | |
| 371 <dt>Returns:</dt> | |
| 372 <dd> | |
| 373 flag indicating whether the task should be shown (boolean) | |
| 374 </dd> | |
| 375 </dl> | |
| 376 <div align="right"><a href="#top">Up</a></div> | |
| 377 <hr /><hr /> | |
| 378 <a NAME="TaskViewer" ID="TaskViewer"></a> | |
| 379 <h2>TaskViewer</h2> | |
| 380 <p> | |
| 381 Class implementing the task viewer. | |
| 382 </p><h4>Signals</h4> | |
| 383 <dl> | |
| 384 <dt>displayFile(string, integer)</dt> | |
| 385 <dd> | |
| 386 emitted to go to a file task | |
| 387 </dd> | |
| 388 </dl> | |
| 389 <h3>Derived from</h3> | |
| 390 QTreeWidget | |
| 391 <h3>Class Attributes</h3> | |
| 392 <table> | |
| 393 <tr><td>None</td></tr> | |
| 394 </table> | |
| 395 <h3>Methods</h3> | |
| 396 <table> | |
| 397 <tr> | |
| 398 <td><a href="#TaskViewer.__init__">TaskViewer</a></td> | |
| 399 <td>Constructor</td> | |
| 400 </tr><tr> | |
| 401 <td><a href="#TaskViewer.__activateFilter">__activateFilter</a></td> | |
| 402 <td>Private slot to handle the "Filtered display" context menu entry.</td> | |
| 403 </tr><tr> | |
| 404 <td><a href="#TaskViewer.__configure">__configure</a></td> | |
| 405 <td>Private method to open the configuration dialog.</td> | |
| 406 </tr><tr> | |
| 407 <td><a href="#TaskViewer.__configureFilter">__configureFilter</a></td> | |
| 408 <td>Private slot to handle the "Configure filter" context menu entry.</td> | |
| 409 </tr><tr> | |
| 410 <td><a href="#TaskViewer.__copyTask">__copyTask</a></td> | |
| 411 <td>Private slot to handle the "Copy" context menu entry.</td> | |
| 412 </tr><tr> | |
| 413 <td><a href="#TaskViewer.__deleteCompleted">__deleteCompleted</a></td> | |
| 414 <td>Private slot to handle the "Delete Completed Tasks" context menu entry.</td> | |
| 415 </tr><tr> | |
| 416 <td><a href="#TaskViewer.__deleteTask">__deleteTask</a></td> | |
| 417 <td>Private slot to handle the "Delete Task" context menu entry.</td> | |
| 418 </tr><tr> | |
| 419 <td><a href="#TaskViewer.__editTaskProperties">__editTaskProperties</a></td> | |
| 420 <td>Private slot to handle the "Properties" context menu entry</td> | |
| 421 </tr><tr> | |
| 422 <td><a href="#TaskViewer.__goToTask">__goToTask</a></td> | |
| 423 <td>Private slot to handle the "Go To" context menu entry.</td> | |
| 424 </tr><tr> | |
| 425 <td><a href="#TaskViewer.__markCompleted">__markCompleted</a></td> | |
| 426 <td>Private slot to handle the "Mark Completed" context menu entry.</td> | |
| 427 </tr><tr> | |
| 428 <td><a href="#TaskViewer.__newTask">__newTask</a></td> | |
| 429 <td>Private slot to handle the "New Task" context menu entry.</td> | |
| 430 </tr><tr> | |
| 431 <td><a href="#TaskViewer.__pasteTask">__pasteTask</a></td> | |
| 432 <td>Private slot to handle the "Paste" context menu entry.</td> | |
| 433 </tr><tr> | |
| 434 <td><a href="#TaskViewer.__refreshDisplay">__refreshDisplay</a></td> | |
| 435 <td>Private method to refresh the display.</td> | |
| 436 </tr><tr> | |
| 437 <td><a href="#TaskViewer.__regenerateProjectTasks">__regenerateProjectTasks</a></td> | |
| 438 <td>Private slot to handle the "Regenerated project tasks" context menu entry.</td> | |
| 439 </tr><tr> | |
| 440 <td><a href="#TaskViewer.__resizeColumns">__resizeColumns</a></td> | |
| 441 <td>Private method to resize the list columns.</td> | |
| 442 </tr><tr> | |
| 443 <td><a href="#TaskViewer.__resort">__resort</a></td> | |
| 444 <td>Private method to resort the tree.</td> | |
| 445 </tr><tr> | |
| 446 <td><a href="#TaskViewer.__showContextMenu">__showContextMenu</a></td> | |
| 447 <td>Private slot to show the context menu of the list.</td> | |
| 448 </tr><tr> | |
| 449 <td><a href="#TaskViewer.__taskItemActivated">__taskItemActivated</a></td> | |
| 450 <td>Private slot to handle the activation of an item.</td> | |
| 451 </tr><tr> | |
| 452 <td><a href="#TaskViewer.addFileTask">addFileTask</a></td> | |
| 453 <td>Public slot to add a file related task.</td> | |
| 454 </tr><tr> | |
| 455 <td><a href="#TaskViewer.addTask">addTask</a></td> | |
| 456 <td>Public slot to add a task.</td> | |
| 457 </tr><tr> | |
| 458 <td><a href="#TaskViewer.clearFileTasks">clearFileTasks</a></td> | |
| 459 <td>Public slot to clear all tasks related to a file.</td> | |
| 460 </tr><tr> | |
| 461 <td><a href="#TaskViewer.clearProjectTasks">clearProjectTasks</a></td> | |
| 462 <td>Public slot to clear project related tasks.</td> | |
| 463 </tr><tr> | |
| 464 <td><a href="#TaskViewer.clearTasks">clearTasks</a></td> | |
| 465 <td>Public slot to clear all tasks from display.</td> | |
| 466 </tr><tr> | |
| 467 <td><a href="#TaskViewer.getGlobalTasks">getGlobalTasks</a></td> | |
| 468 <td>Public method to retrieve all non project related tasks.</td> | |
| 469 </tr><tr> | |
| 470 <td><a href="#TaskViewer.getProjectTasks">getProjectTasks</a></td> | |
| 471 <td>Public method to retrieve all project related tasks.</td> | |
| 472 </tr><tr> | |
| 473 <td><a href="#TaskViewer.handlePreferencesChanged">handlePreferencesChanged</a></td> | |
| 474 <td>Public slot to react to changes of the preferences.</td> | |
| 475 </tr><tr> | |
| 476 <td><a href="#TaskViewer.setProjectOpen">setProjectOpen</a></td> | |
| 477 <td>Public slot to set the project status.</td> | |
| 478 </tr> | |
| 479 </table> | |
| 480 <a NAME="TaskViewer.__init__" ID="TaskViewer.__init__"></a> | |
| 481 <h4>TaskViewer (Constructor)</h4> | |
| 482 <b>TaskViewer</b>(<i>parent, project</i>) | |
| 483 <p> | |
| 484 Constructor | |
| 485 </p><dl> | |
| 486 <dt><i>parent</i></dt> | |
| 487 <dd> | |
| 488 the parent (QWidget) | |
| 489 </dd><dt><i>project</i></dt> | |
| 490 <dd> | |
| 491 reference to the project object | |
| 492 </dd> | |
| 493 </dl><a NAME="TaskViewer.__activateFilter" ID="TaskViewer.__activateFilter"></a> | |
| 494 <h4>TaskViewer.__activateFilter</h4> | |
| 495 <b>__activateFilter</b>(<i>on</i>) | |
| 496 <p> | |
| 497 Private slot to handle the "Filtered display" context menu entry. | |
| 498 </p><dl> | |
| 499 <dt><i>on</i></dt> | |
| 500 <dd> | |
| 501 flag indicating the filter state (boolean) | |
| 502 </dd> | |
| 503 </dl><a NAME="TaskViewer.__configure" ID="TaskViewer.__configure"></a> | |
| 504 <h4>TaskViewer.__configure</h4> | |
| 505 <b>__configure</b>(<i></i>) | |
| 506 <p> | |
| 507 Private method to open the configuration dialog. | |
| 508 </p><a NAME="TaskViewer.__configureFilter" ID="TaskViewer.__configureFilter"></a> | |
| 509 <h4>TaskViewer.__configureFilter</h4> | |
| 510 <b>__configureFilter</b>(<i></i>) | |
| 511 <p> | |
| 512 Private slot to handle the "Configure filter" context menu entry. | |
| 513 </p><a NAME="TaskViewer.__copyTask" ID="TaskViewer.__copyTask"></a> | |
| 514 <h4>TaskViewer.__copyTask</h4> | |
| 515 <b>__copyTask</b>(<i></i>) | |
| 516 <p> | |
| 517 Private slot to handle the "Copy" context menu entry. | |
| 518 </p><a NAME="TaskViewer.__deleteCompleted" ID="TaskViewer.__deleteCompleted"></a> | |
| 519 <h4>TaskViewer.__deleteCompleted</h4> | |
| 520 <b>__deleteCompleted</b>(<i></i>) | |
| 521 <p> | |
| 522 Private slot to handle the "Delete Completed Tasks" context menu entry. | |
| 523 </p><a NAME="TaskViewer.__deleteTask" ID="TaskViewer.__deleteTask"></a> | |
| 524 <h4>TaskViewer.__deleteTask</h4> | |
| 525 <b>__deleteTask</b>(<i></i>) | |
| 526 <p> | |
| 527 Private slot to handle the "Delete Task" context menu entry. | |
| 528 </p><a NAME="TaskViewer.__editTaskProperties" ID="TaskViewer.__editTaskProperties"></a> | |
| 529 <h4>TaskViewer.__editTaskProperties</h4> | |
| 530 <b>__editTaskProperties</b>(<i></i>) | |
| 531 <p> | |
| 532 Private slot to handle the "Properties" context menu entry | |
| 533 </p><a NAME="TaskViewer.__goToTask" ID="TaskViewer.__goToTask"></a> | |
| 534 <h4>TaskViewer.__goToTask</h4> | |
| 535 <b>__goToTask</b>(<i></i>) | |
| 536 <p> | |
| 537 Private slot to handle the "Go To" context menu entry. | |
| 538 </p><a NAME="TaskViewer.__markCompleted" ID="TaskViewer.__markCompleted"></a> | |
| 539 <h4>TaskViewer.__markCompleted</h4> | |
| 540 <b>__markCompleted</b>(<i></i>) | |
| 541 <p> | |
| 542 Private slot to handle the "Mark Completed" context menu entry. | |
| 543 </p><a NAME="TaskViewer.__newTask" ID="TaskViewer.__newTask"></a> | |
| 544 <h4>TaskViewer.__newTask</h4> | |
| 545 <b>__newTask</b>(<i></i>) | |
| 546 <p> | |
| 547 Private slot to handle the "New Task" context menu entry. | |
| 548 </p><a NAME="TaskViewer.__pasteTask" ID="TaskViewer.__pasteTask"></a> | |
| 549 <h4>TaskViewer.__pasteTask</h4> | |
| 550 <b>__pasteTask</b>(<i></i>) | |
| 551 <p> | |
| 552 Private slot to handle the "Paste" context menu entry. | |
| 553 </p><a NAME="TaskViewer.__refreshDisplay" ID="TaskViewer.__refreshDisplay"></a> | |
| 554 <h4>TaskViewer.__refreshDisplay</h4> | |
| 555 <b>__refreshDisplay</b>(<i></i>) | |
| 556 <p> | |
| 557 Private method to refresh the display. | |
| 558 </p><a NAME="TaskViewer.__regenerateProjectTasks" ID="TaskViewer.__regenerateProjectTasks"></a> | |
| 559 <h4>TaskViewer.__regenerateProjectTasks</h4> | |
| 560 <b>__regenerateProjectTasks</b>(<i></i>) | |
| 561 <p> | |
| 562 Private slot to handle the "Regenerated project tasks" context menu entry. | |
| 563 </p><a NAME="TaskViewer.__resizeColumns" ID="TaskViewer.__resizeColumns"></a> | |
| 564 <h4>TaskViewer.__resizeColumns</h4> | |
| 565 <b>__resizeColumns</b>(<i></i>) | |
| 566 <p> | |
| 567 Private method to resize the list columns. | |
| 568 </p><a NAME="TaskViewer.__resort" ID="TaskViewer.__resort"></a> | |
| 569 <h4>TaskViewer.__resort</h4> | |
| 570 <b>__resort</b>(<i></i>) | |
| 571 <p> | |
| 572 Private method to resort the tree. | |
| 573 </p><a NAME="TaskViewer.__showContextMenu" ID="TaskViewer.__showContextMenu"></a> | |
| 574 <h4>TaskViewer.__showContextMenu</h4> | |
| 575 <b>__showContextMenu</b>(<i>coord</i>) | |
| 576 <p> | |
| 577 Private slot to show the context menu of the list. | |
| 578 </p><dl> | |
| 579 <dt><i>coord</i></dt> | |
| 580 <dd> | |
| 581 the position of the mouse pointer (QPoint) | |
| 582 </dd> | |
| 583 </dl><a NAME="TaskViewer.__taskItemActivated" ID="TaskViewer.__taskItemActivated"></a> | |
| 584 <h4>TaskViewer.__taskItemActivated</h4> | |
| 585 <b>__taskItemActivated</b>(<i>itm, col</i>) | |
| 586 <p> | |
| 587 Private slot to handle the activation of an item. | |
| 588 </p><dl> | |
| 589 <dt><i>itm</i></dt> | |
| 590 <dd> | |
| 591 reference to the activated item (QTreeWidgetItem) | |
| 592 </dd><dt><i>col</i></dt> | |
| 593 <dd> | |
| 594 column the item was activated in (integer) | |
| 595 </dd> | |
| 596 </dl><a NAME="TaskViewer.addFileTask" ID="TaskViewer.addFileTask"></a> | |
| 597 <h4>TaskViewer.addFileTask</h4> | |
| 598 <b>addFileTask</b>(<i>description, filename, lineno, isBugfixTask = False, longtext = ""</i>) | |
| 599 <p> | |
| 600 Public slot to add a file related task. | |
| 601 </p><dl> | |
| 602 <dt><i>description</i></dt> | |
| 603 <dd> | |
| 604 descriptive text of the task (string) | |
| 605 </dd><dt><i>filename</i></dt> | |
| 606 <dd> | |
| 607 filename containing the task (string) | |
| 608 </dd><dt><i>lineno</i></dt> | |
| 609 <dd> | |
| 610 line number containing the task (integer) | |
| 611 </dd><dt><i>isBugfixTask</i></dt> | |
| 612 <dd> | |
| 613 flag indicating a bugfix task (boolean) | |
| 614 </dd><dt><i>longtext</i></dt> | |
| 615 <dd> | |
| 616 explanatory text of the task (string) | |
| 617 </dd> | |
| 618 </dl><a NAME="TaskViewer.addTask" ID="TaskViewer.addTask"></a> | |
| 619 <h4>TaskViewer.addTask</h4> | |
| 620 <b>addTask</b>(<i>description, priority = 1, filename = "", lineno = 0, completed = False, _time = 0, isProjectTask = False, isBugfixTask = False, longtext = ""</i>) | |
| 621 <p> | |
| 622 Public slot to add a task. | |
| 623 </p><dl> | |
| 624 <dt><i>description</i></dt> | |
| 625 <dd> | |
| 626 descriptive text of the task (string) | |
| 627 </dd><dt><i>priority</i></dt> | |
| 628 <dd> | |
| 629 priority of the task (0=high, 1=normal, 2=low) | |
| 630 </dd><dt><i>filename</i></dt> | |
| 631 <dd> | |
| 632 filename containing the task (string) | |
| 633 </dd><dt><i>lineno</i></dt> | |
| 634 <dd> | |
| 635 line number containing the task (integer) | |
| 636 </dd><dt><i>completed</i></dt> | |
| 637 <dd> | |
| 638 flag indicating completion status (boolean) | |
| 639 </dd><dt><i>_time</i></dt> | |
| 640 <dd> | |
| 641 creation time of the task (float, if 0 use current time) | |
| 642 </dd><dt><i>isProjectTask</i></dt> | |
| 643 <dd> | |
| 644 flag indicating a task related to the current | |
| 645 project (boolean) | |
| 646 </dd><dt><i>isBugfixTask</i></dt> | |
| 647 <dd> | |
| 648 flag indicating a bugfix task (boolean) | |
| 649 </dd><dt><i>longtext</i></dt> | |
| 650 <dd> | |
| 651 explanatory text of the task (string) | |
| 652 </dd> | |
| 653 </dl><a NAME="TaskViewer.clearFileTasks" ID="TaskViewer.clearFileTasks"></a> | |
| 654 <h4>TaskViewer.clearFileTasks</h4> | |
| 655 <b>clearFileTasks</b>(<i>filename</i>) | |
| 656 <p> | |
| 657 Public slot to clear all tasks related to a file. | |
| 658 </p><dl> | |
| 659 <dt><i>filename</i></dt> | |
| 660 <dd> | |
| 661 name of the file (string) | |
| 662 </dd> | |
| 663 </dl><a NAME="TaskViewer.clearProjectTasks" ID="TaskViewer.clearProjectTasks"></a> | |
| 664 <h4>TaskViewer.clearProjectTasks</h4> | |
| 665 <b>clearProjectTasks</b>(<i></i>) | |
| 666 <p> | |
| 667 Public slot to clear project related tasks. | |
| 668 </p><a NAME="TaskViewer.clearTasks" ID="TaskViewer.clearTasks"></a> | |
| 669 <h4>TaskViewer.clearTasks</h4> | |
| 670 <b>clearTasks</b>(<i></i>) | |
| 671 <p> | |
| 672 Public slot to clear all tasks from display. | |
| 673 </p><a NAME="TaskViewer.getGlobalTasks" ID="TaskViewer.getGlobalTasks"></a> | |
| 674 <h4>TaskViewer.getGlobalTasks</h4> | |
| 675 <b>getGlobalTasks</b>(<i></i>) | |
| 676 <p> | |
| 677 Public method to retrieve all non project related tasks. | |
| 678 </p><dl> | |
| 679 <dt>Returns:</dt> | |
| 680 <dd> | |
| 681 copy of tasks (list of Task) | |
| 682 </dd> | |
| 683 </dl><a NAME="TaskViewer.getProjectTasks" ID="TaskViewer.getProjectTasks"></a> | |
| 684 <h4>TaskViewer.getProjectTasks</h4> | |
| 685 <b>getProjectTasks</b>(<i></i>) | |
| 686 <p> | |
| 687 Public method to retrieve all project related tasks. | |
| 688 </p><dl> | |
| 689 <dt>Returns:</dt> | |
| 690 <dd> | |
| 691 copy of tasks (list of Task) | |
| 692 </dd> | |
| 693 </dl><a NAME="TaskViewer.handlePreferencesChanged" ID="TaskViewer.handlePreferencesChanged"></a> | |
| 694 <h4>TaskViewer.handlePreferencesChanged</h4> | |
| 695 <b>handlePreferencesChanged</b>(<i></i>) | |
| 696 <p> | |
| 697 Public slot to react to changes of the preferences. | |
| 698 </p><a NAME="TaskViewer.setProjectOpen" ID="TaskViewer.setProjectOpen"></a> | |
| 699 <h4>TaskViewer.setProjectOpen</h4> | |
| 700 <b>setProjectOpen</b>(<i>o = False</i>) | |
| 701 <p> | |
| 702 Public slot to set the project status. | |
| 703 </p><dl> | |
| 704 <dt><i>o</i></dt> | |
| 705 <dd> | |
| 706 flag indicating the project status | |
| 707 </dd> | |
| 708 </dl> | |
| 709 <div align="right"><a href="#top">Up</a></div> | |
| 710 <hr /> | |
| 711 </body></html> |
