Documentation/Source/eric5.E5XML.MultiProjectHandler.html

changeset 58
37f0444c3479
parent 50
a36eecf45b2e
child 409
0ea528e80202
equal deleted inserted replaced
57:81326a94fdca 58:37f0444c3479
20 </style> 20 </style>
21 </head> 21 </head>
22 <body><a NAME="top" ID="top"></a> 22 <body><a NAME="top" ID="top"></a>
23 <h1>eric5.E5XML.MultiProjectHandler</h1> 23 <h1>eric5.E5XML.MultiProjectHandler</h1>
24 <p> 24 <p>
25 &#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;. 25 Module implementing the handler class for reading an XML multi project file.
26 </p> 26 </p>
27 <h3>Global Attributes</h3> 27 <h3>Global Attributes</h3>
28 <table> 28 <table>
29 <tr><td>None</td></tr> 29 <tr><td>None</td></tr>
30 </table> 30 </table>
31 <h3>Classes</h3> 31 <h3>Classes</h3>
32 <table> 32 <table>
33 <tr> 33 <tr>
34 <td><a href="#MultiProjectHandler">MultiProjectHandler</a></td> 34 <td><a href="#MultiProjectHandler">MultiProjectHandler</a></td>
35 <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> 35 <td>Class implementing a sax handler to read an XML multi project file.</td>
36 </tr> 36 </tr>
37 </table> 37 </table>
38 <h3>Functions</h3> 38 <h3>Functions</h3>
39 <table> 39 <table>
40 <tr><td>None</td></tr> 40 <tr><td>None</td></tr>
41 </table> 41 </table>
42 <hr /><hr /> 42 <hr /><hr />
43 <a NAME="MultiProjectHandler" ID="MultiProjectHandler"></a> 43 <a NAME="MultiProjectHandler" ID="MultiProjectHandler"></a>
44 <h2>MultiProjectHandler</h2> 44 <h2>MultiProjectHandler</h2>
45 <p> 45 <p>
46 &#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;. 46 Class implementing a sax handler to read an XML multi project file.
47 </p> 47 </p>
48 <h3>Derived from</h3> 48 <h3>Derived from</h3>
49 XMLHandlerBase 49 XMLHandlerBase
50 <h3>Class Attributes</h3> 50 <h3>Class Attributes</h3>
51 <table> 51 <table>
53 </table> 53 </table>
54 <h3>Methods</h3> 54 <h3>Methods</h3>
55 <table> 55 <table>
56 <tr> 56 <tr>
57 <td><a href="#MultiProjectHandler.__init__">MultiProjectHandler</a></td> 57 <td><a href="#MultiProjectHandler.__init__">MultiProjectHandler</a></td>
58 <td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td> 58 <td>Constructor</td>
59 </tr><tr> 59 </tr><tr>
60 <td><a href="#MultiProjectHandler.endDescription">endDescription</a></td> 60 <td><a href="#MultiProjectHandler.endDescription">endDescription</a></td>
61 <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> 61 <td>Handler method for the "Description" end tag.</td>
62 </tr><tr> 62 </tr><tr>
63 <td><a href="#MultiProjectHandler.endProject">endProject</a></td> 63 <td><a href="#MultiProjectHandler.endProject">endProject</a></td>
64 <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> 64 <td>Handler method for the "Project" end tag.</td>
65 </tr><tr> 65 </tr><tr>
66 <td><a href="#MultiProjectHandler.endProjectDescription">endProjectDescription</a></td> 66 <td><a href="#MultiProjectHandler.endProjectDescription">endProjectDescription</a></td>
67 <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> 67 <td>Handler method for the "ProjectDescription" end tag.</td>
68 </tr><tr> 68 </tr><tr>
69 <td><a href="#MultiProjectHandler.endProjectFile">endProjectFile</a></td> 69 <td><a href="#MultiProjectHandler.endProjectFile">endProjectFile</a></td>
70 <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> 70 <td>Handler method for the "ProjectFile" end tag.</td>
71 </tr><tr> 71 </tr><tr>
72 <td><a href="#MultiProjectHandler.endProjectName">endProjectName</a></td> 72 <td><a href="#MultiProjectHandler.endProjectName">endProjectName</a></td>
73 <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> 73 <td>Handler method for the "ProjectName" end tag.</td>
74 </tr><tr> 74 </tr><tr>
75 <td><a href="#MultiProjectHandler.getVersion">getVersion</a></td> 75 <td><a href="#MultiProjectHandler.getVersion">getVersion</a></td>
76 <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> 76 <td>Public method to retrieve the version of the project.</td>
77 </tr><tr> 77 </tr><tr>
78 <td><a href="#MultiProjectHandler.startDocumentMultiProject">startDocumentMultiProject</a></td> 78 <td><a href="#MultiProjectHandler.startDocumentMultiProject">startDocumentMultiProject</a></td>
79 <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> 79 <td>Handler called, when the document parsing is started.</td>
80 </tr><tr> 80 </tr><tr>
81 <td><a href="#MultiProjectHandler.startMultiProject">startMultiProject</a></td> 81 <td><a href="#MultiProjectHandler.startMultiProject">startMultiProject</a></td>
82 <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> 82 <td>Handler method for the "MultiProject" start tag.</td>
83 </tr><tr> 83 </tr><tr>
84 <td><a href="#MultiProjectHandler.startProject">startProject</a></td> 84 <td><a href="#MultiProjectHandler.startProject">startProject</a></td>
85 <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> 85 <td>Handler method for the "Project" start tag.</td>
86 </tr> 86 </tr>
87 </table> 87 </table>
88 <a NAME="MultiProjectHandler.__init__" ID="MultiProjectHandler.__init__"></a> 88 <a NAME="MultiProjectHandler.__init__" ID="MultiProjectHandler.__init__"></a>
89 <h4>MultiProjectHandler (Constructor)</h4> 89 <h4>MultiProjectHandler (Constructor)</h4>
90 <b>MultiProjectHandler</b>(<i>multiProject</i>) 90 <b>MultiProjectHandler</b>(<i>multiProject</i>)
91 <p> 91 <p>
92 &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114; 92 Constructor
93 </p><dl> 93 </p><dl>
94 <dt><i>multiProject</i></dt> 94 <dt><i>multiProject</i></dt>
95 <dd> 95 <dd>
96 &#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; 96 Reference to the multi project object to store the
97 &#105;&#110;&#102;&#111;&#114;&#109;&#97;&#116;&#105;&#111;&#110; &#105;&#110;&#116;&#111;. 97 information into.
98 </dd> 98 </dd>
99 </dl><a NAME="MultiProjectHandler.endDescription" ID="MultiProjectHandler.endDescription"></a> 99 </dl><a NAME="MultiProjectHandler.endDescription" ID="MultiProjectHandler.endDescription"></a>
100 <h4>MultiProjectHandler.endDescription</h4> 100 <h4>MultiProjectHandler.endDescription</h4>
101 <b>endDescription</b>(<i></i>) 101 <b>endDescription</b>(<i></i>)
102 <p> 102 <p>
103 &#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;. 103 Handler method for the "Description" end tag.
104 </p><a NAME="MultiProjectHandler.endProject" ID="MultiProjectHandler.endProject"></a> 104 </p><a NAME="MultiProjectHandler.endProject" ID="MultiProjectHandler.endProject"></a>
105 <h4>MultiProjectHandler.endProject</h4> 105 <h4>MultiProjectHandler.endProject</h4>
106 <b>endProject</b>(<i></i>) 106 <b>endProject</b>(<i></i>)
107 <p> 107 <p>
108 &#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;. 108 Handler method for the "Project" end tag.
109 </p><a NAME="MultiProjectHandler.endProjectDescription" ID="MultiProjectHandler.endProjectDescription"></a> 109 </p><a NAME="MultiProjectHandler.endProjectDescription" ID="MultiProjectHandler.endProjectDescription"></a>
110 <h4>MultiProjectHandler.endProjectDescription</h4> 110 <h4>MultiProjectHandler.endProjectDescription</h4>
111 <b>endProjectDescription</b>(<i></i>) 111 <b>endProjectDescription</b>(<i></i>)
112 <p> 112 <p>
113 &#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;. 113 Handler method for the "ProjectDescription" end tag.
114 </p><a NAME="MultiProjectHandler.endProjectFile" ID="MultiProjectHandler.endProjectFile"></a> 114 </p><a NAME="MultiProjectHandler.endProjectFile" ID="MultiProjectHandler.endProjectFile"></a>
115 <h4>MultiProjectHandler.endProjectFile</h4> 115 <h4>MultiProjectHandler.endProjectFile</h4>
116 <b>endProjectFile</b>(<i></i>) 116 <b>endProjectFile</b>(<i></i>)
117 <p> 117 <p>
118 &#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;. 118 Handler method for the "ProjectFile" end tag.
119 </p><a NAME="MultiProjectHandler.endProjectName" ID="MultiProjectHandler.endProjectName"></a> 119 </p><a NAME="MultiProjectHandler.endProjectName" ID="MultiProjectHandler.endProjectName"></a>
120 <h4>MultiProjectHandler.endProjectName</h4> 120 <h4>MultiProjectHandler.endProjectName</h4>
121 <b>endProjectName</b>(<i></i>) 121 <b>endProjectName</b>(<i></i>)
122 <p> 122 <p>
123 &#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;. 123 Handler method for the "ProjectName" end tag.
124 </p><a NAME="MultiProjectHandler.getVersion" ID="MultiProjectHandler.getVersion"></a> 124 </p><a NAME="MultiProjectHandler.getVersion" ID="MultiProjectHandler.getVersion"></a>
125 <h4>MultiProjectHandler.getVersion</h4> 125 <h4>MultiProjectHandler.getVersion</h4>
126 <b>getVersion</b>(<i></i>) 126 <b>getVersion</b>(<i></i>)
127 <p> 127 <p>
128 &#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;. 128 Public method to retrieve the version of the project.
129 </p><dl> 129 </p><dl>
130 <dt>Returns:</dt> 130 <dt>Returns:</dt>
131 <dd> 131 <dd>
132 &#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;. 132 String containing the version number.
133 </dd> 133 </dd>
134 </dl><a NAME="MultiProjectHandler.startDocumentMultiProject" ID="MultiProjectHandler.startDocumentMultiProject"></a> 134 </dl><a NAME="MultiProjectHandler.startDocumentMultiProject" ID="MultiProjectHandler.startDocumentMultiProject"></a>
135 <h4>MultiProjectHandler.startDocumentMultiProject</h4> 135 <h4>MultiProjectHandler.startDocumentMultiProject</h4>
136 <b>startDocumentMultiProject</b>(<i></i>) 136 <b>startDocumentMultiProject</b>(<i></i>)
137 <p> 137 <p>
138 &#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;. 138 Handler called, when the document parsing is started.
139 </p><a NAME="MultiProjectHandler.startMultiProject" ID="MultiProjectHandler.startMultiProject"></a> 139 </p><a NAME="MultiProjectHandler.startMultiProject" ID="MultiProjectHandler.startMultiProject"></a>
140 <h4>MultiProjectHandler.startMultiProject</h4> 140 <h4>MultiProjectHandler.startMultiProject</h4>
141 <b>startMultiProject</b>(<i>attrs</i>) 141 <b>startMultiProject</b>(<i>attrs</i>)
142 <p> 142 <p>
143 &#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;. 143 Handler method for the "MultiProject" start tag.
144 </p><dl> 144 </p><dl>
145 <dt><i>attrs</i></dt> 145 <dt><i>attrs</i></dt>
146 <dd> 146 <dd>
147 &#108;&#105;&#115;&#116; &#111;&#102; &#116;&#97;&#103; &#97;&#116;&#116;&#114;&#105;&#98;&#117;&#116;&#101;&#115; 147 list of tag attributes
148 </dd> 148 </dd>
149 </dl><a NAME="MultiProjectHandler.startProject" ID="MultiProjectHandler.startProject"></a> 149 </dl><a NAME="MultiProjectHandler.startProject" ID="MultiProjectHandler.startProject"></a>
150 <h4>MultiProjectHandler.startProject</h4> 150 <h4>MultiProjectHandler.startProject</h4>
151 <b>startProject</b>(<i>attrs</i>) 151 <b>startProject</b>(<i>attrs</i>)
152 <p> 152 <p>
153 &#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;. 153 Handler method for the "Project" start tag.
154 </p><dl> 154 </p><dl>
155 <dt><i>attrs</i></dt> 155 <dt><i>attrs</i></dt>
156 <dd> 156 <dd>
157 &#108;&#105;&#115;&#116; &#111;&#102; &#116;&#97;&#103; &#97;&#116;&#116;&#114;&#105;&#98;&#117;&#116;&#101;&#115; 157 list of tag attributes
158 </dd> 158 </dd>
159 </dl> 159 </dl>
160 <div align="right"><a href="#top">Up</a></div> 160 <div align="right"><a href="#top">Up</a></div>
161 <hr /> 161 <hr />
162 </body></html> 162 </body></html>

eric ide

mercurial