Mercurial Repositories > eric / file comparison

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

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

changeset 7301
6df711503ec0
parent 7273
391d6b7b1eff
child 7314
c32c24345ca7
equal deleted inserted replaced
7300:7622b6330e62 7301:6df711503ec0
41 <tr> 41 <tr>
42 <td><a href="#PreviewerHTML">PreviewerHTML</a></td> 42 <td><a href="#PreviewerHTML">PreviewerHTML</a></td>
43 <td>Class implementing a previewer widget for HTML, Markdown and ReST files.</td> 43 <td>Class implementing a previewer widget for HTML, Markdown and ReST files.</td>
44 </tr> 44 </tr>
45 <tr> 45 <tr>
46 <td><a href="#_StrikeThroughExtension">_StrikeThroughExtension</a></td> 46 <td><a href="#_CaretExtension">_CaretExtension</a></td>
47 <td>Class is placed here, because it depends on imported markdown, and markdown import is lazy.</td>
48 </tr>
49 <tr>
50 <td><a href="#_MarkExtension">_MarkExtension</a></td>
51 <td>Class is placed here, because it depends on imported markdown, and markdown import is lazy.</td>
52 </tr>
53 <tr>
54 <td><a href="#_TildeExtension">_TildeExtension</a></td>
47 <td>Class is placed here, because it depends on imported markdown, and markdown import is lazy.</td> 55 <td>Class is placed here, because it depends on imported markdown, and markdown import is lazy.</td>
48 </tr> 56 </tr>
49 </table> 57 </table>
50 <h3>Functions</h3> 58 <h3>Functions</h3>
51 59
148 reference to the parent object (QObject) 156 reference to the parent object (QObject)
149 </dd> 157 </dd>
150 </dl> 158 </dl>
151 <a NAME="PreviewProcessingThread.__convertMarkdown" ID="PreviewProcessingThread.__convertMarkdown"></a> 159 <a NAME="PreviewProcessingThread.__convertMarkdown" ID="PreviewProcessingThread.__convertMarkdown"></a>
152 <h4>PreviewProcessingThread.__convertMarkdown</h4> 160 <h4>PreviewProcessingThread.__convertMarkdown</h4>
153 <b>__convertMarkdown</b>(<i>text, convertNewLineToBreak, htmlFormat</i>) 161 <b>__convertMarkdown</b>(<i>text, convertNewLineToBreak, usePyMdownExtensions, htmlFormat</i>)
154 162
155 <p> 163 <p>
156 Private method to convert Markdown text into HTML. 164 Private method to convert Markdown text into HTML.
157 </p> 165 </p>
158 <dl> 166 <dl>
159 167
160 <dt><i>text</i></dt> 168 <dt><i>text</i> (str)</dt>
161 <dd> 169 <dd>
162 text to be processed (string) 170 text to be processed
163 </dd> 171 </dd>
164 <dt><i>convertNewLineToBreak</i></dt> 172 <dt><i>convertNewLineToBreak</i> (bool)</dt>
165 <dd> 173 <dd>
166 flag indicating to convert new lines 174 flag indicating to convert new lines
167 to HTML break (Markdown only) (boolean) 175 to HTML break (Markdown only)
168 </dd> 176 </dd>
169 <dt><i>htmlFormat</i></dt> 177 <dt><i>usePyMdownExtensions</i> (bool)</dt>
170 <dd> 178 <dd>
171 HTML format to be generated by markdown (string) 179 flag indicating to enable the PyMdown
180 extensions, if they are available
181 </dd>
182 <dt><i>htmlFormat</i> (str)</dt>
183 <dd>
184 HTML format to be generated by markdown
172 </dd> 185 </dd>
173 </dl> 186 </dl>
174 <dl> 187 <dl>
175 <dt>Returns:</dt> 188 <dt>Returns:</dt>
176 <dd> 189 <dd>
177 processed HTML (string) 190 processed HTML
191 </dd>
192 </dl>
193 <dl>
194 <dt>Return Type:</dt>
195 <dd>
196 str
178 </dd> 197 </dd>
179 </dl> 198 </dl>
180 <a NAME="PreviewProcessingThread.__convertReST" ID="PreviewProcessingThread.__convertReST"></a> 199 <a NAME="PreviewProcessingThread.__convertReST" ID="PreviewProcessingThread.__convertReST"></a>
181 <h4>PreviewProcessingThread.__convertReST</h4> 200 <h4>PreviewProcessingThread.__convertReST</h4>
182 <b>__convertReST</b>(<i>text, useSphinx, restDocutilsHtmlFormat</i>) 201 <b>__convertReST</b>(<i>text, useSphinx, restDocutilsHtmlFormat</i>)
251 processed HTML (string) 270 processed HTML (string)
252 </dd> 271 </dd>
253 </dl> 272 </dl>
254 <a NAME="PreviewProcessingThread.__getHtml" ID="PreviewProcessingThread.__getHtml"></a> 273 <a NAME="PreviewProcessingThread.__getHtml" ID="PreviewProcessingThread.__getHtml"></a>
255 <h4>PreviewProcessingThread.__getHtml</h4> 274 <h4>PreviewProcessingThread.__getHtml</h4>
256 <b>__getHtml</b>(<i>language, text, ssiEnabled, filePath, rootPath, useSphinx, convertNewLineToBreak, markdownHtmlFormat, restDocutilsHtmlFormat</i>) 275 <b>__getHtml</b>(<i>language, text, ssiEnabled, filePath, rootPath, useSphinx, convertNewLineToBreak, usePyMdownExtensions, markdownHtmlFormat, restDocutilsHtmlFormat</i>)
257 276
258 <p> 277 <p>
259 Private method to process the given text depending upon the given 278 Private method to process the given text depending upon the given
260 language. 279 language.
261 </p> 280 </p>
262 <dl> 281 <dl>
263 282
264 <dt><i>language</i></dt> 283 <dt><i>language</i> (str)</dt>
265 <dd> 284 <dd>
266 language of the text (string) 285 language of the text
267 </dd> 286 </dd>
268 <dt><i>text</i></dt> 287 <dt><i>text</i> (str)</dt>
269 <dd> 288 <dd>
270 to be processed (string) 289 to be processed
271 </dd> 290 </dd>
272 <dt><i>ssiEnabled</i></dt> 291 <dt><i>ssiEnabled</i> (bool)</dt>
273 <dd> 292 <dd>
274 flag indicating to do some (limited) SSI processing 293 flag indicating to do some (limited) SSI processing
275 (boolean) 294 </dd>
276 </dd> 295 <dt><i>filePath</i> (str)</dt>
277 <dt><i>filePath</i></dt> 296 <dd>
278 <dd> 297 file path of the text
279 file path of the text (string) 298 </dd>
280 </dd> 299 <dt><i>rootPath</i> (str)</dt>
281 <dt><i>rootPath</i></dt> 300 <dd>
282 <dd> 301 root path to be used for SSI processing
283 root path to be used for SSI processing (str) 302 </dd>
284 </dd> 303 <dt><i>useSphinx</i> (bool)</dt>
285 <dt><i>useSphinx</i></dt>
286 <dd> 304 <dd>
287 flag indicating to use Sphinx to generate the 305 flag indicating to use Sphinx to generate the
288 ReST preview (boolean) 306 ReST preview
289 </dd> 307 </dd>
290 <dt><i>convertNewLineToBreak</i></dt> 308 <dt><i>convertNewLineToBreak</i> (bool)</dt>
291 <dd> 309 <dd>
292 flag indicating to convert new lines 310 flag indicating to convert new lines
293 to HTML break (Markdown only) (boolean) 311 to HTML break (Markdown only)
294 </dd> 312 </dd>
295 <dt><i>markdownHtmlFormat</i></dt> 313 <dt><i>usePyMdownExtensions</i> (bool)</dt>
314 <dd>
315 flag indicating to enable the PyMdown
316 extensions, if they are available
317 </dd>
318 <dt><i>markdownHtmlFormat</i> (str)</dt>
296 <dd> 319 <dd>
297 HTML format to be generated by markdown 320 HTML format to be generated by markdown
298 (string) 321 </dd>
299 </dd> 322 <dt><i>restDocutilsHtmlFormat</i> (str)</dt>
300 <dt><i>restDocutilsHtmlFormat</i></dt>
301 <dd> 323 <dd>
302 HTML format to be generated by docutils 324 HTML format to be generated by docutils
303 (string)
304 </dd> 325 </dd>
305 </dl> 326 </dl>
306 <dl> 327 <dl>
307 <dt>Returns:</dt> 328 <dt>Returns:</dt>
308 <dd> 329 <dd>
309 processed HTML text (string) 330 processed HTML text
331 </dd>
332 </dl>
333 <dl>
334 <dt>Return Type:</dt>
335 <dd>
336 str
310 </dd> 337 </dd>
311 </dl> 338 </dl>
312 <a NAME="PreviewProcessingThread.__processRootPath" ID="PreviewProcessingThread.__processRootPath"></a> 339 <a NAME="PreviewProcessingThread.__processRootPath" ID="PreviewProcessingThread.__processRootPath"></a>
313 <h4>PreviewProcessingThread.__processRootPath</h4> 340 <h4>PreviewProcessingThread.__processRootPath</h4>
314 <b>__processRootPath</b>(<i>txt, root</i>) 341 <b>__processRootPath</b>(<i>txt, root</i>)
371 processed HTML (string) 398 processed HTML (string)
372 </dd> 399 </dd>
373 </dl> 400 </dl>
374 <a NAME="PreviewProcessingThread.process" ID="PreviewProcessingThread.process"></a> 401 <a NAME="PreviewProcessingThread.process" ID="PreviewProcessingThread.process"></a>
375 <h4>PreviewProcessingThread.process</h4> 402 <h4>PreviewProcessingThread.process</h4>
376 <b>process</b>(<i>filePath, language, text, ssiEnabled, rootPath, useSphinx, convertNewLineToBreak, markdownHtmlFormat, restDocutilsHtmlFormat</i>) 403 <b>process</b>(<i>filePath, language, text, ssiEnabled, rootPath, useSphinx, convertNewLineToBreak, usePyMdownExtensions, markdownHtmlFormat, restDocutilsHtmlFormat</i>)
377 404
378 <p> 405 <p>
379 Public method to convert the given text to HTML. 406 Public method to convert the given text to HTML.
380 </p> 407 </p>
381 <dl> 408 <dl>
382 409
383 <dt><i>filePath</i></dt> 410 <dt><i>filePath</i> (str)</dt>
384 <dd> 411 <dd>
385 file path of the text (string) 412 file path of the text
386 </dd> 413 </dd>
387 <dt><i>language</i></dt> 414 <dt><i>language</i> (str)</dt>
388 <dd> 415 <dd>
389 language of the text (string) 416 language of the text
390 </dd> 417 </dd>
391 <dt><i>text</i></dt> 418 <dt><i>text</i> (str)</dt>
392 <dd> 419 <dd>
393 text to be processed (string) 420 text to be processed
394 </dd> 421 </dd>
395 <dt><i>ssiEnabled</i></dt> 422 <dt><i>ssiEnabled</i> (bool)</dt>
396 <dd> 423 <dd>
397 flag indicating to do some (limited) SSI processing 424 flag indicating to do some (limited) SSI processing
398 (boolean) 425 </dd>
399 </dd> 426 <dt><i>rootPath</i> (str)</dt>
400 <dt><i>rootPath</i></dt> 427 <dd>
401 <dd> 428 root path to be used for SSI processing
402 root path to be used for SSI processing (str) 429 </dd>
403 </dd> 430 <dt><i>useSphinx</i> (bool)</dt>
404 <dt><i>useSphinx</i></dt>
405 <dd> 431 <dd>
406 flag indicating to use Sphinx to generate the 432 flag indicating to use Sphinx to generate the
407 ReST preview (boolean) 433 ReST preview
408 </dd> 434 </dd>
409 <dt><i>convertNewLineToBreak</i></dt> 435 <dt><i>convertNewLineToBreak</i> (bool)</dt>
410 <dd> 436 <dd>
411 flag indicating to convert new lines 437 flag indicating to convert new lines
412 to HTML break (Markdown only) (boolean) 438 to HTML break (Markdown only)
413 </dd> 439 </dd>
414 <dt><i>markdownHtmlFormat</i></dt> 440 <dt><i>usePyMdownExtensions</i> (bool)</dt>
441 <dd>
442 flag indicating to enable the PyMdown
443 extensions, if they are available
444 </dd>
445 <dt><i>markdownHtmlFormat</i> (str)</dt>
415 <dd> 446 <dd>
416 HTML format to be generated by markdown 447 HTML format to be generated by markdown
417 (string) 448 </dd>
418 </dd> 449 <dt><i>restDocutilsHtmlFormat</i> (str)</dt>
419 <dt><i>restDocutilsHtmlFormat</i></dt>
420 <dd> 450 <dd>
421 HTML format to be generated by docutils 451 HTML format to be generated by docutils
422 (string)
423 </dd> 452 </dd>
424 </dl> 453 </dl>
425 <a NAME="PreviewProcessingThread.run" ID="PreviewProcessingThread.run"></a> 454 <a NAME="PreviewProcessingThread.run" ID="PreviewProcessingThread.run"></a>
426 <h4>PreviewProcessingThread.run</h4> 455 <h4>PreviewProcessingThread.run</h4>
427 <b>run</b>(<i></i>) 456 <b>run</b>(<i></i>)
686 Public method to perform shutdown actions. 715 Public method to perform shutdown actions.
687 </p> 716 </p>
688 <div align="right"><a href="#top">Up</a></div> 717 <div align="right"><a href="#top">Up</a></div>
689 <hr /> 718 <hr />
690 <hr /> 719 <hr />
691 <a NAME="_StrikeThroughExtension" ID="_StrikeThroughExtension"></a> 720 <a NAME="_CaretExtension" ID="_CaretExtension"></a>
692 <h2>_StrikeThroughExtension</h2> 721 <h2>_CaretExtension</h2>
693 722
694 <p> 723 <p>
695 Class is placed here, because it depends on imported markdown, 724 Class is placed here, because it depends on imported
696 and markdown import is lazy. 725 markdown, and markdown import is lazy.
697 </p> 726 </p>
698 <p> 727 <p>
699 (see https://pythonhosted.org/Markdown/extensions/api.html 728 (see https://pythonhosted.org/Markdown/extensions/api.html
700 this page for details) 729 this page for details)
701 </p> 730 </p>
702 <h3>Derived from</h3> 731 <h3>Derived from</h3>
703 markdown.Extension 732 markdown.Extension
704 <h3>Class Attributes</h3> 733 <h3>Class Attributes</h3>
705 734
706 <table> 735 <table>
707 <tr><td>DEL_RE</td></tr> 736 <tr><td>INS_RE</td></tr><tr><td>SUP_RE</td></tr>
708 </table> 737 </table>
709 <h3>Class Methods</h3> 738 <h3>Class Methods</h3>
710 739
711 <table> 740 <table>
712 <tr><td>None</td></tr> 741 <tr><td>None</td></tr>
714 <h3>Methods</h3> 743 <h3>Methods</h3>
715 744
716 <table> 745 <table>
717 746
718 <tr> 747 <tr>
719 <td><a href="#_StrikeThroughExtension.extendMarkdown">extendMarkdown</a></td> 748 <td><a href="#_CaretExtension.extendMarkdown">extendMarkdown</a></td>
720 <td></td> 749 <td></td>
721 </tr> 750 </tr>
722 </table> 751 </table>
723 <h3>Static Methods</h3> 752 <h3>Static Methods</h3>
724 753
725 <table> 754 <table>
726 <tr><td>None</td></tr> 755 <tr><td>None</td></tr>
727 </table> 756 </table>
728 757
729 <a NAME="_StrikeThroughExtension.extendMarkdown" ID="_StrikeThroughExtension.extendMarkdown"></a> 758 <a NAME="_CaretExtension.extendMarkdown" ID="_CaretExtension.extendMarkdown"></a>
730 <h4>_StrikeThroughExtension.extendMarkdown</h4> 759 <h4>_CaretExtension.extendMarkdown</h4>
731 <b>extendMarkdown</b>(<i>md, md_globals</i>) 760 <b>extendMarkdown</b>(<i>md, md_globals</i>)
732 761
733 <div align="right"><a href="#top">Up</a></div> 762 <div align="right"><a href="#top">Up</a></div>
734 <hr /> 763 <hr />
764 <hr />
765 <a NAME="_MarkExtension" ID="_MarkExtension"></a>
766 <h2>_MarkExtension</h2>
767
768 <p>
769 Class is placed here, because it depends on imported
770 markdown, and markdown import is lazy.
771 </p>
772 <p>
773 (see https://pythonhosted.org/Markdown/extensions/api.html
774 this page for details)
775 </p>
776 <h3>Derived from</h3>
777 markdown.Extension
778 <h3>Class Attributes</h3>
779
780 <table>
781 <tr><td>MARK_RE</td></tr>
782 </table>
783 <h3>Class Methods</h3>
784
785 <table>
786 <tr><td>None</td></tr>
787 </table>
788 <h3>Methods</h3>
789
790 <table>
791
792 <tr>
793 <td><a href="#_MarkExtension.extendMarkdown">extendMarkdown</a></td>
794 <td></td>
795 </tr>
796 </table>
797 <h3>Static Methods</h3>
798
799 <table>
800 <tr><td>None</td></tr>
801 </table>
802
803 <a NAME="_MarkExtension.extendMarkdown" ID="_MarkExtension.extendMarkdown"></a>
804 <h4>_MarkExtension.extendMarkdown</h4>
805 <b>extendMarkdown</b>(<i>md, md_globals</i>)
806
807 <div align="right"><a href="#top">Up</a></div>
808 <hr />
809 <hr />
810 <a NAME="_TildeExtension" ID="_TildeExtension"></a>
811 <h2>_TildeExtension</h2>
812
813 <p>
814 Class is placed here, because it depends on imported
815 markdown, and markdown import is lazy.
816 </p>
817 <p>
818 (see https://pythonhosted.org/Markdown/extensions/api.html
819 this page for details)
820 </p>
821 <h3>Derived from</h3>
822 markdown.Extension
823 <h3>Class Attributes</h3>
824
825 <table>
826 <tr><td>DEL_RE</td></tr><tr><td>SUB_RE</td></tr>
827 </table>
828 <h3>Class Methods</h3>
829
830 <table>
831 <tr><td>None</td></tr>
832 </table>
833 <h3>Methods</h3>
834
835 <table>
836
837 <tr>
838 <td><a href="#_TildeExtension.extendMarkdown">extendMarkdown</a></td>
839 <td></td>
840 </tr>
841 </table>
842 <h3>Static Methods</h3>
843
844 <table>
845 <tr><td>None</td></tr>
846 </table>
847
848 <a NAME="_TildeExtension.extendMarkdown" ID="_TildeExtension.extendMarkdown"></a>
849 <h4>_TildeExtension.extendMarkdown</h4>
850 <b>extendMarkdown</b>(<i>md, md_globals</i>)
851
852 <div align="right"><a href="#top">Up</a></div>
853 <hr />
735 </body></html> 854 </body></html>

Mercurial Repository: eric

eric ide

mercurial