Documentation/Source/eric4.E4XML.TasksHandler.html

changeset 3
0d9daebf5b8c
diff -r bc6196164237 -r 0d9daebf5b8c Documentation/Source/eric4.E4XML.TasksHandler.html
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric4.E4XML.TasksHandler.html	Mon Dec 28 16:18:43 2009 +0000
@@ -0,0 +1,214 @@
+<?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.E4XML.TasksHandler</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.E4XML.TasksHandler</h1>
+<p>
+Module implementing the handler class for reading an XML tasks file.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#TasksHandler">TasksHandler</a></td>
+<td>Class implementing a sax handler to read an XML tasks file.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr /><hr />
+<a NAME="TasksHandler" ID="TasksHandler"></a>
+<h2>TasksHandler</h2>
+<p>
+    Class implementing a sax handler to read an XML tasks file.
+</p>
+<h3>Derived from</h3>
+XMLHandlerBase
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#TasksHandler.__init__">TasksHandler</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#TasksHandler.__buildPath">__buildPath</a></td>
+<td>Private method to assemble a path.</td>
+</tr><tr>
+<td><a href="#TasksHandler.endCreated">endCreated</a></td>
+<td>Handler method for the "Created" end tag.</td>
+</tr><tr>
+<td><a href="#TasksHandler.endDescription">endDescription</a></td>
+<td>Handler method for the "Description" end tag.</td>
+</tr><tr>
+<td><a href="#TasksHandler.endDir">endDir</a></td>
+<td>Handler method for the "Dir" end tag.</td>
+</tr><tr>
+<td><a href="#TasksHandler.endFilename">endFilename</a></td>
+<td>Handler method for the "Filename" end tag.</td>
+</tr><tr>
+<td><a href="#TasksHandler.endLinenumber">endLinenumber</a></td>
+<td>Handler method for the "Linenumber" end tag.</td>
+</tr><tr>
+<td><a href="#TasksHandler.endName">endName</a></td>
+<td>Handler method for the "Name" end tag.</td>
+</tr><tr>
+<td><a href="#TasksHandler.endSummary">endSummary</a></td>
+<td>Handler method for the "Summary" end tag.</td>
+</tr><tr>
+<td><a href="#TasksHandler.endTask">endTask</a></td>
+<td>Handler method for the "Task" end tag.</td>
+</tr><tr>
+<td><a href="#TasksHandler.getVersion">getVersion</a></td>
+<td>Public method to retrieve the version of the tasks file.</td>
+</tr><tr>
+<td><a href="#TasksHandler.startDocumentTasks">startDocumentTasks</a></td>
+<td>Handler called, when the document parsing is started.</td>
+</tr><tr>
+<td><a href="#TasksHandler.startFilename">startFilename</a></td>
+<td>Handler method for the "Filename" start tag.</td>
+</tr><tr>
+<td><a href="#TasksHandler.startTask">startTask</a></td>
+<td>Handler method for the "Task" start tag.</td>
+</tr><tr>
+<td><a href="#TasksHandler.startTasks">startTasks</a></td>
+<td>Handler method for the "Tasks" start tag.</td>
+</tr>
+</table>
+<a NAME="TasksHandler.__init__" ID="TasksHandler.__init__"></a>
+<h4>TasksHandler (Constructor)</h4>
+<b>TasksHandler</b>(<i>forProject = False, taskViewer=None</i>)
+<p>
+        Constructor
+</p><dl>
+<dt><i>forProject</i></dt>
+<dd>
+flag indicating project related mode (boolean)
+</dd><dt><i>taskViewer</i></dt>
+<dd>
+reference to the task viewer object
+</dd>
+</dl><a NAME="TasksHandler.__buildPath" ID="TasksHandler.__buildPath"></a>
+<h4>TasksHandler.__buildPath</h4>
+<b>__buildPath</b>(<i></i>)
+<p>
+        Private method to assemble a path.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+The ready assembled path. (string)
+</dd>
+</dl><a NAME="TasksHandler.endCreated" ID="TasksHandler.endCreated"></a>
+<h4>TasksHandler.endCreated</h4>
+<b>endCreated</b>(<i></i>)
+<p>
+        Handler method for the "Created" end tag.
+</p><a NAME="TasksHandler.endDescription" ID="TasksHandler.endDescription"></a>
+<h4>TasksHandler.endDescription</h4>
+<b>endDescription</b>(<i></i>)
+<p>
+        Handler method for the "Description" end tag.
+</p><a NAME="TasksHandler.endDir" ID="TasksHandler.endDir"></a>
+<h4>TasksHandler.endDir</h4>
+<b>endDir</b>(<i></i>)
+<p>
+        Handler method for the "Dir" end tag.
+</p><a NAME="TasksHandler.endFilename" ID="TasksHandler.endFilename"></a>
+<h4>TasksHandler.endFilename</h4>
+<b>endFilename</b>(<i></i>)
+<p>
+        Handler method for the "Filename" end tag.
+</p><a NAME="TasksHandler.endLinenumber" ID="TasksHandler.endLinenumber"></a>
+<h4>TasksHandler.endLinenumber</h4>
+<b>endLinenumber</b>(<i></i>)
+<p>
+        Handler method for the "Linenumber" end tag.
+</p><a NAME="TasksHandler.endName" ID="TasksHandler.endName"></a>
+<h4>TasksHandler.endName</h4>
+<b>endName</b>(<i></i>)
+<p>
+        Handler method for the "Name" end tag.
+</p><a NAME="TasksHandler.endSummary" ID="TasksHandler.endSummary"></a>
+<h4>TasksHandler.endSummary</h4>
+<b>endSummary</b>(<i></i>)
+<p>
+        Handler method for the "Summary" end tag.
+</p><a NAME="TasksHandler.endTask" ID="TasksHandler.endTask"></a>
+<h4>TasksHandler.endTask</h4>
+<b>endTask</b>(<i></i>)
+<p>
+        Handler method for the "Task" end tag.
+</p><a NAME="TasksHandler.getVersion" ID="TasksHandler.getVersion"></a>
+<h4>TasksHandler.getVersion</h4>
+<b>getVersion</b>(<i></i>)
+<p>
+        Public method to retrieve the version of the tasks file.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+String containing the version number.
+</dd>
+</dl><a NAME="TasksHandler.startDocumentTasks" ID="TasksHandler.startDocumentTasks"></a>
+<h4>TasksHandler.startDocumentTasks</h4>
+<b>startDocumentTasks</b>(<i></i>)
+<p>
+        Handler called, when the document parsing is started.
+</p><a NAME="TasksHandler.startFilename" ID="TasksHandler.startFilename"></a>
+<h4>TasksHandler.startFilename</h4>
+<b>startFilename</b>(<i>attrs</i>)
+<p>
+        Handler method for the "Filename" start tag.
+</p><dl>
+<dt><i>attrs</i></dt>
+<dd>
+list of tag attributes
+</dd>
+</dl><a NAME="TasksHandler.startTask" ID="TasksHandler.startTask"></a>
+<h4>TasksHandler.startTask</h4>
+<b>startTask</b>(<i>attrs</i>)
+<p>
+        Handler method for the "Task" start tag.
+</p><dl>
+<dt><i>attrs</i></dt>
+<dd>
+list of tag attributes
+</dd>
+</dl><a NAME="TasksHandler.startTasks" ID="TasksHandler.startTasks"></a>
+<h4>TasksHandler.startTasks</h4>
+<b>startTasks</b>(<i>attrs</i>)
+<p>
+        Handler method for the "Tasks" start tag.
+</p><dl>
+<dt><i>attrs</i></dt>
+<dd>
+list of tag attributes
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial