diff -r ed2f37c1f6b6 -r 1faa0780ae1d Documentation/Source/eric6.Tasks.TaskViewer.html --- a/Documentation/Source/eric6.Tasks.TaskViewer.html Tue Aug 30 20:13:21 2016 +0200 +++ b/Documentation/Source/eric6.Tasks.TaskViewer.html Wed Aug 31 18:20:40 2016 +0200 @@ -34,6 +34,9 @@ <h3>Classes</h3> <table> <tr> +<td><a href="#ProjectTaskExtractionThread">ProjectTaskExtractionThread</a></td> +<td>Class implementing a thread to extract tasks related to a project.</td> +</tr><tr> <td><a href="#TaskViewer">TaskViewer</a></td> <td>Class implementing the task viewer.</td> </tr> @@ -43,6 +46,85 @@ <tr><td>None</td></tr> </table> <hr /><hr /> +<a NAME="ProjectTaskExtractionThread" ID="ProjectTaskExtractionThread"></a> +<h2>ProjectTaskExtractionThread</h2> +<p> + Class implementing a thread to extract tasks related to a project. +</p><h3>Signals</h3> +<dl> +<dt>taskFound(str, str, int, int)</dt> +<dd> +emitted with the task description, + the file name, the line number and task type to signal the presence of + a task +</dd> +</dl> +<h3>Derived from</h3> +QThread +<h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Class Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#ProjectTaskExtractionThread.__init__">ProjectTaskExtractionThread</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#ProjectTaskExtractionThread.requestInterrupt">requestInterrupt</a></td> +<td>Public method to request iterruption of the thread.</td> +</tr><tr> +<td><a href="#ProjectTaskExtractionThread.run">run</a></td> +<td>Public thread method to scan the given files.</td> +</tr><tr> +<td><a href="#ProjectTaskExtractionThread.scan">scan</a></td> +<td>Public method to scan the given list of files for tasks.</td> +</tr> +</table> +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<a NAME="ProjectTaskExtractionThread.__init__" ID="ProjectTaskExtractionThread.__init__"></a> +<h4>ProjectTaskExtractionThread (Constructor)</h4> +<b>ProjectTaskExtractionThread</b>(<i>parent=None</i>) +<p> + Constructor +</p><dl> +<dt><i>parent</i></dt> +<dd> +reference to the parent object (QObject) +</dd> +</dl><a NAME="ProjectTaskExtractionThread.requestInterrupt" ID="ProjectTaskExtractionThread.requestInterrupt"></a> +<h4>ProjectTaskExtractionThread.requestInterrupt</h4> +<b>requestInterrupt</b>(<i></i>) +<p> + Public method to request iterruption of the thread. +</p><a NAME="ProjectTaskExtractionThread.run" ID="ProjectTaskExtractionThread.run"></a> +<h4>ProjectTaskExtractionThread.run</h4> +<b>run</b>(<i></i>) +<p> + Public thread method to scan the given files. +</p><a NAME="ProjectTaskExtractionThread.scan" ID="ProjectTaskExtractionThread.scan"></a> +<h4>ProjectTaskExtractionThread.scan</h4> +<b>scan</b>(<i>markers, files</i>) +<p> + Public method to scan the given list of files for tasks. +</p><dl> +<dt><i>markers</i> (dict of lists of str)</dt> +<dd> +dictionary of defined task markers +</dd><dt><i>files</i> (list of str)</dt> +<dd> +list of file names to be scanned +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> <a NAME="TaskViewer" ID="TaskViewer"></a> <h2>TaskViewer</h2> <p> @@ -171,6 +253,9 @@ </tr><tr> <td><a href="#TaskViewer.setProjectOpen">setProjectOpen</a></td> <td>Public slot to set the project status.</td> +</tr><tr> +<td><a href="#TaskViewer.stopProjectTaskExtraction">stopProjectTaskExtraction</a></td> +<td>Public method to stop the project task extraction thread.</td> </tr> </table> <h3>Static Methods</h3> @@ -488,7 +573,12 @@ <dd> flag indicating the project status </dd> -</dl> +</dl><a NAME="TaskViewer.stopProjectTaskExtraction" ID="TaskViewer.stopProjectTaskExtraction"></a> +<h4>TaskViewer.stopProjectTaskExtraction</h4> +<b>stopProjectTaskExtraction</b>(<i></i>) +<p> + Public method to stop the project task extraction thread. +</p> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file