src/eric7/Documentation/Source/eric7.WebBrowser.WebBrowserPage.html

<!DOCTYPE html>
<html><head>
<title>eric7.WebBrowser.WebBrowserPage</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<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>

<dt>navigationRequestAccepted(url, navigation type, main frame)</dt>
<dd>
emitted
        to signal an accepted navigation request
</dd>
<dt>printPageRequested()</dt>
<dd>
emitted to indicate a print request of the
        shown web page
</dd>
<dt>safeBrowsingAbort()</dt>
<dd>
emitted to indicate an abort due to a safe
        browsing event
</dd>
<dt>safeBrowsingBad(threatType, threatMessages)</dt>
<dd>
emitted to indicate a
        malicious web site as determined by safe browsing
</dd>
<dt>sslConfigurationChanged()</dt>
<dd>
emitted to indicate a change of the
        stored SSL configuration data
</dd>
</dl>
<h3>Derived from</h3>
QWebEnginePage
<h3>Class Attributes</h3>
<table>
<tr><td>PermissionTypeQuestions</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>
</tr>
<tr>
<td><a href="#WebBrowserPage.userAgent">userAgent</a></td>
<td>Class method to get the global user agent setting.</td>
</tr>
<tr>
<td><a href="#WebBrowserPage.userAgentForUrl">userAgentForUrl</a></td>
<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>
</tr>
<tr>
<td><a href="#WebBrowserPage.__contentsSizeChanged">__contentsSizeChanged</a></td>
<td>Private slot to work around QWebEnginePage not scrolling to anchors when opened in a background tab.</td>
</tr>
<tr>
<td><a href="#WebBrowserPage.__featurePermissionRequested">__featurePermissionRequested</a></td>
<td>Private slot handling a feature permission request.</td>
</tr>
<tr>
<td><a href="#WebBrowserPage.__fullScreenRequested">__fullScreenRequested</a></td>
<td>Private slot handling a full screen request.</td>
</tr>
<tr>
<td><a href="#WebBrowserPage.__permissionRequested">__permissionRequested</a></td>
<td>Private slot handling a permission request.</td>
</tr>
<tr>
<td><a href="#WebBrowserPage.__registerProtocolHandlerRequested">__registerProtocolHandlerRequested</a></td>
<td>Private slot to handle the registration of a custom protocol handler.</td>
</tr>
<tr>
<td><a href="#WebBrowserPage.__setupChannelTimeout">__setupChannelTimeout</a></td>
<td>Private slot to initiate the setup of the web channel.</td>
</tr>
<tr>
<td><a href="#WebBrowserPage.__setupWebChannelForUrl">__setupWebChannelForUrl</a></td>
<td>Private method to setup a web channel to our external object.</td>
</tr>
<tr>
<td><a href="#WebBrowserPage.__urlChanged">__urlChanged</a></td>
<td>Private slot to handle changes of the URL.</td>
</tr>
<tr>
<td><a href="#WebBrowserPage.acceptNavigationRequest">acceptNavigationRequest</a></td>
<td>Public method to determine, if a request may be accepted.</td>
</tr>
<tr>
<td><a href="#WebBrowserPage.certificateError">certificateError</a></td>
<td>Public method to handle SSL certificate errors.</td>
</tr>
<tr>
<td><a href="#WebBrowserPage.clearSslConfiguration">clearSslConfiguration</a></td>
<td>Public slot to clear the stored SSL configuration data.</td>
</tr>
<tr>
<td><a href="#WebBrowserPage.execJavaScript">execJavaScript</a></td>
<td>Public method to execute a JavaScript function synchronously.</td>
</tr>
<tr>
<td><a href="#WebBrowserPage.getSafeBrowsingStatus">getSafeBrowsingStatus</a></td>
<td>Public method to get the safe browsing status of the current page.</td>
</tr>
<tr>
<td><a href="#WebBrowserPage.getSslCertificate">getSslCertificate</a></td>
<td>Public method to get a reference to the SSL certificate.</td>
</tr>
<tr>
<td><a href="#WebBrowserPage.getSslCertificateChain">getSslCertificateChain</a></td>
<td>Public method to get a reference to the SSL certificate chain.</td>
</tr>
<tr>
<td><a href="#WebBrowserPage.getSslConfiguration">getSslConfiguration</a></td>
<td>Public method to return a reference to the current SSL configuration.</td>
</tr>
<tr>
<td><a href="#WebBrowserPage.hasValidSslInfo">hasValidSslInfo</a></td>
<td>Public method to check, if the page has a valid SSL certificate.</td>
</tr>
<tr>
<td><a href="#WebBrowserPage.hitTestContent">hitTestContent</a></td>
<td>Public method to test the content at a specified position.</td>
</tr>
<tr>
<td><a href="#WebBrowserPage.isJavaScriptEnabled">isJavaScriptEnabled</a></td>
<td>Public method to test, if JavaScript is enabled.</td>
</tr>
<tr>
<td><a href="#WebBrowserPage.javaScriptConsoleMessage">javaScriptConsoleMessage</a></td>
<td>Public method to show a console message.</td>
</tr>
<tr>
<td><a href="#WebBrowserPage.mapToViewport">mapToViewport</a></td>
<td>Public method to map a position to the viewport.</td>
</tr>
<tr>
<td><a href="#WebBrowserPage.resultCallback">resultCallback</a></td>
<td></td>
</tr>
<tr>
<td><a href="#WebBrowserPage.runJavaScript">runJavaScript</a></td>
<td>Public method to run a script in the context of the page.</td>
</tr>
<tr>
<td><a href="#WebBrowserPage.scroll">scroll</a></td>
<td>Public method to scroll by the given amount of pixels.</td>
</tr>
<tr>
<td><a href="#WebBrowserPage.scrollTo">scrollTo</a></td>
<td>Public method to scroll to the given position.</td>
</tr>
<tr>
<td><a href="#WebBrowserPage.setSslConfiguration">setSslConfiguration</a></td>
<td>Public slot to set the SSL configuration data of the page.</td>
</tr>
<tr>
<td><a href="#WebBrowserPage.showSslInfo">showSslInfo</a></td>
<td>Public slot to show some SSL information for the loaded page.</td>
</tr>
<tr>
<td><a href="#WebBrowserPage.view">view</a></td>
<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>
<dd>
new current user agent string
</dd>
</dl>
<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>
<dd>
flag indicating to resolve an empty
            user agent
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
user agent string
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<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>
<dd>
URL to determine user agent for
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
user agent string
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<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>
<dd>
reference to the WebBrowserView associated with the page
</dd>
<dt><i>parent</i> (QWidget (optional))</dt>
<dd>
reference to the parent widget (defaults to None)
</dd>
</dl>
<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>
<dd>
changed contents size (unused) (unused)
</dd>
</dl>
<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>
<dd>
url requesting the feature
</dd>
<dt><i>feature</i> (QWebEnginePage.Feature)</dt>
<dd>
requested feature
</dd>
</dl>
<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>
<dd>
reference to the full screen request
</dd>
</dl>
<a NAME="WebBrowserPage.__permissionRequested" ID="WebBrowserPage.__permissionRequested"></a>
<h4>WebBrowserPage.__permissionRequested</h4>
<b>__permissionRequested</b>(<i>permission</i>)
<p>
        Private slot handling a permission request.
</p>

<dl>

<dt><i>permission</i> (QWebEnginePermission)</dt>
<dd>
reference to the permission request object
</dd>
</dl>
<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>
<dd>
reference to the registration request
</dd>
</dl>
<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>
<dd>
URL for which to setup the web channel
</dd>
</dl>
<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>
<dd>
new URL
</dd>
</dl>
<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>
<dd>
URL to navigate to
</dd>
<dt><i>type_</i> (QWebEnginePage.NavigationType)</dt>
<dd>
type of the navigation request
</dd>
<dt><i>isMainFrame</i> (bool)</dt>
<dd>
flag indicating, that the request originated from
            the main frame
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
flag indicating acceptance
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<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>
<dd>
object containing the certificate error information
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
flag indicating to ignore this error
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<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 synchronously.
</p>

<dl>

<dt><i>script</i> (str)</dt>
<dd>
JavaScript script source to be executed
</dd>
<dt><i>worldId</i> (QWebEngineScript.ScriptWorldId)</dt>
<dd>
ID to run the script under
</dd>
<dt><i>timeout</i> (int)</dt>
<dd>
max. time the script is given to execute
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
result of the script
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
depending upon script result
</dd>
</dl>
<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>
flag indicating a safe site
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<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>
amended SSL certificate
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
QSslCertificate
</dd>
</dl>
<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>
SSL certificate chain
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
list of QSslCertificate
</dd>
</dl>
<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>
reference to the SSL configuration in use
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
QSslConfiguration
</dd>
</dl>
<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>
flag indicating a valid SSL certificate
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<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>
<dd>
position to execute the test at
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
test result object
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
WebHitTestResult
</dd>
</dl>
<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>
flag indicating the state of the JavaScript support
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<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>
<dd>
severity
</dd>
<dt><i>message</i> (str)</dt>
<dd>
message to be shown
</dd>
<dt><i>lineNumber</i> (int)</dt>
<dd>
line number of an error
</dd>
<dt><i>sourceId</i> (str)</dt>
<dd>
source URL causing the error
</dd>
</dl>
<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>
<dd>
position to be mapped
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
viewport position
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
QPoint
</dd>
</dl>
<a NAME="WebBrowserPage.resultCallback" ID="WebBrowserPage.resultCallback"></a>
<h4>WebBrowserPage.resultCallback</h4>
<b>resultCallback</b>(<i>resDict=resultDict</i>)

<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>
<dd>
JavaScript script source to be executed
</dd>
<dt><i>worldId</i> (int)</dt>
<dd>
ID to run the script under
</dd>
<dt><i>callback</i> (function)</dt>
<dd>
callback function to be executed when the script has
            ended
</dd>
</dl>
<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>
<dd>
horizontal scroll value
</dd>
<dt><i>y</i> (int)</dt>
<dd>
vertical scroll value
</dd>
</dl>
<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>
<dd>
position to scroll to
</dd>
</dl>
<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>
<dd>
SSL configuration to be set
</dd>
</dl>
<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>
<dd>
position to show the info at
</dd>
</dl>
<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>
reference to the WebBrowserView associated with the page
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
WebBrowserView
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>