Documentation/Source/eric5.E5XML.TemplatesHandler.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.TemplatesHandler</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.TemplatesHandler</h1>
<p>
Module implementing the handler class for reading an XML templates file.
</p>
<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>
<table>
<tr>
<td><a href="#TemplatesHandler">TemplatesHandler</a></td>
<td>Class implementing a sax handler to read an XML templates file.</td>
</tr>
</table>
<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>
<hr /><hr />
<a NAME="TemplatesHandler" ID="TemplatesHandler"></a>
<h2>TemplatesHandler</h2>
<p>
    Class implementing a sax handler to read an XML templates 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="#TemplatesHandler.__init__">TemplatesHandler</a></td>
<td>Constructor</td>
</tr><tr>
<td><a href="#TemplatesHandler.endTemplate">endTemplate</a></td>
<td>Handler method for the "Template" end tag.</td>
</tr><tr>
<td><a href="#TemplatesHandler.endTemplateDescription">endTemplateDescription</a></td>
<td>Handler method for the "TemplateDescription" end tag.</td>
</tr><tr>
<td><a href="#TemplatesHandler.endTemplateText">endTemplateText</a></td>
<td>Handler method for the "TemplateText" end tag.</td>
</tr><tr>
<td><a href="#TemplatesHandler.getVersion">getVersion</a></td>
<td>Public method to retrieve the version of the templates.</td>
</tr><tr>
<td><a href="#TemplatesHandler.startDocumentTemplates">startDocumentTemplates</a></td>
<td>Handler called, when the document parsing is started.</td>
</tr><tr>
<td><a href="#TemplatesHandler.startTemplate">startTemplate</a></td>
<td>Handler method for the "Template" start tag.</td>
</tr><tr>
<td><a href="#TemplatesHandler.startTemplateGroup">startTemplateGroup</a></td>
<td>Handler method for the "TemplateGroup" start tag.</td>
</tr><tr>
<td><a href="#TemplatesHandler.startTemplates">startTemplates</a></td>
<td>Handler method for the "Templates" start tag.</td>
</tr>
</table>
<a NAME="TemplatesHandler.__init__" ID="TemplatesHandler.__init__"></a>
<h4>TemplatesHandler (Constructor)</h4>
<b>TemplatesHandler</b>(<i>templateViewer=None</i>)
<p>
        Constructor
</p><dl>
<dt><i>templateViewer</i></dt>
<dd>
reference to the template viewer object
</dd>
</dl><a NAME="TemplatesHandler.endTemplate" ID="TemplatesHandler.endTemplate"></a>
<h4>TemplatesHandler.endTemplate</h4>
<b>endTemplate</b>(<i></i>)
<p>
        Handler method for the "Template" end tag.
</p><a NAME="TemplatesHandler.endTemplateDescription" ID="TemplatesHandler.endTemplateDescription"></a>
<h4>TemplatesHandler.endTemplateDescription</h4>
<b>endTemplateDescription</b>(<i></i>)
<p>
        Handler method for the "TemplateDescription" end tag.
</p><a NAME="TemplatesHandler.endTemplateText" ID="TemplatesHandler.endTemplateText"></a>
<h4>TemplatesHandler.endTemplateText</h4>
<b>endTemplateText</b>(<i></i>)
<p>
        Handler method for the "TemplateText" end tag.
</p><a NAME="TemplatesHandler.getVersion" ID="TemplatesHandler.getVersion"></a>
<h4>TemplatesHandler.getVersion</h4>
<b>getVersion</b>(<i></i>)
<p>
        Public method to retrieve the version of the templates.
</p><dl>
<dt>Returns:</dt>
<dd>
String containing the version number.
</dd>
</dl><a NAME="TemplatesHandler.startDocumentTemplates" ID="TemplatesHandler.startDocumentTemplates"></a>
<h4>TemplatesHandler.startDocumentTemplates</h4>
<b>startDocumentTemplates</b>(<i></i>)
<p>
        Handler called, when the document parsing is started.
</p><a NAME="TemplatesHandler.startTemplate" ID="TemplatesHandler.startTemplate"></a>
<h4>TemplatesHandler.startTemplate</h4>
<b>startTemplate</b>(<i>attrs</i>)
<p>
        Handler method for the "Template" start tag.
</p><dl>
<dt><i>attrs</i></dt>
<dd>
list of tag attributes
</dd>
</dl><a NAME="TemplatesHandler.startTemplateGroup" ID="TemplatesHandler.startTemplateGroup"></a>
<h4>TemplatesHandler.startTemplateGroup</h4>
<b>startTemplateGroup</b>(<i>attrs</i>)
<p>
        Handler method for the "TemplateGroup" start tag.
</p><dl>
<dt><i>attrs</i></dt>
<dd>
list of tag attributes
</dd>
</dl><a NAME="TemplatesHandler.startTemplates" ID="TemplatesHandler.startTemplates"></a>
<h4>TemplatesHandler.startTemplates</h4>
<b>startTemplates</b>(<i>attrs</i>)
<p>
        Handler method for the "Templates" 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>