Documentation/Source/eric5.E5XML.SessionHandler.html

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
<html><head>
<title>eric5.E5XML.SessionHandler</title>
<style>
body {
    background:white;
    margin: 0em 1em 10em 1em;
    color: black;
}

h1 { color: white; background: #4FA4FF; }
h2 { color: white; background: #4FA4FF; }
h3 { color: white; background: #00557F; }
h4 { color: white; background: #00557F; }
    
a { color: #AA5500; }

</style>
</head>
<body><a NAME="top" ID="top"></a>
<h1>eric5.E5XML.SessionHandler</h1>
<p>
Module implementing the handler class for reading an XML project session file.
</p>
<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>
<table>
<tr>
<td><a href="#SessionHandler">SessionHandler</a></td>
<td>Class implementing a sax handler to read an XML project session file.</td>
</tr>
</table>
<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>
<hr /><hr />
<a NAME="SessionHandler" ID="SessionHandler"></a>
<h2>SessionHandler</h2>
<p>
    Class implementing a sax handler to read an XML project session file.
</p>
<h3>Derived from</h3>
XMLHandlerBase
<h3>Class Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>
<table>
<tr>
<td><a href="#SessionHandler.__init__">SessionHandler</a></td>
<td>Constructor</td>
</tr><tr>
<td><a href="#SessionHandler.endBFilename">endBFilename</a></td>
<td>Handler method for the "BFilename" end tag.</td>
</tr><tr>
<td><a href="#SessionHandler.endBookmark">endBookmark</a></td>
<td>Handler method for the "Bookmark" end tag.</td>
</tr><tr>
<td><a href="#SessionHandler.endBreakpoint">endBreakpoint</a></td>
<td>Handler method for the "Breakpoint" end tag.</td>
</tr><tr>
<td><a href="#SessionHandler.endCommandLine">endCommandLine</a></td>
<td>Handler method for the "CommandLine" end tag.</td>
</tr><tr>
<td><a href="#SessionHandler.endCondition">endCondition</a></td>
<td>Handler method for the "Condition" end tag.</td>
</tr><tr>
<td><a href="#SessionHandler.endEnvironment">endEnvironment</a></td>
<td>Handler method for the "Environment" end tag.</td>
</tr><tr>
<td><a href="#SessionHandler.endException">endException</a></td>
<td>Handler method for the "Exception" end tag.</td>
</tr><tr>
<td><a href="#SessionHandler.endExceptions">endExceptions</a></td>
<td>Handler method for the "Exceptions" end tag.</td>
</tr><tr>
<td><a href="#SessionHandler.endFilename">endFilename</a></td>
<td>Handler method for the "Filename" end tag.</td>
</tr><tr>
<td><a href="#SessionHandler.endIgnoredException">endIgnoredException</a></td>
<td>Handler method for the "IgnoredException" end tag.</td>
</tr><tr>
<td><a href="#SessionHandler.endIgnoredExceptions">endIgnoredExceptions</a></td>
<td>Handler method for the "IgnoredExceptions" end tag.</td>
</tr><tr>
<td><a href="#SessionHandler.endMultiProject">endMultiProject</a></td>
<td>Handler method for the "MultiProject" end tag.</td>
</tr><tr>
<td><a href="#SessionHandler.endProject">endProject</a></td>
<td>Handler method for the "Project" end tag.</td>
</tr><tr>
<td><a href="#SessionHandler.endSpecial">endSpecial</a></td>
<td>Handler method for the "Special" end tag.</td>
</tr><tr>
<td><a href="#SessionHandler.endWatchexpression">endWatchexpression</a></td>
<td>Handler method for the "Watchexpression" end tag.</td>
</tr><tr>
<td><a href="#SessionHandler.endWorkingDirectory">endWorkingDirectory</a></td>
<td>Handler method for the "WorkinDirectory" end tag.</td>
</tr><tr>
<td><a href="#SessionHandler.getVersion">getVersion</a></td>
<td>Public method to retrieve the version of the session.</td>
</tr><tr>
<td><a href="#SessionHandler.startAutoClearShell">startAutoClearShell</a></td>
<td>Handler method for the "AutoClearShell" start tag.</td>
</tr><tr>
<td><a href="#SessionHandler.startAutoContinue">startAutoContinue</a></td>
<td>Handler method for the "AutoContinue" start tag.</td>
</tr><tr>
<td><a href="#SessionHandler.startBookmark">startBookmark</a></td>
<td>Handler method for the "Bookmark" start tag.</td>
</tr><tr>
<td><a href="#SessionHandler.startBreakpoint">startBreakpoint</a></td>
<td>Handler method for the "Breakpoint" start tag.</td>
</tr><tr>
<td><a href="#SessionHandler.startCount">startCount</a></td>
<td>Handler method for the "Count" start tag.</td>
</tr><tr>
<td><a href="#SessionHandler.startDocumentSession">startDocumentSession</a></td>
<td>Handler called, when the document parsing is started.</td>
</tr><tr>
<td><a href="#SessionHandler.startEnabled">startEnabled</a></td>
<td>Handler method for the "Enabled" start tag.</td>
</tr><tr>
<td><a href="#SessionHandler.startExceptions">startExceptions</a></td>
<td>Handler method for the "Exceptions" start tag.</td>
</tr><tr>
<td><a href="#SessionHandler.startFilename">startFilename</a></td>
<td>Handler method for the "Filename" start tag.</td>
</tr><tr>
<td><a href="#SessionHandler.startIgnoredExceptions">startIgnoredExceptions</a></td>
<td>Handler method for the "IgnoredExceptions" start tag.</td>
</tr><tr>
<td><a href="#SessionHandler.startLinenumber">startLinenumber</a></td>
<td>Handler method for the "Linenumber" start tag.</td>
</tr><tr>
<td><a href="#SessionHandler.startReportExceptions">startReportExceptions</a></td>
<td>Handler method for the "ReportExceptions" start tag.</td>
</tr><tr>
<td><a href="#SessionHandler.startSession">startSession</a></td>
<td>Handler method for the "Session" start tag.</td>
</tr><tr>
<td><a href="#SessionHandler.startTemporary">startTemporary</a></td>
<td>Handler method for the "Temporary" start tag.</td>
</tr><tr>
<td><a href="#SessionHandler.startTracePython">startTracePython</a></td>
<td>Handler method for the "TracePython" start tag.</td>
</tr><tr>
<td><a href="#SessionHandler.startWatchexpression">startWatchexpression</a></td>
<td>Handler method for the "Watchexpression" start tag.</td>
</tr>
</table>
<a NAME="SessionHandler.__init__" ID="SessionHandler.__init__"></a>
<h4>SessionHandler (Constructor)</h4>
<b>SessionHandler</b>(<i>project</i>)
<p>
        Constructor
</p><dl>
<dt><i>project</i></dt>
<dd>
Reference to the project object to store the
                information into.
</dd>
</dl><a NAME="SessionHandler.endBFilename" ID="SessionHandler.endBFilename"></a>
<h4>SessionHandler.endBFilename</h4>
<b>endBFilename</b>(<i></i>)
<p>
        Handler method for the "BFilename" end tag.
</p><a NAME="SessionHandler.endBookmark" ID="SessionHandler.endBookmark"></a>
<h4>SessionHandler.endBookmark</h4>
<b>endBookmark</b>(<i></i>)
<p>
        Handler method for the "Bookmark" end tag.
</p><a NAME="SessionHandler.endBreakpoint" ID="SessionHandler.endBreakpoint"></a>
<h4>SessionHandler.endBreakpoint</h4>
<b>endBreakpoint</b>(<i></i>)
<p>
        Handler method for the "Breakpoint" end tag.
</p><a NAME="SessionHandler.endCommandLine" ID="SessionHandler.endCommandLine"></a>
<h4>SessionHandler.endCommandLine</h4>
<b>endCommandLine</b>(<i></i>)
<p>
        Handler method for the "CommandLine" end tag.
</p><a NAME="SessionHandler.endCondition" ID="SessionHandler.endCondition"></a>
<h4>SessionHandler.endCondition</h4>
<b>endCondition</b>(<i></i>)
<p>
        Handler method for the "Condition" end tag.
</p><a NAME="SessionHandler.endEnvironment" ID="SessionHandler.endEnvironment"></a>
<h4>SessionHandler.endEnvironment</h4>
<b>endEnvironment</b>(<i></i>)
<p>
        Handler method for the "Environment" end tag.
</p><a NAME="SessionHandler.endException" ID="SessionHandler.endException"></a>
<h4>SessionHandler.endException</h4>
<b>endException</b>(<i></i>)
<p>
        Handler method for the "Exception" end tag.
</p><a NAME="SessionHandler.endExceptions" ID="SessionHandler.endExceptions"></a>
<h4>SessionHandler.endExceptions</h4>
<b>endExceptions</b>(<i></i>)
<p>
        Handler method for the "Exceptions" end tag.
</p><a NAME="SessionHandler.endFilename" ID="SessionHandler.endFilename"></a>
<h4>SessionHandler.endFilename</h4>
<b>endFilename</b>(<i></i>)
<p>
        Handler method for the "Filename" end tag.
</p><a NAME="SessionHandler.endIgnoredException" ID="SessionHandler.endIgnoredException"></a>
<h4>SessionHandler.endIgnoredException</h4>
<b>endIgnoredException</b>(<i></i>)
<p>
        Handler method for the "IgnoredException" end tag.
</p><a NAME="SessionHandler.endIgnoredExceptions" ID="SessionHandler.endIgnoredExceptions"></a>
<h4>SessionHandler.endIgnoredExceptions</h4>
<b>endIgnoredExceptions</b>(<i></i>)
<p>
        Handler method for the "IgnoredExceptions" end tag.
</p><a NAME="SessionHandler.endMultiProject" ID="SessionHandler.endMultiProject"></a>
<h4>SessionHandler.endMultiProject</h4>
<b>endMultiProject</b>(<i></i>)
<p>
        Handler method for the "MultiProject" end tag.
</p><a NAME="SessionHandler.endProject" ID="SessionHandler.endProject"></a>
<h4>SessionHandler.endProject</h4>
<b>endProject</b>(<i></i>)
<p>
        Handler method for the "Project" end tag.
</p><a NAME="SessionHandler.endSpecial" ID="SessionHandler.endSpecial"></a>
<h4>SessionHandler.endSpecial</h4>
<b>endSpecial</b>(<i></i>)
<p>
        Handler method for the "Special" end tag.
</p><a NAME="SessionHandler.endWatchexpression" ID="SessionHandler.endWatchexpression"></a>
<h4>SessionHandler.endWatchexpression</h4>
<b>endWatchexpression</b>(<i></i>)
<p>
        Handler method for the "Watchexpression" end tag.
</p><a NAME="SessionHandler.endWorkingDirectory" ID="SessionHandler.endWorkingDirectory"></a>
<h4>SessionHandler.endWorkingDirectory</h4>
<b>endWorkingDirectory</b>(<i></i>)
<p>
        Handler method for the "WorkinDirectory" end tag.
</p><a NAME="SessionHandler.getVersion" ID="SessionHandler.getVersion"></a>
<h4>SessionHandler.getVersion</h4>
<b>getVersion</b>(<i></i>)
<p>
        Public method to retrieve the version of the session.
</p><dl>
<dt>Returns:</dt>
<dd>
String containing the version number.
</dd>
</dl><a NAME="SessionHandler.startAutoClearShell" ID="SessionHandler.startAutoClearShell"></a>
<h4>SessionHandler.startAutoClearShell</h4>
<b>startAutoClearShell</b>(<i>attrs</i>)
<p>
        Handler method for the "AutoClearShell" start tag.
</p><dl>
<dt><i>attrs</i></dt>
<dd>
list of tag attributes
</dd>
</dl><a NAME="SessionHandler.startAutoContinue" ID="SessionHandler.startAutoContinue"></a>
<h4>SessionHandler.startAutoContinue</h4>
<b>startAutoContinue</b>(<i>attrs</i>)
<p>
        Handler method for the "AutoContinue" start tag.
</p><dl>
<dt><i>attrs</i></dt>
<dd>
list of tag attributes
</dd>
</dl><a NAME="SessionHandler.startBookmark" ID="SessionHandler.startBookmark"></a>
<h4>SessionHandler.startBookmark</h4>
<b>startBookmark</b>(<i>attrs</i>)
<p>
        Handler method for the "Bookmark" start tag.
</p><dl>
<dt><i>attrs</i></dt>
<dd>
list of tag attributes
</dd>
</dl><a NAME="SessionHandler.startBreakpoint" ID="SessionHandler.startBreakpoint"></a>
<h4>SessionHandler.startBreakpoint</h4>
<b>startBreakpoint</b>(<i>attrs</i>)
<p>
        Handler method for the "Breakpoint" start tag.
</p><dl>
<dt><i>attrs</i></dt>
<dd>
list of tag attributes
</dd>
</dl><a NAME="SessionHandler.startCount" ID="SessionHandler.startCount"></a>
<h4>SessionHandler.startCount</h4>
<b>startCount</b>(<i>attrs</i>)
<p>
        Handler method for the "Count" start tag.
</p><dl>
<dt><i>attrs</i></dt>
<dd>
list of tag attributes
</dd>
</dl><a NAME="SessionHandler.startDocumentSession" ID="SessionHandler.startDocumentSession"></a>
<h4>SessionHandler.startDocumentSession</h4>
<b>startDocumentSession</b>(<i></i>)
<p>
        Handler called, when the document parsing is started.
</p><a NAME="SessionHandler.startEnabled" ID="SessionHandler.startEnabled"></a>
<h4>SessionHandler.startEnabled</h4>
<b>startEnabled</b>(<i>attrs</i>)
<p>
        Handler method for the "Enabled" start tag.
</p><dl>
<dt><i>attrs</i></dt>
<dd>
list of tag attributes
</dd>
</dl><a NAME="SessionHandler.startExceptions" ID="SessionHandler.startExceptions"></a>
<h4>SessionHandler.startExceptions</h4>
<b>startExceptions</b>(<i>attrs</i>)
<p>
        Handler method for the "Exceptions" start tag.
</p><dl>
<dt><i>attrs</i></dt>
<dd>
list of tag attributes
</dd>
</dl><a NAME="SessionHandler.startFilename" ID="SessionHandler.startFilename"></a>
<h4>SessionHandler.startFilename</h4>
<b>startFilename</b>(<i>attrs</i>)
<p>
        Handler method for the "Filename" start tag.
</p><dl>
<dt><i>attrs</i></dt>
<dd>
list of tag attributes
</dd>
</dl><a NAME="SessionHandler.startIgnoredExceptions" ID="SessionHandler.startIgnoredExceptions"></a>
<h4>SessionHandler.startIgnoredExceptions</h4>
<b>startIgnoredExceptions</b>(<i>attrs</i>)
<p>
        Handler method for the "IgnoredExceptions" start tag.
</p><dl>
<dt><i>attrs</i></dt>
<dd>
list of tag attributes
</dd>
</dl><a NAME="SessionHandler.startLinenumber" ID="SessionHandler.startLinenumber"></a>
<h4>SessionHandler.startLinenumber</h4>
<b>startLinenumber</b>(<i>attrs</i>)
<p>
        Handler method for the "Linenumber" start tag.
</p><dl>
<dt><i>attrs</i></dt>
<dd>
list of tag attributes
</dd>
</dl><a NAME="SessionHandler.startReportExceptions" ID="SessionHandler.startReportExceptions"></a>
<h4>SessionHandler.startReportExceptions</h4>
<b>startReportExceptions</b>(<i>attrs</i>)
<p>
        Handler method for the "ReportExceptions" start tag.
</p><dl>
<dt><i>attrs</i></dt>
<dd>
list of tag attributes
</dd>
</dl><a NAME="SessionHandler.startSession" ID="SessionHandler.startSession"></a>
<h4>SessionHandler.startSession</h4>
<b>startSession</b>(<i>attrs</i>)
<p>
        Handler method for the "Session" start tag.
</p><dl>
<dt><i>attrs</i></dt>
<dd>
list of tag attributes
</dd>
</dl><a NAME="SessionHandler.startTemporary" ID="SessionHandler.startTemporary"></a>
<h4>SessionHandler.startTemporary</h4>
<b>startTemporary</b>(<i>attrs</i>)
<p>
        Handler method for the "Temporary" start tag.
</p><dl>
<dt><i>attrs</i></dt>
<dd>
list of tag attributes
</dd>
</dl><a NAME="SessionHandler.startTracePython" ID="SessionHandler.startTracePython"></a>
<h4>SessionHandler.startTracePython</h4>
<b>startTracePython</b>(<i>attrs</i>)
<p>
        Handler method for the "TracePython" start tag.
</p><dl>
<dt><i>attrs</i></dt>
<dd>
list of tag attributes
</dd>
</dl><a NAME="SessionHandler.startWatchexpression" ID="SessionHandler.startWatchexpression"></a>
<h4>SessionHandler.startWatchexpression</h4>
<b>startWatchexpression</b>(<i>attrs</i>)
<p>
        Handler method for the "Watchexpression" start tag.
</p><dl>
<dt><i>attrs</i></dt>
<dd>
list of tag attributes
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>