Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.EricXML.HighlightingStylesReader.html
src/eric7/Documentation/Source/eric7.EricXML.HighlightingStylesReader.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.HighlightingStylesReader</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.HighlightingStylesReader</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a class for reading a highlighting styles XML 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="#HighlightingStylesReader">HighlightingStylesReader</a></td> | |
| 25 <td>Class for reading a highlighting styles XML 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="HighlightingStylesReader" ID="HighlightingStylesReader"></a> | |
| 36 <h2>HighlightingStylesReader</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class for reading a highlighting styles XML 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="#HighlightingStylesReader.__init__">HighlightingStylesReader</a></td> | |
| 59 <td>Constructor</td> | |
| 60 </tr> | |
| 61 <tr> | |
| 62 <td><a href="#HighlightingStylesReader.__readLexer">__readLexer</a></td> | |
| 63 <td>Private method to read the lexer info.</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#HighlightingStylesReader.__readStyle">__readStyle</a></td> | |
| 67 <td>Private method to read the style info.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#HighlightingStylesReader.readXML">readXML</a></td> | |
| 71 <td>Public method to read and parse the XML document.</td> | |
| 72 </tr> | |
| 73 </table> | |
| 74 <h3>Static Methods</h3> | |
| 75 | |
| 76 <table> | |
| 77 <tr><td>None</td></tr> | |
| 78 </table> | |
| 79 | |
| 80 <a NAME="HighlightingStylesReader.__init__" ID="HighlightingStylesReader.__init__"></a> | |
| 81 <h4>HighlightingStylesReader (Constructor)</h4> | |
| 82 <b>HighlightingStylesReader</b>(<i>device, lexers</i>) | |
| 83 | |
| 84 <p> | |
| 85 Constructor | |
| 86 </p> | |
| 87 <dl> | |
| 88 | |
| 89 <dt><i>device</i></dt> | |
| 90 <dd> | |
| 91 reference to the I/O device to read from (QIODevice) | |
| 92 </dd> | |
| 93 <dt><i>lexers</i></dt> | |
| 94 <dd> | |
| 95 dictionary of lexer objects for which to import the | |
| 96 styles | |
| 97 </dd> | |
| 98 </dl> | |
| 99 <a NAME="HighlightingStylesReader.__readLexer" ID="HighlightingStylesReader.__readLexer"></a> | |
| 100 <h4>HighlightingStylesReader.__readLexer</h4> | |
| 101 <b>__readLexer</b>(<i></i>) | |
| 102 | |
| 103 <p> | |
| 104 Private method to read the lexer info. | |
| 105 </p> | |
| 106 <a NAME="HighlightingStylesReader.__readStyle" ID="HighlightingStylesReader.__readStyle"></a> | |
| 107 <h4>HighlightingStylesReader.__readStyle</h4> | |
| 108 <b>__readStyle</b>(<i>lexer</i>) | |
| 109 | |
| 110 <p> | |
| 111 Private method to read the style info. | |
| 112 </p> | |
| 113 <dl> | |
| 114 | |
| 115 <dt><i>lexer</i></dt> | |
| 116 <dd> | |
| 117 reference to the lexer object | |
| 118 </dd> | |
| 119 </dl> | |
| 120 <a NAME="HighlightingStylesReader.readXML" ID="HighlightingStylesReader.readXML"></a> | |
| 121 <h4>HighlightingStylesReader.readXML</h4> | |
| 122 <b>readXML</b>(<i></i>) | |
| 123 | |
| 124 <p> | |
| 125 Public method to read and parse the XML document. | |
| 126 </p> | |
| 127 <dl> | |
| 128 <dt>Return:</dt> | |
| 129 <dd> | |
| 130 list of read lexer style definitions | |
| 131 </dd> | |
| 132 </dl> | |
| 133 <dl> | |
| 134 <dt>Return Type:</dt> | |
| 135 <dd> | |
| 136 list of dict | |
| 137 </dd> | |
| 138 </dl> | |
| 139 <div align="right"><a href="#top">Up</a></div> | |
| 140 <hr /> | |
| 141 </body></html> |
