--- a/Documentation/Source/eric6.UI.CodeDocumentationViewer.html Mon Sep 17 19:25:49 2018 +0200 +++ b/Documentation/Source/eric6.UI.CodeDocumentationViewer.html Tue Sep 18 19:23:07 2018 +0200 @@ -34,11 +34,8 @@ <td><a href="#CodeDocumentationViewer">CodeDocumentationViewer</a></td> <td>Class implementing a widget to show some source code information provided by plug-ins.</td> </tr><tr> -<td><a href="#PlainTextDocumentationViewer">PlainTextDocumentationViewer</a></td> -<td>Class implementing the plain text documentation viewer.</td> -</tr><tr> -<td><a href="#WebViewDocumentationViewer">WebViewDocumentationViewer</a></td> -<td>Class implementing the rich text documentation viewer.</td> +<td><a href="#DocumentationViewerWidget">DocumentationViewerWidget</a></td> +<td>Class implementing a rich text documentation viewer.</td> </tr> </table> <h3>Functions</h3> @@ -81,9 +78,6 @@ <td><a href="#CodeDocumentationViewer.__selectProvider">__selectProvider</a></td> <td>Private method to select a provider programmatically.</td> </tr><tr> -<td><a href="#CodeDocumentationViewer.__setHtml">__setHtml</a></td> -<td>Private slot to set the prepared HTML text.</td> -</tr><tr> <td><a href="#CodeDocumentationViewer.__setupUi">__setupUi</a></td> <td>Private method to generate the UI layout.</td> </tr><tr> @@ -148,16 +142,6 @@ <dd> name of the provider to be selected </dd> -</dl><a NAME="CodeDocumentationViewer.__setHtml" ID="CodeDocumentationViewer.__setHtml"></a> -<h4>CodeDocumentationViewer.__setHtml</h4> -<b>__setHtml</b>(<i>html</i>) -<p> - Private slot to set the prepared HTML text. -</p><dl> -<dt><i>html</i> (str)</dt> -<dd> -prepared HTML text -</dd> </dl><a NAME="CodeDocumentationViewer.__setupUi" ID="CodeDocumentationViewer.__setupUi"></a> <h4>CodeDocumentationViewer.__setupUi</h4> <b>__setupUi</b>(<i></i>) @@ -309,10 +293,10 @@ </dl> <div align="right"><a href="#top">Up</a></div> <hr /><hr /> -<a NAME="PlainTextDocumentationViewer" ID="PlainTextDocumentationViewer"></a> -<h2>PlainTextDocumentationViewer</h2> +<a NAME="DocumentationViewerWidget" ID="DocumentationViewerWidget"></a> +<h2>DocumentationViewerWidget</h2> <p> - Class implementing the plain text documentation viewer. + Class implementing a rich text documentation viewer. </p> <h3>Derived from</h3> QWidget @@ -327,26 +311,26 @@ <h3>Methods</h3> <table> <tr> -<td><a href="#PlainTextDocumentationViewer.__init__">PlainTextDocumentationViewer</a></td> +<td><a href="#DocumentationViewerWidget.__init__">DocumentationViewerWidget</a></td> <td>Constructor</td> </tr><tr> -<td><a href="#PlainTextDocumentationViewer.clear">clear</a></td> -<td>Public method to clear the contents.</td> +<td><a href="#DocumentationViewerWidget.__showLink">__showLink</a></td> +<td>Private slot to show the hovered link in a tooltip.</td> </tr><tr> -<td><a href="#PlainTextDocumentationViewer.preferencesChanged">preferencesChanged</a></td> -<td>Public slot to handle a change of preferences.</td> +<td><a href="#DocumentationViewerWidget.clear">clear</a></td> +<td>Public method to clear the shown contents.</td> </tr><tr> -<td><a href="#PlainTextDocumentationViewer.setText">setText</a></td> -<td>Public method to set the text to be shown.</td> +<td><a href="#DocumentationViewerWidget.setHtml">setHtml</a></td> +<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="PlainTextDocumentationViewer.__init__" ID="PlainTextDocumentationViewer.__init__"></a> -<h4>PlainTextDocumentationViewer (Constructor)</h4> -<b>PlainTextDocumentationViewer</b>(<i>parent=None</i>) +<a NAME="DocumentationViewerWidget.__init__" ID="DocumentationViewerWidget.__init__"></a> +<h4>DocumentationViewerWidget (Constructor)</h4> +<b>DocumentationViewerWidget</b>(<i>parent=None</i>) <p> Constructor </p><dl> @@ -354,76 +338,8 @@ <dd> reference to the parent widget </dd> -</dl><a NAME="PlainTextDocumentationViewer.clear" ID="PlainTextDocumentationViewer.clear"></a> -<h4>PlainTextDocumentationViewer.clear</h4> -<b>clear</b>(<i></i>) -<p> - Public method to clear the contents. -</p><a NAME="PlainTextDocumentationViewer.preferencesChanged" ID="PlainTextDocumentationViewer.preferencesChanged"></a> -<h4>PlainTextDocumentationViewer.preferencesChanged</h4> -<b>preferencesChanged</b>(<i></i>) -<p> - Public slot to handle a change of preferences. -</p><a NAME="PlainTextDocumentationViewer.setText" ID="PlainTextDocumentationViewer.setText"></a> -<h4>PlainTextDocumentationViewer.setText</h4> -<b>setText</b>(<i>text</i>) -<p> - Public method to set the text to be shown. -</p><dl> -<dt><i>text</i> (str)</dt> -<dd> -text to be shown -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /><hr /> -<a NAME="WebViewDocumentationViewer" ID="WebViewDocumentationViewer"></a> -<h2>WebViewDocumentationViewer</h2> -<p> - Class implementing the rich text documentation viewer. -</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="#WebViewDocumentationViewer.__init__">WebViewDocumentationViewer</a></td> -<td>Constructor</td> -</tr><tr> -<td><a href="#WebViewDocumentationViewer.__showLink">__showLink</a></td> -<td>Private slot to show the hovered link in a tooltip.</td> -</tr><tr> -<td><a href="#WebViewDocumentationViewer.clear">clear</a></td> -<td>Public method to clear the shown contents.</td> -</tr><tr> -<td><a href="#WebViewDocumentationViewer.setHtml">setHtml</a></td> -<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="WebViewDocumentationViewer.__init__" ID="WebViewDocumentationViewer.__init__"></a> -<h4>WebViewDocumentationViewer (Constructor)</h4> -<b>WebViewDocumentationViewer</b>(<i>parent=None</i>) -<p> - Constructor -</p><dl> -<dt><i>parent</i> (QWidget)</dt> -<dd> -reference to the parent widget -</dd> -</dl><a NAME="WebViewDocumentationViewer.__showLink" ID="WebViewDocumentationViewer.__showLink"></a> -<h4>WebViewDocumentationViewer.__showLink</h4> +</dl><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. @@ -432,13 +348,13 @@ <dd> hovered URL </dd> -</dl><a NAME="WebViewDocumentationViewer.clear" ID="WebViewDocumentationViewer.clear"></a> -<h4>WebViewDocumentationViewer.clear</h4> +</dl><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="WebViewDocumentationViewer.setHtml" ID="WebViewDocumentationViewer.setHtml"></a> -<h4>WebViewDocumentationViewer.setHtml</h4> +</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.