--- a/Documentation/Source/eric5.Tasks.TaskViewer.html Sat Apr 28 17:00:32 2012 +0200
+++ b/Documentation/Source/eric5.Tasks.TaskViewer.html Sun Apr 29 16:42:02 2012 +0200
@@ -35,12 +35,6 @@
<h3>Classes</h3>
<table>
<tr>
-<td><a href="#Task">Task</a></td>
-<td>Class implementing the task data structure.</td>
-</tr><tr>
-<td><a href="#TaskFilter">TaskFilter</a></td>
-<td>Class implementing a filter for tasks.</td>
-</tr><tr>
<td><a href="#TaskViewer">TaskViewer</a></td>
<td>Class implementing the task viewer.</td>
</tr>
@@ -50,359 +44,6 @@
<tr><td>None</td></tr>
</table>
<hr /><hr />
-<a NAME="Task" ID="Task"></a>
-<h2>Task</h2>
-<p>
- Class implementing the task data structure.
-</p>
-<h3>Derived from</h3>
-QTreeWidgetItem
-<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="#Task.__init__">Task</a></td>
-<td>Constructor</td>
-</tr><tr>
-<td><a href="#Task.colorizeTask">colorizeTask</a></td>
-<td>Public slot to set the colors of the task item.</td>
-</tr><tr>
-<td><a href="#Task.getFilename">getFilename</a></td>
-<td>Public method to retrieve the tasks filename.</td>
-</tr><tr>
-<td><a href="#Task.getLineno">getLineno</a></td>
-<td>Public method to retrieve the tasks linenumber.</td>
-</tr><tr>
-<td><a href="#Task.isCompleted">isCompleted</a></td>
-<td>Public slot to return the completion status.</td>
-</tr><tr>
-<td><a href="#Task.isProjectTask">isProjectTask</a></td>
-<td>Public slot to return the project relation status.</td>
-</tr><tr>
-<td><a href="#Task.setCompleted">setCompleted</a></td>
-<td>Public slot to update the completed flag.</td>
-</tr><tr>
-<td><a href="#Task.setDescription">setDescription</a></td>
-<td>Public slot to update the description.</td>
-</tr><tr>
-<td><a href="#Task.setLongText">setLongText</a></td>
-<td>Public slot to update the longtext field.</td>
-</tr><tr>
-<td><a href="#Task.setPriority">setPriority</a></td>
-<td>Public slot to update the priority.</td>
-</tr><tr>
-<td><a href="#Task.setProjectTask">setProjectTask</a></td>
-<td>Public method to set the project relation flag.</td>
-</tr>
-</table>
-<h3>Static Methods</h3>
-<table>
-<tr><td>None</td></tr>
-</table>
-<a NAME="Task.__init__" ID="Task.__init__"></a>
-<h4>Task (Constructor)</h4>
-<b>Task</b>(<i>description, priority=1, filename="", lineno=0, completed=False, _time=0, isProjectTask=False, isBugfixTask=False, project=None, longtext=""</i>)
-<p>
- Constructor
-</p><dl>
-<dt><i>parent</i></dt>
-<dd>
-parent widget of the task (QWidget)
-</dd><dt><i>description</i></dt>
-<dd>
-descriptive text of the task (string)
-</dd><dt><i>priority</i></dt>
-<dd>
-priority of the task (0=high, 1=normal, 2=low)
-</dd><dt><i>filename</i></dt>
-<dd>
-filename containing the task (string)
-</dd><dt><i>lineno</i></dt>
-<dd>
-line number containing the task (integer)
-</dd><dt><i>completed</i></dt>
-<dd>
-flag indicating completion status (boolean)
-</dd><dt><i>_time</i></dt>
-<dd>
-creation time of the task (float, if 0 use current time)
-</dd><dt><i>isProjectTask</i></dt>
-<dd>
-flag indicating a task related to the current project
- (boolean)
-</dd><dt><i>isBugfixTask</i></dt>
-<dd>
-flag indicating a bugfix task (boolean)
-</dd><dt><i>project</i></dt>
-<dd>
-reference to the project object (Project)
-</dd><dt><i>longtext</i></dt>
-<dd>
-explanatory text of the task (string)
-</dd>
-</dl><a NAME="Task.colorizeTask" ID="Task.colorizeTask"></a>
-<h4>Task.colorizeTask</h4>
-<b>colorizeTask</b>(<i></i>)
-<p>
- Public slot to set the colors of the task item.
-</p><a NAME="Task.getFilename" ID="Task.getFilename"></a>
-<h4>Task.getFilename</h4>
-<b>getFilename</b>(<i></i>)
-<p>
- Public method to retrieve the tasks filename.
-</p><dl>
-<dt>Returns:</dt>
-<dd>
-filename (string)
-</dd>
-</dl><a NAME="Task.getLineno" ID="Task.getLineno"></a>
-<h4>Task.getLineno</h4>
-<b>getLineno</b>(<i></i>)
-<p>
- Public method to retrieve the tasks linenumber.
-</p><dl>
-<dt>Returns:</dt>
-<dd>
-linenumber (integer)
-</dd>
-</dl><a NAME="Task.isCompleted" ID="Task.isCompleted"></a>
-<h4>Task.isCompleted</h4>
-<b>isCompleted</b>(<i></i>)
-<p>
- Public slot to return the completion status.
-</p><dl>
-<dt>Returns:</dt>
-<dd>
-flag indicating the completion status (boolean)
-</dd>
-</dl><a NAME="Task.isProjectTask" ID="Task.isProjectTask"></a>
-<h4>Task.isProjectTask</h4>
-<b>isProjectTask</b>(<i></i>)
-<p>
- Public slot to return the project relation status.
-</p><dl>
-<dt>Returns:</dt>
-<dd>
-flag indicating the project relation status (boolean)
-</dd>
-</dl><a NAME="Task.setCompleted" ID="Task.setCompleted"></a>
-<h4>Task.setCompleted</h4>
-<b>setCompleted</b>(<i>completed</i>)
-<p>
- Public slot to update the completed flag.
-</p><dl>
-<dt><i>completed</i></dt>
-<dd>
-flag indicating completion status (boolean)
-</dd>
-</dl><a NAME="Task.setDescription" ID="Task.setDescription"></a>
-<h4>Task.setDescription</h4>
-<b>setDescription</b>(<i>description</i>)
-<p>
- Public slot to update the description.
-</p><dl>
-<dt><i>longtext</i></dt>
-<dd>
-explanatory text of the task (string)
-</dd>
-</dl><a NAME="Task.setLongText" ID="Task.setLongText"></a>
-<h4>Task.setLongText</h4>
-<b>setLongText</b>(<i>longtext</i>)
-<p>
- Public slot to update the longtext field.
-</p><dl>
-<dt><i>longtext</i></dt>
-<dd>
-descriptive text of the task (string)
-</dd>
-</dl><a NAME="Task.setPriority" ID="Task.setPriority"></a>
-<h4>Task.setPriority</h4>
-<b>setPriority</b>(<i>priority</i>)
-<p>
- Public slot to update the priority.
-</p><dl>
-<dt><i>priority</i></dt>
-<dd>
-priority of the task (0=high, 1=normal, 2=low)
-</dd>
-</dl><a NAME="Task.setProjectTask" ID="Task.setProjectTask"></a>
-<h4>Task.setProjectTask</h4>
-<b>setProjectTask</b>(<i>pt</i>)
-<p>
- Public method to set the project relation flag.
-</p><dl>
-<dt><i>pt</i></dt>
-<dd>
-flag indicating a project task (boolean)
-</dd>
-</dl>
-<div align="right"><a href="#top">Up</a></div>
-<hr /><hr />
-<a NAME="TaskFilter" ID="TaskFilter"></a>
-<h2>TaskFilter</h2>
-<p>
- Class implementing a filter for tasks.
-</p>
-<h3>Derived from</h3>
-object
-<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="#TaskFilter.__init__">TaskFilter</a></td>
-<td>Constructor</td>
-</tr><tr>
-<td><a href="#TaskFilter.hasActiveFilter">hasActiveFilter</a></td>
-<td>Public method to check for active filters.</td>
-</tr><tr>
-<td><a href="#TaskFilter.setActive">setActive</a></td>
-<td>Public method to activate the filter.</td>
-</tr><tr>
-<td><a href="#TaskFilter.setDescriptionFilter">setDescriptionFilter</a></td>
-<td>Public method to set the description filter.</td>
-</tr><tr>
-<td><a href="#TaskFilter.setFileNameFilter">setFileNameFilter</a></td>
-<td>Public method to set the filename filter.</td>
-</tr><tr>
-<td><a href="#TaskFilter.setPrioritiesFilter">setPrioritiesFilter</a></td>
-<td>Public method to set the priorities filter.</td>
-</tr><tr>
-<td><a href="#TaskFilter.setScopeFilter">setScopeFilter</a></td>
-<td>Public method to set the scope filter.</td>
-</tr><tr>
-<td><a href="#TaskFilter.setStatusFilter">setStatusFilter</a></td>
-<td>Public method to set the status filter.</td>
-</tr><tr>
-<td><a href="#TaskFilter.setTypeFilter">setTypeFilter</a></td>
-<td>Public method to set the type filter.</td>
-</tr><tr>
-<td><a href="#TaskFilter.showTask">showTask</a></td>
-<td>Public method to check, if a task should be shown.</td>
-</tr>
-</table>
-<h3>Static Methods</h3>
-<table>
-<tr><td>None</td></tr>
-</table>
-<a NAME="TaskFilter.__init__" ID="TaskFilter.__init__"></a>
-<h4>TaskFilter (Constructor)</h4>
-<b>TaskFilter</b>(<i></i>)
-<p>
- Constructor
-</p><a NAME="TaskFilter.hasActiveFilter" ID="TaskFilter.hasActiveFilter"></a>
-<h4>TaskFilter.hasActiveFilter</h4>
-<b>hasActiveFilter</b>(<i></i>)
-<p>
- Public method to check for active filters.
-</p><dl>
-<dt>Returns:</dt>
-<dd>
-flag indicating an active filter was found (boolean)
-</dd>
-</dl><a NAME="TaskFilter.setActive" ID="TaskFilter.setActive"></a>
-<h4>TaskFilter.setActive</h4>
-<b>setActive</b>(<i>enabled</i>)
-<p>
- Public method to activate the filter.
-</p><dl>
-<dt><i>enabled</i></dt>
-<dd>
-flag indicating the activation state (boolean)
-</dd>
-</dl><a NAME="TaskFilter.setDescriptionFilter" ID="TaskFilter.setDescriptionFilter"></a>
-<h4>TaskFilter.setDescriptionFilter</h4>
-<b>setDescriptionFilter</b>(<i>filter</i>)
-<p>
- Public method to set the description filter.
-</p><dl>
-<dt><i>filter</i></dt>
-<dd>
-a regular expression for the description filter
- to set (string) or None
-</dd>
-</dl><a NAME="TaskFilter.setFileNameFilter" ID="TaskFilter.setFileNameFilter"></a>
-<h4>TaskFilter.setFileNameFilter</h4>
-<b>setFileNameFilter</b>(<i>filter</i>)
-<p>
- Public method to set the filename filter.
-</p><dl>
-<dt><i>filter</i></dt>
-<dd>
-a wildcard expression for the filename filter
- to set (string) or None
-</dd>
-</dl><a NAME="TaskFilter.setPrioritiesFilter" ID="TaskFilter.setPrioritiesFilter"></a>
-<h4>TaskFilter.setPrioritiesFilter</h4>
-<b>setPrioritiesFilter</b>(<i>priorities</i>)
-<p>
- Public method to set the priorities filter.
-</p><dl>
-<dt><i>priorities</i></dt>
-<dd>
-list of task priorities (list of integer) or None
-</dd>
-</dl><a NAME="TaskFilter.setScopeFilter" ID="TaskFilter.setScopeFilter"></a>
-<h4>TaskFilter.setScopeFilter</h4>
-<b>setScopeFilter</b>(<i>scope</i>)
-<p>
- Public method to set the scope filter.
-</p><dl>
-<dt><i>scope</i></dt>
-<dd>
-flag indicating a project task (boolean) or None
-</dd>
-</dl><a NAME="TaskFilter.setStatusFilter" ID="TaskFilter.setStatusFilter"></a>
-<h4>TaskFilter.setStatusFilter</h4>
-<b>setStatusFilter</b>(<i>status</i>)
-<p>
- Public method to set the status filter.
-</p><dl>
-<dt><i>status</i></dt>
-<dd>
-flag indicating a completed task (boolean) or None
-</dd>
-</dl><a NAME="TaskFilter.setTypeFilter" ID="TaskFilter.setTypeFilter"></a>
-<h4>TaskFilter.setTypeFilter</h4>
-<b>setTypeFilter</b>(<i>type_</i>)
-<p>
- Public method to set the type filter.
-</p><dl>
-<dt><i>type_</i></dt>
-<dd>
-flag indicating a bugfix task (boolean) or None
-</dd>
-</dl><a NAME="TaskFilter.showTask" ID="TaskFilter.showTask"></a>
-<h4>TaskFilter.showTask</h4>
-<b>showTask</b>(<i>task</i>)
-<p>
- Public method to check, if a task should be shown.
-</p><dl>
-<dt><i>task</i></dt>
-<dd>
-reference to the task object to check (Task)
-</dd>
-</dl><dl>
-<dt>Returns:</dt>
-<dd>
-flag indicating whether the task should be shown (boolean)
-</dd>
-</dl>
-<div align="right"><a href="#top">Up</a></div>
-<hr /><hr />
<a NAME="TaskViewer" ID="TaskViewer"></a>
<h2>TaskViewer</h2>
<p>
@@ -642,7 +283,7 @@
</dd>
</dl><a NAME="TaskViewer.addFileTask" ID="TaskViewer.addFileTask"></a>
<h4>TaskViewer.addFileTask</h4>
-<b>addFileTask</b>(<i>description, filename, lineno, isBugfixTask=False, longtext=""</i>)
+<b>addFileTask</b>(<i>description, filename, lineno, taskType=Task.TypeTodo, longtext=""</i>)
<p>
Public slot to add a file related task.
</p><dl>
@@ -655,16 +296,17 @@
</dd><dt><i>lineno</i></dt>
<dd>
line number containing the task (integer)
-</dd><dt><i>isBugfixTask</i></dt>
+</dd><dt><i>taskType</i></dt>
<dd>
-flag indicating a bugfix task (boolean)
+type of the task (one of Task.TypeFixme, Task.TypeTodo,
+ Task.TypeWarning, Task.TypeNote)
</dd><dt><i>longtext</i></dt>
<dd>
explanatory text of the task (string)
</dd>
</dl><a NAME="TaskViewer.addTask" ID="TaskViewer.addTask"></a>
<h4>TaskViewer.addTask</h4>
-<b>addTask</b>(<i>description, priority=1, filename="", lineno=0, completed=False, _time=0, isProjectTask=False, isBugfixTask=False, longtext=""</i>)
+<b>addTask</b>(<i>description, priority=1, filename="", lineno=0, completed=False, _time=0, isProjectTask=False, taskType=Task.TypeTodo, longtext=""</i>)
<p>
Public slot to add a task.
</p><dl>
@@ -690,9 +332,10 @@
<dd>
flag indicating a task related to the current
project (boolean)
-</dd><dt><i>isBugfixTask</i></dt>
+</dd><dt><i>taskType</i></dt>
<dd>
-flag indicating a bugfix task (boolean)
+type of the task (one of Task.TypeFixme, Task.TypeTodo,
+ Task.TypeWarning, Task.TypeNote)
</dd><dt><i>longtext</i></dt>
<dd>
explanatory text of the task (string)
