Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.UI.Previewers.PreviewerHTML.html

eric6/Documentation/Source/eric6.UI.Previewers.PreviewerHTML.html

changeset 6942
2602857055c5
parent 6287
9a193ff6d24a
child 7204
cbf6d88004ce
equal deleted inserted replaced
6941:f99d60d6b59b 6942:2602857055c5
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.UI.Previewers.PreviewerHTML</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.UI.Previewers.PreviewerHTML</h1>
23 <p>
24 Module implementing a previewer widget for HTML, Markdown and ReST files.
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="#PreviewProcessingThread">PreviewProcessingThread</a></td>
34 <td>Class implementing a thread to process some text into HTML usable by the previewer view.</td>
35 </tr><tr>
36 <td><a href="#PreviewerHTML">PreviewerHTML</a></td>
37 <td>Class implementing a previewer widget for HTML, Markdown and ReST files.</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="PreviewProcessingThread" ID="PreviewProcessingThread"></a>
49 <h2>PreviewProcessingThread</h2>
50 <p>
51 Class implementing a thread to process some text into HTML usable by the
52 previewer view.
53 </p><h3>Signals</h3>
54 <dl>
55 <dt>htmlReady(str, str, str)</dt>
56 <dd>
57 emitted with the file name, the processed
58 HTML and the web site root path to signal the availability of the
59 processed HTML
60 </dd>
61 </dl>
62 <h3>Derived from</h3>
63 QThread
64 <h3>Class Attributes</h3>
65 <table>
66 <tr><td>None</td></tr>
67 </table>
68 <h3>Class Methods</h3>
69 <table>
70 <tr><td>None</td></tr>
71 </table>
72 <h3>Methods</h3>
73 <table>
74 <tr>
75 <td><a href="#PreviewProcessingThread.__init__">PreviewProcessingThread</a></td>
76 <td>Constructor</td>
77 </tr><tr>
78 <td><a href="#PreviewProcessingThread.__convertMarkdown">__convertMarkdown</a></td>
79 <td>Private method to convert Markdown text into HTML.</td>
80 </tr><tr>
81 <td><a href="#PreviewProcessingThread.__convertReST">__convertReST</a></td>
82 <td>Private method to convert ReST text into HTML.</td>
83 </tr><tr>
84 <td><a href="#PreviewProcessingThread.__convertReSTDocutils">__convertReSTDocutils</a></td>
85 <td>Private method to convert ReST text into HTML using 'docutils'.</td>
86 </tr><tr>
87 <td><a href="#PreviewProcessingThread.__convertReSTSphinx">__convertReSTSphinx</a></td>
88 <td>Private method to convert ReST text into HTML using 'sphinx'.</td>
89 </tr><tr>
90 <td><a href="#PreviewProcessingThread.__getHtml">__getHtml</a></td>
91 <td>Private method to process the given text depending upon the given language.</td>
92 </tr><tr>
93 <td><a href="#PreviewProcessingThread.__processRootPath">__processRootPath</a></td>
94 <td>Private method to adjust absolute references to the given root path.</td>
95 </tr><tr>
96 <td><a href="#PreviewProcessingThread.__processSSI">__processSSI</a></td>
97 <td>Private method to process the given text for SSI statements.</td>
98 </tr><tr>
99 <td><a href="#PreviewProcessingThread.process">process</a></td>
100 <td>Public method to convert the given text to HTML.</td>
101 </tr><tr>
102 <td><a href="#PreviewProcessingThread.run">run</a></td>
103 <td>Public thread method to convert the stored data.</td>
104 </tr>
105 </table>
106 <h3>Static Methods</h3>
107 <table>
108 <tr><td>None</td></tr>
109 </table>
110 <a NAME="PreviewProcessingThread.__init__" ID="PreviewProcessingThread.__init__"></a>
111 <h4>PreviewProcessingThread (Constructor)</h4>
112 <b>PreviewProcessingThread</b>(<i>parent=None</i>)
113 <p>
114 Constructor
115 </p><dl>
116 <dt><i>parent</i></dt>
117 <dd>
118 reference to the parent object (QObject)
119 </dd>
120 </dl><a NAME="PreviewProcessingThread.__convertMarkdown" ID="PreviewProcessingThread.__convertMarkdown"></a>
121 <h4>PreviewProcessingThread.__convertMarkdown</h4>
122 <b>__convertMarkdown</b>(<i>text, convertNewLineToBreak, htmlFormat</i>)
123 <p>
124 Private method to convert Markdown text into HTML.
125 </p><dl>
126 <dt><i>text</i></dt>
127 <dd>
128 text to be processed (string)
129 </dd><dt><i>convertNewLineToBreak</i></dt>
130 <dd>
131 flag indicating to convert new lines
132 to HTML break (Markdown only) (boolean)
133 </dd><dt><i>htmlFormat</i></dt>
134 <dd>
135 HTML format to be generated by markdown (string)
136 </dd>
137 </dl><dl>
138 <dt>Returns:</dt>
139 <dd>
140 processed HTML (string)
141 </dd>
142 </dl><a NAME="PreviewProcessingThread.__convertReST" ID="PreviewProcessingThread.__convertReST"></a>
143 <h4>PreviewProcessingThread.__convertReST</h4>
144 <b>__convertReST</b>(<i>text, useSphinx, restDocutilsHtmlFormat</i>)
145 <p>
146 Private method to convert ReST text into HTML.
147 </p><dl>
148 <dt><i>text</i></dt>
149 <dd>
150 text to be processed (string)
151 </dd><dt><i>useSphinx</i></dt>
152 <dd>
153 flag indicating to use Sphinx to generate the
154 ReST preview (boolean)
155 </dd><dt><i>restDocutilsHtmlFormat</i></dt>
156 <dd>
157 HTML format to be generated by docutils
158 (string)
159 </dd>
160 </dl><dl>
161 <dt>Returns:</dt>
162 <dd>
163 processed HTML (string)
164 </dd>
165 </dl><a NAME="PreviewProcessingThread.__convertReSTDocutils" ID="PreviewProcessingThread.__convertReSTDocutils"></a>
166 <h4>PreviewProcessingThread.__convertReSTDocutils</h4>
167 <b>__convertReSTDocutils</b>(<i>text, htmlFormat</i>)
168 <p>
169 Private method to convert ReST text into HTML using 'docutils'.
170 </p><dl>
171 <dt><i>text</i></dt>
172 <dd>
173 text to be processed (string)
174 </dd><dt><i>htmlFormat</i></dt>
175 <dd>
176 HTML format to be generated (string)
177 </dd>
178 </dl><dl>
179 <dt>Returns:</dt>
180 <dd>
181 processed HTML (string)
182 </dd>
183 </dl><a NAME="PreviewProcessingThread.__convertReSTSphinx" ID="PreviewProcessingThread.__convertReSTSphinx"></a>
184 <h4>PreviewProcessingThread.__convertReSTSphinx</h4>
185 <b>__convertReSTSphinx</b>(<i>text</i>)
186 <p>
187 Private method to convert ReST text into HTML using 'sphinx'.
188 </p><dl>
189 <dt><i>text</i></dt>
190 <dd>
191 text to be processed (string)
192 </dd>
193 </dl><dl>
194 <dt>Returns:</dt>
195 <dd>
196 processed HTML (string)
197 </dd>
198 </dl><a NAME="PreviewProcessingThread.__getHtml" ID="PreviewProcessingThread.__getHtml"></a>
199 <h4>PreviewProcessingThread.__getHtml</h4>
200 <b>__getHtml</b>(<i>language, text, ssiEnabled, filePath, rootPath, useSphinx, convertNewLineToBreak, markdownHtmlFormat, restDocutilsHtmlFormat</i>)
201 <p>
202 Private method to process the given text depending upon the given
203 language.
204 </p><dl>
205 <dt><i>language</i></dt>
206 <dd>
207 language of the text (string)
208 </dd><dt><i>text</i></dt>
209 <dd>
210 to be processed (string)
211 </dd><dt><i>ssiEnabled</i></dt>
212 <dd>
213 flag indicating to do some (limited) SSI processing
214 (boolean)
215 </dd><dt><i>filePath</i></dt>
216 <dd>
217 file path of the text (string)
218 </dd><dt><i>rootPath</i></dt>
219 <dd>
220 root path to be used for SSI processing (str)
221 </dd><dt><i>useSphinx</i></dt>
222 <dd>
223 flag indicating to use Sphinx to generate the
224 ReST preview (boolean)
225 </dd><dt><i>convertNewLineToBreak</i></dt>
226 <dd>
227 flag indicating to convert new lines
228 to HTML break (Markdown only) (boolean)
229 </dd><dt><i>markdownHtmlFormat</i></dt>
230 <dd>
231 HTML format to be generated by markdown
232 (string)
233 </dd><dt><i>restDocutilsHtmlFormat</i></dt>
234 <dd>
235 HTML format to be generated by docutils
236 (string)
237 </dd>
238 </dl><dl>
239 <dt>Returns:</dt>
240 <dd>
241 processed HTML text (string)
242 </dd>
243 </dl><a NAME="PreviewProcessingThread.__processRootPath" ID="PreviewProcessingThread.__processRootPath"></a>
244 <h4>PreviewProcessingThread.__processRootPath</h4>
245 <b>__processRootPath</b>(<i>txt, root</i>)
246 <p>
247 Private method to adjust absolute references to the given root path.
248 </p><dl>
249 <dt><i>txt</i> (str)</dt>
250 <dd>
251 text to be processed
252 </dd><dt><i>root</i> (str)</dt>
253 <dd>
254 directory of the document root
255 </dd>
256 </dl><dl>
257 <dt>Returns:</dt>
258 <dd>
259 processed HTML
260 </dd>
261 </dl><dl>
262 <dt>Return Type:</dt>
263 <dd>
264 str
265 </dd>
266 </dl><a NAME="PreviewProcessingThread.__processSSI" ID="PreviewProcessingThread.__processSSI"></a>
267 <h4>PreviewProcessingThread.__processSSI</h4>
268 <b>__processSSI</b>(<i>txt, filename, root</i>)
269 <p>
270 Private method to process the given text for SSI statements.
271 </p><p>
272 Note: Only a limited subset of SSI statements are supported.
273 </p><dl>
274 <dt><i>txt</i></dt>
275 <dd>
276 text to be processed (string)
277 </dd><dt><i>filename</i></dt>
278 <dd>
279 name of the file associated with the given text
280 (string)
281 </dd><dt><i>root</i></dt>
282 <dd>
283 directory of the document root (string)
284 </dd>
285 </dl><dl>
286 <dt>Returns:</dt>
287 <dd>
288 processed HTML (string)
289 </dd>
290 </dl><a NAME="PreviewProcessingThread.process" ID="PreviewProcessingThread.process"></a>
291 <h4>PreviewProcessingThread.process</h4>
292 <b>process</b>(<i>filePath, language, text, ssiEnabled, rootPath, useSphinx, convertNewLineToBreak, markdownHtmlFormat, restDocutilsHtmlFormat</i>)
293 <p>
294 Public method to convert the given text to HTML.
295 </p><dl>
296 <dt><i>filePath</i></dt>
297 <dd>
298 file path of the text (string)
299 </dd><dt><i>language</i></dt>
300 <dd>
301 language of the text (string)
302 </dd><dt><i>text</i></dt>
303 <dd>
304 text to be processed (string)
305 </dd><dt><i>ssiEnabled</i></dt>
306 <dd>
307 flag indicating to do some (limited) SSI processing
308 (boolean)
309 </dd><dt><i>rootPath</i></dt>
310 <dd>
311 root path to be used for SSI processing (str)
312 </dd><dt><i>useSphinx</i></dt>
313 <dd>
314 flag indicating to use Sphinx to generate the
315 ReST preview (boolean)
316 </dd><dt><i>convertNewLineToBreak</i></dt>
317 <dd>
318 flag indicating to convert new lines
319 to HTML break (Markdown only) (boolean)
320 </dd><dt><i>markdownHtmlFormat</i></dt>
321 <dd>
322 HTML format to be generated by markdown
323 (string)
324 </dd><dt><i>restDocutilsHtmlFormat</i></dt>
325 <dd>
326 HTML format to be generated by docutils
327 (string)
328 </dd>
329 </dl><a NAME="PreviewProcessingThread.run" ID="PreviewProcessingThread.run"></a>
330 <h4>PreviewProcessingThread.run</h4>
331 <b>run</b>(<i></i>)
332 <p>
333 Public thread method to convert the stored data.
334 </p>
335 <div align="right"><a href="#top">Up</a></div>
336 <hr /><hr />
337 <a NAME="PreviewerHTML" ID="PreviewerHTML"></a>
338 <h2>PreviewerHTML</h2>
339 <p>
340 Class implementing a previewer widget for HTML, Markdown and ReST files.
341 </p>
342 <h3>Derived from</h3>
343 QWidget
344 <h3>Class Attributes</h3>
345 <table>
346 <tr><td>None</td></tr>
347 </table>
348 <h3>Class Methods</h3>
349 <table>
350 <tr><td>None</td></tr>
351 </table>
352 <h3>Methods</h3>
353 <table>
354 <tr>
355 <td><a href="#PreviewerHTML.__init__">PreviewerHTML</a></td>
356 <td>Constructor</td>
357 </tr><tr>
358 <td><a href="#PreviewerHTML.__execJavaScript">__execJavaScript</a></td>
359 <td>Private function to execute a JavaScript function Synchroneously.</td>
360 </tr><tr>
361 <td><a href="#PreviewerHTML.__restoreScrollBarPositions">__restoreScrollBarPositions</a></td>
362 <td>Private method to restore scroll bar positions for a previewed editor.</td>
363 </tr><tr>
364 <td><a href="#PreviewerHTML.__saveScrollBarPositions">__saveScrollBarPositions</a></td>
365 <td>Private method to save scroll bar positions for a previewed editor.</td>
366 </tr><tr>
367 <td><a href="#PreviewerHTML.__setHtml">__setHtml</a></td>
368 <td>Private method to set the HTML to the view and restore the scroll bars positions.</td>
369 </tr><tr>
370 <td><a href="#PreviewerHTML.__setJavaScriptEnabled">__setJavaScriptEnabled</a></td>
371 <td>Private method to enable/disable JavaScript.</td>
372 </tr><tr>
373 <td><a href="#PreviewerHTML.__showLink">__showLink</a></td>
374 <td>Private slot to show the hovered link in a tooltip.</td>
375 </tr><tr>
376 <td><a href="#PreviewerHTML.on_jsCheckBox_clicked">on_jsCheckBox_clicked</a></td>
377 <td>Private slot to enable/disable JavaScript.</td>
378 </tr><tr>
379 <td><a href="#PreviewerHTML.on_previewView_linkClicked">on_previewView_linkClicked</a></td>
380 <td>Private slot handling the clicking of a link.</td>
381 </tr><tr>
382 <td><a href="#PreviewerHTML.on_previewView_titleChanged">on_previewView_titleChanged</a></td>
383 <td>Private slot to handle a change of the title.</td>
384 </tr><tr>
385 <td><a href="#PreviewerHTML.on_ssiCheckBox_clicked">on_ssiCheckBox_clicked</a></td>
386 <td>Private slot to enable/disable SSI.</td>
387 </tr><tr>
388 <td><a href="#PreviewerHTML.processEditor">processEditor</a></td>
389 <td>Public slot to process an editor's text.</td>
390 </tr><tr>
391 <td><a href="#PreviewerHTML.resultCallback">resultCallback</a></td>
392 <td></td>
393 </tr><tr>
394 <td><a href="#PreviewerHTML.shutdown">shutdown</a></td>
395 <td>Public method to perform shutdown actions.</td>
396 </tr>
397 </table>
398 <h3>Static Methods</h3>
399 <table>
400 <tr><td>None</td></tr>
401 </table>
402 <a NAME="PreviewerHTML.__init__" ID="PreviewerHTML.__init__"></a>
403 <h4>PreviewerHTML (Constructor)</h4>
404 <b>PreviewerHTML</b>(<i>parent=None</i>)
405 <p>
406 Constructor
407 </p><dl>
408 <dt><i>parent</i></dt>
409 <dd>
410 reference to the parent widget (QWidget)
411 </dd>
412 </dl><a NAME="PreviewerHTML.__execJavaScript" ID="PreviewerHTML.__execJavaScript"></a>
413 <h4>PreviewerHTML.__execJavaScript</h4>
414 <b>__execJavaScript</b>(<i>script</i>)
415 <p>
416 Private function to execute a JavaScript function Synchroneously.
417 </p><dl>
418 <dt><i>script</i> (str)</dt>
419 <dd>
420 JavaScript script source to be executed
421 </dd>
422 </dl><dl>
423 <dt>Returns:</dt>
424 <dd>
425 result of the script
426 </dd>
427 </dl><dl>
428 <dt>Return Type:</dt>
429 <dd>
430 depending upon script result
431 </dd>
432 </dl><a NAME="PreviewerHTML.__restoreScrollBarPositions" ID="PreviewerHTML.__restoreScrollBarPositions"></a>
433 <h4>PreviewerHTML.__restoreScrollBarPositions</h4>
434 <b>__restoreScrollBarPositions</b>(<i></i>)
435 <p>
436 Private method to restore scroll bar positions for a previewed editor.
437 </p><a NAME="PreviewerHTML.__saveScrollBarPositions" ID="PreviewerHTML.__saveScrollBarPositions"></a>
438 <h4>PreviewerHTML.__saveScrollBarPositions</h4>
439 <b>__saveScrollBarPositions</b>(<i></i>)
440 <p>
441 Private method to save scroll bar positions for a previewed editor.
442 </p><a NAME="PreviewerHTML.__setHtml" ID="PreviewerHTML.__setHtml"></a>
443 <h4>PreviewerHTML.__setHtml</h4>
444 <b>__setHtml</b>(<i>filePath, html, rootPath</i>)
445 <p>
446 Private method to set the HTML to the view and restore the scroll bars
447 positions.
448 </p><dl>
449 <dt><i>filePath</i> (str)</dt>
450 <dd>
451 file path of the previewed editor
452 </dd><dt><i>html</i> (str)</dt>
453 <dd>
454 processed HTML text ready to be shown
455 </dd><dt><i>rootPath</i> (str)</dt>
456 <dd>
457 path of the web site root
458 </dd>
459 </dl><a NAME="PreviewerHTML.__setJavaScriptEnabled" ID="PreviewerHTML.__setJavaScriptEnabled"></a>
460 <h4>PreviewerHTML.__setJavaScriptEnabled</h4>
461 <b>__setJavaScriptEnabled</b>(<i>enable</i>)
462 <p>
463 Private method to enable/disable JavaScript.
464 </p><dl>
465 <dt><i>enable</i></dt>
466 <dd>
467 flag indicating the enable state (boolean)
468 </dd>
469 </dl><a NAME="PreviewerHTML.__showLink" ID="PreviewerHTML.__showLink"></a>
470 <h4>PreviewerHTML.__showLink</h4>
471 <b>__showLink</b>(<i>urlStr</i>)
472 <p>
473 Private slot to show the hovered link in a tooltip.
474 </p><dl>
475 <dt><i>urlStr</i> (str)</dt>
476 <dd>
477 hovered URL
478 </dd>
479 </dl><a NAME="PreviewerHTML.on_jsCheckBox_clicked" ID="PreviewerHTML.on_jsCheckBox_clicked"></a>
480 <h4>PreviewerHTML.on_jsCheckBox_clicked</h4>
481 <b>on_jsCheckBox_clicked</b>(<i>checked</i>)
482 <p>
483 Private slot to enable/disable JavaScript.
484 </p><dl>
485 <dt><i>checked</i></dt>
486 <dd>
487 state of the checkbox (boolean)
488 </dd>
489 </dl><a NAME="PreviewerHTML.on_previewView_linkClicked" ID="PreviewerHTML.on_previewView_linkClicked"></a>
490 <h4>PreviewerHTML.on_previewView_linkClicked</h4>
491 <b>on_previewView_linkClicked</b>(<i>url</i>)
492 <p>
493 Private slot handling the clicking of a link.
494 </p><dl>
495 <dt><i>url</i> (QUrl)</dt>
496 <dd>
497 URL of the clicked link
498 </dd>
499 </dl><a NAME="PreviewerHTML.on_previewView_titleChanged" ID="PreviewerHTML.on_previewView_titleChanged"></a>
500 <h4>PreviewerHTML.on_previewView_titleChanged</h4>
501 <b>on_previewView_titleChanged</b>(<i>title</i>)
502 <p>
503 Private slot to handle a change of the title.
504 </p><dl>
505 <dt><i>title</i></dt>
506 <dd>
507 new title (string)
508 </dd>
509 </dl><a NAME="PreviewerHTML.on_ssiCheckBox_clicked" ID="PreviewerHTML.on_ssiCheckBox_clicked"></a>
510 <h4>PreviewerHTML.on_ssiCheckBox_clicked</h4>
511 <b>on_ssiCheckBox_clicked</b>(<i>checked</i>)
512 <p>
513 Private slot to enable/disable SSI.
514 </p><dl>
515 <dt><i>checked</i></dt>
516 <dd>
517 state of the checkbox (boolean)
518 </dd>
519 </dl><a NAME="PreviewerHTML.processEditor" ID="PreviewerHTML.processEditor"></a>
520 <h4>PreviewerHTML.processEditor</h4>
521 <b>processEditor</b>(<i>editor=None</i>)
522 <p>
523 Public slot to process an editor's text.
524 </p><dl>
525 <dt><i>editor</i></dt>
526 <dd>
527 editor to be processed (Editor)
528 </dd>
529 </dl><a NAME="PreviewerHTML.resultCallback" ID="PreviewerHTML.resultCallback"></a>
530 <h4>PreviewerHTML.resultCallback</h4>
531 <b>resultCallback</b>(<i>resDict=resultDict</i>)
532 <a NAME="PreviewerHTML.shutdown" ID="PreviewerHTML.shutdown"></a>
533 <h4>PreviewerHTML.shutdown</h4>
534 <b>shutdown</b>(<i></i>)
535 <p>
536 Public method to perform shutdown actions.
537 </p>
538 <div align="right"><a href="#top">Up</a></div>
539 <hr /><hr />
540 <a NAME="_StrikeThroughExtension" ID="_StrikeThroughExtension"></a>
541 <h2>_StrikeThroughExtension</h2>
542 <p>
543 Class is placed here, because it depends on imported markdown,
544 and markdown import is lazy.
545 </p><p>
546 (see https://pythonhosted.org/Markdown/extensions/api.html
547 this page for details)
548 </p>
549 <h3>Derived from</h3>
550 markdown.Extension
551 <h3>Class Attributes</h3>
552 <table>
553 <tr><td>DEL_RE</td></tr>
554 </table>
555 <h3>Class Methods</h3>
556 <table>
557 <tr><td>None</td></tr>
558 </table>
559 <h3>Methods</h3>
560 <table>
561 <tr>
562 <td><a href="#_StrikeThroughExtension.extendMarkdown">extendMarkdown</a></td>
563 <td></td>
564 </tr>
565 </table>
566 <h3>Static Methods</h3>
567 <table>
568 <tr><td>None</td></tr>
569 </table>
570 <a NAME="_StrikeThroughExtension.extendMarkdown" ID="_StrikeThroughExtension.extendMarkdown"></a>
571 <h4>_StrikeThroughExtension.extendMarkdown</h4>
572 <b>extendMarkdown</b>(<i>md, md_globals</i>)
573
574 <div align="right"><a href="#top">Up</a></div>
575 <hr />
576 </body></html>

Mercurial Repository: eric

eric ide

mercurial