--- a/src/eric7/Documentation/Source/eric7.UI.Previewers.PreviewerHTML.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.UI.Previewers.PreviewerHTML.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,19 +7,17 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.UI.Previewers.PreviewerHTML</h1>
-
<p>
Module implementing a previewer widget for HTML, Markdown and ReST files.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#PreviewProcessingThread">PreviewProcessingThread</a></td>
<td>Class implementing a thread to process some text into HTML usable by the previewer view.</td>
@@ -29,20 +27,21 @@
<td>Class implementing a previewer widget for HTML, Markdown and ReST files.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="PreviewProcessingThread" ID="PreviewProcessingThread"></a>
<h2>PreviewProcessingThread</h2>
-
<p>
Class implementing a thread to process some text into HTML usable by the
previewer view.
</p>
+
<h3>Signals</h3>
<dl>
@@ -56,19 +55,17 @@
<h3>Derived from</h3>
QThread
<h3>Class Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#PreviewProcessingThread.__init__">PreviewProcessingThread</a></td>
<td>Constructor</td>
@@ -110,19 +107,20 @@
<td>Public thread method to convert the stored data.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="PreviewProcessingThread.__init__" ID="PreviewProcessingThread.__init__"></a>
<h4>PreviewProcessingThread (Constructor)</h4>
<b>PreviewProcessingThread</b>(<i>parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>parent</i> (QObject)</dt>
@@ -133,10 +131,10 @@
<a NAME="PreviewProcessingThread.__convertMarkdown" ID="PreviewProcessingThread.__convertMarkdown"></a>
<h4>PreviewProcessingThread.__convertMarkdown</h4>
<b>__convertMarkdown</b>(<i>text, convertNewLineToBreak, usePyMdownExtensions, htmlFormat</i>)
-
<p>
Private method to convert Markdown text into HTML.
</p>
+
<dl>
<dt><i>text</i> (str)</dt>
@@ -173,10 +171,10 @@
<a NAME="PreviewProcessingThread.__convertReST" ID="PreviewProcessingThread.__convertReST"></a>
<h4>PreviewProcessingThread.__convertReST</h4>
<b>__convertReST</b>(<i>text, useSphinx, restDocutilsHtmlFormat</i>)
-
<p>
Private method to convert ReST text into HTML.
</p>
+
<dl>
<dt><i>text</i> (str)</dt>
@@ -208,10 +206,10 @@
<a NAME="PreviewProcessingThread.__convertReSTDocutils" ID="PreviewProcessingThread.__convertReSTDocutils"></a>
<h4>PreviewProcessingThread.__convertReSTDocutils</h4>
<b>__convertReSTDocutils</b>(<i>text, htmlFormat</i>)
-
<p>
Private method to convert ReST text into HTML using 'docutils'.
</p>
+
<dl>
<dt><i>text</i> (str)</dt>
@@ -238,10 +236,10 @@
<a NAME="PreviewProcessingThread.__convertReSTSphinx" ID="PreviewProcessingThread.__convertReSTSphinx"></a>
<h4>PreviewProcessingThread.__convertReSTSphinx</h4>
<b>__convertReSTSphinx</b>(<i>text</i>)
-
<p>
Private method to convert ReST text into HTML using 'sphinx'.
</p>
+
<dl>
<dt><i>text</i> (str)</dt>
@@ -264,11 +262,11 @@
<a NAME="PreviewProcessingThread.__getHtml" ID="PreviewProcessingThread.__getHtml"></a>
<h4>PreviewProcessingThread.__getHtml</h4>
<b>__getHtml</b>(<i>language, text, ssiEnabled, filePath, rootPath, useSphinx, convertNewLineToBreak, usePyMdownExtensions, markdownHtmlFormat, restDocutilsHtmlFormat, </i>)
-
<p>
Private method to process the given text depending upon the given
language.
</p>
+
<dl>
<dt><i>language</i> (str)</dt>
@@ -330,10 +328,10 @@
<a NAME="PreviewProcessingThread.__processRootPath" ID="PreviewProcessingThread.__processRootPath"></a>
<h4>PreviewProcessingThread.__processRootPath</h4>
<b>__processRootPath</b>(<i>txt, root</i>)
-
<p>
Private method to adjust absolute references to the given root path.
</p>
+
<dl>
<dt><i>txt</i> (str)</dt>
@@ -360,13 +358,13 @@
<a NAME="PreviewProcessingThread.__processSSI" ID="PreviewProcessingThread.__processSSI"></a>
<h4>PreviewProcessingThread.__processSSI</h4>
<b>__processSSI</b>(<i>txt, filename, root</i>)
-
<p>
Private method to process the given text for SSI statements.
</p>
<p>
Note: Only a limited subset of SSI statements are supported.
</p>
+
<dl>
<dt><i>txt</i> (str)</dt>
@@ -397,10 +395,10 @@
<a NAME="PreviewProcessingThread.process" ID="PreviewProcessingThread.process"></a>
<h4>PreviewProcessingThread.process</h4>
<b>process</b>(<i>filePath, language, text, ssiEnabled, rootPath, useSphinx, convertNewLineToBreak, usePyMdownExtensions, markdownHtmlFormat, restDocutilsHtmlFormat, </i>)
-
<p>
Public method to convert the given text to HTML.
</p>
+
<dl>
<dt><i>filePath</i> (str)</dt>
@@ -450,35 +448,33 @@
<a NAME="PreviewProcessingThread.run" ID="PreviewProcessingThread.run"></a>
<h4>PreviewProcessingThread.run</h4>
<b>run</b>(<i></i>)
-
<p>
Public thread method to convert the stored data.
</p>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="PreviewerHTML" ID="PreviewerHTML"></a>
<h2>PreviewerHTML</h2>
-
<p>
Class implementing a previewer widget for HTML, Markdown and ReST files.
</p>
+
<h3>Derived from</h3>
QWidget
<h3>Class Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#PreviewerHTML.__init__">PreviewerHTML</a></td>
<td>Constructor</td>
@@ -536,19 +532,20 @@
<td>Public method to perform shutdown actions.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="PreviewerHTML.__init__" ID="PreviewerHTML.__init__"></a>
<h4>PreviewerHTML (Constructor)</h4>
<b>PreviewerHTML</b>(<i>parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>parent</i> (QWidget)</dt>
@@ -559,10 +556,10 @@
<a NAME="PreviewerHTML.__execJavaScript" ID="PreviewerHTML.__execJavaScript"></a>
<h4>PreviewerHTML.__execJavaScript</h4>
<b>__execJavaScript</b>(<i>script</i>)
-
<p>
Private function to execute a JavaScript function Synchroneously.
</p>
+
<dl>
<dt><i>script</i> (str)</dt>
@@ -585,25 +582,25 @@
<a NAME="PreviewerHTML.__restoreScrollBarPositions" ID="PreviewerHTML.__restoreScrollBarPositions"></a>
<h4>PreviewerHTML.__restoreScrollBarPositions</h4>
<b>__restoreScrollBarPositions</b>(<i></i>)
-
<p>
Private method to restore scroll bar positions for a previewed editor.
</p>
+
<a NAME="PreviewerHTML.__saveScrollBarPositions" ID="PreviewerHTML.__saveScrollBarPositions"></a>
<h4>PreviewerHTML.__saveScrollBarPositions</h4>
<b>__saveScrollBarPositions</b>(<i></i>)
-
<p>
Private method to save scroll bar positions for a previewed editor.
</p>
+
<a NAME="PreviewerHTML.__setHtml" ID="PreviewerHTML.__setHtml"></a>
<h4>PreviewerHTML.__setHtml</h4>
<b>__setHtml</b>(<i>filePath, html, rootPath</i>)
-
<p>
Private method to set the HTML to the view and restore the scroll bars
positions.
</p>
+
<dl>
<dt><i>filePath</i> (str)</dt>
@@ -622,10 +619,10 @@
<a NAME="PreviewerHTML.__setJavaScriptEnabled" ID="PreviewerHTML.__setJavaScriptEnabled"></a>
<h4>PreviewerHTML.__setJavaScriptEnabled</h4>
<b>__setJavaScriptEnabled</b>(<i>enable</i>)
-
<p>
Private method to enable/disable JavaScript.
</p>
+
<dl>
<dt><i>enable</i> (bool)</dt>
@@ -636,10 +633,10 @@
<a NAME="PreviewerHTML.__showLink" ID="PreviewerHTML.__showLink"></a>
<h4>PreviewerHTML.__showLink</h4>
<b>__showLink</b>(<i>urlStr</i>)
-
<p>
Private slot to show the hovered link in a tooltip.
</p>
+
<dl>
<dt><i>urlStr</i> (str)</dt>
@@ -650,17 +647,17 @@
<a NAME="PreviewerHTML.on_htmlButton_clicked" ID="PreviewerHTML.on_htmlButton_clicked"></a>
<h4>PreviewerHTML.on_htmlButton_clicked</h4>
<b>on_htmlButton_clicked</b>(<i></i>)
-
<p>
Private slot to copy the HTML contents to the clipboard.
</p>
+
<a NAME="PreviewerHTML.on_jsCheckBox_clicked" ID="PreviewerHTML.on_jsCheckBox_clicked"></a>
<h4>PreviewerHTML.on_jsCheckBox_clicked</h4>
<b>on_jsCheckBox_clicked</b>(<i>checked</i>)
-
<p>
Private slot to enable/disable JavaScript.
</p>
+
<dl>
<dt><i>checked</i> (bool)</dt>
@@ -671,10 +668,10 @@
<a NAME="PreviewerHTML.on_previewView_titleChanged" ID="PreviewerHTML.on_previewView_titleChanged"></a>
<h4>PreviewerHTML.on_previewView_titleChanged</h4>
<b>on_previewView_titleChanged</b>(<i>title</i>)
-
<p>
Private slot to handle a change of the title.
</p>
+
<dl>
<dt><i>title</i> (str)</dt>
@@ -685,10 +682,10 @@
<a NAME="PreviewerHTML.on_ssiCheckBox_clicked" ID="PreviewerHTML.on_ssiCheckBox_clicked"></a>
<h4>PreviewerHTML.on_ssiCheckBox_clicked</h4>
<b>on_ssiCheckBox_clicked</b>(<i>checked</i>)
-
<p>
Private slot to enable/disable SSI.
</p>
+
<dl>
<dt><i>checked</i> (bool)</dt>
@@ -699,10 +696,10 @@
<a NAME="PreviewerHTML.processEditor" ID="PreviewerHTML.processEditor"></a>
<h4>PreviewerHTML.processEditor</h4>
<b>processEditor</b>(<i>editor=None</i>)
-
<p>
Public slot to process an editor's text.
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -717,10 +714,10 @@
<a NAME="PreviewerHTML.shutdown" ID="PreviewerHTML.shutdown"></a>
<h4>PreviewerHTML.shutdown</h4>
<b>shutdown</b>(<i></i>)
-
<p>
Public method to perform shutdown actions.
</p>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
