Mercurial Repositories > eric / file comparison

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

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

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
equal deleted inserted replaced
8371:d6062691d424 8372:e0227a7c850e
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.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>
22 <a NAME="top" ID="top"></a>
23 <h1>eric7.UI.Previewers.PreviewerHTML</h1>
24
25 <p>
26 Module implementing a previewer widget for HTML, Markdown and ReST files.
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="#PreviewProcessingThread">PreviewProcessingThread</a></td>
39 <td>Class implementing a thread to process some text into HTML usable by the previewer view.</td>
40 </tr>
41 <tr>
42 <td><a href="#PreviewerHTML">PreviewerHTML</a></td>
43 <td>Class implementing a previewer widget for HTML, Markdown and ReST files.</td>
44 </tr>
45 </table>
46 <h3>Functions</h3>
47
48 <table>
49 <tr><td>None</td></tr>
50 </table>
51 <hr />
52 <hr />
53 <a NAME="PreviewProcessingThread" ID="PreviewProcessingThread"></a>
54 <h2>PreviewProcessingThread</h2>
55
56 <p>
57 Class implementing a thread to process some text into HTML usable by the
58 previewer view.
59 </p>
60 <h3>Signals</h3>
61 <dl>
62
63 <dt>htmlReady(str, str, str)</dt>
64 <dd>
65 emitted with the file name, the processed
66 HTML and the web site root path to signal the availability of the
67 processed HTML
68 </dd>
69 </dl>
70 <h3>Derived from</h3>
71 QThread
72 <h3>Class Attributes</h3>
73
74 <table>
75 <tr><td>None</td></tr>
76 </table>
77 <h3>Class Methods</h3>
78
79 <table>
80 <tr><td>None</td></tr>
81 </table>
82 <h3>Methods</h3>
83
84 <table>
85
86 <tr>
87 <td><a href="#PreviewProcessingThread.__init__">PreviewProcessingThread</a></td>
88 <td>Constructor</td>
89 </tr>
90 <tr>
91 <td><a href="#PreviewProcessingThread.__convertMarkdown">__convertMarkdown</a></td>
92 <td>Private method to convert Markdown text into HTML.</td>
93 </tr>
94 <tr>
95 <td><a href="#PreviewProcessingThread.__convertReST">__convertReST</a></td>
96 <td>Private method to convert ReST text into HTML.</td>
97 </tr>
98 <tr>
99 <td><a href="#PreviewProcessingThread.__convertReSTDocutils">__convertReSTDocutils</a></td>
100 <td>Private method to convert ReST text into HTML using 'docutils'.</td>
101 </tr>
102 <tr>
103 <td><a href="#PreviewProcessingThread.__convertReSTSphinx">__convertReSTSphinx</a></td>
104 <td>Private method to convert ReST text into HTML using 'sphinx'.</td>
105 </tr>
106 <tr>
107 <td><a href="#PreviewProcessingThread.__getHtml">__getHtml</a></td>
108 <td>Private method to process the given text depending upon the given language.</td>
109 </tr>
110 <tr>
111 <td><a href="#PreviewProcessingThread.__processRootPath">__processRootPath</a></td>
112 <td>Private method to adjust absolute references to the given root path.</td>
113 </tr>
114 <tr>
115 <td><a href="#PreviewProcessingThread.__processSSI">__processSSI</a></td>
116 <td>Private method to process the given text for SSI statements.</td>
117 </tr>
118 <tr>
119 <td><a href="#PreviewProcessingThread.process">process</a></td>
120 <td>Public method to convert the given text to HTML.</td>
121 </tr>
122 <tr>
123 <td><a href="#PreviewProcessingThread.run">run</a></td>
124 <td>Public thread method to convert the stored data.</td>
125 </tr>
126 </table>
127 <h3>Static Methods</h3>
128
129 <table>
130 <tr><td>None</td></tr>
131 </table>
132
133 <a NAME="PreviewProcessingThread.__init__" ID="PreviewProcessingThread.__init__"></a>
134 <h4>PreviewProcessingThread (Constructor)</h4>
135 <b>PreviewProcessingThread</b>(<i>parent=None</i>)
136
137 <p>
138 Constructor
139 </p>
140 <dl>
141
142 <dt><i>parent</i></dt>
143 <dd>
144 reference to the parent object (QObject)
145 </dd>
146 </dl>
147 <a NAME="PreviewProcessingThread.__convertMarkdown" ID="PreviewProcessingThread.__convertMarkdown"></a>
148 <h4>PreviewProcessingThread.__convertMarkdown</h4>
149 <b>__convertMarkdown</b>(<i>text, convertNewLineToBreak, usePyMdownExtensions, htmlFormat</i>)
150
151 <p>
152 Private method to convert Markdown text into HTML.
153 </p>
154 <dl>
155
156 <dt><i>text</i> (str)</dt>
157 <dd>
158 text to be processed
159 </dd>
160 <dt><i>convertNewLineToBreak</i> (bool)</dt>
161 <dd>
162 flag indicating to convert new lines
163 to HTML break (Markdown only)
164 </dd>
165 <dt><i>usePyMdownExtensions</i> (bool)</dt>
166 <dd>
167 flag indicating to enable the PyMdown
168 extensions, if they are available
169 </dd>
170 <dt><i>htmlFormat</i> (str)</dt>
171 <dd>
172 HTML format to be generated by markdown
173 </dd>
174 </dl>
175 <dl>
176 <dt>Return:</dt>
177 <dd>
178 processed HTML
179 </dd>
180 </dl>
181 <dl>
182 <dt>Return Type:</dt>
183 <dd>
184 str
185 </dd>
186 </dl>
187 <a NAME="PreviewProcessingThread.__convertReST" ID="PreviewProcessingThread.__convertReST"></a>
188 <h4>PreviewProcessingThread.__convertReST</h4>
189 <b>__convertReST</b>(<i>text, useSphinx, restDocutilsHtmlFormat</i>)
190
191 <p>
192 Private method to convert ReST text into HTML.
193 </p>
194 <dl>
195
196 <dt><i>text</i></dt>
197 <dd>
198 text to be processed (string)
199 </dd>
200 <dt><i>useSphinx</i></dt>
201 <dd>
202 flag indicating to use Sphinx to generate the
203 ReST preview (boolean)
204 </dd>
205 <dt><i>restDocutilsHtmlFormat</i></dt>
206 <dd>
207 HTML format to be generated by docutils
208 (string)
209 </dd>
210 </dl>
211 <dl>
212 <dt>Return:</dt>
213 <dd>
214 processed HTML (string)
215 </dd>
216 </dl>
217 <a NAME="PreviewProcessingThread.__convertReSTDocutils" ID="PreviewProcessingThread.__convertReSTDocutils"></a>
218 <h4>PreviewProcessingThread.__convertReSTDocutils</h4>
219 <b>__convertReSTDocutils</b>(<i>text, htmlFormat</i>)
220
221 <p>
222 Private method to convert ReST text into HTML using 'docutils'.
223 </p>
224 <dl>
225
226 <dt><i>text</i></dt>
227 <dd>
228 text to be processed (string)
229 </dd>
230 <dt><i>htmlFormat</i></dt>
231 <dd>
232 HTML format to be generated (string)
233 </dd>
234 </dl>
235 <dl>
236 <dt>Return:</dt>
237 <dd>
238 processed HTML (string)
239 </dd>
240 </dl>
241 <a NAME="PreviewProcessingThread.__convertReSTSphinx" ID="PreviewProcessingThread.__convertReSTSphinx"></a>
242 <h4>PreviewProcessingThread.__convertReSTSphinx</h4>
243 <b>__convertReSTSphinx</b>(<i>text</i>)
244
245 <p>
246 Private method to convert ReST text into HTML using 'sphinx'.
247 </p>
248 <dl>
249
250 <dt><i>text</i></dt>
251 <dd>
252 text to be processed (string)
253 </dd>
254 </dl>
255 <dl>
256 <dt>Return:</dt>
257 <dd>
258 processed HTML (string)
259 </dd>
260 </dl>
261 <a NAME="PreviewProcessingThread.__getHtml" ID="PreviewProcessingThread.__getHtml"></a>
262 <h4>PreviewProcessingThread.__getHtml</h4>
263 <b>__getHtml</b>(<i>language, text, ssiEnabled, filePath, rootPath, useSphinx, convertNewLineToBreak, usePyMdownExtensions, markdownHtmlFormat, restDocutilsHtmlFormat</i>)
264
265 <p>
266 Private method to process the given text depending upon the given
267 language.
268 </p>
269 <dl>
270
271 <dt><i>language</i> (str)</dt>
272 <dd>
273 language of the text
274 </dd>
275 <dt><i>text</i> (str)</dt>
276 <dd>
277 to be processed
278 </dd>
279 <dt><i>ssiEnabled</i> (bool)</dt>
280 <dd>
281 flag indicating to do some (limited) SSI processing
282 </dd>
283 <dt><i>filePath</i> (str)</dt>
284 <dd>
285 file path of the text
286 </dd>
287 <dt><i>rootPath</i> (str)</dt>
288 <dd>
289 root path to be used for SSI processing
290 </dd>
291 <dt><i>useSphinx</i> (bool)</dt>
292 <dd>
293 flag indicating to use Sphinx to generate the
294 ReST preview
295 </dd>
296 <dt><i>convertNewLineToBreak</i> (bool)</dt>
297 <dd>
298 flag indicating to convert new lines
299 to HTML break (Markdown only)
300 </dd>
301 <dt><i>usePyMdownExtensions</i> (bool)</dt>
302 <dd>
303 flag indicating to enable the PyMdown
304 extensions, if they are available
305 </dd>
306 <dt><i>markdownHtmlFormat</i> (str)</dt>
307 <dd>
308 HTML format to be generated by markdown
309 </dd>
310 <dt><i>restDocutilsHtmlFormat</i> (str)</dt>
311 <dd>
312 HTML format to be generated by docutils
313 </dd>
314 </dl>
315 <dl>
316 <dt>Return:</dt>
317 <dd>
318 processed HTML text
319 </dd>
320 </dl>
321 <dl>
322 <dt>Return Type:</dt>
323 <dd>
324 str
325 </dd>
326 </dl>
327 <a NAME="PreviewProcessingThread.__processRootPath" ID="PreviewProcessingThread.__processRootPath"></a>
328 <h4>PreviewProcessingThread.__processRootPath</h4>
329 <b>__processRootPath</b>(<i>txt, root</i>)
330
331 <p>
332 Private method to adjust absolute references to the given root path.
333 </p>
334 <dl>
335
336 <dt><i>txt</i> (str)</dt>
337 <dd>
338 text to be processed
339 </dd>
340 <dt><i>root</i> (str)</dt>
341 <dd>
342 directory of the document root
343 </dd>
344 </dl>
345 <dl>
346 <dt>Return:</dt>
347 <dd>
348 processed HTML
349 </dd>
350 </dl>
351 <dl>
352 <dt>Return Type:</dt>
353 <dd>
354 str
355 </dd>
356 </dl>
357 <a NAME="PreviewProcessingThread.__processSSI" ID="PreviewProcessingThread.__processSSI"></a>
358 <h4>PreviewProcessingThread.__processSSI</h4>
359 <b>__processSSI</b>(<i>txt, filename, root</i>)
360
361 <p>
362 Private method to process the given text for SSI statements.
363 </p>
364 <p>
365 Note: Only a limited subset of SSI statements are supported.
366 </p>
367 <dl>
368
369 <dt><i>txt</i></dt>
370 <dd>
371 text to be processed (string)
372 </dd>
373 <dt><i>filename</i></dt>
374 <dd>
375 name of the file associated with the given text
376 (string)
377 </dd>
378 <dt><i>root</i></dt>
379 <dd>
380 directory of the document root (string)
381 </dd>
382 </dl>
383 <dl>
384 <dt>Return:</dt>
385 <dd>
386 processed HTML (string)
387 </dd>
388 </dl>
389 <a NAME="PreviewProcessingThread.process" ID="PreviewProcessingThread.process"></a>
390 <h4>PreviewProcessingThread.process</h4>
391 <b>process</b>(<i>filePath, language, text, ssiEnabled, rootPath, useSphinx, convertNewLineToBreak, usePyMdownExtensions, markdownHtmlFormat, restDocutilsHtmlFormat</i>)
392
393 <p>
394 Public method to convert the given text to HTML.
395 </p>
396 <dl>
397
398 <dt><i>filePath</i> (str)</dt>
399 <dd>
400 file path of the text
401 </dd>
402 <dt><i>language</i> (str)</dt>
403 <dd>
404 language of the text
405 </dd>
406 <dt><i>text</i> (str)</dt>
407 <dd>
408 text to be processed
409 </dd>
410 <dt><i>ssiEnabled</i> (bool)</dt>
411 <dd>
412 flag indicating to do some (limited) SSI processing
413 </dd>
414 <dt><i>rootPath</i> (str)</dt>
415 <dd>
416 root path to be used for SSI processing
417 </dd>
418 <dt><i>useSphinx</i> (bool)</dt>
419 <dd>
420 flag indicating to use Sphinx to generate the
421 ReST preview
422 </dd>
423 <dt><i>convertNewLineToBreak</i> (bool)</dt>
424 <dd>
425 flag indicating to convert new lines
426 to HTML break (Markdown only)
427 </dd>
428 <dt><i>usePyMdownExtensions</i> (bool)</dt>
429 <dd>
430 flag indicating to enable the PyMdown
431 extensions, if they are available
432 </dd>
433 <dt><i>markdownHtmlFormat</i> (str)</dt>
434 <dd>
435 HTML format to be generated by markdown
436 </dd>
437 <dt><i>restDocutilsHtmlFormat</i> (str)</dt>
438 <dd>
439 HTML format to be generated by docutils
440 </dd>
441 </dl>
442 <a NAME="PreviewProcessingThread.run" ID="PreviewProcessingThread.run"></a>
443 <h4>PreviewProcessingThread.run</h4>
444 <b>run</b>(<i></i>)
445
446 <p>
447 Public thread method to convert the stored data.
448 </p>
449 <div align="right"><a href="#top">Up</a></div>
450 <hr />
451 <hr />
452 <a NAME="PreviewerHTML" ID="PreviewerHTML"></a>
453 <h2>PreviewerHTML</h2>
454
455 <p>
456 Class implementing a previewer widget for HTML, Markdown and ReST files.
457 </p>
458 <h3>Derived from</h3>
459 QWidget
460 <h3>Class Attributes</h3>
461
462 <table>
463 <tr><td>None</td></tr>
464 </table>
465 <h3>Class Methods</h3>
466
467 <table>
468 <tr><td>None</td></tr>
469 </table>
470 <h3>Methods</h3>
471
472 <table>
473
474 <tr>
475 <td><a href="#PreviewerHTML.__init__">PreviewerHTML</a></td>
476 <td>Constructor</td>
477 </tr>
478 <tr>
479 <td><a href="#PreviewerHTML.__execJavaScript">__execJavaScript</a></td>
480 <td>Private function to execute a JavaScript function Synchroneously.</td>
481 </tr>
482 <tr>
483 <td><a href="#PreviewerHTML.__restoreScrollBarPositions">__restoreScrollBarPositions</a></td>
484 <td>Private method to restore scroll bar positions for a previewed editor.</td>
485 </tr>
486 <tr>
487 <td><a href="#PreviewerHTML.__saveScrollBarPositions">__saveScrollBarPositions</a></td>
488 <td>Private method to save scroll bar positions for a previewed editor.</td>
489 </tr>
490 <tr>
491 <td><a href="#PreviewerHTML.__setHtml">__setHtml</a></td>
492 <td>Private method to set the HTML to the view and restore the scroll bars positions.</td>
493 </tr>
494 <tr>
495 <td><a href="#PreviewerHTML.__setJavaScriptEnabled">__setJavaScriptEnabled</a></td>
496 <td>Private method to enable/disable JavaScript.</td>
497 </tr>
498 <tr>
499 <td><a href="#PreviewerHTML.__showLink">__showLink</a></td>
500 <td>Private slot to show the hovered link in a tooltip.</td>
501 </tr>
502 <tr>
503 <td><a href="#PreviewerHTML.on_jsCheckBox_clicked">on_jsCheckBox_clicked</a></td>
504 <td>Private slot to enable/disable JavaScript.</td>
505 </tr>
506 <tr>
507 <td><a href="#PreviewerHTML.on_previewView_titleChanged">on_previewView_titleChanged</a></td>
508 <td>Private slot to handle a change of the title.</td>
509 </tr>
510 <tr>
511 <td><a href="#PreviewerHTML.on_ssiCheckBox_clicked">on_ssiCheckBox_clicked</a></td>
512 <td>Private slot to enable/disable SSI.</td>
513 </tr>
514 <tr>
515 <td><a href="#PreviewerHTML.processEditor">processEditor</a></td>
516 <td>Public slot to process an editor's text.</td>
517 </tr>
518 <tr>
519 <td><a href="#PreviewerHTML.resultCallback">resultCallback</a></td>
520 <td></td>
521 </tr>
522 <tr>
523 <td><a href="#PreviewerHTML.shutdown">shutdown</a></td>
524 <td>Public method to perform shutdown actions.</td>
525 </tr>
526 </table>
527 <h3>Static Methods</h3>
528
529 <table>
530 <tr><td>None</td></tr>
531 </table>
532
533 <a NAME="PreviewerHTML.__init__" ID="PreviewerHTML.__init__"></a>
534 <h4>PreviewerHTML (Constructor)</h4>
535 <b>PreviewerHTML</b>(<i>parent=None</i>)
536
537 <p>
538 Constructor
539 </p>
540 <dl>
541
542 <dt><i>parent</i></dt>
543 <dd>
544 reference to the parent widget (QWidget)
545 </dd>
546 </dl>
547 <a NAME="PreviewerHTML.__execJavaScript" ID="PreviewerHTML.__execJavaScript"></a>
548 <h4>PreviewerHTML.__execJavaScript</h4>
549 <b>__execJavaScript</b>(<i>script</i>)
550
551 <p>
552 Private function to execute a JavaScript function Synchroneously.
553 </p>
554 <dl>
555
556 <dt><i>script</i> (str)</dt>
557 <dd>
558 JavaScript script source to be executed
559 </dd>
560 </dl>
561 <dl>
562 <dt>Return:</dt>
563 <dd>
564 result of the script
565 </dd>
566 </dl>
567 <dl>
568 <dt>Return Type:</dt>
569 <dd>
570 depending upon script result
571 </dd>
572 </dl>
573 <a NAME="PreviewerHTML.__restoreScrollBarPositions" ID="PreviewerHTML.__restoreScrollBarPositions"></a>
574 <h4>PreviewerHTML.__restoreScrollBarPositions</h4>
575 <b>__restoreScrollBarPositions</b>(<i></i>)
576
577 <p>
578 Private method to restore scroll bar positions for a previewed editor.
579 </p>
580 <a NAME="PreviewerHTML.__saveScrollBarPositions" ID="PreviewerHTML.__saveScrollBarPositions"></a>
581 <h4>PreviewerHTML.__saveScrollBarPositions</h4>
582 <b>__saveScrollBarPositions</b>(<i></i>)
583
584 <p>
585 Private method to save scroll bar positions for a previewed editor.
586 </p>
587 <a NAME="PreviewerHTML.__setHtml" ID="PreviewerHTML.__setHtml"></a>
588 <h4>PreviewerHTML.__setHtml</h4>
589 <b>__setHtml</b>(<i>filePath, html, rootPath</i>)
590
591 <p>
592 Private method to set the HTML to the view and restore the scroll bars
593 positions.
594 </p>
595 <dl>
596
597 <dt><i>filePath</i> (str)</dt>
598 <dd>
599 file path of the previewed editor
600 </dd>
601 <dt><i>html</i> (str)</dt>
602 <dd>
603 processed HTML text ready to be shown
604 </dd>
605 <dt><i>rootPath</i> (str)</dt>
606 <dd>
607 path of the web site root
608 </dd>
609 </dl>
610 <a NAME="PreviewerHTML.__setJavaScriptEnabled" ID="PreviewerHTML.__setJavaScriptEnabled"></a>
611 <h4>PreviewerHTML.__setJavaScriptEnabled</h4>
612 <b>__setJavaScriptEnabled</b>(<i>enable</i>)
613
614 <p>
615 Private method to enable/disable JavaScript.
616 </p>
617 <dl>
618
619 <dt><i>enable</i></dt>
620 <dd>
621 flag indicating the enable state (boolean)
622 </dd>
623 </dl>
624 <a NAME="PreviewerHTML.__showLink" ID="PreviewerHTML.__showLink"></a>
625 <h4>PreviewerHTML.__showLink</h4>
626 <b>__showLink</b>(<i>urlStr</i>)
627
628 <p>
629 Private slot to show the hovered link in a tooltip.
630 </p>
631 <dl>
632
633 <dt><i>urlStr</i> (str)</dt>
634 <dd>
635 hovered URL
636 </dd>
637 </dl>
638 <a NAME="PreviewerHTML.on_jsCheckBox_clicked" ID="PreviewerHTML.on_jsCheckBox_clicked"></a>
639 <h4>PreviewerHTML.on_jsCheckBox_clicked</h4>
640 <b>on_jsCheckBox_clicked</b>(<i>checked</i>)
641
642 <p>
643 Private slot to enable/disable JavaScript.
644 </p>
645 <dl>
646
647 <dt><i>checked</i></dt>
648 <dd>
649 state of the checkbox (boolean)
650 </dd>
651 </dl>
652 <a NAME="PreviewerHTML.on_previewView_titleChanged" ID="PreviewerHTML.on_previewView_titleChanged"></a>
653 <h4>PreviewerHTML.on_previewView_titleChanged</h4>
654 <b>on_previewView_titleChanged</b>(<i>title</i>)
655
656 <p>
657 Private slot to handle a change of the title.
658 </p>
659 <dl>
660
661 <dt><i>title</i></dt>
662 <dd>
663 new title (string)
664 </dd>
665 </dl>
666 <a NAME="PreviewerHTML.on_ssiCheckBox_clicked" ID="PreviewerHTML.on_ssiCheckBox_clicked"></a>
667 <h4>PreviewerHTML.on_ssiCheckBox_clicked</h4>
668 <b>on_ssiCheckBox_clicked</b>(<i>checked</i>)
669
670 <p>
671 Private slot to enable/disable SSI.
672 </p>
673 <dl>
674
675 <dt><i>checked</i></dt>
676 <dd>
677 state of the checkbox (boolean)
678 </dd>
679 </dl>
680 <a NAME="PreviewerHTML.processEditor" ID="PreviewerHTML.processEditor"></a>
681 <h4>PreviewerHTML.processEditor</h4>
682 <b>processEditor</b>(<i>editor=None</i>)
683
684 <p>
685 Public slot to process an editor's text.
686 </p>
687 <dl>
688
689 <dt><i>editor</i></dt>
690 <dd>
691 editor to be processed (Editor)
692 </dd>
693 </dl>
694 <a NAME="PreviewerHTML.resultCallback" ID="PreviewerHTML.resultCallback"></a>
695 <h4>PreviewerHTML.resultCallback</h4>
696 <b>resultCallback</b>(<i>resDict=resultDict</i>)
697
698 <a NAME="PreviewerHTML.shutdown" ID="PreviewerHTML.shutdown"></a>
699 <h4>PreviewerHTML.shutdown</h4>
700 <b>shutdown</b>(<i></i>)
701
702 <p>
703 Public method to perform shutdown actions.
704 </p>
705 <div align="right"><a href="#top">Up</a></div>
706 <hr />
707 </body></html>

Mercurial Repository: eric

eric ide

mercurial