--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/eric7/Documentation/Source/eric7.HelpViewer.HelpViewerImpl.html Mon Nov 01 16:58:52 2021 +0100
@@ -0,0 +1,475 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.HelpViewer.HelpViewerImpl</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<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>
+<p>
+ 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>
+
+<dt>loadFinished(ok)</dt>
+<dd>
+emitted to indicate the completion of a page load
+</dd>
+<dt>titleChanged()</dt>
+<dd>
+emitted to indicate a change of the page title
+</dd>
+<dt>zoomChanged()</dt>
+<dd>
+emitted to indicate a change of the zoom level
+</dd>
+</dl>
+<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>
+</tr>
+<tr>
+<td><a href="#HelpViewerImpl.gotoHistory">gotoHistory</a></td>
+<td>Public method to step through the history.</td>
+</tr>
+<tr>
+<td><a href="#HelpViewerImpl.isBackwardAvailable">isBackwardAvailable</a></td>
+<td>Public method to check, if stepping backward through the history is available.</td>
+</tr>
+<tr>
+<td><a href="#HelpViewerImpl.isEmptyPage">isEmptyPage</a></td>
+<td>Public method to check, if the current page is the empty page.</td>
+</tr>
+<tr>
+<td><a href="#HelpViewerImpl.isForwardAvailable">isForwardAvailable</a></td>
+<td>Public method to check, if stepping forward through the history is available.</td>
+</tr>
+<tr>
+<td><a href="#HelpViewerImpl.isScaleDownAvailable">isScaleDownAvailable</a></td>
+<td>Public method to check, if the min.</td>
+</tr>
+<tr>
+<td><a href="#HelpViewerImpl.isScaleUpAvailable">isScaleUpAvailable</a></td>
+<td>Public method to check, if the max.</td>
+</tr>
+<tr>
+<td><a href="#HelpViewerImpl.link">link</a></td>
+<td>Public method to get the URL of the shown document.</td>
+</tr>
+<tr>
+<td><a href="#HelpViewerImpl.pageTitle">pageTitle</a></td>
+<td>Public method get the page title.</td>
+</tr>
+<tr>
+<td><a href="#HelpViewerImpl.resetScale">resetScale</a></td>
+<td>Public method to reset the zoom level.</td>
+</tr>
+<tr>
+<td><a href="#HelpViewerImpl.scale">scale</a></td>
+<td>Public method to get the zoom level.</td>
+</tr>
+<tr>
+<td><a href="#HelpViewerImpl.scaleDown">scaleDown</a></td>
+<td>Public method to zoom out.</td>
+</tr>
+<tr>
+<td><a href="#HelpViewerImpl.scaleUp">scaleUp</a></td>
+<td>Public method to zoom in.</td>
+</tr>
+<tr>
+<td><a href="#HelpViewerImpl.setLink">setLink</a></td>
+<td>Public method to set the URL of the document to be shown.</td>
+</tr>
+<tr>
+<td><a href="#HelpViewerImpl.setScale">setScale</a></td>
+<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>
+<dd>
+reference to the help engine
+</dd>
+</dl>
+<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>
+<dd>
+history index (<0 backward, >0 forward)
+</dd>
+</dl>
+<dl>
+
+<dt>Raises <b>RuntimeError</b>:</dt>
+<dd>
+raised when not implemented
+</dd>
+</dl>
+<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>
+flag indicating backward stepping is available
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<dl>
+
+<dt>Raises <b>RuntimeError</b>:</dt>
+<dd>
+raised when not implemented
+</dd>
+</dl>
+<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>
+flag indicating an empty page is loaded
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<dl>
+
+<dt>Raises <b>RuntimeError</b>:</dt>
+<dd>
+raised when not implemented
+</dd>
+</dl>
+<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>
+flag indicating forward stepping is available
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<dl>
+
+<dt>Raises <b>RuntimeError</b>:</dt>
+<dd>
+raised when not implemented
+</dd>
+</dl>
+<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>
+flag indicating scale down is available
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<dl>
+
+<dt>Raises <b>RuntimeError</b>:</dt>
+<dd>
+raised when not implemented
+</dd>
+</dl>
+<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>
+flag indicating scale up is available
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<dl>
+
+<dt>Raises <b>RuntimeError</b>:</dt>
+<dd>
+raised when not implemented
+</dd>
+</dl>
+<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>
+URL of the document
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QUrl
+</dd>
+</dl>
+<dl>
+
+<dt>Raises <b>RuntimeError</b>:</dt>
+<dd>
+raised when not implemented
+</dd>
+</dl>
+<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>
+page title
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<dl>
+
+<dt>Raises <b>RuntimeError</b>:</dt>
+<dd>
+raised when not implemented
+</dd>
+</dl>
+<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>RuntimeError</b>:</dt>
+<dd>
+raised when not implemented
+</dd>
+</dl>
+<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>
+current zoom level
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+int
+</dd>
+</dl>
+<dl>
+
+<dt>Raises <b>RuntimeError</b>:</dt>
+<dd>
+raised when not implemented
+</dd>
+</dl>
+<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>RuntimeError</b>:</dt>
+<dd>
+raised when not implemented
+</dd>
+</dl>
+<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>RuntimeError</b>:</dt>
+<dd>
+raised when not implemented
+</dd>
+</dl>
+<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>
+<dd>
+URL of the document
+</dd>
+</dl>
+<dl>
+
+<dt>Raises <b>RuntimeError</b>:</dt>
+<dd>
+raised when not implemented
+</dd>
+</dl>
+<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>
+<dd>
+zoom level to set
+</dd>
+</dl>
+<dl>
+
+<dt>Raises <b>RuntimeError</b>:</dt>
+<dd>
+raised when not implemented
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file
