|
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.E4XML.SessionHandler</title> |
|
6 <style> |
|
7 b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' |
|
8 </style> |
|
9 </head> |
|
10 <body><a NAME="top" ID="top"></a> |
|
11 <h1>eric5.E4XML.SessionHandler</h1> |
|
12 <p> |
|
13 Module implementing the handler class for reading an XML project session file. |
|
14 </p> |
|
15 <h3>Global Attributes</h3> |
|
16 <table> |
|
17 <tr><td>None</td></tr> |
|
18 </table> |
|
19 <h3>Classes</h3> |
|
20 <table> |
|
21 <tr> |
|
22 <td><a href="#SessionHandler">SessionHandler</a></td> |
|
23 <td>Class implementing a sax handler to read an XML project session file.</td> |
|
24 </tr> |
|
25 </table> |
|
26 <h3>Functions</h3> |
|
27 <table> |
|
28 <tr><td>None</td></tr> |
|
29 </table> |
|
30 <hr /><hr /> |
|
31 <a NAME="SessionHandler" ID="SessionHandler"></a> |
|
32 <h2>SessionHandler</h2> |
|
33 <p> |
|
34 Class implementing a sax handler to read an XML project session file. |
|
35 </p> |
|
36 <h3>Derived from</h3> |
|
37 XMLHandlerBase |
|
38 <h3>Class Attributes</h3> |
|
39 <table> |
|
40 <tr><td>None</td></tr> |
|
41 </table> |
|
42 <h3>Methods</h3> |
|
43 <table> |
|
44 <tr> |
|
45 <td><a href="#SessionHandler.__init__">SessionHandler</a></td> |
|
46 <td>Constructor</td> |
|
47 </tr><tr> |
|
48 <td><a href="#SessionHandler.endBFilename">endBFilename</a></td> |
|
49 <td>Handler method for the "BFilename" end tag.</td> |
|
50 </tr><tr> |
|
51 <td><a href="#SessionHandler.endBookmark">endBookmark</a></td> |
|
52 <td>Handler method for the "Bookmark" end tag.</td> |
|
53 </tr><tr> |
|
54 <td><a href="#SessionHandler.endBreakpoint">endBreakpoint</a></td> |
|
55 <td>Handler method for the "Breakpoint" end tag.</td> |
|
56 </tr><tr> |
|
57 <td><a href="#SessionHandler.endCommandLine">endCommandLine</a></td> |
|
58 <td>Handler method for the "CommandLine" end tag.</td> |
|
59 </tr><tr> |
|
60 <td><a href="#SessionHandler.endCondition">endCondition</a></td> |
|
61 <td>Handler method for the "Condition" end tag.</td> |
|
62 </tr><tr> |
|
63 <td><a href="#SessionHandler.endEnvironment">endEnvironment</a></td> |
|
64 <td>Handler method for the "Environment" end tag.</td> |
|
65 </tr><tr> |
|
66 <td><a href="#SessionHandler.endException">endException</a></td> |
|
67 <td>Handler method for the "Exception" end tag.</td> |
|
68 </tr><tr> |
|
69 <td><a href="#SessionHandler.endExceptions">endExceptions</a></td> |
|
70 <td>Handler method for the "Exceptions" end tag.</td> |
|
71 </tr><tr> |
|
72 <td><a href="#SessionHandler.endFilename">endFilename</a></td> |
|
73 <td>Handler method for the "Filename" end tag.</td> |
|
74 </tr><tr> |
|
75 <td><a href="#SessionHandler.endIgnoredException">endIgnoredException</a></td> |
|
76 <td>Handler method for the "IgnoredException" end tag.</td> |
|
77 </tr><tr> |
|
78 <td><a href="#SessionHandler.endIgnoredExceptions">endIgnoredExceptions</a></td> |
|
79 <td>Handler method for the "IgnoredExceptions" end tag.</td> |
|
80 </tr><tr> |
|
81 <td><a href="#SessionHandler.endMultiProject">endMultiProject</a></td> |
|
82 <td>Handler method for the "MultiProject" end tag.</td> |
|
83 </tr><tr> |
|
84 <td><a href="#SessionHandler.endProject">endProject</a></td> |
|
85 <td>Handler method for the "Project" end tag.</td> |
|
86 </tr><tr> |
|
87 <td><a href="#SessionHandler.endSpecial">endSpecial</a></td> |
|
88 <td>Handler method for the "Special" end tag.</td> |
|
89 </tr><tr> |
|
90 <td><a href="#SessionHandler.endWatchexpression">endWatchexpression</a></td> |
|
91 <td>Handler method for the "Watchexpression" end tag.</td> |
|
92 </tr><tr> |
|
93 <td><a href="#SessionHandler.endWorkingDirectory">endWorkingDirectory</a></td> |
|
94 <td>Handler method for the "WorkinDirectory" end tag.</td> |
|
95 </tr><tr> |
|
96 <td><a href="#SessionHandler.getVersion">getVersion</a></td> |
|
97 <td>Public method to retrieve the version of the session.</td> |
|
98 </tr><tr> |
|
99 <td><a href="#SessionHandler.startAutoClearShell">startAutoClearShell</a></td> |
|
100 <td>Handler method for the "AutoClearShell" start tag.</td> |
|
101 </tr><tr> |
|
102 <td><a href="#SessionHandler.startAutoContinue">startAutoContinue</a></td> |
|
103 <td>Handler method for the "AutoContinue" start tag.</td> |
|
104 </tr><tr> |
|
105 <td><a href="#SessionHandler.startBookmark">startBookmark</a></td> |
|
106 <td>Handler method for the "Bookmark" start tag.</td> |
|
107 </tr><tr> |
|
108 <td><a href="#SessionHandler.startBreakpoint">startBreakpoint</a></td> |
|
109 <td>Handler method for the "Breakpoint" start tag.</td> |
|
110 </tr><tr> |
|
111 <td><a href="#SessionHandler.startCount">startCount</a></td> |
|
112 <td>Handler method for the "Count" start tag.</td> |
|
113 </tr><tr> |
|
114 <td><a href="#SessionHandler.startDocumentSession">startDocumentSession</a></td> |
|
115 <td>Handler called, when the document parsing is started.</td> |
|
116 </tr><tr> |
|
117 <td><a href="#SessionHandler.startEnabled">startEnabled</a></td> |
|
118 <td>Handler method for the "Enabled" start tag.</td> |
|
119 </tr><tr> |
|
120 <td><a href="#SessionHandler.startExceptions">startExceptions</a></td> |
|
121 <td>Handler method for the "Exceptions" start tag.</td> |
|
122 </tr><tr> |
|
123 <td><a href="#SessionHandler.startFilename">startFilename</a></td> |
|
124 <td>Handler method for the "Filename" start tag.</td> |
|
125 </tr><tr> |
|
126 <td><a href="#SessionHandler.startIgnoredExceptions">startIgnoredExceptions</a></td> |
|
127 <td>Handler method for the "IgnoredExceptions" start tag.</td> |
|
128 </tr><tr> |
|
129 <td><a href="#SessionHandler.startLinenumber">startLinenumber</a></td> |
|
130 <td>Handler method for the "Linenumber" start tag.</td> |
|
131 </tr><tr> |
|
132 <td><a href="#SessionHandler.startReportExceptions">startReportExceptions</a></td> |
|
133 <td>Handler method for the "ReportExceptions" start tag.</td> |
|
134 </tr><tr> |
|
135 <td><a href="#SessionHandler.startSession">startSession</a></td> |
|
136 <td>Handler method for the "Session" start tag.</td> |
|
137 </tr><tr> |
|
138 <td><a href="#SessionHandler.startTemporary">startTemporary</a></td> |
|
139 <td>Handler method for the "Temporary" start tag.</td> |
|
140 </tr><tr> |
|
141 <td><a href="#SessionHandler.startTracePython">startTracePython</a></td> |
|
142 <td>Handler method for the "TracePython" start tag.</td> |
|
143 </tr><tr> |
|
144 <td><a href="#SessionHandler.startWatchexpression">startWatchexpression</a></td> |
|
145 <td>Handler method for the "Watchexpression" start tag.</td> |
|
146 </tr> |
|
147 </table> |
|
148 <a NAME="SessionHandler.__init__" ID="SessionHandler.__init__"></a> |
|
149 <h4>SessionHandler (Constructor)</h4> |
|
150 <b>SessionHandler</b>(<i>project</i>) |
|
151 <p> |
|
152 Constructor |
|
153 </p><dl> |
|
154 <dt><i>project</i></dt> |
|
155 <dd> |
|
156 Reference to the project object to store the |
|
157 information into. |
|
158 </dd> |
|
159 </dl><a NAME="SessionHandler.endBFilename" ID="SessionHandler.endBFilename"></a> |
|
160 <h4>SessionHandler.endBFilename</h4> |
|
161 <b>endBFilename</b>(<i></i>) |
|
162 <p> |
|
163 Handler method for the "BFilename" end tag. |
|
164 </p><a NAME="SessionHandler.endBookmark" ID="SessionHandler.endBookmark"></a> |
|
165 <h4>SessionHandler.endBookmark</h4> |
|
166 <b>endBookmark</b>(<i></i>) |
|
167 <p> |
|
168 Handler method for the "Bookmark" end tag. |
|
169 </p><a NAME="SessionHandler.endBreakpoint" ID="SessionHandler.endBreakpoint"></a> |
|
170 <h4>SessionHandler.endBreakpoint</h4> |
|
171 <b>endBreakpoint</b>(<i></i>) |
|
172 <p> |
|
173 Handler method for the "Breakpoint" end tag. |
|
174 </p><a NAME="SessionHandler.endCommandLine" ID="SessionHandler.endCommandLine"></a> |
|
175 <h4>SessionHandler.endCommandLine</h4> |
|
176 <b>endCommandLine</b>(<i></i>) |
|
177 <p> |
|
178 Handler method for the "CommandLine" end tag. |
|
179 </p><a NAME="SessionHandler.endCondition" ID="SessionHandler.endCondition"></a> |
|
180 <h4>SessionHandler.endCondition</h4> |
|
181 <b>endCondition</b>(<i></i>) |
|
182 <p> |
|
183 Handler method for the "Condition" end tag. |
|
184 </p><a NAME="SessionHandler.endEnvironment" ID="SessionHandler.endEnvironment"></a> |
|
185 <h4>SessionHandler.endEnvironment</h4> |
|
186 <b>endEnvironment</b>(<i></i>) |
|
187 <p> |
|
188 Handler method for the "Environment" end tag. |
|
189 </p><a NAME="SessionHandler.endException" ID="SessionHandler.endException"></a> |
|
190 <h4>SessionHandler.endException</h4> |
|
191 <b>endException</b>(<i></i>) |
|
192 <p> |
|
193 Handler method for the "Exception" end tag. |
|
194 </p><a NAME="SessionHandler.endExceptions" ID="SessionHandler.endExceptions"></a> |
|
195 <h4>SessionHandler.endExceptions</h4> |
|
196 <b>endExceptions</b>(<i></i>) |
|
197 <p> |
|
198 Handler method for the "Exceptions" end tag. |
|
199 </p><a NAME="SessionHandler.endFilename" ID="SessionHandler.endFilename"></a> |
|
200 <h4>SessionHandler.endFilename</h4> |
|
201 <b>endFilename</b>(<i></i>) |
|
202 <p> |
|
203 Handler method for the "Filename" end tag. |
|
204 </p><a NAME="SessionHandler.endIgnoredException" ID="SessionHandler.endIgnoredException"></a> |
|
205 <h4>SessionHandler.endIgnoredException</h4> |
|
206 <b>endIgnoredException</b>(<i></i>) |
|
207 <p> |
|
208 Handler method for the "IgnoredException" end tag. |
|
209 </p><a NAME="SessionHandler.endIgnoredExceptions" ID="SessionHandler.endIgnoredExceptions"></a> |
|
210 <h4>SessionHandler.endIgnoredExceptions</h4> |
|
211 <b>endIgnoredExceptions</b>(<i></i>) |
|
212 <p> |
|
213 Handler method for the "IgnoredExceptions" end tag. |
|
214 </p><a NAME="SessionHandler.endMultiProject" ID="SessionHandler.endMultiProject"></a> |
|
215 <h4>SessionHandler.endMultiProject</h4> |
|
216 <b>endMultiProject</b>(<i></i>) |
|
217 <p> |
|
218 Handler method for the "MultiProject" end tag. |
|
219 </p><a NAME="SessionHandler.endProject" ID="SessionHandler.endProject"></a> |
|
220 <h4>SessionHandler.endProject</h4> |
|
221 <b>endProject</b>(<i></i>) |
|
222 <p> |
|
223 Handler method for the "Project" end tag. |
|
224 </p><a NAME="SessionHandler.endSpecial" ID="SessionHandler.endSpecial"></a> |
|
225 <h4>SessionHandler.endSpecial</h4> |
|
226 <b>endSpecial</b>(<i></i>) |
|
227 <p> |
|
228 Handler method for the "Special" end tag. |
|
229 </p><a NAME="SessionHandler.endWatchexpression" ID="SessionHandler.endWatchexpression"></a> |
|
230 <h4>SessionHandler.endWatchexpression</h4> |
|
231 <b>endWatchexpression</b>(<i></i>) |
|
232 <p> |
|
233 Handler method for the "Watchexpression" end tag. |
|
234 </p><a NAME="SessionHandler.endWorkingDirectory" ID="SessionHandler.endWorkingDirectory"></a> |
|
235 <h4>SessionHandler.endWorkingDirectory</h4> |
|
236 <b>endWorkingDirectory</b>(<i></i>) |
|
237 <p> |
|
238 Handler method for the "WorkinDirectory" end tag. |
|
239 </p><a NAME="SessionHandler.getVersion" ID="SessionHandler.getVersion"></a> |
|
240 <h4>SessionHandler.getVersion</h4> |
|
241 <b>getVersion</b>(<i></i>) |
|
242 <p> |
|
243 Public method to retrieve the version of the session. |
|
244 </p><dl> |
|
245 <dt>Returns:</dt> |
|
246 <dd> |
|
247 String containing the version number. |
|
248 </dd> |
|
249 </dl><a NAME="SessionHandler.startAutoClearShell" ID="SessionHandler.startAutoClearShell"></a> |
|
250 <h4>SessionHandler.startAutoClearShell</h4> |
|
251 <b>startAutoClearShell</b>(<i>attrs</i>) |
|
252 <p> |
|
253 Handler method for the "AutoClearShell" start tag. |
|
254 </p><dl> |
|
255 <dt><i>attrs</i></dt> |
|
256 <dd> |
|
257 list of tag attributes |
|
258 </dd> |
|
259 </dl><a NAME="SessionHandler.startAutoContinue" ID="SessionHandler.startAutoContinue"></a> |
|
260 <h4>SessionHandler.startAutoContinue</h4> |
|
261 <b>startAutoContinue</b>(<i>attrs</i>) |
|
262 <p> |
|
263 Handler method for the "AutoContinue" start tag. |
|
264 </p><dl> |
|
265 <dt><i>attrs</i></dt> |
|
266 <dd> |
|
267 list of tag attributes |
|
268 </dd> |
|
269 </dl><a NAME="SessionHandler.startBookmark" ID="SessionHandler.startBookmark"></a> |
|
270 <h4>SessionHandler.startBookmark</h4> |
|
271 <b>startBookmark</b>(<i>attrs</i>) |
|
272 <p> |
|
273 Handler method for the "Bookmark" start tag. |
|
274 </p><dl> |
|
275 <dt><i>attrs</i></dt> |
|
276 <dd> |
|
277 list of tag attributes |
|
278 </dd> |
|
279 </dl><a NAME="SessionHandler.startBreakpoint" ID="SessionHandler.startBreakpoint"></a> |
|
280 <h4>SessionHandler.startBreakpoint</h4> |
|
281 <b>startBreakpoint</b>(<i>attrs</i>) |
|
282 <p> |
|
283 Handler method for the "Breakpoint" start tag. |
|
284 </p><dl> |
|
285 <dt><i>attrs</i></dt> |
|
286 <dd> |
|
287 list of tag attributes |
|
288 </dd> |
|
289 </dl><a NAME="SessionHandler.startCount" ID="SessionHandler.startCount"></a> |
|
290 <h4>SessionHandler.startCount</h4> |
|
291 <b>startCount</b>(<i>attrs</i>) |
|
292 <p> |
|
293 Handler method for the "Count" start tag. |
|
294 </p><dl> |
|
295 <dt><i>attrs</i></dt> |
|
296 <dd> |
|
297 list of tag attributes |
|
298 </dd> |
|
299 </dl><a NAME="SessionHandler.startDocumentSession" ID="SessionHandler.startDocumentSession"></a> |
|
300 <h4>SessionHandler.startDocumentSession</h4> |
|
301 <b>startDocumentSession</b>(<i></i>) |
|
302 <p> |
|
303 Handler called, when the document parsing is started. |
|
304 </p><a NAME="SessionHandler.startEnabled" ID="SessionHandler.startEnabled"></a> |
|
305 <h4>SessionHandler.startEnabled</h4> |
|
306 <b>startEnabled</b>(<i>attrs</i>) |
|
307 <p> |
|
308 Handler method for the "Enabled" start tag. |
|
309 </p><dl> |
|
310 <dt><i>attrs</i></dt> |
|
311 <dd> |
|
312 list of tag attributes |
|
313 </dd> |
|
314 </dl><a NAME="SessionHandler.startExceptions" ID="SessionHandler.startExceptions"></a> |
|
315 <h4>SessionHandler.startExceptions</h4> |
|
316 <b>startExceptions</b>(<i>attrs</i>) |
|
317 <p> |
|
318 Handler method for the "Exceptions" start tag. |
|
319 </p><dl> |
|
320 <dt><i>attrs</i></dt> |
|
321 <dd> |
|
322 list of tag attributes |
|
323 </dd> |
|
324 </dl><a NAME="SessionHandler.startFilename" ID="SessionHandler.startFilename"></a> |
|
325 <h4>SessionHandler.startFilename</h4> |
|
326 <b>startFilename</b>(<i>attrs</i>) |
|
327 <p> |
|
328 Handler method for the "Filename" start tag. |
|
329 </p><dl> |
|
330 <dt><i>attrs</i></dt> |
|
331 <dd> |
|
332 list of tag attributes |
|
333 </dd> |
|
334 </dl><a NAME="SessionHandler.startIgnoredExceptions" ID="SessionHandler.startIgnoredExceptions"></a> |
|
335 <h4>SessionHandler.startIgnoredExceptions</h4> |
|
336 <b>startIgnoredExceptions</b>(<i>attrs</i>) |
|
337 <p> |
|
338 Handler method for the "IgnoredExceptions" start tag. |
|
339 </p><dl> |
|
340 <dt><i>attrs</i></dt> |
|
341 <dd> |
|
342 list of tag attributes |
|
343 </dd> |
|
344 </dl><a NAME="SessionHandler.startLinenumber" ID="SessionHandler.startLinenumber"></a> |
|
345 <h4>SessionHandler.startLinenumber</h4> |
|
346 <b>startLinenumber</b>(<i>attrs</i>) |
|
347 <p> |
|
348 Handler method for the "Linenumber" start tag. |
|
349 </p><dl> |
|
350 <dt><i>attrs</i></dt> |
|
351 <dd> |
|
352 list of tag attributes |
|
353 </dd> |
|
354 </dl><a NAME="SessionHandler.startReportExceptions" ID="SessionHandler.startReportExceptions"></a> |
|
355 <h4>SessionHandler.startReportExceptions</h4> |
|
356 <b>startReportExceptions</b>(<i>attrs</i>) |
|
357 <p> |
|
358 Handler method for the "ReportExceptions" start tag. |
|
359 </p><dl> |
|
360 <dt><i>attrs</i></dt> |
|
361 <dd> |
|
362 list of tag attributes |
|
363 </dd> |
|
364 </dl><a NAME="SessionHandler.startSession" ID="SessionHandler.startSession"></a> |
|
365 <h4>SessionHandler.startSession</h4> |
|
366 <b>startSession</b>(<i>attrs</i>) |
|
367 <p> |
|
368 Handler method for the "Session" start tag. |
|
369 </p><dl> |
|
370 <dt><i>attrs</i></dt> |
|
371 <dd> |
|
372 list of tag attributes |
|
373 </dd> |
|
374 </dl><a NAME="SessionHandler.startTemporary" ID="SessionHandler.startTemporary"></a> |
|
375 <h4>SessionHandler.startTemporary</h4> |
|
376 <b>startTemporary</b>(<i>attrs</i>) |
|
377 <p> |
|
378 Handler method for the "Temporary" start tag. |
|
379 </p><dl> |
|
380 <dt><i>attrs</i></dt> |
|
381 <dd> |
|
382 list of tag attributes |
|
383 </dd> |
|
384 </dl><a NAME="SessionHandler.startTracePython" ID="SessionHandler.startTracePython"></a> |
|
385 <h4>SessionHandler.startTracePython</h4> |
|
386 <b>startTracePython</b>(<i>attrs</i>) |
|
387 <p> |
|
388 Handler method for the "TracePython" start tag. |
|
389 </p><dl> |
|
390 <dt><i>attrs</i></dt> |
|
391 <dd> |
|
392 list of tag attributes |
|
393 </dd> |
|
394 </dl><a NAME="SessionHandler.startWatchexpression" ID="SessionHandler.startWatchexpression"></a> |
|
395 <h4>SessionHandler.startWatchexpression</h4> |
|
396 <b>startWatchexpression</b>(<i>attrs</i>) |
|
397 <p> |
|
398 Handler method for the "Watchexpression" start tag. |
|
399 </p><dl> |
|
400 <dt><i>attrs</i></dt> |
|
401 <dd> |
|
402 list of tag attributes |
|
403 </dd> |
|
404 </dl> |
|
405 <div align="right"><a href="#top">Up</a></div> |
|
406 <hr /> |
|
407 </body></html> |