Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric6.E5XML.ProjectReader.html
Documentation/Source/eric6.E5XML.ProjectReader.html
- changeset 3673
- e26d7d0c1088
equal
deleted
inserted
replaced
| 3670:f0cb7579c0b4 | 3673:e26d7d0c1088 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.E5XML.ProjectReader</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <style> | |
| 6 body { | |
| 7 background: #EDECE6; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #85774A; } | |
| 13 h2 { color: white; background: #85774A; } | |
| 14 h3 { color: white; background: #9D936E; } | |
| 15 h4 { color: white; background: #9D936E; } | |
| 16 | |
| 17 a { color: #BA6D36; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | |
| 21 <body><a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.E5XML.ProjectReader</h1> | |
| 23 <p> | |
| 24 Module implementing a class for reading an XML project file. | |
| 25 </p> | |
| 26 <h3>Global Attributes</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <h3>Classes</h3> | |
| 31 <table> | |
| 32 <tr> | |
| 33 <td><a href="#ProjectReader">ProjectReader</a></td> | |
| 34 <td>Class for reading an XML project file.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <h3>Functions</h3> | |
| 38 <table> | |
| 39 <tr><td>None</td></tr> | |
| 40 </table> | |
| 41 <hr /><hr /> | |
| 42 <a NAME="ProjectReader" ID="ProjectReader"></a> | |
| 43 <h2>ProjectReader</h2> | |
| 44 <p> | |
| 45 Class for reading an XML project file. | |
| 46 </p> | |
| 47 <h3>Derived from</h3> | |
| 48 XMLStreamReaderBase | |
| 49 <h3>Class Attributes</h3> | |
| 50 <table> | |
| 51 <tr><td>supportedVersions</td></tr> | |
| 52 </table> | |
| 53 <h3>Class Methods</h3> | |
| 54 <table> | |
| 55 <tr><td>None</td></tr> | |
| 56 </table> | |
| 57 <h3>Methods</h3> | |
| 58 <table> | |
| 59 <tr> | |
| 60 <td><a href="#ProjectReader.__init__">ProjectReader</a></td> | |
| 61 <td>Constructor</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#ProjectReader.__readBasicDataField">__readBasicDataField</a></td> | |
| 64 <td>Private method to read a list of files.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#ProjectReader.__readFiles">__readFiles</a></td> | |
| 67 <td>Private method to read a list of files.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#ProjectReader.__readFiletypeAssociations">__readFiletypeAssociations</a></td> | |
| 70 <td>Private method to read the file type associations.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#ProjectReader.__readLexerAssociations">__readLexerAssociations</a></td> | |
| 73 <td>Private method to read the lexer associations.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#ProjectReader.__readVcs">__readVcs</a></td> | |
| 76 <td>Private method to read the VCS info.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#ProjectReader.readXML">readXML</a></td> | |
| 79 <td>Public method to read and parse the XML document.</td> | |
| 80 </tr> | |
| 81 </table> | |
| 82 <h3>Static Methods</h3> | |
| 83 <table> | |
| 84 <tr><td>None</td></tr> | |
| 85 </table> | |
| 86 <a NAME="ProjectReader.__init__" ID="ProjectReader.__init__"></a> | |
| 87 <h4>ProjectReader (Constructor)</h4> | |
| 88 <b>ProjectReader</b>(<i>device, project</i>) | |
| 89 <p> | |
| 90 Constructor | |
| 91 </p><dl> | |
| 92 <dt><i>device</i></dt> | |
| 93 <dd> | |
| 94 reference to the I/O device to read from (QIODevice) | |
| 95 </dd><dt><i>project</i></dt> | |
| 96 <dd> | |
| 97 Reference to the project object to store the | |
| 98 information into. | |
| 99 </dd> | |
| 100 </dl><a NAME="ProjectReader.__readBasicDataField" ID="ProjectReader.__readBasicDataField"></a> | |
| 101 <h4>ProjectReader.__readBasicDataField</h4> | |
| 102 <b>__readBasicDataField</b>(<i>tag, dataTag, dataKey</i>) | |
| 103 <p> | |
| 104 Private method to read a list of files. | |
| 105 </p><dl> | |
| 106 <dt><i>tag</i></dt> | |
| 107 <dd> | |
| 108 name of the list tag (string) | |
| 109 </dd><dt><i>dataTag</i></dt> | |
| 110 <dd> | |
| 111 name of the data tag (string) | |
| 112 </dd><dt><i>dataKey</i></dt> | |
| 113 <dd> | |
| 114 key of the project data element (string) | |
| 115 </dd> | |
| 116 </dl><a NAME="ProjectReader.__readFiles" ID="ProjectReader.__readFiles"></a> | |
| 117 <h4>ProjectReader.__readFiles</h4> | |
| 118 <b>__readFiles</b>(<i>tag, listTag, dataKey</i>) | |
| 119 <p> | |
| 120 Private method to read a list of files. | |
| 121 </p><dl> | |
| 122 <dt><i>tag</i></dt> | |
| 123 <dd> | |
| 124 name of the list tag (string) | |
| 125 </dd><dt><i>listTag</i></dt> | |
| 126 <dd> | |
| 127 name of the list element tag (string) | |
| 128 </dd><dt><i>dataKey</i></dt> | |
| 129 <dd> | |
| 130 key of the project data element (string) | |
| 131 </dd> | |
| 132 </dl><a NAME="ProjectReader.__readFiletypeAssociations" ID="ProjectReader.__readFiletypeAssociations"></a> | |
| 133 <h4>ProjectReader.__readFiletypeAssociations</h4> | |
| 134 <b>__readFiletypeAssociations</b>(<i></i>) | |
| 135 <p> | |
| 136 Private method to read the file type associations. | |
| 137 </p><a NAME="ProjectReader.__readLexerAssociations" ID="ProjectReader.__readLexerAssociations"></a> | |
| 138 <h4>ProjectReader.__readLexerAssociations</h4> | |
| 139 <b>__readLexerAssociations</b>(<i></i>) | |
| 140 <p> | |
| 141 Private method to read the lexer associations. | |
| 142 </p><a NAME="ProjectReader.__readVcs" ID="ProjectReader.__readVcs"></a> | |
| 143 <h4>ProjectReader.__readVcs</h4> | |
| 144 <b>__readVcs</b>(<i></i>) | |
| 145 <p> | |
| 146 Private method to read the VCS info. | |
| 147 </p><a NAME="ProjectReader.readXML" ID="ProjectReader.readXML"></a> | |
| 148 <h4>ProjectReader.readXML</h4> | |
| 149 <b>readXML</b>(<i></i>) | |
| 150 <p> | |
| 151 Public method to read and parse the XML document. | |
| 152 </p> | |
| 153 <div align="right"><a href="#top">Up</a></div> | |
| 154 <hr /> | |
| 155 </body></html> |
