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