Documentation/Source/eric4.Tasks.TaskViewer.html

changeset 3
0d9daebf5b8c
diff -r bc6196164237 -r 0d9daebf5b8c Documentation/Source/eric4.Tasks.TaskViewer.html
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric4.Tasks.TaskViewer.html	Mon Dec 28 16:18:43 2009 +0000
@@ -0,0 +1,723 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
+'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
+<html><head>
+<title>eric4.Tasks.TaskViewer</title>
+<style>
+body {
+    background:white;
+    margin: 0em 1em 10em 1em;
+    color: black;
+}
+
+h1 { color: white; background: #4FA4FF; }
+h2 { color: white; background: #4FA4FF; }
+h3 { color: white; background: #00557F; }
+h4 { color: white; background: #00557F; }
+    
+a { color: #AA5500; }
+
+</style>
+</head>
+<body><a NAME="top" ID="top"></a>
+<h1>eric4.Tasks.TaskViewer</h1>
+<p>
+Module implementing a task viewer and associated classes.
+</p><p>
+Tasks can be defined manually or automatically. Automatically
+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="#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>
+</table>
+<h3>Functions</h3>
+<table>
+<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>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>
+<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, ppath = "", 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>ppath</i></dt>
+<dd>
+the project path (string)
+</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>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>
+<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>
+    Class implementing the task viewer.
+</p><h4>Signals</h4>
+<dl>
+<dt>displayFile(string, integer)</dt>
+<dd>
+emitted to go to a file task
+</dd>
+</dl>
+<h3>Derived from</h3>
+QTreeWidget
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#TaskViewer.__init__">TaskViewer</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#TaskViewer.__activateFilter">__activateFilter</a></td>
+<td>Private slot to handle the "Filtered display" context menu entry.</td>
+</tr><tr>
+<td><a href="#TaskViewer.__configure">__configure</a></td>
+<td>Private method to open the configuration dialog.</td>
+</tr><tr>
+<td><a href="#TaskViewer.__configureFilter">__configureFilter</a></td>
+<td>Private slot to handle the "Configure filter" context menu entry.</td>
+</tr><tr>
+<td><a href="#TaskViewer.__copyTask">__copyTask</a></td>
+<td>Private slot to handle the "Copy" context menu entry.</td>
+</tr><tr>
+<td><a href="#TaskViewer.__deleteCompleted">__deleteCompleted</a></td>
+<td>Private slot to handle the "Delete Completed Tasks" context menu entry.</td>
+</tr><tr>
+<td><a href="#TaskViewer.__deleteTask">__deleteTask</a></td>
+<td>Private slot to handle the "Delete Task" context menu entry.</td>
+</tr><tr>
+<td><a href="#TaskViewer.__editTaskProperties">__editTaskProperties</a></td>
+<td>Private slot to handle the "Properties" context menu entry</td>
+</tr><tr>
+<td><a href="#TaskViewer.__goToTask">__goToTask</a></td>
+<td>Private slot to handle the "Go To" context menu entry.</td>
+</tr><tr>
+<td><a href="#TaskViewer.__markCompleted">__markCompleted</a></td>
+<td>Private slot to handle the "Mark Completed" context menu entry.</td>
+</tr><tr>
+<td><a href="#TaskViewer.__newTask">__newTask</a></td>
+<td>Private slot to handle the "New Task" context menu entry.</td>
+</tr><tr>
+<td><a href="#TaskViewer.__pasteTask">__pasteTask</a></td>
+<td>Private slot to handle the "Paste" context menu entry.</td>
+</tr><tr>
+<td><a href="#TaskViewer.__refreshDisplay">__refreshDisplay</a></td>
+<td>Private method to refresh the display.</td>
+</tr><tr>
+<td><a href="#TaskViewer.__regenerateProjectTasks">__regenerateProjectTasks</a></td>
+<td>Private slot to handle the "Regenerated project tasks" context menu entry.</td>
+</tr><tr>
+<td><a href="#TaskViewer.__resizeColumns">__resizeColumns</a></td>
+<td>Private method to resize the list columns.</td>
+</tr><tr>
+<td><a href="#TaskViewer.__resort">__resort</a></td>
+<td>Private method to resort the tree.</td>
+</tr><tr>
+<td><a href="#TaskViewer.__showContextMenu">__showContextMenu</a></td>
+<td>Private slot to show the context menu of the list.</td>
+</tr><tr>
+<td><a href="#TaskViewer.__taskItemActivated">__taskItemActivated</a></td>
+<td>Private slot to handle the activation of an item.</td>
+</tr><tr>
+<td><a href="#TaskViewer.addFileTask">addFileTask</a></td>
+<td>Public slot to add a file related task.</td>
+</tr><tr>
+<td><a href="#TaskViewer.addTask">addTask</a></td>
+<td>Public slot to add a task.</td>
+</tr><tr>
+<td><a href="#TaskViewer.clearFileTasks">clearFileTasks</a></td>
+<td>Public slot to clear all tasks related to a file.</td>
+</tr><tr>
+<td><a href="#TaskViewer.clearProjectTasks">clearProjectTasks</a></td>
+<td>Public slot to clear project related tasks.</td>
+</tr><tr>
+<td><a href="#TaskViewer.clearTasks">clearTasks</a></td>
+<td>Public slot to clear all tasks from display.</td>
+</tr><tr>
+<td><a href="#TaskViewer.getGlobalTasks">getGlobalTasks</a></td>
+<td>Public method to retrieve all non project related tasks.</td>
+</tr><tr>
+<td><a href="#TaskViewer.getProjectTasks">getProjectTasks</a></td>
+<td>Public method to retrieve all project related tasks.</td>
+</tr><tr>
+<td><a href="#TaskViewer.handlePreferencesChanged">handlePreferencesChanged</a></td>
+<td>Public slot to react to changes of the preferences.</td>
+</tr><tr>
+<td><a href="#TaskViewer.setProjectOpen">setProjectOpen</a></td>
+<td>Public slot to set the project status.</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></dt>
+<dd>
+the parent (QWidget)
+</dd><dt><i>project</i></dt>
+<dd>
+reference to the project object
+</dd>
+</dl><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></dt>
+<dd>
+flag indicating the filter state (boolean)
+</dd>
+</dl><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.__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.__deleteTask" ID="TaskViewer.__deleteTask"></a>
+<h4>TaskViewer.__deleteTask</h4>
+<b>__deleteTask</b>(<i></i>)
+<p>
+        Private slot to handle the "Delete Task" context menu entry.
+</p><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.__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.__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.__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.__regenerateProjectTasks" ID="TaskViewer.__regenerateProjectTasks"></a>
+<h4>TaskViewer.__regenerateProjectTasks</h4>
+<b>__regenerateProjectTasks</b>(<i></i>)
+<p>
+        Private slot to handle the "Regenerated project tasks" context menu entry.
+</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></dt>
+<dd>
+the position of the mouse pointer (QPoint)
+</dd>
+</dl><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></dt>
+<dd>
+reference to the activated item (QTreeWidgetItem)
+</dd><dt><i>col</i></dt>
+<dd>
+column the item was activated in (integer)
+</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>)
+<p>
+        Public slot to add a file related task.
+</p><dl>
+<dt><i>description</i></dt>
+<dd>
+descriptive text of the task (string)
+</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>isBugfixTask</i></dt>
+<dd>
+flag indicating a bugfix task (boolean)
+</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>)
+<p>
+        Public slot to add a task.
+</p><dl>
+<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>longtext</i></dt>
+<dd>
+explanatory text of the task (string)
+</dd>
+</dl><a NAME="TaskViewer.clearFileTasks" ID="TaskViewer.clearFileTasks"></a>
+<h4>TaskViewer.clearFileTasks</h4>
+<b>clearFileTasks</b>(<i>filename</i>)
+<p>
+        Public slot to clear all tasks related to a file.
+</p><dl>
+<dt><i>filename</i></dt>
+<dd>
+name of the file (string)
+</dd>
+</dl><a NAME="TaskViewer.clearProjectTasks" ID="TaskViewer.clearProjectTasks"></a>
+<h4>TaskViewer.clearProjectTasks</h4>
+<b>clearProjectTasks</b>(<i></i>)
+<p>
+        Public slot to clear project related tasks.
+</p><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.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>Returns:</dt>
+<dd>
+copy of tasks (list of Task)
+</dd>
+</dl><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>Returns:</dt>
+<dd>
+copy of tasks (list of Task)
+</dd>
+</dl><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.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></dt>
+<dd>
+flag indicating the project status
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial