Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.QScintilla.Exporters.ExporterHTML.html
src/eric7/Documentation/Source/eric7.QScintilla.Exporters.ExporterHTML.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 9236
- db53a9efe7ef
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.QScintilla.Exporters.ExporterHTML</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.QScintilla.Exporters.ExporterHTML</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing an exporter for HTML. | |
| 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="#ExporterHTML">ExporterHTML</a></td> | |
| 25 <td>Class implementing an exporter for HTML.</td> | |
| 26 </tr> | |
| 27 <tr> | |
| 28 <td><a href="#HTMLGenerator">HTMLGenerator</a></td> | |
| 29 <td>Class implementing an HTML generator for exporting source code.</td> | |
| 30 </tr> | |
| 31 </table> | |
| 32 <h3>Functions</h3> | |
| 33 | |
| 34 <table> | |
| 35 <tr><td>None</td></tr> | |
| 36 </table> | |
| 37 <hr /> | |
| 38 <hr /> | |
| 39 <a NAME="ExporterHTML" ID="ExporterHTML"></a> | |
| 40 <h2>ExporterHTML</h2> | |
| 41 | |
| 42 <p> | |
| 43 Class implementing an exporter for HTML. | |
| 44 </p> | |
| 45 <h3>Derived from</h3> | |
| 46 ExporterBase | |
| 47 <h3>Class Attributes</h3> | |
| 48 | |
| 49 <table> | |
| 50 <tr><td>None</td></tr> | |
| 51 </table> | |
| 52 <h3>Class Methods</h3> | |
| 53 | |
| 54 <table> | |
| 55 <tr><td>None</td></tr> | |
| 56 </table> | |
| 57 <h3>Methods</h3> | |
| 58 | |
| 59 <table> | |
| 60 | |
| 61 <tr> | |
| 62 <td><a href="#ExporterHTML.__init__">ExporterHTML</a></td> | |
| 63 <td>Constructor</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#ExporterHTML.__generateFromMarkdown">__generateFromMarkdown</a></td> | |
| 67 <td>Private method to convert Markdown text into HTML.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#ExporterHTML.__generateFromReSTDocutils">__generateFromReSTDocutils</a></td> | |
| 71 <td>Private method to convert ReST text into HTML using 'docutils'.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#ExporterHTML.exportSource">exportSource</a></td> | |
| 75 <td>Public method performing the export.</td> | |
| 76 </tr> | |
| 77 </table> | |
| 78 <h3>Static Methods</h3> | |
| 79 | |
| 80 <table> | |
| 81 <tr><td>None</td></tr> | |
| 82 </table> | |
| 83 | |
| 84 <a NAME="ExporterHTML.__init__" ID="ExporterHTML.__init__"></a> | |
| 85 <h4>ExporterHTML (Constructor)</h4> | |
| 86 <b>ExporterHTML</b>(<i>editor, parent=None</i>) | |
| 87 | |
| 88 <p> | |
| 89 Constructor | |
| 90 </p> | |
| 91 <dl> | |
| 92 | |
| 93 <dt><i>editor</i></dt> | |
| 94 <dd> | |
| 95 reference to the editor object (QScintilla.Editor.Editor) | |
| 96 </dd> | |
| 97 <dt><i>parent</i></dt> | |
| 98 <dd> | |
| 99 parent object of the exporter (QObject) | |
| 100 </dd> | |
| 101 </dl> | |
| 102 <a NAME="ExporterHTML.__generateFromMarkdown" ID="ExporterHTML.__generateFromMarkdown"></a> | |
| 103 <h4>ExporterHTML.__generateFromMarkdown</h4> | |
| 104 <b>__generateFromMarkdown</b>(<i>useDarkScheme</i>) | |
| 105 | |
| 106 <p> | |
| 107 Private method to convert Markdown text into HTML. | |
| 108 </p> | |
| 109 <dl> | |
| 110 | |
| 111 <dt><i>useDarkScheme</i> (bool)</dt> | |
| 112 <dd> | |
| 113 flag indicating to export using a dark color | |
| 114 scheme | |
| 115 </dd> | |
| 116 </dl> | |
| 117 <dl> | |
| 118 <dt>Return:</dt> | |
| 119 <dd> | |
| 120 processed HTML | |
| 121 </dd> | |
| 122 </dl> | |
| 123 <dl> | |
| 124 <dt>Return Type:</dt> | |
| 125 <dd> | |
| 126 str | |
| 127 </dd> | |
| 128 </dl> | |
| 129 <a NAME="ExporterHTML.__generateFromReSTDocutils" ID="ExporterHTML.__generateFromReSTDocutils"></a> | |
| 130 <h4>ExporterHTML.__generateFromReSTDocutils</h4> | |
| 131 <b>__generateFromReSTDocutils</b>(<i></i>) | |
| 132 | |
| 133 <p> | |
| 134 Private method to convert ReST text into HTML using 'docutils'. | |
| 135 </p> | |
| 136 <dl> | |
| 137 <dt>Return:</dt> | |
| 138 <dd> | |
| 139 processed HTML (string) | |
| 140 </dd> | |
| 141 </dl> | |
| 142 <a NAME="ExporterHTML.exportSource" ID="ExporterHTML.exportSource"></a> | |
| 143 <h4>ExporterHTML.exportSource</h4> | |
| 144 <b>exportSource</b>(<i></i>) | |
| 145 | |
| 146 <p> | |
| 147 Public method performing the export. | |
| 148 </p> | |
| 149 <div align="right"><a href="#top">Up</a></div> | |
| 150 <hr /> | |
| 151 <hr /> | |
| 152 <a NAME="HTMLGenerator" ID="HTMLGenerator"></a> | |
| 153 <h2>HTMLGenerator</h2> | |
| 154 | |
| 155 <p> | |
| 156 Class implementing an HTML generator for exporting source code. | |
| 157 </p> | |
| 158 <h3>Derived from</h3> | |
| 159 None | |
| 160 <h3>Class Attributes</h3> | |
| 161 | |
| 162 <table> | |
| 163 <tr><td>None</td></tr> | |
| 164 </table> | |
| 165 <h3>Class Methods</h3> | |
| 166 | |
| 167 <table> | |
| 168 <tr><td>None</td></tr> | |
| 169 </table> | |
| 170 <h3>Methods</h3> | |
| 171 | |
| 172 <table> | |
| 173 | |
| 174 <tr> | |
| 175 <td><a href="#HTMLGenerator.__init__">HTMLGenerator</a></td> | |
| 176 <td>Constructor</td> | |
| 177 </tr> | |
| 178 <tr> | |
| 179 <td><a href="#HTMLGenerator.generate">generate</a></td> | |
| 180 <td>Public method to generate HTML for the source editor.</td> | |
| 181 </tr> | |
| 182 </table> | |
| 183 <h3>Static Methods</h3> | |
| 184 | |
| 185 <table> | |
| 186 <tr><td>None</td></tr> | |
| 187 </table> | |
| 188 | |
| 189 <a NAME="HTMLGenerator.__init__" ID="HTMLGenerator.__init__"></a> | |
| 190 <h4>HTMLGenerator (Constructor)</h4> | |
| 191 <b>HTMLGenerator</b>(<i>editor</i>) | |
| 192 | |
| 193 <p> | |
| 194 Constructor | |
| 195 </p> | |
| 196 <dl> | |
| 197 | |
| 198 <dt><i>editor</i></dt> | |
| 199 <dd> | |
| 200 reference to the editor object (QScintilla.Editor.Editor) | |
| 201 </dd> | |
| 202 </dl> | |
| 203 <a NAME="HTMLGenerator.generate" ID="HTMLGenerator.generate"></a> | |
| 204 <h4>HTMLGenerator.generate</h4> | |
| 205 <b>generate</b>(<i>tabSize=4, useTabs=False, wysiwyg=True, folding=False, onlyStylesUsed=False, titleFullPath=False</i>) | |
| 206 | |
| 207 <p> | |
| 208 Public method to generate HTML for the source editor. | |
| 209 </p> | |
| 210 <dl> | |
| 211 | |
| 212 <dt><i>tabSize</i></dt> | |
| 213 <dd> | |
| 214 size of tabs (integer) | |
| 215 </dd> | |
| 216 <dt><i>useTabs</i></dt> | |
| 217 <dd> | |
| 218 flag indicating the use of tab characters (boolean) | |
| 219 </dd> | |
| 220 <dt><i>wysiwyg</i></dt> | |
| 221 <dd> | |
| 222 flag indicating colorization (boolean) | |
| 223 </dd> | |
| 224 <dt><i>folding</i></dt> | |
| 225 <dd> | |
| 226 flag indicating usage of fold markers | |
| 227 </dd> | |
| 228 <dt><i>onlyStylesUsed</i></dt> | |
| 229 <dd> | |
| 230 flag indicating to include only style | |
| 231 definitions for styles used in the source (boolean) | |
| 232 </dd> | |
| 233 <dt><i>titleFullPath</i></dt> | |
| 234 <dd> | |
| 235 flag indicating to include the full file path | |
| 236 in the title tag (boolean) | |
| 237 </dd> | |
| 238 </dl> | |
| 239 <dl> | |
| 240 <dt>Return:</dt> | |
| 241 <dd> | |
| 242 generated HTML text (string) | |
| 243 </dd> | |
| 244 </dl> | |
| 245 <div align="right"><a href="#top">Up</a></div> | |
| 246 <hr /> | |
| 247 </body></html> |
