eric6/Documentation/Source/eric6.Tasks.Task.html

changeset 8281
184ece570a2b
parent 8049
af58c1d47e5e
--- a/eric6/Documentation/Source/eric6.Tasks.Task.html	Sun May 02 15:09:14 2021 +0200
+++ b/eric6/Documentation/Source/eric6.Tasks.Task.html	Sun May 02 15:09:29 2021 +0200
@@ -38,6 +38,14 @@
 <td><a href="#Task">Task</a></td>
 <td>Class implementing the task data structure.</td>
 </tr>
+<tr>
+<td><a href="#TaskPriority">TaskPriority</a></td>
+<td>Class defining the task priorities.</td>
+</tr>
+<tr>
+<td><a href="#TaskType">TaskType</a></td>
+<td>Class defining the task types.</td>
+</tr>
 </table>
 <h3>Functions</h3>
 
@@ -57,7 +65,7 @@
 <h3>Class Attributes</h3>
 
 <table>
-<tr><td>TaskType2ColorName</td></tr><tr><td>TaskType2IconName</td></tr><tr><td>TaskType2MarkersName</td></tr><tr><td>TypeDocu</td></tr><tr><td>TypeFixme</td></tr><tr><td>TypeNone</td></tr><tr><td>TypeNote</td></tr><tr><td>TypeTest</td></tr><tr><td>TypeTodo</td></tr><tr><td>TypeWarning</td></tr>
+<tr><td>TaskType2ColorName</td></tr><tr><td>TaskType2IconName</td></tr><tr><td>TaskType2MarkersName</td></tr>
 </table>
 <h3>Class Methods</h3>
 
@@ -129,6 +137,10 @@
 <td>Public slot to update the description.</td>
 </tr>
 <tr>
+<td><a href="#Task.setTaskType">setTaskType</a></td>
+<td>Public method to update the task type.</td>
+</tr>
+<tr>
 <td><a href="#Task.toDict">toDict</a></td>
 <td>Public method to convert the task data to a dictionary.</td>
 </tr>
@@ -141,62 +153,61 @@
 
 <a NAME="Task.__init__" ID="Task.__init__"></a>
 <h4>Task (Constructor)</h4>
-<b>Task</b>(<i>summary, priority=1, filename="", lineno=0, completed=False, _time=0, isProjectTask=False, taskType=TypeTodo, project=None, description="", uid="", parentUid=""</i>)
+<b>Task</b>(<i>summary, priority=TaskPriority.NORMAL, filename="", lineno=0, completed=False, _time=0, isProjectTask=False, taskType=TaskType.TODO, project=None, description="", uid="", parentUid=""</i>)
 
 <p>
         Constructor
 </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 TypeFixme, TypeTodo,
-            TypeWarning, TypeNote, TypeTest, TypeDocu)
+type of the task
 </dd>
-<dt><i>project</i></dt>
+<dt><i>project</i> (Project)</dt>
 <dd>
-reference to the project object (Project)
+reference to the project object
 </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>parentUid</i></dt>
+<dt><i>parentUid</i> (str)</dt>
 <dd>
-unique id of the parent task (string)
+unique id of the parent task
 </dd>
 </dl>
 <a NAME="Task.colorizeTask" ID="Task.colorizeTask"></a>
@@ -334,9 +345,9 @@
 </p>
 <dl>
 
-<dt><i>description</i></dt>
+<dt><i>description</i> (str)</dt>
 <dd>
-descriptive text of the task (string)
+descriptive text of the task
 </dd>
 </dl>
 <a NAME="Task.setPriority" ID="Task.setPriority"></a>
@@ -348,9 +359,9 @@
 </p>
 <dl>
 
-<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>
 </dl>
 <a NAME="Task.setProjectTask" ID="Task.setProjectTask"></a>
@@ -381,6 +392,20 @@
 summary text of the task (string)
 </dd>
 </dl>
+<a NAME="Task.setTaskType" ID="Task.setTaskType"></a>
+<h4>Task.setTaskType</h4>
+<b>setTaskType</b>(<i>taskType</i>)
+
+<p>
+        Public method to update the task type.
+</p>
+<dl>
+
+<dt><i>taskType</i> (TaskType)</dt>
+<dd>
+type of the task
+</dd>
+</dl>
 <a NAME="Task.toDict" ID="Task.toDict"></a>
 <h4>Task.toDict</h4>
 <b>toDict</b>(<i></i>)
@@ -402,4 +427,68 @@
 </dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr />
+<hr />
+<a NAME="TaskPriority" ID="TaskPriority"></a>
+<h2>TaskPriority</h2>
+
+<p>
+    Class defining the task priorities.
+</p>
+<h3>Derived from</h3>
+enum.IntEnum
+<h3>Class Attributes</h3>
+
+<table>
+<tr><td>HIGH</td></tr><tr><td>LOW</td></tr><tr><td>NORMAL</td></tr>
+</table>
+<h3>Class Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="TaskType" ID="TaskType"></a>
+<h2>TaskType</h2>
+
+<p>
+    Class defining the task types.
+</p>
+<h3>Derived from</h3>
+enum.IntEnum
+<h3>Class Attributes</h3>
+
+<table>
+<tr><td>DOCU</td></tr><tr><td>FIXME</td></tr><tr><td>NONE</td></tr><tr><td>NOTE</td></tr><tr><td>TEST</td></tr><tr><td>TODO</td></tr><tr><td>WARNING</td></tr>
+</table>
+<h3>Class Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<div align="right"><a href="#top">Up</a></div>
+<hr />
 </body></html>
\ No newline at end of file

eric ide

mercurial