--- a/src/eric7/Documentation/Source/eric7.WebBrowser.WebBrowserPage.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.WebBrowser.WebBrowserPage.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,37 +7,36 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.WebBrowser.WebBrowserPage</h1>
-
<p>
Module implementing the helpbrowser using QWebView.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>SSL_AVAILABLE</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#WebBrowserPage">WebBrowserPage</a></td>
<td>Class implementing an enhanced web page.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="WebBrowserPage" ID="WebBrowserPage"></a>
<h2>WebBrowserPage</h2>
-
<p>
Class implementing an enhanced web page.
</p>
+
<h3>Signals</h3>
<dl>
@@ -70,14 +69,13 @@
<h3>Derived from</h3>
QWebEnginePage
<h3>Class Attributes</h3>
-
<table>
-<tr><td>SafeJsWorld</td></tr><tr><td>UnsafeJsWorld</td></tr>
+<tr><td>SafeJsWorld</td></tr>
+<tr><td>UnsafeJsWorld</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
-
<tr>
<td><a href="#WebBrowserPage.setUserAgent">setUserAgent</a></td>
<td>Class method to set the global user agent string.</td>
@@ -91,10 +89,9 @@
<td>Class method to determine the user agent for the given URL.</td>
</tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#WebBrowserPage.__init__">WebBrowserPage</a></td>
<td>Constructor</td>
@@ -208,19 +205,20 @@
<td>Public method to get a reference to the WebBrowserView associated with the page.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="WebBrowserPage.setUserAgent" ID="WebBrowserPage.setUserAgent"></a>
<h4>WebBrowserPage.setUserAgent (class method)</h4>
<b>setUserAgent</b>(<i>agent</i>)
-
<p>
Class method to set the global user agent string.
</p>
+
<dl>
<dt><i>agent</i> (str)</dt>
@@ -231,10 +229,10 @@
<a NAME="WebBrowserPage.userAgent" ID="WebBrowserPage.userAgent"></a>
<h4>WebBrowserPage.userAgent (class method)</h4>
<b>userAgent</b>(<i>resolveEmpty=False</i>)
-
<p>
Class method to get the global user agent setting.
</p>
+
<dl>
<dt><i>resolveEmpty</i> (bool)</dt>
@@ -258,10 +256,10 @@
<a NAME="WebBrowserPage.userAgentForUrl" ID="WebBrowserPage.userAgentForUrl"></a>
<h4>WebBrowserPage.userAgentForUrl (class method)</h4>
<b>userAgentForUrl</b>(<i>url</i>)
-
<p>
Class method to determine the user agent for the given URL.
</p>
+
<dl>
<dt><i>url</i> (QUrl)</dt>
@@ -284,10 +282,10 @@
<a NAME="WebBrowserPage.__init__" ID="WebBrowserPage.__init__"></a>
<h4>WebBrowserPage (Constructor)</h4>
<b>WebBrowserPage</b>(<i>view, parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>view</i> (WebBrowserView)</dt>
@@ -302,11 +300,11 @@
<a NAME="WebBrowserPage.__contentsSizeChanged" ID="WebBrowserPage.__contentsSizeChanged"></a>
<h4>WebBrowserPage.__contentsSizeChanged</h4>
<b>__contentsSizeChanged</b>(<i>size</i>)
-
<p>
Private slot to work around QWebEnginePage not scrolling to anchors
when opened in a background tab.
</p>
+
<dl>
<dt><i>size</i> (QSizeF)</dt>
@@ -317,10 +315,10 @@
<a NAME="WebBrowserPage.__featurePermissionRequested" ID="WebBrowserPage.__featurePermissionRequested"></a>
<h4>WebBrowserPage.__featurePermissionRequested</h4>
<b>__featurePermissionRequested</b>(<i>url, feature</i>)
-
<p>
Private slot handling a feature permission request.
</p>
+
<dl>
<dt><i>url</i> (QUrl)</dt>
@@ -335,10 +333,10 @@
<a NAME="WebBrowserPage.__fullScreenRequested" ID="WebBrowserPage.__fullScreenRequested"></a>
<h4>WebBrowserPage.__fullScreenRequested</h4>
<b>__fullScreenRequested</b>(<i>request</i>)
-
<p>
Private slot handling a full screen request.
</p>
+
<dl>
<dt><i>request</i> (QWebEngineFullScreenRequest)</dt>
@@ -349,11 +347,11 @@
<a NAME="WebBrowserPage.__registerProtocolHandlerRequested" ID="WebBrowserPage.__registerProtocolHandlerRequested"></a>
<h4>WebBrowserPage.__registerProtocolHandlerRequested</h4>
<b>__registerProtocolHandlerRequested</b>(<i>request</i>)
-
<p>
Private slot to handle the registration of a custom protocol
handler.
</p>
+
<dl>
<dt><i>request</i> (QWebEngineRegisterProtocolHandlerRequest)</dt>
@@ -364,17 +362,17 @@
<a NAME="WebBrowserPage.__setupChannelTimeout" ID="WebBrowserPage.__setupChannelTimeout"></a>
<h4>WebBrowserPage.__setupChannelTimeout</h4>
<b>__setupChannelTimeout</b>(<i></i>)
-
<p>
Private slot to initiate the setup of the web channel.
</p>
+
<a NAME="WebBrowserPage.__setupWebChannelForUrl" ID="WebBrowserPage.__setupWebChannelForUrl"></a>
<h4>WebBrowserPage.__setupWebChannelForUrl</h4>
<b>__setupWebChannelForUrl</b>(<i>url</i>)
-
<p>
Private method to setup a web channel to our external object.
</p>
+
<dl>
<dt><i>url</i> (QUrl)</dt>
@@ -385,10 +383,10 @@
<a NAME="WebBrowserPage.__urlChanged" ID="WebBrowserPage.__urlChanged"></a>
<h4>WebBrowserPage.__urlChanged</h4>
<b>__urlChanged</b>(<i>url</i>)
-
<p>
Private slot to handle changes of the URL.
</p>
+
<dl>
<dt><i>url</i> (QUrl)</dt>
@@ -399,10 +397,10 @@
<a NAME="WebBrowserPage.acceptNavigationRequest" ID="WebBrowserPage.acceptNavigationRequest"></a>
<h4>WebBrowserPage.acceptNavigationRequest</h4>
<b>acceptNavigationRequest</b>(<i>url, type_, isMainFrame</i>)
-
<p>
Public method to determine, if a request may be accepted.
</p>
+
<dl>
<dt><i>url</i> (QUrl)</dt>
@@ -434,10 +432,10 @@
<a NAME="WebBrowserPage.certificateError" ID="WebBrowserPage.certificateError"></a>
<h4>WebBrowserPage.certificateError</h4>
<b>certificateError</b>(<i>error</i>)
-
<p>
Public method to handle SSL certificate errors.
</p>
+
<dl>
<dt><i>error</i> (QWebEngineCertificateError)</dt>
@@ -460,17 +458,17 @@
<a NAME="WebBrowserPage.clearSslConfiguration" ID="WebBrowserPage.clearSslConfiguration"></a>
<h4>WebBrowserPage.clearSslConfiguration</h4>
<b>clearSslConfiguration</b>(<i></i>)
-
<p>
Public slot to clear the stored SSL configuration data.
</p>
+
<a NAME="WebBrowserPage.execJavaScript" ID="WebBrowserPage.execJavaScript"></a>
<h4>WebBrowserPage.execJavaScript</h4>
<b>execJavaScript</b>(<i>script, worldId=QWebEngineScript.ScriptWorldId.MainWorld, timeout=500</i>)
-
<p>
Public method to execute a JavaScript function synchroneously.
</p>
+
<dl>
<dt><i>script</i> (str)</dt>
@@ -501,10 +499,10 @@
<a NAME="WebBrowserPage.getSafeBrowsingStatus" ID="WebBrowserPage.getSafeBrowsingStatus"></a>
<h4>WebBrowserPage.getSafeBrowsingStatus</h4>
<b>getSafeBrowsingStatus</b>(<i></i>)
-
<p>
Public method to get the safe browsing status of the current page.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -520,10 +518,10 @@
<a NAME="WebBrowserPage.getSslCertificate" ID="WebBrowserPage.getSslCertificate"></a>
<h4>WebBrowserPage.getSslCertificate</h4>
<b>getSslCertificate</b>(<i></i>)
-
<p>
Public method to get a reference to the SSL certificate.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -539,10 +537,10 @@
<a NAME="WebBrowserPage.getSslCertificateChain" ID="WebBrowserPage.getSslCertificateChain"></a>
<h4>WebBrowserPage.getSslCertificateChain</h4>
<b>getSslCertificateChain</b>(<i></i>)
-
<p>
Public method to get a reference to the SSL certificate chain.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -558,10 +556,10 @@
<a NAME="WebBrowserPage.getSslConfiguration" ID="WebBrowserPage.getSslConfiguration"></a>
<h4>WebBrowserPage.getSslConfiguration</h4>
<b>getSslConfiguration</b>(<i></i>)
-
<p>
Public method to return a reference to the current SSL configuration.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -577,10 +575,10 @@
<a NAME="WebBrowserPage.hasValidSslInfo" ID="WebBrowserPage.hasValidSslInfo"></a>
<h4>WebBrowserPage.hasValidSslInfo</h4>
<b>hasValidSslInfo</b>(<i></i>)
-
<p>
Public method to check, if the page has a valid SSL certificate.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -596,10 +594,10 @@
<a NAME="WebBrowserPage.hitTestContent" ID="WebBrowserPage.hitTestContent"></a>
<h4>WebBrowserPage.hitTestContent</h4>
<b>hitTestContent</b>(<i>pos</i>)
-
<p>
Public method to test the content at a specified position.
</p>
+
<dl>
<dt><i>pos</i> (QPoint)</dt>
@@ -622,10 +620,10 @@
<a NAME="WebBrowserPage.isJavaScriptEnabled" ID="WebBrowserPage.isJavaScriptEnabled"></a>
<h4>WebBrowserPage.isJavaScriptEnabled</h4>
<b>isJavaScriptEnabled</b>(<i></i>)
-
<p>
Public method to test, if JavaScript is enabled.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -641,10 +639,10 @@
<a NAME="WebBrowserPage.javaScriptConsoleMessage" ID="WebBrowserPage.javaScriptConsoleMessage"></a>
<h4>WebBrowserPage.javaScriptConsoleMessage</h4>
<b>javaScriptConsoleMessage</b>(<i>level, message, lineNumber, sourceId</i>)
-
<p>
Public method to show a console message.
</p>
+
<dl>
<dt><i>level</i> (QWebEnginePage.JavaScriptConsoleMessageLevel)</dt>
@@ -667,10 +665,10 @@
<a NAME="WebBrowserPage.mapToViewport" ID="WebBrowserPage.mapToViewport"></a>
<h4>WebBrowserPage.mapToViewport</h4>
<b>mapToViewport</b>(<i>pos</i>)
-
<p>
Public method to map a position to the viewport.
</p>
+
<dl>
<dt><i>pos</i> (QPoint)</dt>
@@ -697,10 +695,10 @@
<a NAME="WebBrowserPage.runJavaScript" ID="WebBrowserPage.runJavaScript"></a>
<h4>WebBrowserPage.runJavaScript</h4>
<b>runJavaScript</b>(<i>script, worldId=-1, callback=None</i>)
-
<p>
Public method to run a script in the context of the page.
</p>
+
<dl>
<dt><i>script</i> (str)</dt>
@@ -720,10 +718,10 @@
<a NAME="WebBrowserPage.scroll" ID="WebBrowserPage.scroll"></a>
<h4>WebBrowserPage.scroll</h4>
<b>scroll</b>(<i>x, y</i>)
-
<p>
Public method to scroll by the given amount of pixels.
</p>
+
<dl>
<dt><i>x</i> (int)</dt>
@@ -738,10 +736,10 @@
<a NAME="WebBrowserPage.scrollTo" ID="WebBrowserPage.scrollTo"></a>
<h4>WebBrowserPage.scrollTo</h4>
<b>scrollTo</b>(<i>pos</i>)
-
<p>
Public method to scroll to the given position.
</p>
+
<dl>
<dt><i>pos</i> (QPointF)</dt>
@@ -752,10 +750,10 @@
<a NAME="WebBrowserPage.setSslConfiguration" ID="WebBrowserPage.setSslConfiguration"></a>
<h4>WebBrowserPage.setSslConfiguration</h4>
<b>setSslConfiguration</b>(<i>sslConfiguration</i>)
-
<p>
Public slot to set the SSL configuration data of the page.
</p>
+
<dl>
<dt><i>sslConfiguration</i> (QSslConfiguration)</dt>
@@ -766,10 +764,10 @@
<a NAME="WebBrowserPage.showSslInfo" ID="WebBrowserPage.showSslInfo"></a>
<h4>WebBrowserPage.showSslInfo</h4>
<b>showSslInfo</b>(<i>pos</i>)
-
<p>
Public slot to show some SSL information for the loaded page.
</p>
+
<dl>
<dt><i>pos</i> (QPoint)</dt>
@@ -780,11 +778,11 @@
<a NAME="WebBrowserPage.view" ID="WebBrowserPage.view"></a>
<h4>WebBrowserPage.view</h4>
<b>view</b>(<i></i>)
-
<p>
Public method to get a reference to the WebBrowserView associated with
the page.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -799,4 +797,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
