--- a/src/eric7/Documentation/Source/eric7.HelpViewer.HelpViewerImpl.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.HelpViewer.HelpViewerImpl.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,34 +7,32 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.HelpViewer.HelpViewerImpl</h1>
-
<p>
Module implementing the help viewer base class.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#HelpViewerImpl">HelpViewerImpl</a></td>
<td>Class implementing the help viewer base class.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="HelpViewerImpl" ID="HelpViewerImpl"></a>
<h2>HelpViewerImpl</h2>
-
<p>
Class implementing the help viewer base class.
</p>
@@ -42,6 +40,7 @@
This is the base class of help viewer implementations and defines the
interface. Als subclasses must implement the these methods.
</p>
+
<h3>Signals</h3>
<dl>
@@ -61,19 +60,17 @@
<h3>Derived from</h3>
None
<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="#HelpViewerImpl.__init__">HelpViewerImpl</a></td>
<td>Constructor</td>
@@ -135,19 +132,20 @@
<td>Public method to set the zoom level.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="HelpViewerImpl.__init__" ID="HelpViewerImpl.__init__"></a>
<h4>HelpViewerImpl (Constructor)</h4>
<b>HelpViewerImpl</b>(<i>engine</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>engine</i> (QHelpEngine)</dt>
@@ -158,10 +156,10 @@
<a NAME="HelpViewerImpl.gotoHistory" ID="HelpViewerImpl.gotoHistory"></a>
<h4>HelpViewerImpl.gotoHistory</h4>
<b>gotoHistory</b>(<i>index</i>)
-
<p>
Public method to step through the history.
</p>
+
<dl>
<dt><i>index</i> (int)</dt>
@@ -179,11 +177,11 @@
<a NAME="HelpViewerImpl.isBackwardAvailable" ID="HelpViewerImpl.isBackwardAvailable"></a>
<h4>HelpViewerImpl.isBackwardAvailable</h4>
<b>isBackwardAvailable</b>(<i></i>)
-
<p>
Public method to check, if stepping backward through the history is
available.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -206,10 +204,10 @@
<a NAME="HelpViewerImpl.isEmptyPage" ID="HelpViewerImpl.isEmptyPage"></a>
<h4>HelpViewerImpl.isEmptyPage</h4>
<b>isEmptyPage</b>(<i></i>)
-
<p>
Public method to check, if the current page is the empty page.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -232,11 +230,11 @@
<a NAME="HelpViewerImpl.isForwardAvailable" ID="HelpViewerImpl.isForwardAvailable"></a>
<h4>HelpViewerImpl.isForwardAvailable</h4>
<b>isForwardAvailable</b>(<i></i>)
-
<p>
Public method to check, if stepping forward through the history is
available.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -259,10 +257,10 @@
<a NAME="HelpViewerImpl.isScaleDownAvailable" ID="HelpViewerImpl.isScaleDownAvailable"></a>
<h4>HelpViewerImpl.isScaleDownAvailable</h4>
<b>isScaleDownAvailable</b>(<i></i>)
-
<p>
Public method to check, if the min. zoom level is reached.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -285,10 +283,10 @@
<a NAME="HelpViewerImpl.isScaleUpAvailable" ID="HelpViewerImpl.isScaleUpAvailable"></a>
<h4>HelpViewerImpl.isScaleUpAvailable</h4>
<b>isScaleUpAvailable</b>(<i></i>)
-
<p>
Public method to check, if the max. zoom level is reached.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -311,10 +309,10 @@
<a NAME="HelpViewerImpl.link" ID="HelpViewerImpl.link"></a>
<h4>HelpViewerImpl.link</h4>
<b>link</b>(<i></i>)
-
<p>
Public method to get the URL of the shown document.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -337,10 +335,10 @@
<a NAME="HelpViewerImpl.pageTitle" ID="HelpViewerImpl.pageTitle"></a>
<h4>HelpViewerImpl.pageTitle</h4>
<b>pageTitle</b>(<i></i>)
-
<p>
Public method get the page title.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -363,10 +361,10 @@
<a NAME="HelpViewerImpl.resetScale" ID="HelpViewerImpl.resetScale"></a>
<h4>HelpViewerImpl.resetScale</h4>
<b>resetScale</b>(<i></i>)
-
<p>
Public method to reset the zoom level.
</p>
+
<dl>
<dt>Raises <b>NotImplementedError</b>:</dt>
@@ -377,10 +375,10 @@
<a NAME="HelpViewerImpl.scale" ID="HelpViewerImpl.scale"></a>
<h4>HelpViewerImpl.scale</h4>
<b>scale</b>(<i></i>)
-
<p>
Public method to get the zoom level.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -403,10 +401,10 @@
<a NAME="HelpViewerImpl.scaleDown" ID="HelpViewerImpl.scaleDown"></a>
<h4>HelpViewerImpl.scaleDown</h4>
<b>scaleDown</b>(<i></i>)
-
<p>
Public method to zoom out.
</p>
+
<dl>
<dt>Raises <b>NotImplementedError</b>:</dt>
@@ -417,10 +415,10 @@
<a NAME="HelpViewerImpl.scaleUp" ID="HelpViewerImpl.scaleUp"></a>
<h4>HelpViewerImpl.scaleUp</h4>
<b>scaleUp</b>(<i></i>)
-
<p>
Public method to zoom in.
</p>
+
<dl>
<dt>Raises <b>NotImplementedError</b>:</dt>
@@ -431,10 +429,10 @@
<a NAME="HelpViewerImpl.setLink" ID="HelpViewerImpl.setLink"></a>
<h4>HelpViewerImpl.setLink</h4>
<b>setLink</b>(<i>url</i>)
-
<p>
Public method to set the URL of the document to be shown.
</p>
+
<dl>
<dt><i>url</i> (QUrl)</dt>
@@ -452,10 +450,10 @@
<a NAME="HelpViewerImpl.setScale" ID="HelpViewerImpl.setScale"></a>
<h4>HelpViewerImpl.setScale</h4>
<b>setScale</b>(<i>scale</i>)
-
<p>
Public method to set the zoom level.
</p>
+
<dl>
<dt><i>scale</i> (int)</dt>
@@ -472,4 +470,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
