--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/eric7/Documentation/Source/eric7.EricXML.ProjectReader.html Mon May 24 11:19:57 2021 +0200 @@ -0,0 +1,199 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.EricXML.ProjectReader</title> +<meta charset="UTF-8"> +<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>eric7.EricXML.ProjectReader</h1> + +<p> +Module implementing a class for reading an XML project file. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#ProjectReader">ProjectReader</a></td> +<td>Class for reading an XML project file.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="ProjectReader" ID="ProjectReader"></a> +<h2>ProjectReader</h2> + +<p> + Class for reading an XML project file. +</p> +<h3>Derived from</h3> +XMLStreamReaderBase +<h3>Class Attributes</h3> + +<table> +<tr><td>supportedVersions</td></tr> +</table> +<h3>Class Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> + +<table> + +<tr> +<td><a href="#ProjectReader.__init__">ProjectReader</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#ProjectReader.__readBasicDataField">__readBasicDataField</a></td> +<td>Private method to read a list of files.</td> +</tr> +<tr> +<td><a href="#ProjectReader.__readFiles">__readFiles</a></td> +<td>Private method to read a list of files.</td> +</tr> +<tr> +<td><a href="#ProjectReader.__readFiletypeAssociations">__readFiletypeAssociations</a></td> +<td>Private method to read the file type associations.</td> +</tr> +<tr> +<td><a href="#ProjectReader.__readLexerAssociations">__readLexerAssociations</a></td> +<td>Private method to read the lexer associations.</td> +</tr> +<tr> +<td><a href="#ProjectReader.__readVcs">__readVcs</a></td> +<td>Private method to read the VCS info.</td> +</tr> +<tr> +<td><a href="#ProjectReader.readXML">readXML</a></td> +<td>Public method to read and parse the XML document.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="ProjectReader.__init__" ID="ProjectReader.__init__"></a> +<h4>ProjectReader (Constructor)</h4> +<b>ProjectReader</b>(<i>device, project</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>device</i></dt> +<dd> +reference to the I/O device to read from (QIODevice) +</dd> +<dt><i>project</i></dt> +<dd> +Reference to the project object to store the + information into. +</dd> +</dl> +<a NAME="ProjectReader.__readBasicDataField" ID="ProjectReader.__readBasicDataField"></a> +<h4>ProjectReader.__readBasicDataField</h4> +<b>__readBasicDataField</b>(<i>tag, dataTag, dataKey</i>) + +<p> + Private method to read a list of files. +</p> +<dl> + +<dt><i>tag</i></dt> +<dd> +name of the list tag (string) +</dd> +<dt><i>dataTag</i></dt> +<dd> +name of the data tag (string) +</dd> +<dt><i>dataKey</i></dt> +<dd> +key of the project data element (string) +</dd> +</dl> +<a NAME="ProjectReader.__readFiles" ID="ProjectReader.__readFiles"></a> +<h4>ProjectReader.__readFiles</h4> +<b>__readFiles</b>(<i>tag, listTag, dataKey</i>) + +<p> + Private method to read a list of files. +</p> +<dl> + +<dt><i>tag</i></dt> +<dd> +name of the list tag (string) +</dd> +<dt><i>listTag</i></dt> +<dd> +name of the list element tag (string) +</dd> +<dt><i>dataKey</i></dt> +<dd> +key of the project data element (string) +</dd> +</dl> +<a NAME="ProjectReader.__readFiletypeAssociations" ID="ProjectReader.__readFiletypeAssociations"></a> +<h4>ProjectReader.__readFiletypeAssociations</h4> +<b>__readFiletypeAssociations</b>(<i></i>) + +<p> + Private method to read the file type associations. +</p> +<a NAME="ProjectReader.__readLexerAssociations" ID="ProjectReader.__readLexerAssociations"></a> +<h4>ProjectReader.__readLexerAssociations</h4> +<b>__readLexerAssociations</b>(<i></i>) + +<p> + Private method to read the lexer associations. +</p> +<a NAME="ProjectReader.__readVcs" ID="ProjectReader.__readVcs"></a> +<h4>ProjectReader.__readVcs</h4> +<b>__readVcs</b>(<i></i>) + +<p> + Private method to read the VCS info. +</p> +<a NAME="ProjectReader.readXML" ID="ProjectReader.readXML"></a> +<h4>ProjectReader.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