5 <link rel="stylesheet" href="styles.css"> |
5 <link rel="stylesheet" href="styles.css"> |
6 </head> |
6 </head> |
7 <body> |
7 <body> |
8 <a NAME="top" ID="top"></a> |
8 <a NAME="top" ID="top"></a> |
9 <h1>eric7.UI.Previewers.PreviewerHTML</h1> |
9 <h1>eric7.UI.Previewers.PreviewerHTML</h1> |
10 |
|
11 <p> |
10 <p> |
12 Module implementing a previewer widget for HTML, Markdown and ReST files. |
11 Module implementing a previewer widget for HTML, Markdown and ReST files. |
13 </p> |
12 </p> |
|
13 |
14 <h3>Global Attributes</h3> |
14 <h3>Global Attributes</h3> |
15 |
|
16 <table> |
15 <table> |
17 <tr><td>None</td></tr> |
16 <tr><td>None</td></tr> |
18 </table> |
17 </table> |
|
18 |
19 <h3>Classes</h3> |
19 <h3>Classes</h3> |
20 |
20 <table> |
21 <table> |
|
22 |
|
23 <tr> |
21 <tr> |
24 <td><a href="#PreviewProcessingThread">PreviewProcessingThread</a></td> |
22 <td><a href="#PreviewProcessingThread">PreviewProcessingThread</a></td> |
25 <td>Class implementing a thread to process some text into HTML usable by the previewer view.</td> |
23 <td>Class implementing a thread to process some text into HTML usable by the previewer view.</td> |
26 </tr> |
24 </tr> |
27 <tr> |
25 <tr> |
28 <td><a href="#PreviewerHTML">PreviewerHTML</a></td> |
26 <td><a href="#PreviewerHTML">PreviewerHTML</a></td> |
29 <td>Class implementing a previewer widget for HTML, Markdown and ReST files.</td> |
27 <td>Class implementing a previewer widget for HTML, Markdown and ReST files.</td> |
30 </tr> |
28 </tr> |
31 </table> |
29 </table> |
|
30 |
32 <h3>Functions</h3> |
31 <h3>Functions</h3> |
33 |
|
34 <table> |
32 <table> |
35 <tr><td>None</td></tr> |
33 <tr><td>None</td></tr> |
36 </table> |
34 </table> |
|
35 |
37 <hr /> |
36 <hr /> |
38 <hr /> |
37 <hr /> |
39 <a NAME="PreviewProcessingThread" ID="PreviewProcessingThread"></a> |
38 <a NAME="PreviewProcessingThread" ID="PreviewProcessingThread"></a> |
40 <h2>PreviewProcessingThread</h2> |
39 <h2>PreviewProcessingThread</h2> |
41 |
|
42 <p> |
40 <p> |
43 Class implementing a thread to process some text into HTML usable by the |
41 Class implementing a thread to process some text into HTML usable by the |
44 previewer view. |
42 previewer view. |
45 </p> |
43 </p> |
|
44 |
46 <h3>Signals</h3> |
45 <h3>Signals</h3> |
47 <dl> |
46 <dl> |
48 |
47 |
49 <dt>htmlReady(str, str, str)</dt> |
48 <dt>htmlReady(str, str, str)</dt> |
50 <dd> |
49 <dd> |
108 <tr> |
105 <tr> |
109 <td><a href="#PreviewProcessingThread.run">run</a></td> |
106 <td><a href="#PreviewProcessingThread.run">run</a></td> |
110 <td>Public thread method to convert the stored data.</td> |
107 <td>Public thread method to convert the stored data.</td> |
111 </tr> |
108 </tr> |
112 </table> |
109 </table> |
|
110 |
113 <h3>Static Methods</h3> |
111 <h3>Static Methods</h3> |
114 |
|
115 <table> |
112 <table> |
116 <tr><td>None</td></tr> |
113 <tr><td>None</td></tr> |
117 </table> |
114 </table> |
|
115 |
118 |
116 |
119 <a NAME="PreviewProcessingThread.__init__" ID="PreviewProcessingThread.__init__"></a> |
117 <a NAME="PreviewProcessingThread.__init__" ID="PreviewProcessingThread.__init__"></a> |
120 <h4>PreviewProcessingThread (Constructor)</h4> |
118 <h4>PreviewProcessingThread (Constructor)</h4> |
121 <b>PreviewProcessingThread</b>(<i>parent=None</i>) |
119 <b>PreviewProcessingThread</b>(<i>parent=None</i>) |
122 |
|
123 <p> |
120 <p> |
124 Constructor |
121 Constructor |
125 </p> |
122 </p> |
|
123 |
126 <dl> |
124 <dl> |
127 |
125 |
128 <dt><i>parent</i> (QObject)</dt> |
126 <dt><i>parent</i> (QObject)</dt> |
129 <dd> |
127 <dd> |
130 reference to the parent object |
128 reference to the parent object |
131 </dd> |
129 </dd> |
132 </dl> |
130 </dl> |
133 <a NAME="PreviewProcessingThread.__convertMarkdown" ID="PreviewProcessingThread.__convertMarkdown"></a> |
131 <a NAME="PreviewProcessingThread.__convertMarkdown" ID="PreviewProcessingThread.__convertMarkdown"></a> |
134 <h4>PreviewProcessingThread.__convertMarkdown</h4> |
132 <h4>PreviewProcessingThread.__convertMarkdown</h4> |
135 <b>__convertMarkdown</b>(<i>text, convertNewLineToBreak, usePyMdownExtensions, htmlFormat</i>) |
133 <b>__convertMarkdown</b>(<i>text, convertNewLineToBreak, usePyMdownExtensions, htmlFormat</i>) |
136 |
|
137 <p> |
134 <p> |
138 Private method to convert Markdown text into HTML. |
135 Private method to convert Markdown text into HTML. |
139 </p> |
136 </p> |
|
137 |
140 <dl> |
138 <dl> |
141 |
139 |
142 <dt><i>text</i> (str)</dt> |
140 <dt><i>text</i> (str)</dt> |
143 <dd> |
141 <dd> |
144 text to be processed |
142 text to be processed |
262 </dd> |
260 </dd> |
263 </dl> |
261 </dl> |
264 <a NAME="PreviewProcessingThread.__getHtml" ID="PreviewProcessingThread.__getHtml"></a> |
262 <a NAME="PreviewProcessingThread.__getHtml" ID="PreviewProcessingThread.__getHtml"></a> |
265 <h4>PreviewProcessingThread.__getHtml</h4> |
263 <h4>PreviewProcessingThread.__getHtml</h4> |
266 <b>__getHtml</b>(<i>language, text, ssiEnabled, filePath, rootPath, useSphinx, convertNewLineToBreak, usePyMdownExtensions, markdownHtmlFormat, restDocutilsHtmlFormat, </i>) |
264 <b>__getHtml</b>(<i>language, text, ssiEnabled, filePath, rootPath, useSphinx, convertNewLineToBreak, usePyMdownExtensions, markdownHtmlFormat, restDocutilsHtmlFormat, </i>) |
267 |
|
268 <p> |
265 <p> |
269 Private method to process the given text depending upon the given |
266 Private method to process the given text depending upon the given |
270 language. |
267 language. |
271 </p> |
268 </p> |
|
269 |
272 <dl> |
270 <dl> |
273 |
271 |
274 <dt><i>language</i> (str)</dt> |
272 <dt><i>language</i> (str)</dt> |
275 <dd> |
273 <dd> |
276 language of the text |
274 language of the text |
395 </dd> |
393 </dd> |
396 </dl> |
394 </dl> |
397 <a NAME="PreviewProcessingThread.process" ID="PreviewProcessingThread.process"></a> |
395 <a NAME="PreviewProcessingThread.process" ID="PreviewProcessingThread.process"></a> |
398 <h4>PreviewProcessingThread.process</h4> |
396 <h4>PreviewProcessingThread.process</h4> |
399 <b>process</b>(<i>filePath, language, text, ssiEnabled, rootPath, useSphinx, convertNewLineToBreak, usePyMdownExtensions, markdownHtmlFormat, restDocutilsHtmlFormat, </i>) |
397 <b>process</b>(<i>filePath, language, text, ssiEnabled, rootPath, useSphinx, convertNewLineToBreak, usePyMdownExtensions, markdownHtmlFormat, restDocutilsHtmlFormat, </i>) |
400 |
|
401 <p> |
398 <p> |
402 Public method to convert the given text to HTML. |
399 Public method to convert the given text to HTML. |
403 </p> |
400 </p> |
|
401 |
404 <dl> |
402 <dl> |
405 |
403 |
406 <dt><i>filePath</i> (str)</dt> |
404 <dt><i>filePath</i> (str)</dt> |
407 <dd> |
405 <dd> |
408 file path of the text |
406 file path of the text |
448 </dd> |
446 </dd> |
449 </dl> |
447 </dl> |
450 <a NAME="PreviewProcessingThread.run" ID="PreviewProcessingThread.run"></a> |
448 <a NAME="PreviewProcessingThread.run" ID="PreviewProcessingThread.run"></a> |
451 <h4>PreviewProcessingThread.run</h4> |
449 <h4>PreviewProcessingThread.run</h4> |
452 <b>run</b>(<i></i>) |
450 <b>run</b>(<i></i>) |
453 |
|
454 <p> |
451 <p> |
455 Public thread method to convert the stored data. |
452 Public thread method to convert the stored data. |
456 </p> |
453 </p> |
|
454 |
457 <div align="right"><a href="#top">Up</a></div> |
455 <div align="right"><a href="#top">Up</a></div> |
458 <hr /> |
456 <hr /> |
459 <hr /> |
457 <hr /> |
460 <a NAME="PreviewerHTML" ID="PreviewerHTML"></a> |
458 <a NAME="PreviewerHTML" ID="PreviewerHTML"></a> |
461 <h2>PreviewerHTML</h2> |
459 <h2>PreviewerHTML</h2> |
462 |
|
463 <p> |
460 <p> |
464 Class implementing a previewer widget for HTML, Markdown and ReST files. |
461 Class implementing a previewer widget for HTML, Markdown and ReST files. |
465 </p> |
462 </p> |
|
463 |
466 <h3>Derived from</h3> |
464 <h3>Derived from</h3> |
467 QWidget |
465 QWidget |
468 <h3>Class Attributes</h3> |
466 <h3>Class Attributes</h3> |
469 |
|
470 <table> |
467 <table> |
471 <tr><td>None</td></tr> |
468 <tr><td>None</td></tr> |
472 </table> |
469 </table> |
|
470 |
473 <h3>Class Methods</h3> |
471 <h3>Class Methods</h3> |
474 |
|
475 <table> |
472 <table> |
476 <tr><td>None</td></tr> |
473 <tr><td>None</td></tr> |
477 </table> |
474 </table> |
|
475 |
478 <h3>Methods</h3> |
476 <h3>Methods</h3> |
479 |
477 <table> |
480 <table> |
|
481 |
|
482 <tr> |
478 <tr> |
483 <td><a href="#PreviewerHTML.__init__">PreviewerHTML</a></td> |
479 <td><a href="#PreviewerHTML.__init__">PreviewerHTML</a></td> |
484 <td>Constructor</td> |
480 <td>Constructor</td> |
485 </tr> |
481 </tr> |
486 <tr> |
482 <tr> |
534 <tr> |
530 <tr> |
535 <td><a href="#PreviewerHTML.shutdown">shutdown</a></td> |
531 <td><a href="#PreviewerHTML.shutdown">shutdown</a></td> |
536 <td>Public method to perform shutdown actions.</td> |
532 <td>Public method to perform shutdown actions.</td> |
537 </tr> |
533 </tr> |
538 </table> |
534 </table> |
|
535 |
539 <h3>Static Methods</h3> |
536 <h3>Static Methods</h3> |
540 |
|
541 <table> |
537 <table> |
542 <tr><td>None</td></tr> |
538 <tr><td>None</td></tr> |
543 </table> |
539 </table> |
|
540 |
544 |
541 |
545 <a NAME="PreviewerHTML.__init__" ID="PreviewerHTML.__init__"></a> |
542 <a NAME="PreviewerHTML.__init__" ID="PreviewerHTML.__init__"></a> |
546 <h4>PreviewerHTML (Constructor)</h4> |
543 <h4>PreviewerHTML (Constructor)</h4> |
547 <b>PreviewerHTML</b>(<i>parent=None</i>) |
544 <b>PreviewerHTML</b>(<i>parent=None</i>) |
548 |
|
549 <p> |
545 <p> |
550 Constructor |
546 Constructor |
551 </p> |
547 </p> |
|
548 |
552 <dl> |
549 <dl> |
553 |
550 |
554 <dt><i>parent</i> (QWidget)</dt> |
551 <dt><i>parent</i> (QWidget)</dt> |
555 <dd> |
552 <dd> |
556 reference to the parent widget |
553 reference to the parent widget |
557 </dd> |
554 </dd> |
558 </dl> |
555 </dl> |
559 <a NAME="PreviewerHTML.__execJavaScript" ID="PreviewerHTML.__execJavaScript"></a> |
556 <a NAME="PreviewerHTML.__execJavaScript" ID="PreviewerHTML.__execJavaScript"></a> |
560 <h4>PreviewerHTML.__execJavaScript</h4> |
557 <h4>PreviewerHTML.__execJavaScript</h4> |
561 <b>__execJavaScript</b>(<i>script</i>) |
558 <b>__execJavaScript</b>(<i>script</i>) |
562 |
|
563 <p> |
559 <p> |
564 Private function to execute a JavaScript function Synchroneously. |
560 Private function to execute a JavaScript function Synchroneously. |
565 </p> |
561 </p> |
|
562 |
566 <dl> |
563 <dl> |
567 |
564 |
568 <dt><i>script</i> (str)</dt> |
565 <dt><i>script</i> (str)</dt> |
569 <dd> |
566 <dd> |
570 JavaScript script source to be executed |
567 JavaScript script source to be executed |
583 </dd> |
580 </dd> |
584 </dl> |
581 </dl> |
585 <a NAME="PreviewerHTML.__restoreScrollBarPositions" ID="PreviewerHTML.__restoreScrollBarPositions"></a> |
582 <a NAME="PreviewerHTML.__restoreScrollBarPositions" ID="PreviewerHTML.__restoreScrollBarPositions"></a> |
586 <h4>PreviewerHTML.__restoreScrollBarPositions</h4> |
583 <h4>PreviewerHTML.__restoreScrollBarPositions</h4> |
587 <b>__restoreScrollBarPositions</b>(<i></i>) |
584 <b>__restoreScrollBarPositions</b>(<i></i>) |
588 |
|
589 <p> |
585 <p> |
590 Private method to restore scroll bar positions for a previewed editor. |
586 Private method to restore scroll bar positions for a previewed editor. |
591 </p> |
587 </p> |
|
588 |
592 <a NAME="PreviewerHTML.__saveScrollBarPositions" ID="PreviewerHTML.__saveScrollBarPositions"></a> |
589 <a NAME="PreviewerHTML.__saveScrollBarPositions" ID="PreviewerHTML.__saveScrollBarPositions"></a> |
593 <h4>PreviewerHTML.__saveScrollBarPositions</h4> |
590 <h4>PreviewerHTML.__saveScrollBarPositions</h4> |
594 <b>__saveScrollBarPositions</b>(<i></i>) |
591 <b>__saveScrollBarPositions</b>(<i></i>) |
595 |
|
596 <p> |
592 <p> |
597 Private method to save scroll bar positions for a previewed editor. |
593 Private method to save scroll bar positions for a previewed editor. |
598 </p> |
594 </p> |
|
595 |
599 <a NAME="PreviewerHTML.__setHtml" ID="PreviewerHTML.__setHtml"></a> |
596 <a NAME="PreviewerHTML.__setHtml" ID="PreviewerHTML.__setHtml"></a> |
600 <h4>PreviewerHTML.__setHtml</h4> |
597 <h4>PreviewerHTML.__setHtml</h4> |
601 <b>__setHtml</b>(<i>filePath, html, rootPath</i>) |
598 <b>__setHtml</b>(<i>filePath, html, rootPath</i>) |
602 |
|
603 <p> |
599 <p> |
604 Private method to set the HTML to the view and restore the scroll bars |
600 Private method to set the HTML to the view and restore the scroll bars |
605 positions. |
601 positions. |
606 </p> |
602 </p> |
|
603 |
607 <dl> |
604 <dl> |
608 |
605 |
609 <dt><i>filePath</i> (str)</dt> |
606 <dt><i>filePath</i> (str)</dt> |
610 <dd> |
607 <dd> |
611 file path of the previewed editor |
608 file path of the previewed editor |
620 </dd> |
617 </dd> |
621 </dl> |
618 </dl> |
622 <a NAME="PreviewerHTML.__setJavaScriptEnabled" ID="PreviewerHTML.__setJavaScriptEnabled"></a> |
619 <a NAME="PreviewerHTML.__setJavaScriptEnabled" ID="PreviewerHTML.__setJavaScriptEnabled"></a> |
623 <h4>PreviewerHTML.__setJavaScriptEnabled</h4> |
620 <h4>PreviewerHTML.__setJavaScriptEnabled</h4> |
624 <b>__setJavaScriptEnabled</b>(<i>enable</i>) |
621 <b>__setJavaScriptEnabled</b>(<i>enable</i>) |
625 |
|
626 <p> |
622 <p> |
627 Private method to enable/disable JavaScript. |
623 Private method to enable/disable JavaScript. |
628 </p> |
624 </p> |
|
625 |
629 <dl> |
626 <dl> |
630 |
627 |
631 <dt><i>enable</i> (bool)</dt> |
628 <dt><i>enable</i> (bool)</dt> |
632 <dd> |
629 <dd> |
633 flag indicating the enable state |
630 flag indicating the enable state |
634 </dd> |
631 </dd> |
635 </dl> |
632 </dl> |
636 <a NAME="PreviewerHTML.__showLink" ID="PreviewerHTML.__showLink"></a> |
633 <a NAME="PreviewerHTML.__showLink" ID="PreviewerHTML.__showLink"></a> |
637 <h4>PreviewerHTML.__showLink</h4> |
634 <h4>PreviewerHTML.__showLink</h4> |
638 <b>__showLink</b>(<i>urlStr</i>) |
635 <b>__showLink</b>(<i>urlStr</i>) |
639 |
|
640 <p> |
636 <p> |
641 Private slot to show the hovered link in a tooltip. |
637 Private slot to show the hovered link in a tooltip. |
642 </p> |
638 </p> |
|
639 |
643 <dl> |
640 <dl> |
644 |
641 |
645 <dt><i>urlStr</i> (str)</dt> |
642 <dt><i>urlStr</i> (str)</dt> |
646 <dd> |
643 <dd> |
647 hovered URL |
644 hovered URL |
648 </dd> |
645 </dd> |
649 </dl> |
646 </dl> |
650 <a NAME="PreviewerHTML.on_htmlButton_clicked" ID="PreviewerHTML.on_htmlButton_clicked"></a> |
647 <a NAME="PreviewerHTML.on_htmlButton_clicked" ID="PreviewerHTML.on_htmlButton_clicked"></a> |
651 <h4>PreviewerHTML.on_htmlButton_clicked</h4> |
648 <h4>PreviewerHTML.on_htmlButton_clicked</h4> |
652 <b>on_htmlButton_clicked</b>(<i></i>) |
649 <b>on_htmlButton_clicked</b>(<i></i>) |
653 |
|
654 <p> |
650 <p> |
655 Private slot to copy the HTML contents to the clipboard. |
651 Private slot to copy the HTML contents to the clipboard. |
656 </p> |
652 </p> |
|
653 |
657 <a NAME="PreviewerHTML.on_jsCheckBox_clicked" ID="PreviewerHTML.on_jsCheckBox_clicked"></a> |
654 <a NAME="PreviewerHTML.on_jsCheckBox_clicked" ID="PreviewerHTML.on_jsCheckBox_clicked"></a> |
658 <h4>PreviewerHTML.on_jsCheckBox_clicked</h4> |
655 <h4>PreviewerHTML.on_jsCheckBox_clicked</h4> |
659 <b>on_jsCheckBox_clicked</b>(<i>checked</i>) |
656 <b>on_jsCheckBox_clicked</b>(<i>checked</i>) |
660 |
|
661 <p> |
657 <p> |
662 Private slot to enable/disable JavaScript. |
658 Private slot to enable/disable JavaScript. |
663 </p> |
659 </p> |
|
660 |
664 <dl> |
661 <dl> |
665 |
662 |
666 <dt><i>checked</i> (bool)</dt> |
663 <dt><i>checked</i> (bool)</dt> |
667 <dd> |
664 <dd> |
668 state of the checkbox |
665 state of the checkbox |
669 </dd> |
666 </dd> |
670 </dl> |
667 </dl> |
671 <a NAME="PreviewerHTML.on_previewView_titleChanged" ID="PreviewerHTML.on_previewView_titleChanged"></a> |
668 <a NAME="PreviewerHTML.on_previewView_titleChanged" ID="PreviewerHTML.on_previewView_titleChanged"></a> |
672 <h4>PreviewerHTML.on_previewView_titleChanged</h4> |
669 <h4>PreviewerHTML.on_previewView_titleChanged</h4> |
673 <b>on_previewView_titleChanged</b>(<i>title</i>) |
670 <b>on_previewView_titleChanged</b>(<i>title</i>) |
674 |
|
675 <p> |
671 <p> |
676 Private slot to handle a change of the title. |
672 Private slot to handle a change of the title. |
677 </p> |
673 </p> |
|
674 |
678 <dl> |
675 <dl> |
679 |
676 |
680 <dt><i>title</i> (str)</dt> |
677 <dt><i>title</i> (str)</dt> |
681 <dd> |
678 <dd> |
682 new title |
679 new title |
683 </dd> |
680 </dd> |
684 </dl> |
681 </dl> |
685 <a NAME="PreviewerHTML.on_ssiCheckBox_clicked" ID="PreviewerHTML.on_ssiCheckBox_clicked"></a> |
682 <a NAME="PreviewerHTML.on_ssiCheckBox_clicked" ID="PreviewerHTML.on_ssiCheckBox_clicked"></a> |
686 <h4>PreviewerHTML.on_ssiCheckBox_clicked</h4> |
683 <h4>PreviewerHTML.on_ssiCheckBox_clicked</h4> |
687 <b>on_ssiCheckBox_clicked</b>(<i>checked</i>) |
684 <b>on_ssiCheckBox_clicked</b>(<i>checked</i>) |
688 |
|
689 <p> |
685 <p> |
690 Private slot to enable/disable SSI. |
686 Private slot to enable/disable SSI. |
691 </p> |
687 </p> |
|
688 |
692 <dl> |
689 <dl> |
693 |
690 |
694 <dt><i>checked</i> (bool)</dt> |
691 <dt><i>checked</i> (bool)</dt> |
695 <dd> |
692 <dd> |
696 state of the checkbox |
693 state of the checkbox |
697 </dd> |
694 </dd> |
698 </dl> |
695 </dl> |
699 <a NAME="PreviewerHTML.processEditor" ID="PreviewerHTML.processEditor"></a> |
696 <a NAME="PreviewerHTML.processEditor" ID="PreviewerHTML.processEditor"></a> |
700 <h4>PreviewerHTML.processEditor</h4> |
697 <h4>PreviewerHTML.processEditor</h4> |
701 <b>processEditor</b>(<i>editor=None</i>) |
698 <b>processEditor</b>(<i>editor=None</i>) |
702 |
|
703 <p> |
699 <p> |
704 Public slot to process an editor's text. |
700 Public slot to process an editor's text. |
705 </p> |
701 </p> |
|
702 |
706 <dl> |
703 <dl> |
707 |
704 |
708 <dt><i>editor</i> (Editor)</dt> |
705 <dt><i>editor</i> (Editor)</dt> |
709 <dd> |
706 <dd> |
710 editor to be processed |
707 editor to be processed |