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