eric: Documentation/Source/eric5.E5XML.UserProjectHandler.html@0ea528e80202

<?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.UserProjectHandler</title>
<style>
body {
    background: white;
    margin: 0em 1em 10em 1em;
    color: black;
}

h1 { color: white; background: #85774A; }
h2 { color: white; background: #85774A; }
h3 { color: black; background: #C1BBA4; }
h4 { color: black; background: #C1BBA4; }

a { color: #C07037; }

</style>
</head>
<body><a NAME="top" ID="top"></a>
<h1>eric5.E5XML.UserProjectHandler</h1>
<p>
Module implementing the handler class for reading an XML user project properties file.
</p>
<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>
<table>
<tr>
<td><a href="#UserProjectHandler">UserProjectHandler</a></td>
<td>Class implementing a sax handler to read an XML user project properties file.</td>
</tr>
</table>
<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>
<hr /><hr />
<a NAME="UserProjectHandler" ID="UserProjectHandler"></a>
<h2>UserProjectHandler</h2>
<p>
    Class implementing a sax handler to read an XML user project properties 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="#UserProjectHandler.__init__">UserProjectHandler</a></td>
<td>Constructor</td>
</tr><tr>
<td><a href="#UserProjectHandler.endVcsType">endVcsType</a></td>
<td>Handler method for the "VcsType" end tag.</td>
</tr><tr>
<td><a href="#UserProjectHandler.getVersion">getVersion</a></td>
<td>Public method to retrieve the version of the user project file.</td>
</tr><tr>
<td><a href="#UserProjectHandler.startDocumentProject">startDocumentProject</a></td>
<td>Handler called, when the document parsing is started.</td>
</tr><tr>
<td><a href="#UserProjectHandler.startUserProject">startUserProject</a></td>
<td>Handler method for the "UserProject" start tag.</td>
</tr><tr>
<td><a href="#UserProjectHandler.startVcsStatusMonitorInterval">startVcsStatusMonitorInterval</a></td>
<td>Handler method for the "VcsStatusMonitorInterval" start tag.</td>
</tr>
</table>
<a NAME="UserProjectHandler.__init__" ID="UserProjectHandler.__init__"></a>
<h4>UserProjectHandler (Constructor)</h4>
<b>UserProjectHandler</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="UserProjectHandler.endVcsType" ID="UserProjectHandler.endVcsType"></a>
<h4>UserProjectHandler.endVcsType</h4>
<b>endVcsType</b>(<i></i>)
<p>
        Handler method for the "VcsType" end tag.
</p><a NAME="UserProjectHandler.getVersion" ID="UserProjectHandler.getVersion"></a>
<h4>UserProjectHandler.getVersion</h4>
<b>getVersion</b>(<i></i>)
<p>
        Public method to retrieve the version of the user project file.
</p><dl>
<dt>Returns:</dt>
<dd>
String containing the version number.
</dd>
</dl><a NAME="UserProjectHandler.startDocumentProject" ID="UserProjectHandler.startDocumentProject"></a>
<h4>UserProjectHandler.startDocumentProject</h4>
<b>startDocumentProject</b>(<i></i>)
<p>
        Handler called, when the document parsing is started.
</p><a NAME="UserProjectHandler.startUserProject" ID="UserProjectHandler.startUserProject"></a>
<h4>UserProjectHandler.startUserProject</h4>
<b>startUserProject</b>(<i>attrs</i>)
<p>
        Handler method for the "UserProject" start tag.
</p><dl>
<dt><i>attrs</i></dt>
<dd>
list of tag attributes
</dd>
</dl><a NAME="UserProjectHandler.startVcsStatusMonitorInterval" ID="UserProjectHandler.startVcsStatusMonitorInterval"></a>
<h4>UserProjectHandler.startVcsStatusMonitorInterval</h4>
<b>startVcsStatusMonitorInterval</b>(<i>attrs</i>)
<p>
        Handler method for the "VcsStatusMonitorInterval" 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>