Documentation/Source/eric5.E5XML.TasksHandler.html

changeset 58
37f0444c3479
parent 50
a36eecf45b2e
child 409
0ea528e80202
--- a/Documentation/Source/eric5.E5XML.TasksHandler.html	Thu Jan 14 17:27:31 2010 +0000
+++ b/Documentation/Source/eric5.E5XML.TasksHandler.html	Thu Jan 14 18:35:52 2010 +0000
@@ -22,7 +22,7 @@
 <body><a NAME="top" ID="top"></a>
 <h1>eric5.E5XML.TasksHandler</h1>
 <p>
-&#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#104;&#97;&#110;&#100;&#108;&#101;&#114; &#99;&#108;&#97;&#115;&#115; &#102;&#111;&#114; &#114;&#101;&#97;&#100;&#105;&#110;&#103; &#97;&#110; &#88;&#77;&#76; &#116;&#97;&#115;&#107;&#115; &#102;&#105;&#108;&#101;.
+Module implementing the handler class for reading an XML tasks file.
 </p>
 <h3>Global Attributes</h3>
 <table>
@@ -32,7 +32,7 @@
 <table>
 <tr>
 <td><a href="#TasksHandler">TasksHandler</a></td>
-<td>&#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#115;&#97;x &#104;&#97;&#110;&#100;&#108;&#101;&#114; &#116;&#111; &#114;&#101;&#97;&#100; &#97;&#110; &#88;&#77;&#76; &#116;&#97;&#115;&#107;&#115; &#102;&#105;&#108;&#101;.</td>
+<td>Class implementing a sax handler to read an XML tasks file.</td>
 </tr>
 </table>
 <h3>Functions</h3>
@@ -43,7 +43,7 @@
 <a NAME="TasksHandler" ID="TasksHandler"></a>
 <h2>TasksHandler</h2>
 <p>
-    &#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#115;&#97;x &#104;&#97;&#110;&#100;&#108;&#101;&#114; &#116;&#111; &#114;&#101;&#97;&#100; &#97;&#110; &#88;&#77;&#76; &#116;&#97;&#115;&#107;&#115; &#102;&#105;&#108;&#101;.
+    Class implementing a sax handler to read an XML tasks file.
 </p>
 <h3>Derived from</h3>
 XMLHandlerBase
@@ -55,158 +55,158 @@
 <table>
 <tr>
 <td><a href="#TasksHandler.__init__">TasksHandler</a></td>
-<td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td>
+<td>Constructor</td>
 </tr><tr>
 <td><a href="#TasksHandler.__buildPath">__buildPath</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#97;&#115;&#115;&#101;&#109;&#98;&#108;&#101; &#97; &#112;&#97;&#116;&#104;.</td>
+<td>Private method to assemble a path.</td>
 </tr><tr>
 <td><a href="#TasksHandler.endCreated">endCreated</a></td>
-<td>&#72;&#97;&#110;&#100;&#108;&#101;&#114; &#109;&#101;&#116;&#104;&#111;&#100; &#102;&#111;&#114; &#116;&#104;&#101; "&#67;&#114;&#101;&#97;&#116;&#101;&#100;" &#101;&#110;&#100; &#116;&#97;&#103;.</td>
+<td>Handler method for the "Created" end tag.</td>
 </tr><tr>
 <td><a href="#TasksHandler.endDescription">endDescription</a></td>
-<td>&#72;&#97;&#110;&#100;&#108;&#101;&#114; &#109;&#101;&#116;&#104;&#111;&#100; &#102;&#111;&#114; &#116;&#104;&#101; "&#68;&#101;&#115;&#99;&#114;&#105;&#112;&#116;&#105;&#111;&#110;" &#101;&#110;&#100; &#116;&#97;&#103;.</td>
+<td>Handler method for the "Description" end tag.</td>
 </tr><tr>
 <td><a href="#TasksHandler.endDir">endDir</a></td>
-<td>&#72;&#97;&#110;&#100;&#108;&#101;&#114; &#109;&#101;&#116;&#104;&#111;&#100; &#102;&#111;&#114; &#116;&#104;&#101; "&#68;&#105;&#114;" &#101;&#110;&#100; &#116;&#97;&#103;.</td>
+<td>Handler method for the "Dir" end tag.</td>
 </tr><tr>
 <td><a href="#TasksHandler.endFilename">endFilename</a></td>
-<td>&#72;&#97;&#110;&#100;&#108;&#101;&#114; &#109;&#101;&#116;&#104;&#111;&#100; &#102;&#111;&#114; &#116;&#104;&#101; "&#70;&#105;&#108;&#101;&#110;&#97;&#109;&#101;" &#101;&#110;&#100; &#116;&#97;&#103;.</td>
+<td>Handler method for the "Filename" end tag.</td>
 </tr><tr>
 <td><a href="#TasksHandler.endLinenumber">endLinenumber</a></td>
-<td>&#72;&#97;&#110;&#100;&#108;&#101;&#114; &#109;&#101;&#116;&#104;&#111;&#100; &#102;&#111;&#114; &#116;&#104;&#101; "&#76;&#105;&#110;&#101;&#110;&#117;&#109;&#98;&#101;&#114;" &#101;&#110;&#100; &#116;&#97;&#103;.</td>
+<td>Handler method for the "Linenumber" end tag.</td>
 </tr><tr>
 <td><a href="#TasksHandler.endName">endName</a></td>
-<td>&#72;&#97;&#110;&#100;&#108;&#101;&#114; &#109;&#101;&#116;&#104;&#111;&#100; &#102;&#111;&#114; &#116;&#104;&#101; "&#78;&#97;&#109;&#101;" &#101;&#110;&#100; &#116;&#97;&#103;.</td>
+<td>Handler method for the "Name" end tag.</td>
 </tr><tr>
 <td><a href="#TasksHandler.endSummary">endSummary</a></td>
-<td>&#72;&#97;&#110;&#100;&#108;&#101;&#114; &#109;&#101;&#116;&#104;&#111;&#100; &#102;&#111;&#114; &#116;&#104;&#101; "&#83;&#117;&#109;&#109;&#97;&#114;y" &#101;&#110;&#100; &#116;&#97;&#103;.</td>
+<td>Handler method for the "Summary" end tag.</td>
 </tr><tr>
 <td><a href="#TasksHandler.endTask">endTask</a></td>
-<td>&#72;&#97;&#110;&#100;&#108;&#101;&#114; &#109;&#101;&#116;&#104;&#111;&#100; &#102;&#111;&#114; &#116;&#104;&#101; "&#84;&#97;&#115;&#107;" &#101;&#110;&#100; &#116;&#97;&#103;.</td>
+<td>Handler method for the "Task" end tag.</td>
 </tr><tr>
 <td><a href="#TasksHandler.getVersion">getVersion</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#116;&#114;&#105;&#101;v&#101; &#116;&#104;&#101; v&#101;&#114;&#115;&#105;&#111;&#110; &#111;&#102; &#116;&#104;&#101; &#116;&#97;&#115;&#107;&#115; &#102;&#105;&#108;&#101;.</td>
+<td>Public method to retrieve the version of the tasks file.</td>
 </tr><tr>
 <td><a href="#TasksHandler.startDocumentTasks">startDocumentTasks</a></td>
-<td>&#72;&#97;&#110;&#100;&#108;&#101;&#114; &#99;&#97;&#108;&#108;&#101;&#100;, w&#104;&#101;&#110; &#116;&#104;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116; &#112;&#97;&#114;&#115;&#105;&#110;&#103; &#105;&#115; &#115;&#116;&#97;&#114;&#116;&#101;&#100;.</td>
+<td>Handler called, when the document parsing is started.</td>
 </tr><tr>
 <td><a href="#TasksHandler.startFilename">startFilename</a></td>
-<td>&#72;&#97;&#110;&#100;&#108;&#101;&#114; &#109;&#101;&#116;&#104;&#111;&#100; &#102;&#111;&#114; &#116;&#104;&#101; "&#70;&#105;&#108;&#101;&#110;&#97;&#109;&#101;" &#115;&#116;&#97;&#114;&#116; &#116;&#97;&#103;.</td>
+<td>Handler method for the "Filename" start tag.</td>
 </tr><tr>
 <td><a href="#TasksHandler.startTask">startTask</a></td>
-<td>&#72;&#97;&#110;&#100;&#108;&#101;&#114; &#109;&#101;&#116;&#104;&#111;&#100; &#102;&#111;&#114; &#116;&#104;&#101; "&#84;&#97;&#115;&#107;" &#115;&#116;&#97;&#114;&#116; &#116;&#97;&#103;.</td>
+<td>Handler method for the "Task" start tag.</td>
 </tr><tr>
 <td><a href="#TasksHandler.startTasks">startTasks</a></td>
-<td>&#72;&#97;&#110;&#100;&#108;&#101;&#114; &#109;&#101;&#116;&#104;&#111;&#100; &#102;&#111;&#114; &#116;&#104;&#101; "&#84;&#97;&#115;&#107;&#115;" &#115;&#116;&#97;&#114;&#116; &#116;&#97;&#103;.</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>
-        &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;
+        Constructor
 </p><dl>
 <dt><i>forProject</i></dt>
 <dd>
-&#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#112;&#114;&#111;&#106;&#101;&#99;&#116; &#114;&#101;&#108;&#97;&#116;&#101;&#100; &#109;&#111;&#100;&#101; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;)
+flag indicating project related mode (boolean)
 </dd><dt><i>taskViewer</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#116;&#97;&#115;&#107; v&#105;&#101;w&#101;&#114; &#111;&#98;&#106;&#101;&#99;&#116;
+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>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#97;&#115;&#115;&#101;&#109;&#98;&#108;&#101; &#97; &#112;&#97;&#116;&#104;.
+        Private method to assemble a path.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#84;&#104;&#101; &#114;&#101;&#97;&#100;y &#97;&#115;&#115;&#101;&#109;&#98;&#108;&#101;&#100; &#112;&#97;&#116;&#104;. (&#115;&#116;&#114;&#105;&#110;&#103;)
+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>
-        &#72;&#97;&#110;&#100;&#108;&#101;&#114; &#109;&#101;&#116;&#104;&#111;&#100; &#102;&#111;&#114; &#116;&#104;&#101; "&#67;&#114;&#101;&#97;&#116;&#101;&#100;" &#101;&#110;&#100; &#116;&#97;&#103;.
+        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>
-        &#72;&#97;&#110;&#100;&#108;&#101;&#114; &#109;&#101;&#116;&#104;&#111;&#100; &#102;&#111;&#114; &#116;&#104;&#101; "&#68;&#101;&#115;&#99;&#114;&#105;&#112;&#116;&#105;&#111;&#110;" &#101;&#110;&#100; &#116;&#97;&#103;.
+        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>
-        &#72;&#97;&#110;&#100;&#108;&#101;&#114; &#109;&#101;&#116;&#104;&#111;&#100; &#102;&#111;&#114; &#116;&#104;&#101; "&#68;&#105;&#114;" &#101;&#110;&#100; &#116;&#97;&#103;.
+        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>
-        &#72;&#97;&#110;&#100;&#108;&#101;&#114; &#109;&#101;&#116;&#104;&#111;&#100; &#102;&#111;&#114; &#116;&#104;&#101; "&#70;&#105;&#108;&#101;&#110;&#97;&#109;&#101;" &#101;&#110;&#100; &#116;&#97;&#103;.
+        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>
-        &#72;&#97;&#110;&#100;&#108;&#101;&#114; &#109;&#101;&#116;&#104;&#111;&#100; &#102;&#111;&#114; &#116;&#104;&#101; "&#76;&#105;&#110;&#101;&#110;&#117;&#109;&#98;&#101;&#114;" &#101;&#110;&#100; &#116;&#97;&#103;.
+        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>
-        &#72;&#97;&#110;&#100;&#108;&#101;&#114; &#109;&#101;&#116;&#104;&#111;&#100; &#102;&#111;&#114; &#116;&#104;&#101; "&#78;&#97;&#109;&#101;" &#101;&#110;&#100; &#116;&#97;&#103;.
+        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>
-        &#72;&#97;&#110;&#100;&#108;&#101;&#114; &#109;&#101;&#116;&#104;&#111;&#100; &#102;&#111;&#114; &#116;&#104;&#101; "&#83;&#117;&#109;&#109;&#97;&#114;y" &#101;&#110;&#100; &#116;&#97;&#103;.
+        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>
-        &#72;&#97;&#110;&#100;&#108;&#101;&#114; &#109;&#101;&#116;&#104;&#111;&#100; &#102;&#111;&#114; &#116;&#104;&#101; "&#84;&#97;&#115;&#107;" &#101;&#110;&#100; &#116;&#97;&#103;.
+        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>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#116;&#114;&#105;&#101;v&#101; &#116;&#104;&#101; v&#101;&#114;&#115;&#105;&#111;&#110; &#111;&#102; &#116;&#104;&#101; &#116;&#97;&#115;&#107;&#115; &#102;&#105;&#108;&#101;.
+        Public method to retrieve the version of the tasks file.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#83;&#116;&#114;&#105;&#110;&#103; &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#105;&#110;&#103; &#116;&#104;&#101; v&#101;&#114;&#115;&#105;&#111;&#110; &#110;&#117;&#109;&#98;&#101;&#114;.
+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>
-        &#72;&#97;&#110;&#100;&#108;&#101;&#114; &#99;&#97;&#108;&#108;&#101;&#100;, w&#104;&#101;&#110; &#116;&#104;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116; &#112;&#97;&#114;&#115;&#105;&#110;&#103; &#105;&#115; &#115;&#116;&#97;&#114;&#116;&#101;&#100;.
+        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>
-        &#72;&#97;&#110;&#100;&#108;&#101;&#114; &#109;&#101;&#116;&#104;&#111;&#100; &#102;&#111;&#114; &#116;&#104;&#101; "&#70;&#105;&#108;&#101;&#110;&#97;&#109;&#101;" &#115;&#116;&#97;&#114;&#116; &#116;&#97;&#103;.
+        Handler method for the "Filename" start tag.
 </p><dl>
 <dt><i>attrs</i></dt>
 <dd>
-&#108;&#105;&#115;&#116; &#111;&#102; &#116;&#97;&#103; &#97;&#116;&#116;&#114;&#105;&#98;&#117;&#116;&#101;&#115;
+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>
-        &#72;&#97;&#110;&#100;&#108;&#101;&#114; &#109;&#101;&#116;&#104;&#111;&#100; &#102;&#111;&#114; &#116;&#104;&#101; "&#84;&#97;&#115;&#107;" &#115;&#116;&#97;&#114;&#116; &#116;&#97;&#103;.
+        Handler method for the "Task" start tag.
 </p><dl>
 <dt><i>attrs</i></dt>
 <dd>
-&#108;&#105;&#115;&#116; &#111;&#102; &#116;&#97;&#103; &#97;&#116;&#116;&#114;&#105;&#98;&#117;&#116;&#101;&#115;
+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>
-        &#72;&#97;&#110;&#100;&#108;&#101;&#114; &#109;&#101;&#116;&#104;&#111;&#100; &#102;&#111;&#114; &#116;&#104;&#101; "&#84;&#97;&#115;&#107;&#115;" &#115;&#116;&#97;&#114;&#116; &#116;&#97;&#103;.
+        Handler method for the "Tasks" start tag.
 </p><dl>
 <dt><i>attrs</i></dt>
 <dd>
-&#108;&#105;&#115;&#116; &#111;&#102; &#116;&#97;&#103; &#97;&#116;&#116;&#114;&#105;&#98;&#117;&#116;&#101;&#115;
+list of tag attributes
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>

eric ide

mercurial