Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric5.E5XML.SessionHandler.html

Documentation/Source/eric5.E5XML.SessionHandler.html

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

Mercurial Repository: eric

eric ide

mercurial