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