Documentation/Source/eric5.E5XML.MultiProjectHandler.html

changeset 58
37f0444c3479
parent 50
a36eecf45b2e
child 409
0ea528e80202
diff -r 81326a94fdca -r 37f0444c3479 Documentation/Source/eric5.E5XML.MultiProjectHandler.html
--- a/Documentation/Source/eric5.E5XML.MultiProjectHandler.html	Thu Jan 14 17:27:31 2010 +0000
+++ b/Documentation/Source/eric5.E5XML.MultiProjectHandler.html	Thu Jan 14 18:35:52 2010 +0000
@@ -22,7 +22,7 @@
 <body><a NAME="top" ID="top"></a>
 <h1>eric5.E5XML.MultiProjectHandler</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; &#109;&#117;&#108;&#116;&#105; &#112;&#114;&#111;&#106;&#101;&#99;&#116; &#102;&#105;&#108;&#101;.
+Module implementing the handler class for reading an XML multi project file.
 </p>
 <h3>Global Attributes</h3>
 <table>
@@ -32,7 +32,7 @@
 <table>
 <tr>
 <td><a href="#MultiProjectHandler">MultiProjectHandler</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; &#109;&#117;&#108;&#116;&#105; &#112;&#114;&#111;&#106;&#101;&#99;&#116; &#102;&#105;&#108;&#101;.</td>
+<td>Class implementing a sax handler to read an XML multi project file.</td>
 </tr>
 </table>
 <h3>Functions</h3>
@@ -43,7 +43,7 @@
 <a NAME="MultiProjectHandler" ID="MultiProjectHandler"></a>
 <h2>MultiProjectHandler</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; &#109;&#117;&#108;&#116;&#105; &#112;&#114;&#111;&#106;&#101;&#99;&#116; &#102;&#105;&#108;&#101;.
+    Class implementing a sax handler to read an XML multi project file.
 </p>
 <h3>Derived from</h3>
 XMLHandlerBase
@@ -55,106 +55,106 @@
 <table>
 <tr>
 <td><a href="#MultiProjectHandler.__init__">MultiProjectHandler</a></td>
-<td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td>
+<td>Constructor</td>
 </tr><tr>
 <td><a href="#MultiProjectHandler.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="#MultiProjectHandler.endProject">endProject</a></td>
-<td>&#72;&#97;&#110;&#100;&#108;&#101;&#114; &#109;&#101;&#116;&#104;&#111;&#100; &#102;&#111;&#114; &#116;&#104;&#101; "&#80;&#114;&#111;&#106;&#101;&#99;&#116;" &#101;&#110;&#100; &#116;&#97;&#103;.</td>
+<td>Handler method for the "Project" end tag.</td>
 </tr><tr>
 <td><a href="#MultiProjectHandler.endProjectDescription">endProjectDescription</a></td>
-<td>&#72;&#97;&#110;&#100;&#108;&#101;&#114; &#109;&#101;&#116;&#104;&#111;&#100; &#102;&#111;&#114; &#116;&#104;&#101; "&#80;&#114;&#111;&#106;&#101;&#99;&#116;&#68;&#101;&#115;&#99;&#114;&#105;&#112;&#116;&#105;&#111;&#110;" &#101;&#110;&#100; &#116;&#97;&#103;.</td>
+<td>Handler method for the "ProjectDescription" end tag.</td>
 </tr><tr>
 <td><a href="#MultiProjectHandler.endProjectFile">endProjectFile</a></td>
-<td>&#72;&#97;&#110;&#100;&#108;&#101;&#114; &#109;&#101;&#116;&#104;&#111;&#100; &#102;&#111;&#114; &#116;&#104;&#101; "&#80;&#114;&#111;&#106;&#101;&#99;&#116;&#70;&#105;&#108;&#101;" &#101;&#110;&#100; &#116;&#97;&#103;.</td>
+<td>Handler method for the "ProjectFile" end tag.</td>
 </tr><tr>
 <td><a href="#MultiProjectHandler.endProjectName">endProjectName</a></td>
-<td>&#72;&#97;&#110;&#100;&#108;&#101;&#114; &#109;&#101;&#116;&#104;&#111;&#100; &#102;&#111;&#114; &#116;&#104;&#101; "&#80;&#114;&#111;&#106;&#101;&#99;&#116;&#78;&#97;&#109;&#101;" &#101;&#110;&#100; &#116;&#97;&#103;.</td>
+<td>Handler method for the "ProjectName" end tag.</td>
 </tr><tr>
 <td><a href="#MultiProjectHandler.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; &#112;&#114;&#111;&#106;&#101;&#99;&#116;.</td>
+<td>Public method to retrieve the version of the project.</td>
 </tr><tr>
 <td><a href="#MultiProjectHandler.startDocumentMultiProject">startDocumentMultiProject</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="#MultiProjectHandler.startMultiProject">startMultiProject</a></td>
-<td>&#72;&#97;&#110;&#100;&#108;&#101;&#114; &#109;&#101;&#116;&#104;&#111;&#100; &#102;&#111;&#114; &#116;&#104;&#101; "&#77;&#117;&#108;&#116;&#105;&#80;&#114;&#111;&#106;&#101;&#99;&#116;" &#115;&#116;&#97;&#114;&#116; &#116;&#97;&#103;.</td>
+<td>Handler method for the "MultiProject" start tag.</td>
 </tr><tr>
 <td><a href="#MultiProjectHandler.startProject">startProject</a></td>
-<td>&#72;&#97;&#110;&#100;&#108;&#101;&#114; &#109;&#101;&#116;&#104;&#111;&#100; &#102;&#111;&#114; &#116;&#104;&#101; "&#80;&#114;&#111;&#106;&#101;&#99;&#116;" &#115;&#116;&#97;&#114;&#116; &#116;&#97;&#103;.</td>
+<td>Handler method for the "Project" start tag.</td>
 </tr>
 </table>
 <a NAME="MultiProjectHandler.__init__" ID="MultiProjectHandler.__init__"></a>
 <h4>MultiProjectHandler (Constructor)</h4>
 <b>MultiProjectHandler</b>(<i>multiProject</i>)
 <p>
-        &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;
+        Constructor
 </p><dl>
 <dt><i>multiProject</i></dt>
 <dd>
-&#82;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#109;&#117;&#108;&#116;&#105; &#112;&#114;&#111;&#106;&#101;&#99;&#116; &#111;&#98;&#106;&#101;&#99;&#116; &#116;&#111; &#115;&#116;&#111;&#114;&#101; &#116;&#104;&#101;
-                &#105;&#110;&#102;&#111;&#114;&#109;&#97;&#116;&#105;&#111;&#110; &#105;&#110;&#116;&#111;.
+Reference to the multi project object to store the
+                information into.
 </dd>
 </dl><a NAME="MultiProjectHandler.endDescription" ID="MultiProjectHandler.endDescription"></a>
 <h4>MultiProjectHandler.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="MultiProjectHandler.endProject" ID="MultiProjectHandler.endProject"></a>
 <h4>MultiProjectHandler.endProject</h4>
 <b>endProject</b>(<i></i>)
 <p>
-        &#72;&#97;&#110;&#100;&#108;&#101;&#114; &#109;&#101;&#116;&#104;&#111;&#100; &#102;&#111;&#114; &#116;&#104;&#101; "&#80;&#114;&#111;&#106;&#101;&#99;&#116;" &#101;&#110;&#100; &#116;&#97;&#103;.
+        Handler method for the "Project" end tag.
 </p><a NAME="MultiProjectHandler.endProjectDescription" ID="MultiProjectHandler.endProjectDescription"></a>
 <h4>MultiProjectHandler.endProjectDescription</h4>
 <b>endProjectDescription</b>(<i></i>)
 <p>
-        &#72;&#97;&#110;&#100;&#108;&#101;&#114; &#109;&#101;&#116;&#104;&#111;&#100; &#102;&#111;&#114; &#116;&#104;&#101; "&#80;&#114;&#111;&#106;&#101;&#99;&#116;&#68;&#101;&#115;&#99;&#114;&#105;&#112;&#116;&#105;&#111;&#110;" &#101;&#110;&#100; &#116;&#97;&#103;.
+        Handler method for the "ProjectDescription" end tag.
 </p><a NAME="MultiProjectHandler.endProjectFile" ID="MultiProjectHandler.endProjectFile"></a>
 <h4>MultiProjectHandler.endProjectFile</h4>
 <b>endProjectFile</b>(<i></i>)
 <p>
-        &#72;&#97;&#110;&#100;&#108;&#101;&#114; &#109;&#101;&#116;&#104;&#111;&#100; &#102;&#111;&#114; &#116;&#104;&#101; "&#80;&#114;&#111;&#106;&#101;&#99;&#116;&#70;&#105;&#108;&#101;" &#101;&#110;&#100; &#116;&#97;&#103;.
+        Handler method for the "ProjectFile" end tag.
 </p><a NAME="MultiProjectHandler.endProjectName" ID="MultiProjectHandler.endProjectName"></a>
 <h4>MultiProjectHandler.endProjectName</h4>
 <b>endProjectName</b>(<i></i>)
 <p>
-        &#72;&#97;&#110;&#100;&#108;&#101;&#114; &#109;&#101;&#116;&#104;&#111;&#100; &#102;&#111;&#114; &#116;&#104;&#101; "&#80;&#114;&#111;&#106;&#101;&#99;&#116;&#78;&#97;&#109;&#101;" &#101;&#110;&#100; &#116;&#97;&#103;.
+        Handler method for the "ProjectName" end tag.
 </p><a NAME="MultiProjectHandler.getVersion" ID="MultiProjectHandler.getVersion"></a>
 <h4>MultiProjectHandler.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; &#112;&#114;&#111;&#106;&#101;&#99;&#116;.
+        Public method to retrieve the version of the project.
 </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="MultiProjectHandler.startDocumentMultiProject" ID="MultiProjectHandler.startDocumentMultiProject"></a>
 <h4>MultiProjectHandler.startDocumentMultiProject</h4>
 <b>startDocumentMultiProject</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="MultiProjectHandler.startMultiProject" ID="MultiProjectHandler.startMultiProject"></a>
 <h4>MultiProjectHandler.startMultiProject</h4>
 <b>startMultiProject</b>(<i>attrs</i>)
 <p>
-        &#72;&#97;&#110;&#100;&#108;&#101;&#114; &#109;&#101;&#116;&#104;&#111;&#100; &#102;&#111;&#114; &#116;&#104;&#101; "&#77;&#117;&#108;&#116;&#105;&#80;&#114;&#111;&#106;&#101;&#99;&#116;" &#115;&#116;&#97;&#114;&#116; &#116;&#97;&#103;.
+        Handler method for the "MultiProject" 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="MultiProjectHandler.startProject" ID="MultiProjectHandler.startProject"></a>
 <h4>MultiProjectHandler.startProject</h4>
 <b>startProject</b>(<i>attrs</i>)
 <p>
-        &#72;&#97;&#110;&#100;&#108;&#101;&#114; &#109;&#101;&#116;&#104;&#111;&#100; &#102;&#111;&#114; &#116;&#104;&#101; "&#80;&#114;&#111;&#106;&#101;&#99;&#116;" &#115;&#116;&#97;&#114;&#116; &#116;&#97;&#103;.
+        Handler method for the "Project" 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