Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.QScintilla.Exporters.ExporterHTML.html
Documentation/Source/eric5.QScintilla.Exporters.ExporterHTML.html
- changeset 532
- a3c0f1e2594a
- parent 440
- 69ace3e2dcf6
- child 945
- 8cd4d08fa9f6
- child 1278
- fb0460fd00b9
equal
deleted
inserted
replaced
| 531:26efb720a299 | 532:a3c0f1e2594a |
|---|---|
| 31 <h3>Classes</h3> | 31 <h3>Classes</h3> |
| 32 <table> | 32 <table> |
| 33 <tr> | 33 <tr> |
| 34 <td><a href="#ExporterHTML">ExporterHTML</a></td> | 34 <td><a href="#ExporterHTML">ExporterHTML</a></td> |
| 35 <td>Class implementing an exporter for HTML.</td> | 35 <td>Class implementing an exporter for HTML.</td> |
| 36 </tr><tr> | |
| 37 <td><a href="#HTMLGenerator">HTMLGenerator</a></td> | |
| 38 <td>Class implementing an HTML generator for exporting source code.</td> | |
| 36 </tr> | 39 </tr> |
| 37 </table> | 40 </table> |
| 38 <h3>Functions</h3> | 41 <h3>Functions</h3> |
| 39 <table> | 42 <table> |
| 40 <tr><td>None</td></tr> | 43 <tr><td>None</td></tr> |
| 79 <b>exportSource</b>(<i></i>) | 82 <b>exportSource</b>(<i></i>) |
| 80 <p> | 83 <p> |
| 81 Public method performing the export. | 84 Public method performing the export. |
| 82 </p> | 85 </p> |
| 83 <div align="right"><a href="#top">Up</a></div> | 86 <div align="right"><a href="#top">Up</a></div> |
| 87 <hr /><hr /> | |
| 88 <a NAME="HTMLGenerator" ID="HTMLGenerator"></a> | |
| 89 <h2>HTMLGenerator</h2> | |
| 90 <p> | |
| 91 Class implementing an HTML generator for exporting source code. | |
| 92 </p> | |
| 93 <h3>Derived from</h3> | |
| 94 object | |
| 95 <h3>Class Attributes</h3> | |
| 96 <table> | |
| 97 <tr><td>None</td></tr> | |
| 98 </table> | |
| 99 <h3>Methods</h3> | |
| 100 <table> | |
| 101 <tr> | |
| 102 <td><a href="#HTMLGenerator.__init__">HTMLGenerator</a></td> | |
| 103 <td>Constructor</td> | |
| 104 </tr><tr> | |
| 105 <td><a href="#HTMLGenerator.generate">generate</a></td> | |
| 106 <td>Public method to generate HTML for the source editor.</td> | |
| 107 </tr> | |
| 108 </table> | |
| 109 <a NAME="HTMLGenerator.__init__" ID="HTMLGenerator.__init__"></a> | |
| 110 <h4>HTMLGenerator (Constructor)</h4> | |
| 111 <b>HTMLGenerator</b>(<i>editor</i>) | |
| 112 <p> | |
| 113 Constructor | |
| 114 </p><dl> | |
| 115 <dt><i>editor</i></dt> | |
| 116 <dd> | |
| 117 reference to the editor object (QScintilla.Editor.Editor) | |
| 118 </dd> | |
| 119 </dl><a NAME="HTMLGenerator.generate" ID="HTMLGenerator.generate"></a> | |
| 120 <h4>HTMLGenerator.generate</h4> | |
| 121 <b>generate</b>(<i>tabSize = 4, useTabs = False, wysiwyg = True, folding = False, onlyStylesUsed = False, titleFullPath = False</i>) | |
| 122 <p> | |
| 123 Public method to generate HTML for the source editor. | |
| 124 </p><dl> | |
| 125 <dt><i>tabSize=</i></dt> | |
| 126 <dd> | |
| 127 size of tabs (integer) | |
| 128 </dd><dt><i>useTabs=</i></dt> | |
| 129 <dd> | |
| 130 flag indicating the use of tab characters (boolean) | |
| 131 </dd><dt><i>wysiwyg=</i></dt> | |
| 132 <dd> | |
| 133 flag indicating colorization (boolean) | |
| 134 </dd><dt><i>folding=</i></dt> | |
| 135 <dd> | |
| 136 flag indicating usage of fold markers | |
| 137 </dd><dt><i>onlyStylesUsed=</i></dt> | |
| 138 <dd> | |
| 139 flag indicating to include only style definitions | |
| 140 for styles used in the source (boolean) | |
| 141 </dd><dt><i>titleFullPath=</i></dt> | |
| 142 <dd> | |
| 143 flag indicating to include the full file path | |
| 144 in the title tag (boolean) | |
| 145 </dd> | |
| 146 </dl><dl> | |
| 147 <dt>Returns:</dt> | |
| 148 <dd> | |
| 149 generated HTML text (string) | |
| 150 </dd> | |
| 151 </dl> | |
| 152 <div align="right"><a href="#top">Up</a></div> | |
| 84 <hr /> | 153 <hr /> |
| 85 </body></html> | 154 </body></html> |
