eric6/Documentation/Source/eric6.WebBrowser.WebBrowserPage.html

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

eric ide

mercurial