|
1 <?xml version="1.0" encoding="utf-8"?> |
|
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' |
|
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> |
|
4 <html><head> |
|
5 <title>eric5.E5XML.MultiProjectHandler</title> |
|
6 <style> |
|
7 body { |
|
8 background:white; |
|
9 margin: 0em 1em 10em 1em; |
|
10 color: black; |
|
11 } |
|
12 |
|
13 h1 { color: white; background: #4FA4FF; } |
|
14 h2 { color: white; background: #4FA4FF; } |
|
15 h3 { color: white; background: #00557F; } |
|
16 h4 { color: white; background: #00557F; } |
|
17 |
|
18 a { color: #AA5500; } |
|
19 |
|
20 </style> |
|
21 </head> |
|
22 <body><a NAME="top" ID="top"></a> |
|
23 <h1>eric5.E5XML.MultiProjectHandler</h1> |
|
24 <p> |
|
25 Module implementing the handler class for reading an XML multi project file. |
|
26 </p> |
|
27 <h3>Global Attributes</h3> |
|
28 <table> |
|
29 <tr><td>None</td></tr> |
|
30 </table> |
|
31 <h3>Classes</h3> |
|
32 <table> |
|
33 <tr> |
|
34 <td><a href="#MultiProjectHandler">MultiProjectHandler</a></td> |
|
35 <td>Class implementing a sax handler to read an XML multi project file.</td> |
|
36 </tr> |
|
37 </table> |
|
38 <h3>Functions</h3> |
|
39 <table> |
|
40 <tr><td>None</td></tr> |
|
41 </table> |
|
42 <hr /><hr /> |
|
43 <a NAME="MultiProjectHandler" ID="MultiProjectHandler"></a> |
|
44 <h2>MultiProjectHandler</h2> |
|
45 <p> |
|
46 Class implementing a sax handler to read an XML multi project file. |
|
47 </p> |
|
48 <h3>Derived from</h3> |
|
49 XMLHandlerBase |
|
50 <h3>Class Attributes</h3> |
|
51 <table> |
|
52 <tr><td>None</td></tr> |
|
53 </table> |
|
54 <h3>Methods</h3> |
|
55 <table> |
|
56 <tr> |
|
57 <td><a href="#MultiProjectHandler.__init__">MultiProjectHandler</a></td> |
|
58 <td>Constructor</td> |
|
59 </tr><tr> |
|
60 <td><a href="#MultiProjectHandler.endDescription">endDescription</a></td> |
|
61 <td>Handler method for the "Description" end tag.</td> |
|
62 </tr><tr> |
|
63 <td><a href="#MultiProjectHandler.endProject">endProject</a></td> |
|
64 <td>Handler method for the "Project" end tag.</td> |
|
65 </tr><tr> |
|
66 <td><a href="#MultiProjectHandler.endProjectDescription">endProjectDescription</a></td> |
|
67 <td>Handler method for the "ProjectDescription" end tag.</td> |
|
68 </tr><tr> |
|
69 <td><a href="#MultiProjectHandler.endProjectFile">endProjectFile</a></td> |
|
70 <td>Handler method for the "ProjectFile" end tag.</td> |
|
71 </tr><tr> |
|
72 <td><a href="#MultiProjectHandler.endProjectName">endProjectName</a></td> |
|
73 <td>Handler method for the "ProjectName" end tag.</td> |
|
74 </tr><tr> |
|
75 <td><a href="#MultiProjectHandler.getVersion">getVersion</a></td> |
|
76 <td>Public method to retrieve the version of the project.</td> |
|
77 </tr><tr> |
|
78 <td><a href="#MultiProjectHandler.startDocumentMultiProject">startDocumentMultiProject</a></td> |
|
79 <td>Handler called, when the document parsing is started.</td> |
|
80 </tr><tr> |
|
81 <td><a href="#MultiProjectHandler.startMultiProject">startMultiProject</a></td> |
|
82 <td>Handler method for the "MultiProject" start tag.</td> |
|
83 </tr><tr> |
|
84 <td><a href="#MultiProjectHandler.startProject">startProject</a></td> |
|
85 <td>Handler method for the "Project" start tag.</td> |
|
86 </tr> |
|
87 </table> |
|
88 <a NAME="MultiProjectHandler.__init__" ID="MultiProjectHandler.__init__"></a> |
|
89 <h4>MultiProjectHandler (Constructor)</h4> |
|
90 <b>MultiProjectHandler</b>(<i>multiProject</i>) |
|
91 <p> |
|
92 Constructor |
|
93 </p><dl> |
|
94 <dt><i>multiProject</i></dt> |
|
95 <dd> |
|
96 Reference to the multi project object to store the |
|
97 information into. |
|
98 </dd> |
|
99 </dl><a NAME="MultiProjectHandler.endDescription" ID="MultiProjectHandler.endDescription"></a> |
|
100 <h4>MultiProjectHandler.endDescription</h4> |
|
101 <b>endDescription</b>(<i></i>) |
|
102 <p> |
|
103 Handler method for the "Description" end tag. |
|
104 </p><a NAME="MultiProjectHandler.endProject" ID="MultiProjectHandler.endProject"></a> |
|
105 <h4>MultiProjectHandler.endProject</h4> |
|
106 <b>endProject</b>(<i></i>) |
|
107 <p> |
|
108 Handler method for the "Project" end tag. |
|
109 </p><a NAME="MultiProjectHandler.endProjectDescription" ID="MultiProjectHandler.endProjectDescription"></a> |
|
110 <h4>MultiProjectHandler.endProjectDescription</h4> |
|
111 <b>endProjectDescription</b>(<i></i>) |
|
112 <p> |
|
113 Handler method for the "ProjectDescription" end tag. |
|
114 </p><a NAME="MultiProjectHandler.endProjectFile" ID="MultiProjectHandler.endProjectFile"></a> |
|
115 <h4>MultiProjectHandler.endProjectFile</h4> |
|
116 <b>endProjectFile</b>(<i></i>) |
|
117 <p> |
|
118 Handler method for the "ProjectFile" end tag. |
|
119 </p><a NAME="MultiProjectHandler.endProjectName" ID="MultiProjectHandler.endProjectName"></a> |
|
120 <h4>MultiProjectHandler.endProjectName</h4> |
|
121 <b>endProjectName</b>(<i></i>) |
|
122 <p> |
|
123 Handler method for the "ProjectName" end tag. |
|
124 </p><a NAME="MultiProjectHandler.getVersion" ID="MultiProjectHandler.getVersion"></a> |
|
125 <h4>MultiProjectHandler.getVersion</h4> |
|
126 <b>getVersion</b>(<i></i>) |
|
127 <p> |
|
128 Public method to retrieve the version of the project. |
|
129 </p><dl> |
|
130 <dt>Returns:</dt> |
|
131 <dd> |
|
132 String containing the version number. |
|
133 </dd> |
|
134 </dl><a NAME="MultiProjectHandler.startDocumentMultiProject" ID="MultiProjectHandler.startDocumentMultiProject"></a> |
|
135 <h4>MultiProjectHandler.startDocumentMultiProject</h4> |
|
136 <b>startDocumentMultiProject</b>(<i></i>) |
|
137 <p> |
|
138 Handler called, when the document parsing is started. |
|
139 </p><a NAME="MultiProjectHandler.startMultiProject" ID="MultiProjectHandler.startMultiProject"></a> |
|
140 <h4>MultiProjectHandler.startMultiProject</h4> |
|
141 <b>startMultiProject</b>(<i>attrs</i>) |
|
142 <p> |
|
143 Handler method for the "MultiProject" start tag. |
|
144 </p><dl> |
|
145 <dt><i>attrs</i></dt> |
|
146 <dd> |
|
147 list of tag attributes |
|
148 </dd> |
|
149 </dl><a NAME="MultiProjectHandler.startProject" ID="MultiProjectHandler.startProject"></a> |
|
150 <h4>MultiProjectHandler.startProject</h4> |
|
151 <b>startProject</b>(<i>attrs</i>) |
|
152 <p> |
|
153 Handler method for the "Project" start tag. |
|
154 </p><dl> |
|
155 <dt><i>attrs</i></dt> |
|
156 <dd> |
|
157 list of tag attributes |
|
158 </dd> |
|
159 </dl> |
|
160 <div align="right"><a href="#top">Up</a></div> |
|
161 <hr /> |
|
162 </body></html> |