Mercurial Repositories > eric / file comparison

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

Documentation/Source/eric6.WebBrowser.WebBrowserPage.html

changeset 4918
71caf42a13d8
child 4926
f7ef43c73ae3
equal deleted inserted replaced
4917:682750cc7bd5 4918:71caf42a13d8
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.WebBrowser.WebBrowserPage</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body><a NAME="top" ID="top"></a>
22 <h1>eric6.WebBrowser.WebBrowserPage</h1>
23 <p>
24 Module implementing the helpbrowser using QWebView.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#WebBrowserPage">WebBrowserPage</a></td>
34 <td>Class implementing an enhanced web page.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="WebBrowserPage" ID="WebBrowserPage"></a>
43 <h2>WebBrowserPage</h2>
44 <p>
45 Class implementing an enhanced web page.
46 </p>
47 <h3>Derived from</h3>
48 QWebEnginePage
49 <h3>Class Attributes</h3>
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <h3>Class Methods</h3>
54 <table>
55 <tr>
56 <td><a href="#WebBrowserPage.setUserAgent">setUserAgent</a></td>
57 <td>Class method to set the global user agent string.</td>
58 </tr><tr>
59 <td><a href="#WebBrowserPage.userAgent">userAgent</a></td>
60 <td>Class method to get the global user agent setting.</td>
61 </tr><tr>
62 <td><a href="#WebBrowserPage.userAgentForUrl">userAgentForUrl</a></td>
63 <td>Class method to determine the user agent for the given URL.</td>
64 </tr>
65 </table>
66 <h3>Methods</h3>
67 <table>
68 <tr>
69 <td><a href="#WebBrowserPage.__init__">WebBrowserPage</a></td>
70 <td>Constructor</td>
71 </tr><tr>
72 <td><a href="#WebBrowserPage.__featurePermissionRequested">__featurePermissionRequested</a></td>
73 <td>Private slot handling a feature permission request.</td>
74 </tr><tr>
75 <td><a href="#WebBrowserPage.__fullScreenRequested">__fullScreenRequested</a></td>
76 <td>Private slot handling a full screen request.</td>
77 </tr><tr>
78 <td><a href="#WebBrowserPage.__setupWebChannel">__setupWebChannel</a></td>
79 <td>Private method to setup a web channel to our external object.</td>
80 </tr><tr>
81 <td><a href="#WebBrowserPage.acceptNavigationRequest">acceptNavigationRequest</a></td>
82 <td>Public method to determine, if a request may be accepted.</td>
83 </tr><tr>
84 <td><a href="#WebBrowserPage.certificateError">certificateError</a></td>
85 <td>Public method to handle SSL certificate errors.</td>
86 </tr><tr>
87 <td><a href="#WebBrowserPage.execJavaScript">execJavaScript</a></td>
88 <td>Public method to execute a JavaScript function synchroneously.</td>
89 </tr><tr>
90 <td><a href="#WebBrowserPage.hitTestContent">hitTestContent</a></td>
91 <td>Public method to test the content at a specified position.</td>
92 </tr><tr>
93 <td><a href="#WebBrowserPage.javaScriptConsoleMessage">javaScriptConsoleMessage</a></td>
94 <td>Public method to show a console message.</td>
95 </tr><tr>
96 <td><a href="#WebBrowserPage.resultCallback">resultCallback</a></td>
97 <td></td>
98 </tr><tr>
99 <td><a href="#WebBrowserPage.scroll">scroll</a></td>
100 <td>Public method to scroll by the given amount of pixels.</td>
101 </tr>
102 </table>
103 <h3>Static Methods</h3>
104 <table>
105 <tr><td>None</td></tr>
106 </table>
107 <a NAME="WebBrowserPage.setUserAgent" ID="WebBrowserPage.setUserAgent"></a>
108 <h4>WebBrowserPage.setUserAgent (class method)</h4>
109 <b>setUserAgent</b>(<i>agent</i>)
110 <p>
111 Class method to set the global user agent string.
112 </p><dl>
113 <dt><i>agent</i></dt>
114 <dd>
115 new current user agent string (string)
116 </dd>
117 </dl><a NAME="WebBrowserPage.userAgent" ID="WebBrowserPage.userAgent"></a>
118 <h4>WebBrowserPage.userAgent (class method)</h4>
119 <b>userAgent</b>(<i>resolveEmpty=False</i>)
120 <p>
121 Class method to get the global user agent setting.
122 </p><dl>
123 <dt><i>resolveEmpty</i></dt>
124 <dd>
125 flag indicating to resolve an empty
126 user agent (boolean)
127 </dd>
128 </dl><dl>
129 <dt>Returns:</dt>
130 <dd>
131 user agent string (string)
132 </dd>
133 </dl><a NAME="WebBrowserPage.userAgentForUrl" ID="WebBrowserPage.userAgentForUrl"></a>
134 <h4>WebBrowserPage.userAgentForUrl (class method)</h4>
135 <b>userAgentForUrl</b>(<i>url</i>)
136 <p>
137 Class method to determine the user agent for the given URL.
138 </p><dl>
139 <dt><i>url</i></dt>
140 <dd>
141 URL to determine user agent for (QUrl)
142 </dd>
143 </dl><dl>
144 <dt>Returns:</dt>
145 <dd>
146 user agent string (string)
147 </dd>
148 </dl><a NAME="WebBrowserPage.__init__" ID="WebBrowserPage.__init__"></a>
149 <h4>WebBrowserPage (Constructor)</h4>
150 <b>WebBrowserPage</b>(<i>parent=None</i>)
151 <p>
152 Constructor
153 </p><dl>
154 <dt><i>parent</i></dt>
155 <dd>
156 parent widget of this window (QWidget)
157 </dd>
158 </dl><a NAME="WebBrowserPage.__featurePermissionRequested" ID="WebBrowserPage.__featurePermissionRequested"></a>
159 <h4>WebBrowserPage.__featurePermissionRequested</h4>
160 <b>__featurePermissionRequested</b>(<i>url, feature</i>)
161 <p>
162 Private slot handling a feature permission request.
163 </p><dl>
164 <dt><i>url</i> (QUrl)</dt>
165 <dd>
166 url requesting the feature
167 </dd><dt><i>feature</i> (QWebEnginePage.Feature)</dt>
168 <dd>
169 requested feature
170 </dd>
171 </dl><a NAME="WebBrowserPage.__fullScreenRequested" ID="WebBrowserPage.__fullScreenRequested"></a>
172 <h4>WebBrowserPage.__fullScreenRequested</h4>
173 <b>__fullScreenRequested</b>(<i>request</i>)
174 <p>
175 Private slot handling a full screen request.
176 </p><dl>
177 <dt><i>request</i> (QWebEngineFullScreenRequest)</dt>
178 <dd>
179 reference to the full screen request
180 </dd>
181 </dl><a NAME="WebBrowserPage.__setupWebChannel" ID="WebBrowserPage.__setupWebChannel"></a>
182 <h4>WebBrowserPage.__setupWebChannel</h4>
183 <b>__setupWebChannel</b>(<i></i>)
184 <p>
185 Private method to setup a web channel to our external object.
186 </p><a NAME="WebBrowserPage.acceptNavigationRequest" ID="WebBrowserPage.acceptNavigationRequest"></a>
187 <h4>WebBrowserPage.acceptNavigationRequest</h4>
188 <b>acceptNavigationRequest</b>(<i>url, type_, isMainFrame</i>)
189 <p>
190 Public method to determine, if a request may be accepted.
191 </p><dl>
192 <dt><i>url</i> (QUrl)</dt>
193 <dd>
194 URL to navigate to
195 </dd><dt><i>type_</i> (QWebEnginePage.NavigationType)</dt>
196 <dd>
197 type of the navigation request
198 </dd><dt><i>isMainFrame</i> (bool)</dt>
199 <dd>
200 flag indicating, that the request originated from
201 the main frame
202 </dd>
203 </dl><dl>
204 <dt>Returns:</dt>
205 <dd>
206 flag indicating acceptance
207 </dd>
208 </dl><dl>
209 <dt>Return Type:</dt>
210 <dd>
211 bool
212 </dd>
213 </dl><a NAME="WebBrowserPage.certificateError" ID="WebBrowserPage.certificateError"></a>
214 <h4>WebBrowserPage.certificateError</h4>
215 <b>certificateError</b>(<i>error</i>)
216 <p>
217 Public method to handle SSL certificate errors.
218 </p><dl>
219 <dt><i>error</i> (QWebEngineCertificateError)</dt>
220 <dd>
221 object containing the certificate error information
222 </dd>
223 </dl><dl>
224 <dt>Returns:</dt>
225 <dd>
226 flag indicating to ignore this error
227 </dd>
228 </dl><dl>
229 <dt>Return Type:</dt>
230 <dd>
231 bool
232 </dd>
233 </dl><a NAME="WebBrowserPage.execJavaScript" ID="WebBrowserPage.execJavaScript"></a>
234 <h4>WebBrowserPage.execJavaScript</h4>
235 <b>execJavaScript</b>(<i>script</i>)
236 <p>
237 Public method to execute a JavaScript function synchroneously.
238 </p><dl>
239 <dt><i>script</i> (str)</dt>
240 <dd>
241 JavaScript script source to be executed
242 </dd>
243 </dl><dl>
244 <dt>Returns:</dt>
245 <dd>
246 result of the script
247 </dd>
248 </dl><dl>
249 <dt>Return Type:</dt>
250 <dd>
251 depending upon script result
252 </dd>
253 </dl><a NAME="WebBrowserPage.hitTestContent" ID="WebBrowserPage.hitTestContent"></a>
254 <h4>WebBrowserPage.hitTestContent</h4>
255 <b>hitTestContent</b>(<i>pos</i>)
256 <p>
257 Public method to test the content at a specified position.
258 </p><dl>
259 <dt><i>pos</i> (QPoint)</dt>
260 <dd>
261 position to execute the test at
262 </dd>
263 </dl><dl>
264 <dt>Returns:</dt>
265 <dd>
266 test result object
267 </dd>
268 </dl><dl>
269 <dt>Return Type:</dt>
270 <dd>
271 WebHitTestResult
272 </dd>
273 </dl><a NAME="WebBrowserPage.javaScriptConsoleMessage" ID="WebBrowserPage.javaScriptConsoleMessage"></a>
274 <h4>WebBrowserPage.javaScriptConsoleMessage</h4>
275 <b>javaScriptConsoleMessage</b>(<i>level, message, lineNumber, sourceId</i>)
276 <p>
277 Public method to show a console message.
278 </p><dl>
279 <dt><i>level</i> (QWebEnginePage.JavaScriptConsoleMessageLevel)</dt>
280 <dd>
281 severity
282 </dd><dt><i>message</i> (str)</dt>
283 <dd>
284 message to be shown
285 </dd><dt><i>lineNumber</i> (int)</dt>
286 <dd>
287 line number of an error
288 </dd><dt><i>sourceId</i> (str)</dt>
289 <dd>
290 source URL causing the error
291 </dd>
292 </dl><a NAME="WebBrowserPage.resultCallback" ID="WebBrowserPage.resultCallback"></a>
293 <h4>WebBrowserPage.resultCallback</h4>
294 <b>resultCallback</b>(<i>resDict=resultDict</i>)
295 <a NAME="WebBrowserPage.scroll" ID="WebBrowserPage.scroll"></a>
296 <h4>WebBrowserPage.scroll</h4>
297 <b>scroll</b>(<i>x, y</i>)
298 <p>
299 Public method to scroll by the given amount of pixels.
300 </p><dl>
301 <dt><i>x</i> (int)</dt>
302 <dd>
303 horizontal scroll value
304 </dd><dt><i>y</i> (int)</dt>
305 <dd>
306 vertical scroll value
307 </dd>
308 </dl>
309 <div align="right"><a href="#top">Up</a></div>
310 <hr />
311 </body></html>

Mercurial Repository: eric

eric ide

mercurial