eric6/Documentation/Source/eric6.Tasks.TaskViewer.html

changeset 8281
184ece570a2b
parent 8070
6758ba4670e1
child 8665
1600bcd3a378
--- a/eric6/Documentation/Source/eric6.Tasks.TaskViewer.html	Sun May 02 15:09:14 2021 +0200
+++ b/eric6/Documentation/Source/eric6.Tasks.TaskViewer.html	Sun May 02 15:09:29 2021 +0200
@@ -64,11 +64,11 @@
 <h3>Signals</h3>
 <dl>
 
-<dt>taskFound(str, str, int, int)</dt>
+<dt>taskFound(str, str, int, TaskType)</dt>
 <dd>
-emitted with the task description,
-        the file name, the line number and task type to signal the presence of
-        a task
+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>
@@ -561,96 +561,100 @@
 </dl>
 <a NAME="TaskViewer.addFileTask" ID="TaskViewer.addFileTask"></a>
 <h4>TaskViewer.addFileTask</h4>
-<b>addFileTask</b>(<i>summary, filename, lineno, taskType=Task.TypeTodo, description=""</i>)
+<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></dt>
+<dt><i>summary</i> (str)</dt>
 <dd>
-summary text of the task (string)
+summary text of the task
 </dd>
-<dt><i>filename</i></dt>
+<dt><i>filename</i> (str)</dt>
 <dd>
-filename containing the task (string)
+filename containing the task
 </dd>
-<dt><i>lineno</i></dt>
+<dt><i>lineno</i> (int)</dt>
 <dd>
-line number containing the task (integer)
+line number containing the task
 </dd>
-<dt><i>taskType</i></dt>
+<dt><i>taskType</i> (TaskType)</dt>
 <dd>
-type of the task (one of Task.TypeFixme, Task.TypeTodo,
-            Task.TypeWarning, Task.TypeNote)
+type of the task
 </dd>
-<dt><i>description</i></dt>
+<dt><i>description</i> (str)</dt>
 <dd>
-explanatory text of the task (string)
+explanatory text of the task
 </dd>
 </dl>
 <a NAME="TaskViewer.addTask" ID="TaskViewer.addTask"></a>
 <h4>TaskViewer.addTask</h4>
-<b>addTask</b>(<i>summary, priority=1, filename="", lineno=0, completed=False, _time=0, isProjectTask=False, taskType=Task.TypeTodo, description="", uid="", parentTask=None</i>)
+<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></dt>
+<dt><i>summary</i> (str)</dt>
 <dd>
-summary text of the task (string)
+summary text of the task
 </dd>
-<dt><i>priority</i></dt>
+<dt><i>priority</i> (TaskPriority)</dt>
 <dd>
-priority of the task (0=high, 1=normal, 2=low)
+priority of the task
 </dd>
-<dt><i>filename</i></dt>
+<dt><i>filename</i> (str)</dt>
 <dd>
-filename containing the task (string)
+filename containing the task
 </dd>
-<dt><i>lineno</i></dt>
+<dt><i>lineno</i> (int)</dt>
 <dd>
-line number containing the task (integer)
+line number containing the task
 </dd>
-<dt><i>completed</i></dt>
+<dt><i>completed</i> (bool)</dt>
 <dd>
-flag indicating completion status (boolean)
+flag indicating completion status
 </dd>
-<dt><i>_time</i></dt>
+<dt><i>_time</i> (float)</dt>
 <dd>
-creation time of the task (float, if 0 use current time)
+creation time of the task (if 0 use current time)
 </dd>
-<dt><i>isProjectTask</i></dt>
+<dt><i>isProjectTask</i> (bool)</dt>
 <dd>
 flag indicating a task related to the current
-            project (boolean)
+            project
 </dd>
-<dt><i>taskType</i></dt>
+<dt><i>taskType</i> (TaskType)</dt>
 <dd>
-type of the task (one of Task.TypeFixme, Task.TypeTodo,
-            Task.TypeWarning, Task.TypeNote)
+type of the task
 </dd>
-<dt><i>description</i></dt>
+<dt><i>description</i> (str)</dt>
 <dd>
-explanatory text of the task (string)
+explanatory text of the task
 </dd>
-<dt><i>uid</i></dt>
+<dt><i>uid</i> (str)</dt>
 <dd>
-unique id of the task (string)
+unique id of the task
 </dd>
-<dt><i>parentTask</i></dt>
+<dt><i>parentTask</i> (Task or str)</dt>
 <dd>
-reference to the parent task item (Task) or the
-            UID of the parent task
+reference to the parent task item or the UID of the
+            parent task
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-reference to the task item (Task)
+reference to the task item
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+Task
 </dd>
 </dl>
 <a NAME="TaskViewer.clearFileTasks" ID="TaskViewer.clearFileTasks"></a>

eric ide

mercurial