Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric6.Tasks.TaskViewer.html
Documentation/Source/eric6.Tasks.TaskViewer.html
- changeset 5117
- 1faa0780ae1d
- parent 5105
- 8a773a100c34
- child 5851
- 8f8b264e5d5f
equal
deleted
inserted
replaced
| 5115:ed2f37c1f6b6 | 5117:1faa0780ae1d |
|---|---|
| 32 <tr><td>None</td></tr> | 32 <tr><td>None</td></tr> |
| 33 </table> | 33 </table> |
| 34 <h3>Classes</h3> | 34 <h3>Classes</h3> |
| 35 <table> | 35 <table> |
| 36 <tr> | 36 <tr> |
| 37 <td><a href="#ProjectTaskExtractionThread">ProjectTaskExtractionThread</a></td> | |
| 38 <td>Class implementing a thread to extract tasks related to a project.</td> | |
| 39 </tr><tr> | |
| 37 <td><a href="#TaskViewer">TaskViewer</a></td> | 40 <td><a href="#TaskViewer">TaskViewer</a></td> |
| 38 <td>Class implementing the task viewer.</td> | 41 <td>Class implementing the task viewer.</td> |
| 39 </tr> | 42 </tr> |
| 40 </table> | 43 </table> |
| 41 <h3>Functions</h3> | 44 <h3>Functions</h3> |
| 42 <table> | 45 <table> |
| 43 <tr><td>None</td></tr> | 46 <tr><td>None</td></tr> |
| 44 </table> | 47 </table> |
| 48 <hr /><hr /> | |
| 49 <a NAME="ProjectTaskExtractionThread" ID="ProjectTaskExtractionThread"></a> | |
| 50 <h2>ProjectTaskExtractionThread</h2> | |
| 51 <p> | |
| 52 Class implementing a thread to extract tasks related to a project. | |
| 53 </p><h3>Signals</h3> | |
| 54 <dl> | |
| 55 <dt>taskFound(str, str, int, int)</dt> | |
| 56 <dd> | |
| 57 emitted with the task description, | |
| 58 the file name, the line number and task type to signal the presence of | |
| 59 a task | |
| 60 </dd> | |
| 61 </dl> | |
| 62 <h3>Derived from</h3> | |
| 63 QThread | |
| 64 <h3>Class Attributes</h3> | |
| 65 <table> | |
| 66 <tr><td>None</td></tr> | |
| 67 </table> | |
| 68 <h3>Class Methods</h3> | |
| 69 <table> | |
| 70 <tr><td>None</td></tr> | |
| 71 </table> | |
| 72 <h3>Methods</h3> | |
| 73 <table> | |
| 74 <tr> | |
| 75 <td><a href="#ProjectTaskExtractionThread.__init__">ProjectTaskExtractionThread</a></td> | |
| 76 <td>Constructor</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#ProjectTaskExtractionThread.requestInterrupt">requestInterrupt</a></td> | |
| 79 <td>Public method to request iterruption of the thread.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#ProjectTaskExtractionThread.run">run</a></td> | |
| 82 <td>Public thread method to scan the given files.</td> | |
| 83 </tr><tr> | |
| 84 <td><a href="#ProjectTaskExtractionThread.scan">scan</a></td> | |
| 85 <td>Public method to scan the given list of files for tasks.</td> | |
| 86 </tr> | |
| 87 </table> | |
| 88 <h3>Static Methods</h3> | |
| 89 <table> | |
| 90 <tr><td>None</td></tr> | |
| 91 </table> | |
| 92 <a NAME="ProjectTaskExtractionThread.__init__" ID="ProjectTaskExtractionThread.__init__"></a> | |
| 93 <h4>ProjectTaskExtractionThread (Constructor)</h4> | |
| 94 <b>ProjectTaskExtractionThread</b>(<i>parent=None</i>) | |
| 95 <p> | |
| 96 Constructor | |
| 97 </p><dl> | |
| 98 <dt><i>parent</i></dt> | |
| 99 <dd> | |
| 100 reference to the parent object (QObject) | |
| 101 </dd> | |
| 102 </dl><a NAME="ProjectTaskExtractionThread.requestInterrupt" ID="ProjectTaskExtractionThread.requestInterrupt"></a> | |
| 103 <h4>ProjectTaskExtractionThread.requestInterrupt</h4> | |
| 104 <b>requestInterrupt</b>(<i></i>) | |
| 105 <p> | |
| 106 Public method to request iterruption of the thread. | |
| 107 </p><a NAME="ProjectTaskExtractionThread.run" ID="ProjectTaskExtractionThread.run"></a> | |
| 108 <h4>ProjectTaskExtractionThread.run</h4> | |
| 109 <b>run</b>(<i></i>) | |
| 110 <p> | |
| 111 Public thread method to scan the given files. | |
| 112 </p><a NAME="ProjectTaskExtractionThread.scan" ID="ProjectTaskExtractionThread.scan"></a> | |
| 113 <h4>ProjectTaskExtractionThread.scan</h4> | |
| 114 <b>scan</b>(<i>markers, files</i>) | |
| 115 <p> | |
| 116 Public method to scan the given list of files for tasks. | |
| 117 </p><dl> | |
| 118 <dt><i>markers</i> (dict of lists of str)</dt> | |
| 119 <dd> | |
| 120 dictionary of defined task markers | |
| 121 </dd><dt><i>files</i> (list of str)</dt> | |
| 122 <dd> | |
| 123 list of file names to be scanned | |
| 124 </dd> | |
| 125 </dl> | |
| 126 <div align="right"><a href="#top">Up</a></div> | |
| 45 <hr /><hr /> | 127 <hr /><hr /> |
| 46 <a NAME="TaskViewer" ID="TaskViewer"></a> | 128 <a NAME="TaskViewer" ID="TaskViewer"></a> |
| 47 <h2>TaskViewer</h2> | 129 <h2>TaskViewer</h2> |
| 48 <p> | 130 <p> |
| 49 Class implementing the task viewer. | 131 Class implementing the task viewer. |
| 169 <td><a href="#TaskViewer.saveProjectTasks">saveProjectTasks</a></td> | 251 <td><a href="#TaskViewer.saveProjectTasks">saveProjectTasks</a></td> |
| 170 <td>Public method to write the project tasks.</td> | 252 <td>Public method to write the project tasks.</td> |
| 171 </tr><tr> | 253 </tr><tr> |
| 172 <td><a href="#TaskViewer.setProjectOpen">setProjectOpen</a></td> | 254 <td><a href="#TaskViewer.setProjectOpen">setProjectOpen</a></td> |
| 173 <td>Public slot to set the project status.</td> | 255 <td>Public slot to set the project status.</td> |
| 256 </tr><tr> | |
| 257 <td><a href="#TaskViewer.stopProjectTaskExtraction">stopProjectTaskExtraction</a></td> | |
| 258 <td>Public method to stop the project task extraction thread.</td> | |
| 174 </tr> | 259 </tr> |
| 175 </table> | 260 </table> |
| 176 <h3>Static Methods</h3> | 261 <h3>Static Methods</h3> |
| 177 <table> | 262 <table> |
| 178 <tr><td>None</td></tr> | 263 <tr><td>None</td></tr> |
| 486 </p><dl> | 571 </p><dl> |
| 487 <dt><i>o</i></dt> | 572 <dt><i>o</i></dt> |
| 488 <dd> | 573 <dd> |
| 489 flag indicating the project status | 574 flag indicating the project status |
| 490 </dd> | 575 </dd> |
| 491 </dl> | 576 </dl><a NAME="TaskViewer.stopProjectTaskExtraction" ID="TaskViewer.stopProjectTaskExtraction"></a> |
| 577 <h4>TaskViewer.stopProjectTaskExtraction</h4> | |
| 578 <b>stopProjectTaskExtraction</b>(<i></i>) | |
| 579 <p> | |
| 580 Public method to stop the project task extraction thread. | |
| 581 </p> | |
| 492 <div align="right"><a href="#top">Up</a></div> | 582 <div align="right"><a href="#top">Up</a></div> |
| 493 <hr /> | 583 <hr /> |
| 494 </body></html> | 584 </body></html> |
