--- a/src/eric7/Documentation/Source/eric7.Tasks.TaskViewer.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.Tasks.TaskViewer.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,7 +7,6 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Tasks.TaskViewer</h1>
-
<p>
Module implementing a task viewer and associated classes.
</p>
@@ -16,15 +15,14 @@
generated tasks are derived from a comment with a special
introductory text. This text is configurable.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<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>
@@ -34,19 +32,20 @@
<td>Class implementing the task viewer.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<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>
@@ -60,19 +59,17 @@
<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>
@@ -90,19 +87,20 @@
<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> (QObject)</dt>
@@ -113,24 +111,24 @@
<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>
@@ -147,10 +145,10 @@
<hr />
<a NAME="TaskViewer" ID="TaskViewer"></a>
<h2>TaskViewer</h2>
-
<p>
Class implementing the task viewer.
</p>
+
<h3>Signals</h3>
<dl>
@@ -162,19 +160,17 @@
<h3>Derived from</h3>
QTreeWidget
<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="#TaskViewer.__init__">TaskViewer</a></td>
<td>Constructor</td>
@@ -332,19 +328,20 @@
<td>Public method to stop the project task extraction thread.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="TaskViewer.__init__" ID="TaskViewer.__init__"></a>
<h4>TaskViewer (Constructor)</h4>
<b>TaskViewer</b>(<i>parent, project</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>parent</i> (QWidget)</dt>
@@ -359,10 +356,10 @@
<a NAME="TaskViewer.__activateFilter" ID="TaskViewer.__activateFilter"></a>
<h4>TaskViewer.__activateFilter</h4>
<b>__activateFilter</b>(<i>on</i>)
-
<p>
Private slot to handle the "Filtered display" context menu entry.
</p>
+
<dl>
<dt><i>on</i> (bool)</dt>
@@ -373,52 +370,52 @@
<a NAME="TaskViewer.__checkTopLevelItems" ID="TaskViewer.__checkTopLevelItems"></a>
<h4>TaskViewer.__checkTopLevelItems</h4>
<b>__checkTopLevelItems</b>(<i></i>)
-
<p>
Private slot to check the 'Extracted Tasks' item for children.
</p>
+
<a NAME="TaskViewer.__configure" ID="TaskViewer.__configure"></a>
<h4>TaskViewer.__configure</h4>
<b>__configure</b>(<i></i>)
-
<p>
Private method to open the configuration dialog.
</p>
+
<a NAME="TaskViewer.__configureFilter" ID="TaskViewer.__configureFilter"></a>
<h4>TaskViewer.__configureFilter</h4>
<b>__configureFilter</b>(<i></i>)
-
<p>
Private slot to handle the "Configure filter" context menu entry.
</p>
+
<a NAME="TaskViewer.__configureProjectTasksScanOptions" ID="TaskViewer.__configureProjectTasksScanOptions"></a>
<h4>TaskViewer.__configureProjectTasksScanOptions</h4>
<b>__configureProjectTasksScanOptions</b>(<i></i>)
-
<p>
Private slot to configure scan options for project tasks.
</p>
+
<a NAME="TaskViewer.__copyTask" ID="TaskViewer.__copyTask"></a>
<h4>TaskViewer.__copyTask</h4>
<b>__copyTask</b>(<i></i>)
-
<p>
Private slot to handle the "Copy" context menu entry.
</p>
+
<a NAME="TaskViewer.__deleteCompleted" ID="TaskViewer.__deleteCompleted"></a>
<h4>TaskViewer.__deleteCompleted</h4>
<b>__deleteCompleted</b>(<i></i>)
-
<p>
Private slot to handle the "Delete Completed Tasks" context menu entry.
</p>
+
<a NAME="TaskViewer.__deleteSubTasks" ID="TaskViewer.__deleteSubTasks"></a>
<h4>TaskViewer.__deleteSubTasks</h4>
<b>__deleteSubTasks</b>(<i>task</i>)
-
<p>
Private method to delete all sub-tasks.
</p>
+
<dl>
<dt><i>task</i> (Task)</dt>
@@ -429,10 +426,10 @@
<a NAME="TaskViewer.__deleteTask" ID="TaskViewer.__deleteTask"></a>
<h4>TaskViewer.__deleteTask</h4>
<b>__deleteTask</b>(<i>task=None</i>)
-
<p>
Private slot to delete a task.
</p>
+
<dl>
<dt><i>task</i> (Task)</dt>
@@ -443,87 +440,87 @@
<a NAME="TaskViewer.__editTaskProperties" ID="TaskViewer.__editTaskProperties"></a>
<h4>TaskViewer.__editTaskProperties</h4>
<b>__editTaskProperties</b>(<i></i>)
-
<p>
Private slot to handle the "Properties" context menu entry.
</p>
+
<a NAME="TaskViewer.__generateTopLevelItems" ID="TaskViewer.__generateTopLevelItems"></a>
<h4>TaskViewer.__generateTopLevelItems</h4>
<b>__generateTopLevelItems</b>(<i></i>)
-
<p>
Private method to generate the 'Extracted Tasks' item.
</p>
+
<a NAME="TaskViewer.__goToTask" ID="TaskViewer.__goToTask"></a>
<h4>TaskViewer.__goToTask</h4>
<b>__goToTask</b>(<i></i>)
-
<p>
Private slot to handle the "Go To" context menu entry.
</p>
+
<a NAME="TaskViewer.__markCompleted" ID="TaskViewer.__markCompleted"></a>
<h4>TaskViewer.__markCompleted</h4>
<b>__markCompleted</b>(<i></i>)
-
<p>
Private slot to handle the "Mark Completed" context menu entry.
</p>
+
<a NAME="TaskViewer.__newSubTask" ID="TaskViewer.__newSubTask"></a>
<h4>TaskViewer.__newSubTask</h4>
<b>__newSubTask</b>(<i></i>)
-
<p>
Private slot to handle the "New Sub-Task" context menu entry.
</p>
+
<a NAME="TaskViewer.__newTask" ID="TaskViewer.__newTask"></a>
<h4>TaskViewer.__newTask</h4>
<b>__newTask</b>(<i></i>)
-
<p>
Private slot to handle the "New Task" context menu entry.
</p>
+
<a NAME="TaskViewer.__pasteMainTask" ID="TaskViewer.__pasteMainTask"></a>
<h4>TaskViewer.__pasteMainTask</h4>
<b>__pasteMainTask</b>(<i></i>)
-
<p>
Private slot to handle the "Paste as Main Task" context menu entry.
</p>
+
<a NAME="TaskViewer.__pasteTask" ID="TaskViewer.__pasteTask"></a>
<h4>TaskViewer.__pasteTask</h4>
<b>__pasteTask</b>(<i></i>)
-
<p>
Private slot to handle the "Paste" context menu entry.
</p>
+
<a NAME="TaskViewer.__refreshDisplay" ID="TaskViewer.__refreshDisplay"></a>
<h4>TaskViewer.__refreshDisplay</h4>
<b>__refreshDisplay</b>(<i></i>)
-
<p>
Private method to refresh the display.
</p>
+
<a NAME="TaskViewer.__resizeColumns" ID="TaskViewer.__resizeColumns"></a>
<h4>TaskViewer.__resizeColumns</h4>
<b>__resizeColumns</b>(<i></i>)
-
<p>
Private method to resize the list columns.
</p>
+
<a NAME="TaskViewer.__resort" ID="TaskViewer.__resort"></a>
<h4>TaskViewer.__resort</h4>
<b>__resort</b>(<i></i>)
-
<p>
Private method to resort the tree.
</p>
+
<a NAME="TaskViewer.__showContextMenu" ID="TaskViewer.__showContextMenu"></a>
<h4>TaskViewer.__showContextMenu</h4>
<b>__showContextMenu</b>(<i>coord</i>)
-
<p>
Private slot to show the context menu of the list.
</p>
+
<dl>
<dt><i>coord</i> (QPoint)</dt>
@@ -534,10 +531,10 @@
<a NAME="TaskViewer.__taskItemActivated" ID="TaskViewer.__taskItemActivated"></a>
<h4>TaskViewer.__taskItemActivated</h4>
<b>__taskItemActivated</b>(<i>itm, col</i>)
-
<p>
Private slot to handle the activation of an item.
</p>
+
<dl>
<dt><i>itm</i> (QTreeWidgetItem)</dt>
@@ -552,10 +549,10 @@
<a NAME="TaskViewer.addFileTask" ID="TaskViewer.addFileTask"></a>
<h4>TaskViewer.addFileTask</h4>
<b>addFileTask</b>(<i>summary, filename, lineno, taskType=TaskType.TODO, description=""</i>)
-
<p>
Public slot to add a file related task.
</p>
+
<dl>
<dt><i>summary</i> (str)</dt>
@@ -582,10 +579,10 @@
<a NAME="TaskViewer.addTask" ID="TaskViewer.addTask"></a>
<h4>TaskViewer.addTask</h4>
<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>)
-
<p>
Public slot to add a task.
</p>
+
<dl>
<dt><i>summary</i> (str)</dt>
@@ -650,10 +647,10 @@
<a NAME="TaskViewer.clearFileTasks" ID="TaskViewer.clearFileTasks"></a>
<h4>TaskViewer.clearFileTasks</h4>
<b>clearFileTasks</b>(<i>filename, conditionally=False</i>)
-
<p>
Public slot to clear all tasks related to a file.
</p>
+
<dl>
<dt><i>filename</i> (str)</dt>
@@ -669,10 +666,10 @@
<a NAME="TaskViewer.clearProjectTasks" ID="TaskViewer.clearProjectTasks"></a>
<h4>TaskViewer.clearProjectTasks</h4>
<b>clearProjectTasks</b>(<i>fileOnly=False</i>)
-
<p>
Public slot to clear project related tasks.
</p>
+
<dl>
<dt><i>fileOnly</i> (bool)</dt>
@@ -683,17 +680,17 @@
<a NAME="TaskViewer.clearTasks" ID="TaskViewer.clearTasks"></a>
<h4>TaskViewer.clearTasks</h4>
<b>clearTasks</b>(<i></i>)
-
<p>
Public slot to clear all tasks from display.
</p>
+
<a NAME="TaskViewer.containsTask" ID="TaskViewer.containsTask"></a>
<h4>TaskViewer.containsTask</h4>
<b>containsTask</b>(<i>taskToTest</i>)
-
<p>
Public method to test, if a task is already in the tasks list.
</p>
+
<dl>
<dt><i>taskToTest</i> (Task)</dt>
@@ -716,10 +713,10 @@
<a NAME="TaskViewer.findParentTask" ID="TaskViewer.findParentTask"></a>
<h4>TaskViewer.findParentTask</h4>
<b>findParentTask</b>(<i>parentUid</i>)
-
<p>
Public method to find a parent task by its ID.
</p>
+
<dl>
<dt><i>parentUid</i> (str)</dt>
@@ -742,10 +739,10 @@
<a NAME="TaskViewer.getGlobalTasks" ID="TaskViewer.getGlobalTasks"></a>
<h4>TaskViewer.getGlobalTasks</h4>
<b>getGlobalTasks</b>(<i></i>)
-
<p>
Public method to retrieve all non project related tasks.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -761,10 +758,10 @@
<a NAME="TaskViewer.getProjectTasks" ID="TaskViewer.getProjectTasks"></a>
<h4>TaskViewer.getProjectTasks</h4>
<b>getProjectTasks</b>(<i></i>)
-
<p>
Public method to retrieve all project related tasks.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -780,10 +777,10 @@
<a NAME="TaskViewer.getTasksScanFilter" ID="TaskViewer.getTasksScanFilter"></a>
<h4>TaskViewer.getTasksScanFilter</h4>
<b>getTasksScanFilter</b>(<i></i>)
-
<p>
Public method to get the project scan filter.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -799,17 +796,17 @@
<a NAME="TaskViewer.handlePreferencesChanged" ID="TaskViewer.handlePreferencesChanged"></a>
<h4>TaskViewer.handlePreferencesChanged</h4>
<b>handlePreferencesChanged</b>(<i></i>)
-
<p>
Public slot to react to changes of the preferences.
</p>
+
<a NAME="TaskViewer.regenerateProjectTasks" ID="TaskViewer.regenerateProjectTasks"></a>
<h4>TaskViewer.regenerateProjectTasks</h4>
<b>regenerateProjectTasks</b>(<i>quiet=False</i>)
-
<p>
Public slot to regenerate project related tasks.
</p>
+
<dl>
<dt><i>quiet</i> (bool)</dt>
@@ -820,17 +817,17 @@
<a NAME="TaskViewer.saveProjectTasks" ID="TaskViewer.saveProjectTasks"></a>
<h4>TaskViewer.saveProjectTasks</h4>
<b>saveProjectTasks</b>(<i></i>)
-
<p>
Public method to write the project tasks.
</p>
+
<a NAME="TaskViewer.setProjectOpen" ID="TaskViewer.setProjectOpen"></a>
<h4>TaskViewer.setProjectOpen</h4>
<b>setProjectOpen</b>(<i>o=False</i>)
-
<p>
Public slot to set the project status.
</p>
+
<dl>
<dt><i>o</i> (bool)</dt>
@@ -841,10 +838,10 @@
<a NAME="TaskViewer.setTasksScanFilter" ID="TaskViewer.setTasksScanFilter"></a>
<h4>TaskViewer.setTasksScanFilter</h4>
<b>setTasksScanFilter</b>(<i>filterStr: str</i>)
-
<p>
Public method to set the project scan filter.
</p>
+
<dl>
<dt><i>filterStr</i> (str)</dt>
@@ -855,10 +852,10 @@
<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
+</body></html>
