Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.Preferences.HighlightingStylesFile.html
eric6/Documentation/Source/eric6.Preferences.HighlightingStylesFile.html
- changeset 8049
- af58c1d47e5e
equal
deleted
inserted
replaced
| 8048:aa1a01274673 | 8049:af58c1d47e5e |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.Preferences.HighlightingStylesFile</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>eric6.Preferences.HighlightingStylesFile</h1> | |
| 24 | |
| 25 <p> | |
| 26 Module implementing a class representing the highlighting styles JSON 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="#HighlightingStylesFile">HighlightingStylesFile</a></td> | |
| 39 <td>Class representing the highlighting styles JSON 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="HighlightingStylesFile" ID="HighlightingStylesFile"></a> | |
| 50 <h2>HighlightingStylesFile</h2> | |
| 51 | |
| 52 <p> | |
| 53 Class representing the highlighting styles JSON file. | |
| 54 </p> | |
| 55 <h3>Derived from</h3> | |
| 56 QObject | |
| 57 <h3>Class Attributes</h3> | |
| 58 | |
| 59 <table> | |
| 60 <tr><td>None</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="#HighlightingStylesFile.__init__">HighlightingStylesFile</a></td> | |
| 73 <td>Constructor</td> | |
| 74 </tr> | |
| 75 <tr> | |
| 76 <td><a href="#HighlightingStylesFile.readFile">readFile</a></td> | |
| 77 <td>Public method to read the highlighting styles data from a highlighting styles JSON file.</td> | |
| 78 </tr> | |
| 79 <tr> | |
| 80 <td><a href="#HighlightingStylesFile.writeFile">writeFile</a></td> | |
| 81 <td>Public method to write the highlighting styles data to a highlighting styles JSON file.</td> | |
| 82 </tr> | |
| 83 </table> | |
| 84 <h3>Static Methods</h3> | |
| 85 | |
| 86 <table> | |
| 87 <tr><td>None</td></tr> | |
| 88 </table> | |
| 89 | |
| 90 <a NAME="HighlightingStylesFile.__init__" ID="HighlightingStylesFile.__init__"></a> | |
| 91 <h4>HighlightingStylesFile (Constructor)</h4> | |
| 92 <b>HighlightingStylesFile</b>(<i>parent: QObject = None</i>) | |
| 93 | |
| 94 <p> | |
| 95 Constructor | |
| 96 </p> | |
| 97 <dl> | |
| 98 | |
| 99 <dt><i>parent</i> (QObject (optional))</dt> | |
| 100 <dd> | |
| 101 reference to the parent object (defaults to None) | |
| 102 </dd> | |
| 103 </dl> | |
| 104 <a NAME="HighlightingStylesFile.readFile" ID="HighlightingStylesFile.readFile"></a> | |
| 105 <h4>HighlightingStylesFile.readFile</h4> | |
| 106 <b>readFile</b>(<i>filename: str</i>) | |
| 107 | |
| 108 <p> | |
| 109 Public method to read the highlighting styles data from a highlighting | |
| 110 styles JSON file. | |
| 111 </p> | |
| 112 <dl> | |
| 113 | |
| 114 <dt><i>filename</i> (str)</dt> | |
| 115 <dd> | |
| 116 name of the highlighting styles file | |
| 117 </dd> | |
| 118 </dl> | |
| 119 <dl> | |
| 120 <dt>Return:</dt> | |
| 121 <dd> | |
| 122 list of read lexer style definitions | |
| 123 </dd> | |
| 124 </dl> | |
| 125 <dl> | |
| 126 <dt>Return Type:</dt> | |
| 127 <dd> | |
| 128 list of dict | |
| 129 </dd> | |
| 130 </dl> | |
| 131 <a NAME="HighlightingStylesFile.writeFile" ID="HighlightingStylesFile.writeFile"></a> | |
| 132 <h4>HighlightingStylesFile.writeFile</h4> | |
| 133 <b>writeFile</b>(<i>filename: str, lexers: list</i>) | |
| 134 | |
| 135 <p> | |
| 136 Public method to write the highlighting styles data to a highlighting | |
| 137 styles JSON file. | |
| 138 </p> | |
| 139 <dl> | |
| 140 | |
| 141 <dt><i>filename</i> (str)</dt> | |
| 142 <dd> | |
| 143 name of the highlighting styles file | |
| 144 </dd> | |
| 145 <dt><i>lexers</i> (list of PreferencesLexer)</dt> | |
| 146 <dd> | |
| 147 list of lexers for which to export the styles | |
| 148 </dd> | |
| 149 </dl> | |
| 150 <dl> | |
| 151 <dt>Return:</dt> | |
| 152 <dd> | |
| 153 flag indicating a successful write | |
| 154 </dd> | |
| 155 </dl> | |
| 156 <dl> | |
| 157 <dt>Return Type:</dt> | |
| 158 <dd> | |
| 159 bool | |
| 160 </dd> | |
| 161 </dl> | |
| 162 <div align="right"><a href="#top">Up</a></div> | |
| 163 <hr /> | |
| 164 </body></html> |
