Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.QScintilla.Exporters.ExporterHTML.html

eric6/Documentation/Source/eric6.QScintilla.Exporters.ExporterHTML.html

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

Mercurial Repository: eric

eric ide

mercurial