--- a/src/eric7/Documentation/Source/eric7.HelpViewer.HelpViewerImplQTB.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.HelpViewer.HelpViewerImplQTB.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,53 +7,51 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.HelpViewer.HelpViewerImplQTB</h1>
-
<p>
Module implementing the QTextBrowser based help viewer class.
</p>
+
<h3>Global Attributes</h3>
-
<table>
-<tr><td>AboutBlank</td></tr><tr><td>PageNotFound</td></tr>
+<tr><td>AboutBlank</td></tr>
+<tr><td>PageNotFound</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#HelpViewerImplQTB">HelpViewerImplQTB</a></td>
<td>Class implementing the QTextBrowser based help viewer class.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="HelpViewerImplQTB" ID="HelpViewerImplQTB"></a>
<h2>HelpViewerImplQTB</h2>
-
<p>
Class implementing the QTextBrowser based help viewer class.
</p>
+
<h3>Derived from</h3>
HelpViewerImpl, QTextBrowser
<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="#HelpViewerImplQTB.__init__">HelpViewerImplQTB</a></td>
<td>Constructor</td>
@@ -183,19 +181,20 @@
<td>Protected method to handle wheel event to zoom.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="HelpViewerImplQTB.__init__" ID="HelpViewerImplQTB.__init__"></a>
<h4>HelpViewerImplQTB (Constructor)</h4>
<b>HelpViewerImplQTB</b>(<i>engine, parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>engine</i> (QHelpEngine)</dt>
@@ -210,10 +209,10 @@
<a NAME="HelpViewerImplQTB.__bookmarkPage" ID="HelpViewerImplQTB.__bookmarkPage"></a>
<h4>HelpViewerImplQTB.__bookmarkPage</h4>
<b>__bookmarkPage</b>(<i>act</i>)
-
<p>
Private method called by the context menu to bookmark the page.
</p>
+
<dl>
<dt><i>act</i> (QAction)</dt>
@@ -224,10 +223,10 @@
<a NAME="HelpViewerImplQTB.__canLoadResource" ID="HelpViewerImplQTB.__canLoadResource"></a>
<h4>HelpViewerImplQTB.__canLoadResource</h4>
<b>__canLoadResource</b>(<i>url</i>)
-
<p>
Private method to check, if the given resource can be loaded.
</p>
+
<dl>
<dt><i>url</i> (QUrl)</dt>
@@ -250,25 +249,25 @@
<a NAME="HelpViewerImplQTB.__closeOtherPages" ID="HelpViewerImplQTB.__closeOtherPages"></a>
<h4>HelpViewerImplQTB.__closeOtherPages</h4>
<b>__closeOtherPages</b>(<i></i>)
-
<p>
Private method called by the context menu to close all other pages.
</p>
+
<a NAME="HelpViewerImplQTB.__closePage" ID="HelpViewerImplQTB.__closePage"></a>
<h4>HelpViewerImplQTB.__closePage</h4>
<b>__closePage</b>(<i></i>)
-
<p>
Private method called by the context menu to close the current page.
</p>
+
<a NAME="HelpViewerImplQTB.__copyLink" ID="HelpViewerImplQTB.__copyLink"></a>
<h4>HelpViewerImplQTB.__copyLink</h4>
<b>__copyLink</b>(<i>act</i>)
-
<p>
Private method called by the context menu to copy a link to the
clipboard.
</p>
+
<dl>
<dt><i>act</i> (QAction)</dt>
@@ -279,10 +278,10 @@
<a NAME="HelpViewerImplQTB.__createLinkContextMenu" ID="HelpViewerImplQTB.__createLinkContextMenu"></a>
<h4>HelpViewerImplQTB.__createLinkContextMenu</h4>
<b>__createLinkContextMenu</b>(<i>menu, linkUrl</i>)
-
<p>
Private method to populate the context menu for URLs.
</p>
+
<dl>
<dt><i>menu</i> (QMenu)</dt>
@@ -297,11 +296,11 @@
<a NAME="HelpViewerImplQTB.__openLinkInBackgroundPage" ID="HelpViewerImplQTB.__openLinkInBackgroundPage"></a>
<h4>HelpViewerImplQTB.__openLinkInBackgroundPage</h4>
<b>__openLinkInBackgroundPage</b>(<i>act</i>)
-
<p>
Private method called by the context menu to open a link in a
background page.
</p>
+
<dl>
<dt><i>act</i> (QAction)</dt>
@@ -312,10 +311,10 @@
<a NAME="HelpViewerImplQTB.__openLinkInNewPage" ID="HelpViewerImplQTB.__openLinkInNewPage"></a>
<h4>HelpViewerImplQTB.__openLinkInNewPage</h4>
<b>__openLinkInNewPage</b>(<i>act</i>)
-
<p>
Private method called by the context menu to open a link in a new page.
</p>
+
<dl>
<dt><i>act</i> (QAction)</dt>
@@ -326,10 +325,10 @@
<a NAME="HelpViewerImplQTB.__showContextMenu" ID="HelpViewerImplQTB.__showContextMenu"></a>
<h4>HelpViewerImplQTB.__showContextMenu</h4>
<b>__showContextMenu</b>(<i>pos</i>)
-
<p>
Private slot to show the context menu.
</p>
+
<dl>
<dt><i>pos</i> (QPoint)</dt>
@@ -340,10 +339,10 @@
<a NAME="HelpViewerImplQTB.doSetSource" ID="HelpViewerImplQTB.doSetSource"></a>
<h4>HelpViewerImplQTB.doSetSource</h4>
<b>doSetSource</b>(<i>url, type_</i>)
-
<p>
Public method to load the data and show it.
</p>
+
<dl>
<dt><i>url</i> (QUrl)</dt>
@@ -358,10 +357,10 @@
<a NAME="HelpViewerImplQTB.event" ID="HelpViewerImplQTB.event"></a>
<h4>HelpViewerImplQTB.event</h4>
<b>event</b>(<i>evt</i>)
-
<p>
Public method handling events.
</p>
+
<dl>
<dt><i>evt</i> (QEvent)</dt>
@@ -384,10 +383,10 @@
<a NAME="HelpViewerImplQTB.gestureEvent" ID="HelpViewerImplQTB.gestureEvent"></a>
<h4>HelpViewerImplQTB.gestureEvent</h4>
<b>gestureEvent</b>(<i>evt</i>)
-
<p>
Protected method handling gesture events.
</p>
+
<dl>
<dt><i>evt</i> (QGestureEvent)</dt>
@@ -398,10 +397,10 @@
<a NAME="HelpViewerImplQTB.gotoHistory" ID="HelpViewerImplQTB.gotoHistory"></a>
<h4>HelpViewerImplQTB.gotoHistory</h4>
<b>gotoHistory</b>(<i>index</i>)
-
<p>
Public method to step through the history.
</p>
+
<dl>
<dt><i>index</i> (int)</dt>
@@ -412,11 +411,11 @@
<a NAME="HelpViewerImplQTB.isBackwardAvailable" ID="HelpViewerImplQTB.isBackwardAvailable"></a>
<h4>HelpViewerImplQTB.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>
@@ -432,10 +431,10 @@
<a NAME="HelpViewerImplQTB.isEmptyPage" ID="HelpViewerImplQTB.isEmptyPage"></a>
<h4>HelpViewerImplQTB.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>
@@ -451,11 +450,11 @@
<a NAME="HelpViewerImplQTB.isForwardAvailable" ID="HelpViewerImplQTB.isForwardAvailable"></a>
<h4>HelpViewerImplQTB.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>
@@ -471,10 +470,10 @@
<a NAME="HelpViewerImplQTB.isScaleDownAvailable" ID="HelpViewerImplQTB.isScaleDownAvailable"></a>
<h4>HelpViewerImplQTB.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>
@@ -490,10 +489,10 @@
<a NAME="HelpViewerImplQTB.isScaleUpAvailable" ID="HelpViewerImplQTB.isScaleUpAvailable"></a>
<h4>HelpViewerImplQTB.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>
@@ -509,10 +508,10 @@
<a NAME="HelpViewerImplQTB.keyPressEvent" ID="HelpViewerImplQTB.keyPressEvent"></a>
<h4>HelpViewerImplQTB.keyPressEvent</h4>
<b>keyPressEvent</b>(<i>evt</i>)
-
<p>
Protected method to handle key press events.
</p>
+
<dl>
<dt><i>evt</i> (QKeyEvent)</dt>
@@ -523,10 +522,10 @@
<a NAME="HelpViewerImplQTB.link" ID="HelpViewerImplQTB.link"></a>
<h4>HelpViewerImplQTB.link</h4>
<b>link</b>(<i></i>)
-
<p>
Public method to get the URL of the shown document.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -542,11 +541,11 @@
<a NAME="HelpViewerImplQTB.loadResource" ID="HelpViewerImplQTB.loadResource"></a>
<h4>HelpViewerImplQTB.loadResource</h4>
<b>loadResource</b>(<i>type_, name</i>)
-
<p>
Public method to load data of the specified type from the resource with
the given name.
</p>
+
<dl>
<dt><i>type_</i> (int)</dt>
@@ -573,10 +572,10 @@
<a NAME="HelpViewerImplQTB.mousePressEvent" ID="HelpViewerImplQTB.mousePressEvent"></a>
<h4>HelpViewerImplQTB.mousePressEvent</h4>
<b>mousePressEvent</b>(<i>evt</i>)
-
<p>
Protected method called by a mouse press event.
</p>
+
<dl>
<dt><i>evt</i> (QMouseEvent)</dt>
@@ -587,10 +586,10 @@
<a NAME="HelpViewerImplQTB.mouseReleaseEvent" ID="HelpViewerImplQTB.mouseReleaseEvent"></a>
<h4>HelpViewerImplQTB.mouseReleaseEvent</h4>
<b>mouseReleaseEvent</b>(<i>evt</i>)
-
<p>
Protected method called by a mouse release event.
</p>
+
<dl>
<dt><i>evt</i> (QMouseEvent)</dt>
@@ -601,10 +600,10 @@
<a NAME="HelpViewerImplQTB.pageTitle" ID="HelpViewerImplQTB.pageTitle"></a>
<h4>HelpViewerImplQTB.pageTitle</h4>
<b>pageTitle</b>(<i></i>)
-
<p>
Public method get the page title.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -620,17 +619,17 @@
<a NAME="HelpViewerImplQTB.resetScale" ID="HelpViewerImplQTB.resetScale"></a>
<h4>HelpViewerImplQTB.resetScale</h4>
<b>resetScale</b>(<i></i>)
-
<p>
Public method to reset the zoom level.
</p>
+
<a NAME="HelpViewerImplQTB.scale" ID="HelpViewerImplQTB.scale"></a>
<h4>HelpViewerImplQTB.scale</h4>
<b>scale</b>(<i></i>)
-
<p>
Public method to get the zoom level.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -646,24 +645,24 @@
<a NAME="HelpViewerImplQTB.scaleDown" ID="HelpViewerImplQTB.scaleDown"></a>
<h4>HelpViewerImplQTB.scaleDown</h4>
<b>scaleDown</b>(<i></i>)
-
<p>
Public method to zoom out.
</p>
+
<a NAME="HelpViewerImplQTB.scaleUp" ID="HelpViewerImplQTB.scaleUp"></a>
<h4>HelpViewerImplQTB.scaleUp</h4>
<b>scaleUp</b>(<i></i>)
-
<p>
Public method to zoom in.
</p>
+
<a NAME="HelpViewerImplQTB.setLink" ID="HelpViewerImplQTB.setLink"></a>
<h4>HelpViewerImplQTB.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>
@@ -674,10 +673,10 @@
<a NAME="HelpViewerImplQTB.setScale" ID="HelpViewerImplQTB.setScale"></a>
<h4>HelpViewerImplQTB.setScale</h4>
<b>setScale</b>(<i>scale</i>)
-
<p>
Public method to set the zoom level.
</p>
+
<dl>
<dt><i>scale</i> (int)</dt>
@@ -688,10 +687,10 @@
<a NAME="HelpViewerImplQTB.wheelEvent" ID="HelpViewerImplQTB.wheelEvent"></a>
<h4>HelpViewerImplQTB.wheelEvent</h4>
<b>wheelEvent</b>(<i>evt</i>)
-
<p>
Protected method to handle wheel event to zoom.
</p>
+
<dl>
<dt><i>evt</i> (QWheelEvent)</dt>
@@ -701,4 +700,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
