Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.WebBrowser.WebBrowserPage.html
src/eric7/Documentation/Source/eric7.WebBrowser.WebBrowserPage.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8752
- 3c1ea4dfb691
- child 9386
- 5b95a970a2d0
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.WebBrowser.WebBrowserPage</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.WebBrowser.WebBrowserPage</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the helpbrowser using QWebView. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#WebBrowserPage">WebBrowserPage</a></td> | |
| 25 <td>Class implementing an enhanced web page.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <hr /> | |
| 34 <hr /> | |
| 35 <a NAME="WebBrowserPage" ID="WebBrowserPage"></a> | |
| 36 <h2>WebBrowserPage</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing an enhanced web page. | |
| 40 </p> | |
| 41 <h3>Signals</h3> | |
| 42 <dl> | |
| 43 | |
| 44 <dt>navigationRequestAccepted(url, navigation type, main frame)</dt> | |
| 45 <dd> | |
| 46 emitted | |
| 47 to signal an accepted navigation request | |
| 48 </dd> | |
| 49 <dt>printPageRequested()</dt> | |
| 50 <dd> | |
| 51 emitted to indicate a print request of the | |
| 52 shown web page | |
| 53 </dd> | |
| 54 <dt>safeBrowsingAbort()</dt> | |
| 55 <dd> | |
| 56 emitted to indicate an abort due to a safe | |
| 57 browsing event | |
| 58 </dd> | |
| 59 <dt>safeBrowsingBad(threatType, threatMessages)</dt> | |
| 60 <dd> | |
| 61 emitted to indicate a | |
| 62 malicious web site as determined by safe browsing | |
| 63 </dd> | |
| 64 <dt>sslConfigurationChanged()</dt> | |
| 65 <dd> | |
| 66 emitted to indicate a change of the | |
| 67 stored SSL configuration data | |
| 68 </dd> | |
| 69 </dl> | |
| 70 <h3>Derived from</h3> | |
| 71 QWebEnginePage | |
| 72 <h3>Class Attributes</h3> | |
| 73 | |
| 74 <table> | |
| 75 <tr><td>SafeJsWorld</td></tr><tr><td>UnsafeJsWorld</td></tr> | |
| 76 </table> | |
| 77 <h3>Class Methods</h3> | |
| 78 | |
| 79 <table> | |
| 80 | |
| 81 <tr> | |
| 82 <td><a href="#WebBrowserPage.setUserAgent">setUserAgent</a></td> | |
| 83 <td>Class method to set the global user agent string.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#WebBrowserPage.userAgent">userAgent</a></td> | |
| 87 <td>Class method to get the global user agent setting.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 90 <td><a href="#WebBrowserPage.userAgentForUrl">userAgentForUrl</a></td> | |
| 91 <td>Class method to determine the user agent for the given URL.</td> | |
| 92 </tr> | |
| 93 </table> | |
| 94 <h3>Methods</h3> | |
| 95 | |
| 96 <table> | |
| 97 | |
| 98 <tr> | |
| 99 <td><a href="#WebBrowserPage.__init__">WebBrowserPage</a></td> | |
| 100 <td>Constructor</td> | |
| 101 </tr> | |
| 102 <tr> | |
| 103 <td><a href="#WebBrowserPage.__contentsSizeChanged">__contentsSizeChanged</a></td> | |
| 104 <td>Private slot to work around QWebEnginePage not scrolling to anchors when opened in a background tab.</td> | |
| 105 </tr> | |
| 106 <tr> | |
| 107 <td><a href="#WebBrowserPage.__featurePermissionRequested">__featurePermissionRequested</a></td> | |
| 108 <td>Private slot handling a feature permission request.</td> | |
| 109 </tr> | |
| 110 <tr> | |
| 111 <td><a href="#WebBrowserPage.__fullScreenRequested">__fullScreenRequested</a></td> | |
| 112 <td>Private slot handling a full screen request.</td> | |
| 113 </tr> | |
| 114 <tr> | |
| 115 <td><a href="#WebBrowserPage.__registerProtocolHandlerRequested">__registerProtocolHandlerRequested</a></td> | |
| 116 <td>Private slot to handle the registration of a custom protocol handler.</td> | |
| 117 </tr> | |
| 118 <tr> | |
| 119 <td><a href="#WebBrowserPage.__setupChannelTimeout">__setupChannelTimeout</a></td> | |
| 120 <td>Private slot to initiate the setup of the web channel.</td> | |
| 121 </tr> | |
| 122 <tr> | |
| 123 <td><a href="#WebBrowserPage.__setupWebChannelForUrl">__setupWebChannelForUrl</a></td> | |
| 124 <td>Private method to setup a web channel to our external object.</td> | |
| 125 </tr> | |
| 126 <tr> | |
| 127 <td><a href="#WebBrowserPage.__urlChanged">__urlChanged</a></td> | |
| 128 <td>Private slot to handle changes of the URL.</td> | |
| 129 </tr> | |
| 130 <tr> | |
| 131 <td><a href="#WebBrowserPage.acceptNavigationRequest">acceptNavigationRequest</a></td> | |
| 132 <td>Public method to determine, if a request may be accepted.</td> | |
| 133 </tr> | |
| 134 <tr> | |
| 135 <td><a href="#WebBrowserPage.certificateError">certificateError</a></td> | |
| 136 <td>Public method to handle SSL certificate errors.</td> | |
| 137 </tr> | |
| 138 <tr> | |
| 139 <td><a href="#WebBrowserPage.clearSslConfiguration">clearSslConfiguration</a></td> | |
| 140 <td>Public slot to clear the stored SSL configuration data.</td> | |
| 141 </tr> | |
| 142 <tr> | |
| 143 <td><a href="#WebBrowserPage.execJavaScript">execJavaScript</a></td> | |
| 144 <td>Public method to execute a JavaScript function synchroneously.</td> | |
| 145 </tr> | |
| 146 <tr> | |
| 147 <td><a href="#WebBrowserPage.execPrintPage">execPrintPage</a></td> | |
| 148 <td>Public method to execute a synchronous print.</td> | |
| 149 </tr> | |
| 150 <tr> | |
| 151 <td><a href="#WebBrowserPage.getSafeBrowsingStatus">getSafeBrowsingStatus</a></td> | |
| 152 <td>Public method to get the safe browsing status of the current page.</td> | |
| 153 </tr> | |
| 154 <tr> | |
| 155 <td><a href="#WebBrowserPage.getSslCertificate">getSslCertificate</a></td> | |
| 156 <td>Public method to get a reference to the SSL certificate.</td> | |
| 157 </tr> | |
| 158 <tr> | |
| 159 <td><a href="#WebBrowserPage.getSslCertificateChain">getSslCertificateChain</a></td> | |
| 160 <td>Public method to get a reference to the SSL certificate chain.</td> | |
| 161 </tr> | |
| 162 <tr> | |
| 163 <td><a href="#WebBrowserPage.getSslConfiguration">getSslConfiguration</a></td> | |
| 164 <td>Public method to return a reference to the current SSL configuration.</td> | |
| 165 </tr> | |
| 166 <tr> | |
| 167 <td><a href="#WebBrowserPage.hasValidSslInfo">hasValidSslInfo</a></td> | |
| 168 <td>Public method to check, if the page has a valid SSL certificate.</td> | |
| 169 </tr> | |
| 170 <tr> | |
| 171 <td><a href="#WebBrowserPage.hitTestContent">hitTestContent</a></td> | |
| 172 <td>Public method to test the content at a specified position.</td> | |
| 173 </tr> | |
| 174 <tr> | |
| 175 <td><a href="#WebBrowserPage.isJavaScriptEnabled">isJavaScriptEnabled</a></td> | |
| 176 <td>Public method to test, if JavaScript is enabled.</td> | |
| 177 </tr> | |
| 178 <tr> | |
| 179 <td><a href="#WebBrowserPage.javaScriptConsoleMessage">javaScriptConsoleMessage</a></td> | |
| 180 <td>Public method to show a console message.</td> | |
| 181 </tr> | |
| 182 <tr> | |
| 183 <td><a href="#WebBrowserPage.mapToViewport">mapToViewport</a></td> | |
| 184 <td>Public method to map a position to the viewport.</td> | |
| 185 </tr> | |
| 186 <tr> | |
| 187 <td><a href="#WebBrowserPage.printCallback">printCallback</a></td> | |
| 188 <td></td> | |
| 189 </tr> | |
| 190 <tr> | |
| 191 <td><a href="#WebBrowserPage.registerProtocolHandlerRequestScheme">registerProtocolHandlerRequestScheme</a></td> | |
| 192 <td>Public method to get the registered protocol handler request scheme.</td> | |
| 193 </tr> | |
| 194 <tr> | |
| 195 <td><a href="#WebBrowserPage.registerProtocolHandlerRequestUrl">registerProtocolHandlerRequestUrl</a></td> | |
| 196 <td>Public method to get the registered protocol handler request URL.</td> | |
| 197 </tr> | |
| 198 <tr> | |
| 199 <td><a href="#WebBrowserPage.resultCallback">resultCallback</a></td> | |
| 200 <td></td> | |
| 201 </tr> | |
| 202 <tr> | |
| 203 <td><a href="#WebBrowserPage.runJavaScript">runJavaScript</a></td> | |
| 204 <td>Public method to run a script in the context of the page.</td> | |
| 205 </tr> | |
| 206 <tr> | |
| 207 <td><a href="#WebBrowserPage.scroll">scroll</a></td> | |
| 208 <td>Public method to scroll by the given amount of pixels.</td> | |
| 209 </tr> | |
| 210 <tr> | |
| 211 <td><a href="#WebBrowserPage.scrollTo">scrollTo</a></td> | |
| 212 <td>Public method to scroll to the given position.</td> | |
| 213 </tr> | |
| 214 <tr> | |
| 215 <td><a href="#WebBrowserPage.setSslConfiguration">setSslConfiguration</a></td> | |
| 216 <td>Public slot to set the SSL configuration data of the page.</td> | |
| 217 </tr> | |
| 218 <tr> | |
| 219 <td><a href="#WebBrowserPage.showSslInfo">showSslInfo</a></td> | |
| 220 <td>Public slot to show some SSL information for the loaded page.</td> | |
| 221 </tr> | |
| 222 <tr> | |
| 223 <td><a href="#WebBrowserPage.view">view</a></td> | |
| 224 <td>Public method to get a reference to the WebBrowserView associated with the page.</td> | |
| 225 </tr> | |
| 226 </table> | |
| 227 <h3>Static Methods</h3> | |
| 228 | |
| 229 <table> | |
| 230 <tr><td>None</td></tr> | |
| 231 </table> | |
| 232 | |
| 233 <a NAME="WebBrowserPage.setUserAgent" ID="WebBrowserPage.setUserAgent"></a> | |
| 234 <h4>WebBrowserPage.setUserAgent (class method)</h4> | |
| 235 <b>setUserAgent</b>(<i>agent</i>) | |
| 236 | |
| 237 <p> | |
| 238 Class method to set the global user agent string. | |
| 239 </p> | |
| 240 <dl> | |
| 241 | |
| 242 <dt><i>agent</i></dt> | |
| 243 <dd> | |
| 244 new current user agent string (string) | |
| 245 </dd> | |
| 246 </dl> | |
| 247 <a NAME="WebBrowserPage.userAgent" ID="WebBrowserPage.userAgent"></a> | |
| 248 <h4>WebBrowserPage.userAgent (class method)</h4> | |
| 249 <b>userAgent</b>(<i>resolveEmpty=False</i>) | |
| 250 | |
| 251 <p> | |
| 252 Class method to get the global user agent setting. | |
| 253 </p> | |
| 254 <dl> | |
| 255 | |
| 256 <dt><i>resolveEmpty</i></dt> | |
| 257 <dd> | |
| 258 flag indicating to resolve an empty | |
| 259 user agent (boolean) | |
| 260 </dd> | |
| 261 </dl> | |
| 262 <dl> | |
| 263 <dt>Return:</dt> | |
| 264 <dd> | |
| 265 user agent string (string) | |
| 266 </dd> | |
| 267 </dl> | |
| 268 <a NAME="WebBrowserPage.userAgentForUrl" ID="WebBrowserPage.userAgentForUrl"></a> | |
| 269 <h4>WebBrowserPage.userAgentForUrl (class method)</h4> | |
| 270 <b>userAgentForUrl</b>(<i>url</i>) | |
| 271 | |
| 272 <p> | |
| 273 Class method to determine the user agent for the given URL. | |
| 274 </p> | |
| 275 <dl> | |
| 276 | |
| 277 <dt><i>url</i></dt> | |
| 278 <dd> | |
| 279 URL to determine user agent for (QUrl) | |
| 280 </dd> | |
| 281 </dl> | |
| 282 <dl> | |
| 283 <dt>Return:</dt> | |
| 284 <dd> | |
| 285 user agent string (string) | |
| 286 </dd> | |
| 287 </dl> | |
| 288 <a NAME="WebBrowserPage.__init__" ID="WebBrowserPage.__init__"></a> | |
| 289 <h4>WebBrowserPage (Constructor)</h4> | |
| 290 <b>WebBrowserPage</b>(<i>view, parent=None</i>) | |
| 291 | |
| 292 <p> | |
| 293 Constructor | |
| 294 </p> | |
| 295 <dl> | |
| 296 | |
| 297 <dt><i>view</i> (WebBrowserView)</dt> | |
| 298 <dd> | |
| 299 reference to the WebBrowserView associated with the page | |
| 300 </dd> | |
| 301 <dt><i>parent</i> (QWidget (optional))</dt> | |
| 302 <dd> | |
| 303 reference to the parent widget (defaults to None) | |
| 304 </dd> | |
| 305 </dl> | |
| 306 <a NAME="WebBrowserPage.__contentsSizeChanged" ID="WebBrowserPage.__contentsSizeChanged"></a> | |
| 307 <h4>WebBrowserPage.__contentsSizeChanged</h4> | |
| 308 <b>__contentsSizeChanged</b>(<i>size</i>) | |
| 309 | |
| 310 <p> | |
| 311 Private slot to work around QWebEnginePage not scrolling to anchors | |
| 312 when opened in a background tab. | |
| 313 </p> | |
| 314 <dl> | |
| 315 | |
| 316 <dt><i>size</i> (QSize)</dt> | |
| 317 <dd> | |
| 318 changed contents size (unused) | |
| 319 </dd> | |
| 320 </dl> | |
| 321 <a NAME="WebBrowserPage.__featurePermissionRequested" ID="WebBrowserPage.__featurePermissionRequested"></a> | |
| 322 <h4>WebBrowserPage.__featurePermissionRequested</h4> | |
| 323 <b>__featurePermissionRequested</b>(<i>url, feature</i>) | |
| 324 | |
| 325 <p> | |
| 326 Private slot handling a feature permission request. | |
| 327 </p> | |
| 328 <dl> | |
| 329 | |
| 330 <dt><i>url</i> (QUrl)</dt> | |
| 331 <dd> | |
| 332 url requesting the feature | |
| 333 </dd> | |
| 334 <dt><i>feature</i> (QWebEnginePage.Feature)</dt> | |
| 335 <dd> | |
| 336 requested feature | |
| 337 </dd> | |
| 338 </dl> | |
| 339 <a NAME="WebBrowserPage.__fullScreenRequested" ID="WebBrowserPage.__fullScreenRequested"></a> | |
| 340 <h4>WebBrowserPage.__fullScreenRequested</h4> | |
| 341 <b>__fullScreenRequested</b>(<i>request</i>) | |
| 342 | |
| 343 <p> | |
| 344 Private slot handling a full screen request. | |
| 345 </p> | |
| 346 <dl> | |
| 347 | |
| 348 <dt><i>request</i> (QWebEngineFullScreenRequest)</dt> | |
| 349 <dd> | |
| 350 reference to the full screen request | |
| 351 </dd> | |
| 352 </dl> | |
| 353 <a NAME="WebBrowserPage.__registerProtocolHandlerRequested" ID="WebBrowserPage.__registerProtocolHandlerRequested"></a> | |
| 354 <h4>WebBrowserPage.__registerProtocolHandlerRequested</h4> | |
| 355 <b>__registerProtocolHandlerRequested</b>(<i>request</i>) | |
| 356 | |
| 357 <p> | |
| 358 Private slot to handle the registration of a custom protocol | |
| 359 handler. | |
| 360 </p> | |
| 361 <dl> | |
| 362 | |
| 363 <dt><i>request</i> (QWebEngineRegisterProtocolHandlerRequest)</dt> | |
| 364 <dd> | |
| 365 reference to the registration request | |
| 366 </dd> | |
| 367 </dl> | |
| 368 <a NAME="WebBrowserPage.__setupChannelTimeout" ID="WebBrowserPage.__setupChannelTimeout"></a> | |
| 369 <h4>WebBrowserPage.__setupChannelTimeout</h4> | |
| 370 <b>__setupChannelTimeout</b>(<i></i>) | |
| 371 | |
| 372 <p> | |
| 373 Private slot to initiate the setup of the web channel. | |
| 374 </p> | |
| 375 <a NAME="WebBrowserPage.__setupWebChannelForUrl" ID="WebBrowserPage.__setupWebChannelForUrl"></a> | |
| 376 <h4>WebBrowserPage.__setupWebChannelForUrl</h4> | |
| 377 <b>__setupWebChannelForUrl</b>(<i>url</i>) | |
| 378 | |
| 379 <p> | |
| 380 Private method to setup a web channel to our external object. | |
| 381 </p> | |
| 382 <dl> | |
| 383 | |
| 384 <dt><i>url</i> (QUrl)</dt> | |
| 385 <dd> | |
| 386 URL for which to setup the web channel | |
| 387 </dd> | |
| 388 </dl> | |
| 389 <a NAME="WebBrowserPage.__urlChanged" ID="WebBrowserPage.__urlChanged"></a> | |
| 390 <h4>WebBrowserPage.__urlChanged</h4> | |
| 391 <b>__urlChanged</b>(<i>url</i>) | |
| 392 | |
| 393 <p> | |
| 394 Private slot to handle changes of the URL. | |
| 395 </p> | |
| 396 <dl> | |
| 397 | |
| 398 <dt><i>url</i> (QUrl)</dt> | |
| 399 <dd> | |
| 400 new URL | |
| 401 </dd> | |
| 402 </dl> | |
| 403 <a NAME="WebBrowserPage.acceptNavigationRequest" ID="WebBrowserPage.acceptNavigationRequest"></a> | |
| 404 <h4>WebBrowserPage.acceptNavigationRequest</h4> | |
| 405 <b>acceptNavigationRequest</b>(<i>url, type_, isMainFrame</i>) | |
| 406 | |
| 407 <p> | |
| 408 Public method to determine, if a request may be accepted. | |
| 409 </p> | |
| 410 <dl> | |
| 411 | |
| 412 <dt><i>url</i> (QUrl)</dt> | |
| 413 <dd> | |
| 414 URL to navigate to | |
| 415 </dd> | |
| 416 <dt><i>type_</i> (QWebEnginePage.NavigationType)</dt> | |
| 417 <dd> | |
| 418 type of the navigation request | |
| 419 </dd> | |
| 420 <dt><i>isMainFrame</i> (bool)</dt> | |
| 421 <dd> | |
| 422 flag indicating, that the request originated from | |
| 423 the main frame | |
| 424 </dd> | |
| 425 </dl> | |
| 426 <dl> | |
| 427 <dt>Return:</dt> | |
| 428 <dd> | |
| 429 flag indicating acceptance | |
| 430 </dd> | |
| 431 </dl> | |
| 432 <dl> | |
| 433 <dt>Return Type:</dt> | |
| 434 <dd> | |
| 435 bool | |
| 436 </dd> | |
| 437 </dl> | |
| 438 <a NAME="WebBrowserPage.certificateError" ID="WebBrowserPage.certificateError"></a> | |
| 439 <h4>WebBrowserPage.certificateError</h4> | |
| 440 <b>certificateError</b>(<i>error</i>) | |
| 441 | |
| 442 <p> | |
| 443 Public method to handle SSL certificate errors. | |
| 444 </p> | |
| 445 <dl> | |
| 446 | |
| 447 <dt><i>error</i> (QWebEngineCertificateError)</dt> | |
| 448 <dd> | |
| 449 object containing the certificate error information | |
| 450 </dd> | |
| 451 </dl> | |
| 452 <dl> | |
| 453 <dt>Return:</dt> | |
| 454 <dd> | |
| 455 flag indicating to ignore this error | |
| 456 </dd> | |
| 457 </dl> | |
| 458 <dl> | |
| 459 <dt>Return Type:</dt> | |
| 460 <dd> | |
| 461 bool | |
| 462 </dd> | |
| 463 </dl> | |
| 464 <a NAME="WebBrowserPage.clearSslConfiguration" ID="WebBrowserPage.clearSslConfiguration"></a> | |
| 465 <h4>WebBrowserPage.clearSslConfiguration</h4> | |
| 466 <b>clearSslConfiguration</b>(<i></i>) | |
| 467 | |
| 468 <p> | |
| 469 Public slot to clear the stored SSL configuration data. | |
| 470 </p> | |
| 471 <a NAME="WebBrowserPage.execJavaScript" ID="WebBrowserPage.execJavaScript"></a> | |
| 472 <h4>WebBrowserPage.execJavaScript</h4> | |
| 473 <b>execJavaScript</b>(<i>script, worldId=QWebEngineScript.ScriptWorldId.MainWorld, timeout=500</i>) | |
| 474 | |
| 475 <p> | |
| 476 Public method to execute a JavaScript function synchroneously. | |
| 477 </p> | |
| 478 <dl> | |
| 479 | |
| 480 <dt><i>script</i> (str)</dt> | |
| 481 <dd> | |
| 482 JavaScript script source to be executed | |
| 483 </dd> | |
| 484 <dt><i>worldId</i> (QWebEngineScript.ScriptWorldId)</dt> | |
| 485 <dd> | |
| 486 ID to run the script under | |
| 487 </dd> | |
| 488 <dt><i>timeout</i> (int)</dt> | |
| 489 <dd> | |
| 490 max. time the script is given to execute | |
| 491 </dd> | |
| 492 </dl> | |
| 493 <dl> | |
| 494 <dt>Return:</dt> | |
| 495 <dd> | |
| 496 result of the script | |
| 497 </dd> | |
| 498 </dl> | |
| 499 <dl> | |
| 500 <dt>Return Type:</dt> | |
| 501 <dd> | |
| 502 depending upon script result | |
| 503 </dd> | |
| 504 </dl> | |
| 505 <a NAME="WebBrowserPage.execPrintPage" ID="WebBrowserPage.execPrintPage"></a> | |
| 506 <h4>WebBrowserPage.execPrintPage</h4> | |
| 507 <b>execPrintPage</b>(<i>printer, timeout=1000</i>) | |
| 508 | |
| 509 <p> | |
| 510 Public method to execute a synchronous print. | |
| 511 </p> | |
| 512 <dl> | |
| 513 | |
| 514 <dt><i>printer</i> (QPrinter)</dt> | |
| 515 <dd> | |
| 516 reference to the printer object | |
| 517 </dd> | |
| 518 <dt><i>timeout</i> (int)</dt> | |
| 519 <dd> | |
| 520 timeout value in milliseconds | |
| 521 </dd> | |
| 522 </dl> | |
| 523 <dl> | |
| 524 <dt>Return:</dt> | |
| 525 <dd> | |
| 526 flag indicating a successful print job | |
| 527 </dd> | |
| 528 </dl> | |
| 529 <dl> | |
| 530 <dt>Return Type:</dt> | |
| 531 <dd> | |
| 532 bool | |
| 533 </dd> | |
| 534 </dl> | |
| 535 <a NAME="WebBrowserPage.getSafeBrowsingStatus" ID="WebBrowserPage.getSafeBrowsingStatus"></a> | |
| 536 <h4>WebBrowserPage.getSafeBrowsingStatus</h4> | |
| 537 <b>getSafeBrowsingStatus</b>(<i></i>) | |
| 538 | |
| 539 <p> | |
| 540 Public method to get the safe browsing status of the current page. | |
| 541 </p> | |
| 542 <dl> | |
| 543 <dt>Return:</dt> | |
| 544 <dd> | |
| 545 flag indicating a safe site | |
| 546 </dd> | |
| 547 </dl> | |
| 548 <dl> | |
| 549 <dt>Return Type:</dt> | |
| 550 <dd> | |
| 551 bool | |
| 552 </dd> | |
| 553 </dl> | |
| 554 <a NAME="WebBrowserPage.getSslCertificate" ID="WebBrowserPage.getSslCertificate"></a> | |
| 555 <h4>WebBrowserPage.getSslCertificate</h4> | |
| 556 <b>getSslCertificate</b>(<i></i>) | |
| 557 | |
| 558 <p> | |
| 559 Public method to get a reference to the SSL certificate. | |
| 560 </p> | |
| 561 <dl> | |
| 562 <dt>Return:</dt> | |
| 563 <dd> | |
| 564 amended SSL certificate | |
| 565 </dd> | |
| 566 </dl> | |
| 567 <dl> | |
| 568 <dt>Return Type:</dt> | |
| 569 <dd> | |
| 570 QSslCertificate | |
| 571 </dd> | |
| 572 </dl> | |
| 573 <a NAME="WebBrowserPage.getSslCertificateChain" ID="WebBrowserPage.getSslCertificateChain"></a> | |
| 574 <h4>WebBrowserPage.getSslCertificateChain</h4> | |
| 575 <b>getSslCertificateChain</b>(<i></i>) | |
| 576 | |
| 577 <p> | |
| 578 Public method to get a reference to the SSL certificate chain. | |
| 579 </p> | |
| 580 <dl> | |
| 581 <dt>Return:</dt> | |
| 582 <dd> | |
| 583 SSL certificate chain | |
| 584 </dd> | |
| 585 </dl> | |
| 586 <dl> | |
| 587 <dt>Return Type:</dt> | |
| 588 <dd> | |
| 589 list of QSslCertificate | |
| 590 </dd> | |
| 591 </dl> | |
| 592 <a NAME="WebBrowserPage.getSslConfiguration" ID="WebBrowserPage.getSslConfiguration"></a> | |
| 593 <h4>WebBrowserPage.getSslConfiguration</h4> | |
| 594 <b>getSslConfiguration</b>(<i></i>) | |
| 595 | |
| 596 <p> | |
| 597 Public method to return a reference to the current SSL configuration. | |
| 598 </p> | |
| 599 <dl> | |
| 600 <dt>Return:</dt> | |
| 601 <dd> | |
| 602 reference to the SSL configuration in use | |
| 603 </dd> | |
| 604 </dl> | |
| 605 <dl> | |
| 606 <dt>Return Type:</dt> | |
| 607 <dd> | |
| 608 QSslConfiguration | |
| 609 </dd> | |
| 610 </dl> | |
| 611 <a NAME="WebBrowserPage.hasValidSslInfo" ID="WebBrowserPage.hasValidSslInfo"></a> | |
| 612 <h4>WebBrowserPage.hasValidSslInfo</h4> | |
| 613 <b>hasValidSslInfo</b>(<i></i>) | |
| 614 | |
| 615 <p> | |
| 616 Public method to check, if the page has a valid SSL certificate. | |
| 617 </p> | |
| 618 <dl> | |
| 619 <dt>Return:</dt> | |
| 620 <dd> | |
| 621 flag indicating a valid SSL certificate | |
| 622 </dd> | |
| 623 </dl> | |
| 624 <dl> | |
| 625 <dt>Return Type:</dt> | |
| 626 <dd> | |
| 627 bool | |
| 628 </dd> | |
| 629 </dl> | |
| 630 <a NAME="WebBrowserPage.hitTestContent" ID="WebBrowserPage.hitTestContent"></a> | |
| 631 <h4>WebBrowserPage.hitTestContent</h4> | |
| 632 <b>hitTestContent</b>(<i>pos</i>) | |
| 633 | |
| 634 <p> | |
| 635 Public method to test the content at a specified position. | |
| 636 </p> | |
| 637 <dl> | |
| 638 | |
| 639 <dt><i>pos</i> (QPoint)</dt> | |
| 640 <dd> | |
| 641 position to execute the test at | |
| 642 </dd> | |
| 643 </dl> | |
| 644 <dl> | |
| 645 <dt>Return:</dt> | |
| 646 <dd> | |
| 647 test result object | |
| 648 </dd> | |
| 649 </dl> | |
| 650 <dl> | |
| 651 <dt>Return Type:</dt> | |
| 652 <dd> | |
| 653 WebHitTestResult | |
| 654 </dd> | |
| 655 </dl> | |
| 656 <a NAME="WebBrowserPage.isJavaScriptEnabled" ID="WebBrowserPage.isJavaScriptEnabled"></a> | |
| 657 <h4>WebBrowserPage.isJavaScriptEnabled</h4> | |
| 658 <b>isJavaScriptEnabled</b>(<i></i>) | |
| 659 | |
| 660 <p> | |
| 661 Public method to test, if JavaScript is enabled. | |
| 662 </p> | |
| 663 <dl> | |
| 664 <dt>Return:</dt> | |
| 665 <dd> | |
| 666 flag indicating the state of the JavaScript support | |
| 667 </dd> | |
| 668 </dl> | |
| 669 <dl> | |
| 670 <dt>Return Type:</dt> | |
| 671 <dd> | |
| 672 bool | |
| 673 </dd> | |
| 674 </dl> | |
| 675 <a NAME="WebBrowserPage.javaScriptConsoleMessage" ID="WebBrowserPage.javaScriptConsoleMessage"></a> | |
| 676 <h4>WebBrowserPage.javaScriptConsoleMessage</h4> | |
| 677 <b>javaScriptConsoleMessage</b>(<i>level, message, lineNumber, sourceId</i>) | |
| 678 | |
| 679 <p> | |
| 680 Public method to show a console message. | |
| 681 </p> | |
| 682 <dl> | |
| 683 | |
| 684 <dt><i>level</i> (QWebEnginePage.JavaScriptConsoleMessageLevel)</dt> | |
| 685 <dd> | |
| 686 severity | |
| 687 </dd> | |
| 688 <dt><i>message</i> (str)</dt> | |
| 689 <dd> | |
| 690 message to be shown | |
| 691 </dd> | |
| 692 <dt><i>lineNumber</i> (int)</dt> | |
| 693 <dd> | |
| 694 line number of an error | |
| 695 </dd> | |
| 696 <dt><i>sourceId</i> (str)</dt> | |
| 697 <dd> | |
| 698 source URL causing the error | |
| 699 </dd> | |
| 700 </dl> | |
| 701 <a NAME="WebBrowserPage.mapToViewport" ID="WebBrowserPage.mapToViewport"></a> | |
| 702 <h4>WebBrowserPage.mapToViewport</h4> | |
| 703 <b>mapToViewport</b>(<i>pos</i>) | |
| 704 | |
| 705 <p> | |
| 706 Public method to map a position to the viewport. | |
| 707 </p> | |
| 708 <dl> | |
| 709 | |
| 710 <dt><i>pos</i> (QPoint)</dt> | |
| 711 <dd> | |
| 712 position to be mapped | |
| 713 </dd> | |
| 714 </dl> | |
| 715 <dl> | |
| 716 <dt>Return:</dt> | |
| 717 <dd> | |
| 718 viewport position | |
| 719 </dd> | |
| 720 </dl> | |
| 721 <dl> | |
| 722 <dt>Return Type:</dt> | |
| 723 <dd> | |
| 724 QPoint | |
| 725 </dd> | |
| 726 </dl> | |
| 727 <a NAME="WebBrowserPage.printCallback" ID="WebBrowserPage.printCallback"></a> | |
| 728 <h4>WebBrowserPage.printCallback</h4> | |
| 729 <b>printCallback</b>(<i>resDict=resultDict</i>) | |
| 730 | |
| 731 <a NAME="WebBrowserPage.registerProtocolHandlerRequestScheme" ID="WebBrowserPage.registerProtocolHandlerRequestScheme"></a> | |
| 732 <h4>WebBrowserPage.registerProtocolHandlerRequestScheme</h4> | |
| 733 <b>registerProtocolHandlerRequestScheme</b>(<i></i>) | |
| 734 | |
| 735 <p> | |
| 736 Public method to get the registered protocol handler request scheme. | |
| 737 </p> | |
| 738 <dl> | |
| 739 <dt>Return:</dt> | |
| 740 <dd> | |
| 741 registered protocol handler request scheme | |
| 742 </dd> | |
| 743 </dl> | |
| 744 <dl> | |
| 745 <dt>Return Type:</dt> | |
| 746 <dd> | |
| 747 str | |
| 748 </dd> | |
| 749 </dl> | |
| 750 <a NAME="WebBrowserPage.registerProtocolHandlerRequestUrl" ID="WebBrowserPage.registerProtocolHandlerRequestUrl"></a> | |
| 751 <h4>WebBrowserPage.registerProtocolHandlerRequestUrl</h4> | |
| 752 <b>registerProtocolHandlerRequestUrl</b>(<i></i>) | |
| 753 | |
| 754 <p> | |
| 755 Public method to get the registered protocol handler request URL. | |
| 756 </p> | |
| 757 <dl> | |
| 758 <dt>Return:</dt> | |
| 759 <dd> | |
| 760 registered protocol handler request URL | |
| 761 </dd> | |
| 762 </dl> | |
| 763 <dl> | |
| 764 <dt>Return Type:</dt> | |
| 765 <dd> | |
| 766 QUrl | |
| 767 </dd> | |
| 768 </dl> | |
| 769 <a NAME="WebBrowserPage.resultCallback" ID="WebBrowserPage.resultCallback"></a> | |
| 770 <h4>WebBrowserPage.resultCallback</h4> | |
| 771 <b>resultCallback</b>(<i>resDict=resultDict</i>) | |
| 772 | |
| 773 <a NAME="WebBrowserPage.runJavaScript" ID="WebBrowserPage.runJavaScript"></a> | |
| 774 <h4>WebBrowserPage.runJavaScript</h4> | |
| 775 <b>runJavaScript</b>(<i>script, worldId=-1, callback=None</i>) | |
| 776 | |
| 777 <p> | |
| 778 Public method to run a script in the context of the page. | |
| 779 </p> | |
| 780 <dl> | |
| 781 | |
| 782 <dt><i>script</i> (str)</dt> | |
| 783 <dd> | |
| 784 JavaScript script source to be executed | |
| 785 </dd> | |
| 786 <dt><i>worldId</i> (int)</dt> | |
| 787 <dd> | |
| 788 ID to run the script under | |
| 789 </dd> | |
| 790 <dt><i>callback</i> (function)</dt> | |
| 791 <dd> | |
| 792 callback function to be executed when the script has | |
| 793 ended | |
| 794 </dd> | |
| 795 </dl> | |
| 796 <a NAME="WebBrowserPage.scroll" ID="WebBrowserPage.scroll"></a> | |
| 797 <h4>WebBrowserPage.scroll</h4> | |
| 798 <b>scroll</b>(<i>x, y</i>) | |
| 799 | |
| 800 <p> | |
| 801 Public method to scroll by the given amount of pixels. | |
| 802 </p> | |
| 803 <dl> | |
| 804 | |
| 805 <dt><i>x</i> (int)</dt> | |
| 806 <dd> | |
| 807 horizontal scroll value | |
| 808 </dd> | |
| 809 <dt><i>y</i> (int)</dt> | |
| 810 <dd> | |
| 811 vertical scroll value | |
| 812 </dd> | |
| 813 </dl> | |
| 814 <a NAME="WebBrowserPage.scrollTo" ID="WebBrowserPage.scrollTo"></a> | |
| 815 <h4>WebBrowserPage.scrollTo</h4> | |
| 816 <b>scrollTo</b>(<i>pos</i>) | |
| 817 | |
| 818 <p> | |
| 819 Public method to scroll to the given position. | |
| 820 </p> | |
| 821 <dl> | |
| 822 | |
| 823 <dt><i>pos</i> (QPointF)</dt> | |
| 824 <dd> | |
| 825 position to scroll to | |
| 826 </dd> | |
| 827 </dl> | |
| 828 <a NAME="WebBrowserPage.setSslConfiguration" ID="WebBrowserPage.setSslConfiguration"></a> | |
| 829 <h4>WebBrowserPage.setSslConfiguration</h4> | |
| 830 <b>setSslConfiguration</b>(<i>sslConfiguration</i>) | |
| 831 | |
| 832 <p> | |
| 833 Public slot to set the SSL configuration data of the page. | |
| 834 </p> | |
| 835 <dl> | |
| 836 | |
| 837 <dt><i>sslConfiguration</i> (QSslConfiguration)</dt> | |
| 838 <dd> | |
| 839 SSL configuration to be set | |
| 840 </dd> | |
| 841 </dl> | |
| 842 <a NAME="WebBrowserPage.showSslInfo" ID="WebBrowserPage.showSslInfo"></a> | |
| 843 <h4>WebBrowserPage.showSslInfo</h4> | |
| 844 <b>showSslInfo</b>(<i>pos</i>) | |
| 845 | |
| 846 <p> | |
| 847 Public slot to show some SSL information for the loaded page. | |
| 848 </p> | |
| 849 <dl> | |
| 850 | |
| 851 <dt><i>pos</i> (QPoint)</dt> | |
| 852 <dd> | |
| 853 position to show the info at | |
| 854 </dd> | |
| 855 </dl> | |
| 856 <a NAME="WebBrowserPage.view" ID="WebBrowserPage.view"></a> | |
| 857 <h4>WebBrowserPage.view</h4> | |
| 858 <b>view</b>(<i></i>) | |
| 859 | |
| 860 <p> | |
| 861 Public method to get a reference to the WebBrowserView associated with | |
| 862 the page. | |
| 863 </p> | |
| 864 <dl> | |
| 865 <dt>Return:</dt> | |
| 866 <dd> | |
| 867 reference to the WebBrowserView associated with the page | |
| 868 r@type WebBrowserView | |
| 869 </dd> | |
| 870 </dl> | |
| 871 <div align="right"><a href="#top">Up</a></div> | |
| 872 <hr /> | |
| 873 </body></html> |
