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 10479
- 856476537696
- parent 10423
- 299802979277
equal
deleted
inserted
replaced
| 10478:de9106c55c3d | 10479:856476537696 |
|---|---|
| 5 <link rel="stylesheet" href="styles.css"> | 5 <link rel="stylesheet" href="styles.css"> |
| 6 </head> | 6 </head> |
| 7 <body> | 7 <body> |
| 8 <a NAME="top" ID="top"></a> | 8 <a NAME="top" ID="top"></a> |
| 9 <h1>eric7.EricXML.ProjectReader</h1> | 9 <h1>eric7.EricXML.ProjectReader</h1> |
| 10 | |
| 11 <p> | 10 <p> |
| 12 Module implementing a class for reading an XML project file. | 11 Module implementing a class for reading an XML project file. |
| 13 </p> | 12 </p> |
| 13 | |
| 14 <h3>Global Attributes</h3> | 14 <h3>Global Attributes</h3> |
| 15 | |
| 16 <table> | 15 <table> |
| 17 <tr><td>None</td></tr> | 16 <tr><td>None</td></tr> |
| 18 </table> | 17 </table> |
| 18 | |
| 19 <h3>Classes</h3> | 19 <h3>Classes</h3> |
| 20 | |
| 21 <table> | 20 <table> |
| 22 | |
| 23 <tr> | 21 <tr> |
| 24 <td><a href="#ProjectReader">ProjectReader</a></td> | 22 <td><a href="#ProjectReader">ProjectReader</a></td> |
| 25 <td>Class for reading an XML project file.</td> | 23 <td>Class for reading an XML project file.</td> |
| 26 </tr> | 24 </tr> |
| 27 </table> | 25 </table> |
| 26 | |
| 28 <h3>Functions</h3> | 27 <h3>Functions</h3> |
| 29 | |
| 30 <table> | 28 <table> |
| 31 <tr><td>None</td></tr> | 29 <tr><td>None</td></tr> |
| 32 </table> | 30 </table> |
| 31 | |
| 33 <hr /> | 32 <hr /> |
| 34 <hr /> | 33 <hr /> |
| 35 <a NAME="ProjectReader" ID="ProjectReader"></a> | 34 <a NAME="ProjectReader" ID="ProjectReader"></a> |
| 36 <h2>ProjectReader</h2> | 35 <h2>ProjectReader</h2> |
| 37 | |
| 38 <p> | 36 <p> |
| 39 Class for reading an XML project file. | 37 Class for reading an XML project file. |
| 40 </p> | 38 </p> |
| 39 | |
| 41 <h3>Derived from</h3> | 40 <h3>Derived from</h3> |
| 42 XMLStreamReaderBase | 41 XMLStreamReaderBase |
| 43 <h3>Class Attributes</h3> | 42 <h3>Class Attributes</h3> |
| 44 | |
| 45 <table> | 43 <table> |
| 46 <tr><td>supportedVersions</td></tr> | 44 <tr><td>supportedVersions</td></tr> |
| 47 </table> | 45 </table> |
| 46 | |
| 48 <h3>Class Methods</h3> | 47 <h3>Class Methods</h3> |
| 49 | |
| 50 <table> | 48 <table> |
| 51 <tr><td>None</td></tr> | 49 <tr><td>None</td></tr> |
| 52 </table> | 50 </table> |
| 51 | |
| 53 <h3>Methods</h3> | 52 <h3>Methods</h3> |
| 54 | |
| 55 <table> | 53 <table> |
| 56 | |
| 57 <tr> | 54 <tr> |
| 58 <td><a href="#ProjectReader.__init__">ProjectReader</a></td> | 55 <td><a href="#ProjectReader.__init__">ProjectReader</a></td> |
| 59 <td>Constructor</td> | 56 <td>Constructor</td> |
| 60 </tr> | 57 </tr> |
| 61 <tr> | 58 <tr> |
| 81 <tr> | 78 <tr> |
| 82 <td><a href="#ProjectReader.readXML">readXML</a></td> | 79 <td><a href="#ProjectReader.readXML">readXML</a></td> |
| 83 <td>Public method to read and parse the XML document.</td> | 80 <td>Public method to read and parse the XML document.</td> |
| 84 </tr> | 81 </tr> |
| 85 </table> | 82 </table> |
| 83 | |
| 86 <h3>Static Methods</h3> | 84 <h3>Static Methods</h3> |
| 87 | |
| 88 <table> | 85 <table> |
| 89 <tr><td>None</td></tr> | 86 <tr><td>None</td></tr> |
| 90 </table> | 87 </table> |
| 91 | 88 |
| 89 | |
| 92 <a NAME="ProjectReader.__init__" ID="ProjectReader.__init__"></a> | 90 <a NAME="ProjectReader.__init__" ID="ProjectReader.__init__"></a> |
| 93 <h4>ProjectReader (Constructor)</h4> | 91 <h4>ProjectReader (Constructor)</h4> |
| 94 <b>ProjectReader</b>(<i>device, project</i>) | 92 <b>ProjectReader</b>(<i>device, project</i>) |
| 95 | |
| 96 <p> | 93 <p> |
| 97 Constructor | 94 Constructor |
| 98 </p> | 95 </p> |
| 96 | |
| 99 <dl> | 97 <dl> |
| 100 | 98 |
| 101 <dt><i>device</i> (QIODevice)</dt> | 99 <dt><i>device</i> (QIODevice)</dt> |
| 102 <dd> | 100 <dd> |
| 103 reference to the I/O device to read from | 101 reference to the I/O device to read from |
| 109 </dd> | 107 </dd> |
| 110 </dl> | 108 </dl> |
| 111 <a NAME="ProjectReader.__readBasicDataField" ID="ProjectReader.__readBasicDataField"></a> | 109 <a NAME="ProjectReader.__readBasicDataField" ID="ProjectReader.__readBasicDataField"></a> |
| 112 <h4>ProjectReader.__readBasicDataField</h4> | 110 <h4>ProjectReader.__readBasicDataField</h4> |
| 113 <b>__readBasicDataField</b>(<i>tag, dataTag, dataKey</i>) | 111 <b>__readBasicDataField</b>(<i>tag, dataTag, dataKey</i>) |
| 114 | |
| 115 <p> | 112 <p> |
| 116 Private method to read a list of files. | 113 Private method to read a list of files. |
| 117 </p> | 114 </p> |
| 115 | |
| 118 <dl> | 116 <dl> |
| 119 | 117 |
| 120 <dt><i>tag</i> (str)</dt> | 118 <dt><i>tag</i> (str)</dt> |
| 121 <dd> | 119 <dd> |
| 122 name of the list tag | 120 name of the list tag |
| 131 </dd> | 129 </dd> |
| 132 </dl> | 130 </dl> |
| 133 <a NAME="ProjectReader.__readFiles" ID="ProjectReader.__readFiles"></a> | 131 <a NAME="ProjectReader.__readFiles" ID="ProjectReader.__readFiles"></a> |
| 134 <h4>ProjectReader.__readFiles</h4> | 132 <h4>ProjectReader.__readFiles</h4> |
| 135 <b>__readFiles</b>(<i>tag, listTag, dataKey</i>) | 133 <b>__readFiles</b>(<i>tag, listTag, dataKey</i>) |
| 136 | |
| 137 <p> | 134 <p> |
| 138 Private method to read a list of files. | 135 Private method to read a list of files. |
| 139 </p> | 136 </p> |
| 137 | |
| 140 <dl> | 138 <dl> |
| 141 | 139 |
| 142 <dt><i>tag</i> (str)</dt> | 140 <dt><i>tag</i> (str)</dt> |
| 143 <dd> | 141 <dd> |
| 144 name of the list tag | 142 name of the list tag |
| 153 </dd> | 151 </dd> |
| 154 </dl> | 152 </dl> |
| 155 <a NAME="ProjectReader.__readFiletypeAssociations" ID="ProjectReader.__readFiletypeAssociations"></a> | 153 <a NAME="ProjectReader.__readFiletypeAssociations" ID="ProjectReader.__readFiletypeAssociations"></a> |
| 156 <h4>ProjectReader.__readFiletypeAssociations</h4> | 154 <h4>ProjectReader.__readFiletypeAssociations</h4> |
| 157 <b>__readFiletypeAssociations</b>(<i></i>) | 155 <b>__readFiletypeAssociations</b>(<i></i>) |
| 158 | |
| 159 <p> | 156 <p> |
| 160 Private method to read the file type associations. | 157 Private method to read the file type associations. |
| 161 </p> | 158 </p> |
| 159 | |
| 162 <a NAME="ProjectReader.__readLexerAssociations" ID="ProjectReader.__readLexerAssociations"></a> | 160 <a NAME="ProjectReader.__readLexerAssociations" ID="ProjectReader.__readLexerAssociations"></a> |
| 163 <h4>ProjectReader.__readLexerAssociations</h4> | 161 <h4>ProjectReader.__readLexerAssociations</h4> |
| 164 <b>__readLexerAssociations</b>(<i></i>) | 162 <b>__readLexerAssociations</b>(<i></i>) |
| 165 | |
| 166 <p> | 163 <p> |
| 167 Private method to read the lexer associations. | 164 Private method to read the lexer associations. |
| 168 </p> | 165 </p> |
| 166 | |
| 169 <a NAME="ProjectReader.__readVcs" ID="ProjectReader.__readVcs"></a> | 167 <a NAME="ProjectReader.__readVcs" ID="ProjectReader.__readVcs"></a> |
| 170 <h4>ProjectReader.__readVcs</h4> | 168 <h4>ProjectReader.__readVcs</h4> |
| 171 <b>__readVcs</b>(<i></i>) | 169 <b>__readVcs</b>(<i></i>) |
| 172 | |
| 173 <p> | 170 <p> |
| 174 Private method to read the VCS info. | 171 Private method to read the VCS info. |
| 175 </p> | 172 </p> |
| 173 | |
| 176 <a NAME="ProjectReader.readXML" ID="ProjectReader.readXML"></a> | 174 <a NAME="ProjectReader.readXML" ID="ProjectReader.readXML"></a> |
| 177 <h4>ProjectReader.readXML</h4> | 175 <h4>ProjectReader.readXML</h4> |
| 178 <b>readXML</b>(<i></i>) | 176 <b>readXML</b>(<i></i>) |
| 179 | |
| 180 <p> | 177 <p> |
| 181 Public method to read and parse the XML document. | 178 Public method to read and parse the XML document. |
| 182 </p> | 179 </p> |
| 180 | |
| 183 <div align="right"><a href="#top">Up</a></div> | 181 <div align="right"><a href="#top">Up</a></div> |
| 184 <hr /> | 182 <hr /> |
| 185 </body></html> | 183 </body></html> |
