--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Documentation/Source/eric5.E5XML.TemplatesReader.html Sun Sep 12 19:38:36 2010 +0200 @@ -0,0 +1,101 @@ +<?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.TemplatesReader</title> +<style> +body { + background: #EDECE6; + margin: 0em 1em 10em 1em; + color: black; +} + +h1 { color: white; background: #85774A; } +h2 { color: white; background: #85774A; } +h3 { color: white; background: #9D936E; } +h4 { color: white; background: #9D936E; } + +a { color: #BA6D36; } + +</style> +</head> +<body><a NAME="top" ID="top"></a> +<h1>eric5.E5XML.TemplatesReader</h1> +<p> +Module implementing a 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="#TemplatesReader">TemplatesReader</a></td> +<td>Class for reading an XML tasks file.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="TemplatesReader" ID="TemplatesReader"></a> +<h2>TemplatesReader</h2> +<p> + Class for reading an XML tasks file. +</p> +<h3>Derived from</h3> +XMLStreamReaderBase +<h3>Class Attributes</h3> +<table> +<tr><td>supportedVersions</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#TemplatesReader.__init__">TemplatesReader</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#TemplatesReader.__readTemplate">__readTemplate</a></td> +<td>Private method to read the template definition.</td> +</tr><tr> +<td><a href="#TemplatesReader.__readTemplateGroup">__readTemplateGroup</a></td> +<td>Private method to read a template group.</td> +</tr><tr> +<td><a href="#TemplatesReader.readXML">readXML</a></td> +<td>Public method to read and parse the XML document.</td> +</tr> +</table> +<a NAME="TemplatesReader.__init__" ID="TemplatesReader.__init__"></a> +<h4>TemplatesReader (Constructor)</h4> +<b>TemplatesReader</b>(<i>device, viewer = None</i>) +<p> + Constructor +</p><dl> +<dt><i>device</i></dt> +<dd> +reference to the I/O device to read from (QIODevice) +</dd><dt><i>viewer</i></dt> +<dd> +reference to the template viewer object (TemplateViewer) +</dd> +</dl><a NAME="TemplatesReader.__readTemplate" ID="TemplatesReader.__readTemplate"></a> +<h4>TemplatesReader.__readTemplate</h4> +<b>__readTemplate</b>(<i></i>) +<p> + Private method to read the template definition. +</p><a NAME="TemplatesReader.__readTemplateGroup" ID="TemplatesReader.__readTemplateGroup"></a> +<h4>TemplatesReader.__readTemplateGroup</h4> +<b>__readTemplateGroup</b>(<i></i>) +<p> + Private method to read a template group. +</p><a NAME="TemplatesReader.readXML" ID="TemplatesReader.readXML"></a> +<h4>TemplatesReader.readXML</h4> +<b>readXML</b>(<i></i>) +<p> + Public method to read and parse the XML document. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file