Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.EricXML.ProjectReader.html
src/eric7/Documentation/Source/eric7.EricXML.ProjectReader.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 10423
- 299802979277
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.EricXML.ProjectReader</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.EricXML.ProjectReader</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a class for reading an XML project file. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#ProjectReader">ProjectReader</a></td> | |
| 25 <td>Class for reading an XML project file.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <hr /> | |
| 34 <hr /> | |
| 35 <a NAME="ProjectReader" ID="ProjectReader"></a> | |
| 36 <h2>ProjectReader</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class for reading an XML project file. | |
| 40 </p> | |
| 41 <h3>Derived from</h3> | |
| 42 XMLStreamReaderBase | |
| 43 <h3>Class Attributes</h3> | |
| 44 | |
| 45 <table> | |
| 46 <tr><td>supportedVersions</td></tr> | |
| 47 </table> | |
| 48 <h3>Class Methods</h3> | |
| 49 | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Methods</h3> | |
| 54 | |
| 55 <table> | |
| 56 | |
| 57 <tr> | |
| 58 <td><a href="#ProjectReader.__init__">ProjectReader</a></td> | |
| 59 <td>Constructor</td> | |
| 60 </tr> | |
| 61 <tr> | |
| 62 <td><a href="#ProjectReader.__readBasicDataField">__readBasicDataField</a></td> | |
| 63 <td>Private method to read a list of files.</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#ProjectReader.__readFiles">__readFiles</a></td> | |
| 67 <td>Private method to read a list of files.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#ProjectReader.__readFiletypeAssociations">__readFiletypeAssociations</a></td> | |
| 71 <td>Private method to read the file type associations.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#ProjectReader.__readLexerAssociations">__readLexerAssociations</a></td> | |
| 75 <td>Private method to read the lexer associations.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#ProjectReader.__readVcs">__readVcs</a></td> | |
| 79 <td>Private method to read the VCS info.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#ProjectReader.readXML">readXML</a></td> | |
| 83 <td>Public method to read and parse the XML document.</td> | |
| 84 </tr> | |
| 85 </table> | |
| 86 <h3>Static Methods</h3> | |
| 87 | |
| 88 <table> | |
| 89 <tr><td>None</td></tr> | |
| 90 </table> | |
| 91 | |
| 92 <a NAME="ProjectReader.__init__" ID="ProjectReader.__init__"></a> | |
| 93 <h4>ProjectReader (Constructor)</h4> | |
| 94 <b>ProjectReader</b>(<i>device, project</i>) | |
| 95 | |
| 96 <p> | |
| 97 Constructor | |
| 98 </p> | |
| 99 <dl> | |
| 100 | |
| 101 <dt><i>device</i></dt> | |
| 102 <dd> | |
| 103 reference to the I/O device to read from (QIODevice) | |
| 104 </dd> | |
| 105 <dt><i>project</i></dt> | |
| 106 <dd> | |
| 107 Reference to the project object to store the | |
| 108 information into. | |
| 109 </dd> | |
| 110 </dl> | |
| 111 <a NAME="ProjectReader.__readBasicDataField" ID="ProjectReader.__readBasicDataField"></a> | |
| 112 <h4>ProjectReader.__readBasicDataField</h4> | |
| 113 <b>__readBasicDataField</b>(<i>tag, dataTag, dataKey</i>) | |
| 114 | |
| 115 <p> | |
| 116 Private method to read a list of files. | |
| 117 </p> | |
| 118 <dl> | |
| 119 | |
| 120 <dt><i>tag</i></dt> | |
| 121 <dd> | |
| 122 name of the list tag (string) | |
| 123 </dd> | |
| 124 <dt><i>dataTag</i></dt> | |
| 125 <dd> | |
| 126 name of the data tag (string) | |
| 127 </dd> | |
| 128 <dt><i>dataKey</i></dt> | |
| 129 <dd> | |
| 130 key of the project data element (string) | |
| 131 </dd> | |
| 132 </dl> | |
| 133 <a NAME="ProjectReader.__readFiles" ID="ProjectReader.__readFiles"></a> | |
| 134 <h4>ProjectReader.__readFiles</h4> | |
| 135 <b>__readFiles</b>(<i>tag, listTag, dataKey</i>) | |
| 136 | |
| 137 <p> | |
| 138 Private method to read a list of files. | |
| 139 </p> | |
| 140 <dl> | |
| 141 | |
| 142 <dt><i>tag</i></dt> | |
| 143 <dd> | |
| 144 name of the list tag (string) | |
| 145 </dd> | |
| 146 <dt><i>listTag</i></dt> | |
| 147 <dd> | |
| 148 name of the list element tag (string) | |
| 149 </dd> | |
| 150 <dt><i>dataKey</i></dt> | |
| 151 <dd> | |
| 152 key of the project data element (string) | |
| 153 </dd> | |
| 154 </dl> | |
| 155 <a NAME="ProjectReader.__readFiletypeAssociations" ID="ProjectReader.__readFiletypeAssociations"></a> | |
| 156 <h4>ProjectReader.__readFiletypeAssociations</h4> | |
| 157 <b>__readFiletypeAssociations</b>(<i></i>) | |
| 158 | |
| 159 <p> | |
| 160 Private method to read the file type associations. | |
| 161 </p> | |
| 162 <a NAME="ProjectReader.__readLexerAssociations" ID="ProjectReader.__readLexerAssociations"></a> | |
| 163 <h4>ProjectReader.__readLexerAssociations</h4> | |
| 164 <b>__readLexerAssociations</b>(<i></i>) | |
| 165 | |
| 166 <p> | |
| 167 Private method to read the lexer associations. | |
| 168 </p> | |
| 169 <a NAME="ProjectReader.__readVcs" ID="ProjectReader.__readVcs"></a> | |
| 170 <h4>ProjectReader.__readVcs</h4> | |
| 171 <b>__readVcs</b>(<i></i>) | |
| 172 | |
| 173 <p> | |
| 174 Private method to read the VCS info. | |
| 175 </p> | |
| 176 <a NAME="ProjectReader.readXML" ID="ProjectReader.readXML"></a> | |
| 177 <h4>ProjectReader.readXML</h4> | |
| 178 <b>readXML</b>(<i></i>) | |
| 179 | |
| 180 <p> | |
| 181 Public method to read and parse the XML document. | |
| 182 </p> | |
| 183 <div align="right"><a href="#top">Up</a></div> | |
| 184 <hr /> | |
| 185 </body></html> |
