--- a/src/eric7/Documentation/Source/eric7.UI.CodeDocumentationViewer.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.UI.CodeDocumentationViewer.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,20 +7,18 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.UI.CodeDocumentationViewer</h1>
-
<p>
Module implementing a widget to show some source code information provided by
plug-ins.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#CodeDocumentationViewer">CodeDocumentationViewer</a></td>
<td>Class implementing a widget to show some source code information provided by plug-ins.</td>
@@ -30,20 +28,21 @@
<td>Class implementing a rich text documentation viewer.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="CodeDocumentationViewer" ID="CodeDocumentationViewer"></a>
<h2>CodeDocumentationViewer</h2>
-
<p>
Class implementing a widget to show some source code information provided
by plug-ins.
</p>
+
<h3>Signals</h3>
<dl>
@@ -60,19 +59,17 @@
<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="#CodeDocumentationViewer.__init__">CodeDocumentationViewer</a></td>
<td>Constructor</td>
@@ -138,19 +135,20 @@
<td>Public method register a source docu provider.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="CodeDocumentationViewer.__init__" ID="CodeDocumentationViewer.__init__"></a>
<h4>CodeDocumentationViewer (Constructor)</h4>
<b>CodeDocumentationViewer</b>(<i>parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>parent</i> (QWidget)</dt>
@@ -161,10 +159,10 @@
<a NAME="CodeDocumentationViewer.__selectProvider" ID="CodeDocumentationViewer.__selectProvider"></a>
<h4>CodeDocumentationViewer.__selectProvider</h4>
<b>__selectProvider</b>(<i>provider</i>)
-
<p>
Private method to select a provider programmatically.
</p>
+
<dl>
<dt><i>provider</i> (str)</dt>
@@ -175,28 +173,27 @@
<a NAME="CodeDocumentationViewer.__setupUi" ID="CodeDocumentationViewer.__setupUi"></a>
<h4>CodeDocumentationViewer.__setupUi</h4>
<b>__setupUi</b>(<i></i>)
-
<p>
Private method to generate the UI layout.
</p>
+
<a NAME="CodeDocumentationViewer.__showDisabledMessage" ID="CodeDocumentationViewer.__showDisabledMessage"></a>
<h4>CodeDocumentationViewer.__showDisabledMessage</h4>
<b>__showDisabledMessage</b>(<i></i>)
-
<p>
Private method to show a message giving the reason for being disabled.
</p>
+
<a NAME="CodeDocumentationViewer.__unregisterTimerTimeout" ID="CodeDocumentationViewer.__unregisterTimerTimeout"></a>
<h4>CodeDocumentationViewer.__unregisterTimerTimeout</h4>
<b>__unregisterTimerTimeout</b>(<i></i>)
-
<p>
Private slot handling the timeout signal of the unregister timer.
</p>
+
<a NAME="CodeDocumentationViewer.documentationReady" ID="CodeDocumentationViewer.documentationReady"></a>
<h4>CodeDocumentationViewer.documentationReady</h4>
<b>documentationReady</b>(<i>documentationInfo, isWarning=False, isDocWarning=False</i>)
-
<p>
Public method to provide the documentation info to the viewer.
</p>
@@ -212,6 +209,7 @@
docstring: its documentation string
typ: its type information
</p>
+
<dl>
<dt><i>documentationInfo</i> (dict or str)</dt>
@@ -230,17 +228,17 @@
<a NAME="CodeDocumentationViewer.finalizeSetup" ID="CodeDocumentationViewer.finalizeSetup"></a>
<h4>CodeDocumentationViewer.finalizeSetup</h4>
<b>finalizeSetup</b>(<i></i>)
-
<p>
Public method to finalize the setup of the documentation viewer.
</p>
+
<a NAME="CodeDocumentationViewer.getProviders" ID="CodeDocumentationViewer.getProviders"></a>
<h4>CodeDocumentationViewer.getProviders</h4>
<b>getProviders</b>(<i></i>)
-
<p>
Public method to get a list of providers and their visible strings.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -256,10 +254,10 @@
<a NAME="CodeDocumentationViewer.isEnabled" ID="CodeDocumentationViewer.isEnabled"></a>
<h4>CodeDocumentationViewer.isEnabled</h4>
<b>isEnabled</b>(<i></i>)
-
<p>
Public method to check, if the code documentation viewer is enabled.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -275,11 +273,11 @@
<a NAME="CodeDocumentationViewer.isSupportedLanguage" ID="CodeDocumentationViewer.isSupportedLanguage"></a>
<h4>CodeDocumentationViewer.isSupportedLanguage</h4>
<b>isSupportedLanguage</b>(<i>language</i>)
-
<p>
Public method to check, if the given language is supported by the
selected provider.
</p>
+
<dl>
<dt><i>language</i> (str)</dt>
@@ -302,10 +300,10 @@
<a NAME="CodeDocumentationViewer.on_providerComboBox_currentIndexChanged" ID="CodeDocumentationViewer.on_providerComboBox_currentIndexChanged"></a>
<h4>CodeDocumentationViewer.on_providerComboBox_currentIndexChanged</h4>
<b>on_providerComboBox_currentIndexChanged</b>(<i>index</i>)
-
<p>
Private slot to handle the selection of a provider.
</p>
+
<dl>
<dt><i>index</i> (int)</dt>
@@ -316,17 +314,17 @@
<a NAME="CodeDocumentationViewer.preferencesChanged" ID="CodeDocumentationViewer.preferencesChanged"></a>
<h4>CodeDocumentationViewer.preferencesChanged</h4>
<b>preferencesChanged</b>(<i></i>)
-
<p>
Public slot to handle a change of preferences.
</p>
+
<a NAME="CodeDocumentationViewer.registerProvider" ID="CodeDocumentationViewer.registerProvider"></a>
<h4>CodeDocumentationViewer.registerProvider</h4>
<b>registerProvider</b>(<i>providerName, providerDisplay, provider, supported</i>)
-
<p>
Public method register a source docu provider.
</p>
+
<dl>
<dt><i>providerName</i> (str)</dt>
@@ -358,10 +356,10 @@
<a NAME="CodeDocumentationViewer.showInfo" ID="CodeDocumentationViewer.showInfo"></a>
<h4>CodeDocumentationViewer.showInfo</h4>
<b>showInfo</b>(<i>editor</i>)
-
<p>
Public method to request code documentation data from a provider.
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -372,17 +370,17 @@
<a NAME="CodeDocumentationViewer.shutdown" ID="CodeDocumentationViewer.shutdown"></a>
<h4>CodeDocumentationViewer.shutdown</h4>
<b>shutdown</b>(<i></i>)
-
<p>
Public method to perform shutdown actions.
</p>
+
<a NAME="CodeDocumentationViewer.unregisterProvider" ID="CodeDocumentationViewer.unregisterProvider"></a>
<h4>CodeDocumentationViewer.unregisterProvider</h4>
<b>unregisterProvider</b>(<i>providerName</i>)
-
<p>
Public method register a source docu provider.
</p>
+
<dl>
<dt><i>providerName</i> (str)</dt>
@@ -395,26 +393,25 @@
<hr />
<a NAME="DocumentationViewerWidget" ID="DocumentationViewerWidget"></a>
<h2>DocumentationViewerWidget</h2>
-
<p>
Class implementing a rich text documentation viewer.
</p>
+
<h3>Derived from</h3>
QWidget
<h3>Class Attributes</h3>
+<table>
+<tr><td>EmpytDocument_Dark</td></tr>
+<tr><td>EmpytDocument_Light</td></tr>
+</table>
-<table>
-<tr><td>EmpytDocument_Dark</td></tr><tr><td>EmpytDocument_Light</td></tr>
-</table>
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#DocumentationViewerWidget.__init__">DocumentationViewerWidget</a></td>
<td>Constructor</td>
@@ -432,19 +429,20 @@
<td>Public method to set the HTML text of the widget.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="DocumentationViewerWidget.__init__" ID="DocumentationViewerWidget.__init__"></a>
<h4>DocumentationViewerWidget (Constructor)</h4>
<b>DocumentationViewerWidget</b>(<i>parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>parent</i> (QWidget)</dt>
@@ -455,10 +453,10 @@
<a NAME="DocumentationViewerWidget.__showLink" ID="DocumentationViewerWidget.__showLink"></a>
<h4>DocumentationViewerWidget.__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>
@@ -469,17 +467,17 @@
<a NAME="DocumentationViewerWidget.clear" ID="DocumentationViewerWidget.clear"></a>
<h4>DocumentationViewerWidget.clear</h4>
<b>clear</b>(<i></i>)
-
<p>
Public method to clear the shown contents.
</p>
+
<a NAME="DocumentationViewerWidget.setHtml" ID="DocumentationViewerWidget.setHtml"></a>
<h4>DocumentationViewerWidget.setHtml</h4>
<b>setHtml</b>(<i>html</i>)
-
<p>
Public method to set the HTML text of the widget.
</p>
+
<dl>
<dt><i>html</i> (str)</dt>
@@ -489,4 +487,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
