5 <link rel="stylesheet" href="styles.css"> |
5 <link rel="stylesheet" href="styles.css"> |
6 </head> |
6 </head> |
7 <body> |
7 <body> |
8 <a NAME="top" ID="top"></a> |
8 <a NAME="top" ID="top"></a> |
9 <h1>eric7.WebBrowser.Tools.WebHitTestResult</h1> |
9 <h1>eric7.WebBrowser.Tools.WebHitTestResult</h1> |
10 |
|
11 <p> |
10 <p> |
12 Module implementing an object for testing certain aspects of a web page. |
11 Module implementing an object for testing certain aspects of a web page. |
13 </p> |
12 </p> |
|
13 |
14 <h3>Global Attributes</h3> |
14 <h3>Global Attributes</h3> |
15 |
|
16 <table> |
15 <table> |
17 <tr><td>None</td></tr> |
16 <tr><td>None</td></tr> |
18 </table> |
17 </table> |
|
18 |
19 <h3>Classes</h3> |
19 <h3>Classes</h3> |
20 |
20 <table> |
21 <table> |
|
22 |
|
23 <tr> |
21 <tr> |
24 <td><a href="#WebHitTestResult">WebHitTestResult</a></td> |
22 <td><a href="#WebHitTestResult">WebHitTestResult</a></td> |
25 <td>Class implementing an object for testing certain aspects of a web page.</td> |
23 <td>Class implementing an object for testing certain aspects of a web page.</td> |
26 </tr> |
24 </tr> |
27 </table> |
25 </table> |
|
26 |
28 <h3>Functions</h3> |
27 <h3>Functions</h3> |
29 |
|
30 <table> |
28 <table> |
31 <tr><td>None</td></tr> |
29 <tr><td>None</td></tr> |
32 </table> |
30 </table> |
|
31 |
33 <hr /> |
32 <hr /> |
34 <hr /> |
33 <hr /> |
35 <a NAME="WebHitTestResult" ID="WebHitTestResult"></a> |
34 <a NAME="WebHitTestResult" ID="WebHitTestResult"></a> |
36 <h2>WebHitTestResult</h2> |
35 <h2>WebHitTestResult</h2> |
37 |
|
38 <p> |
36 <p> |
39 Class implementing an object for testing certain aspects of a web page. |
37 Class implementing an object for testing certain aspects of a web page. |
40 </p> |
38 </p> |
|
39 |
41 <h3>Derived from</h3> |
40 <h3>Derived from</h3> |
42 None |
41 None |
43 <h3>Class Attributes</h3> |
42 <h3>Class Attributes</h3> |
44 |
|
45 <table> |
43 <table> |
46 <tr><td>None</td></tr> |
44 <tr><td>None</td></tr> |
47 </table> |
45 </table> |
|
46 |
48 <h3>Class Methods</h3> |
47 <h3>Class Methods</h3> |
49 |
|
50 <table> |
48 <table> |
51 <tr><td>None</td></tr> |
49 <tr><td>None</td></tr> |
52 </table> |
50 </table> |
|
51 |
53 <h3>Methods</h3> |
52 <h3>Methods</h3> |
54 |
53 <table> |
55 <table> |
|
56 |
|
57 <tr> |
54 <tr> |
58 <td><a href="#WebHitTestResult.__init__">WebHitTestResult</a></td> |
55 <td><a href="#WebHitTestResult.__init__">WebHitTestResult</a></td> |
59 <td>Constructor</td> |
56 <td>Constructor</td> |
60 </tr> |
57 </tr> |
61 <tr> |
58 <tr> |
125 <tr> |
122 <tr> |
126 <td><a href="#WebHitTestResult.viewportPos">viewportPos</a></td> |
123 <td><a href="#WebHitTestResult.viewportPos">viewportPos</a></td> |
127 <td>Public method to get the viewport position.</td> |
124 <td>Public method to get the viewport position.</td> |
128 </tr> |
125 </tr> |
129 </table> |
126 </table> |
|
127 |
130 <h3>Static Methods</h3> |
128 <h3>Static Methods</h3> |
131 |
|
132 <table> |
129 <table> |
133 <tr><td>None</td></tr> |
130 <tr><td>None</td></tr> |
134 </table> |
131 </table> |
|
132 |
135 |
133 |
136 <a NAME="WebHitTestResult.__init__" ID="WebHitTestResult.__init__"></a> |
134 <a NAME="WebHitTestResult.__init__" ID="WebHitTestResult.__init__"></a> |
137 <h4>WebHitTestResult (Constructor)</h4> |
135 <h4>WebHitTestResult (Constructor)</h4> |
138 <b>WebHitTestResult</b>(<i>page, pos</i>) |
136 <b>WebHitTestResult</b>(<i>page, pos</i>) |
139 |
|
140 <p> |
137 <p> |
141 Constructor |
138 Constructor |
142 </p> |
139 </p> |
|
140 |
143 <dl> |
141 <dl> |
144 |
142 |
145 <dt><i>page</i> (WebBrowserPage)</dt> |
143 <dt><i>page</i> (WebBrowserPage)</dt> |
146 <dd> |
144 <dd> |
147 reference to the web page |
145 reference to the web page |
152 </dd> |
150 </dd> |
153 </dl> |
151 </dl> |
154 <a NAME="WebHitTestResult.__populate" ID="WebHitTestResult.__populate"></a> |
152 <a NAME="WebHitTestResult.__populate" ID="WebHitTestResult.__populate"></a> |
155 <h4>WebHitTestResult.__populate</h4> |
153 <h4>WebHitTestResult.__populate</h4> |
156 <b>__populate</b>(<i>url, res</i>) |
154 <b>__populate</b>(<i>url, res</i>) |
157 |
|
158 <p> |
155 <p> |
159 Private method to populate the object. |
156 Private method to populate the object. |
160 </p> |
157 </p> |
|
158 |
161 <dl> |
159 <dl> |
162 |
160 |
163 <dt><i>url</i> (QUrl)</dt> |
161 <dt><i>url</i> (QUrl)</dt> |
164 <dd> |
162 <dd> |
165 URL of the tested page |
163 URL of the tested page |
246 </dd> |
244 </dd> |
247 </dl> |
245 </dl> |
248 <a NAME="WebHitTestResult.isContentEditable" ID="WebHitTestResult.isContentEditable"></a> |
246 <a NAME="WebHitTestResult.isContentEditable" ID="WebHitTestResult.isContentEditable"></a> |
249 <h4>WebHitTestResult.isContentEditable</h4> |
247 <h4>WebHitTestResult.isContentEditable</h4> |
250 <b>isContentEditable</b>(<i></i>) |
248 <b>isContentEditable</b>(<i></i>) |
251 |
|
252 <p> |
249 <p> |
253 Public method to check for editable content. |
250 Public method to check for editable content. |
254 </p> |
251 </p> |
|
252 |
255 <dl> |
253 <dl> |
256 <dt>Return:</dt> |
254 <dt>Return:</dt> |
257 <dd> |
255 <dd> |
258 flag indicating editable content |
256 flag indicating editable content |
259 </dd> |
257 </dd> |
265 </dd> |
263 </dd> |
266 </dl> |
264 </dl> |
267 <a NAME="WebHitTestResult.isContentSelected" ID="WebHitTestResult.isContentSelected"></a> |
265 <a NAME="WebHitTestResult.isContentSelected" ID="WebHitTestResult.isContentSelected"></a> |
268 <h4>WebHitTestResult.isContentSelected</h4> |
266 <h4>WebHitTestResult.isContentSelected</h4> |
269 <b>isContentSelected</b>(<i></i>) |
267 <b>isContentSelected</b>(<i></i>) |
270 |
|
271 <p> |
268 <p> |
272 Public method to check for selected content. |
269 Public method to check for selected content. |
273 </p> |
270 </p> |
|
271 |
274 <dl> |
272 <dl> |
275 <dt>Return:</dt> |
273 <dt>Return:</dt> |
276 <dd> |
274 <dd> |
277 flag indicating selected content |
275 flag indicating selected content |
278 </dd> |
276 </dd> |
284 </dd> |
282 </dd> |
285 </dl> |
283 </dl> |
286 <a NAME="WebHitTestResult.isNull" ID="WebHitTestResult.isNull"></a> |
284 <a NAME="WebHitTestResult.isNull" ID="WebHitTestResult.isNull"></a> |
287 <h4>WebHitTestResult.isNull</h4> |
285 <h4>WebHitTestResult.isNull</h4> |
288 <b>isNull</b>(<i></i>) |
286 <b>isNull</b>(<i></i>) |
289 |
|
290 <p> |
287 <p> |
291 Public method to test, if the hit test is empty. |
288 Public method to test, if the hit test is empty. |
292 </p> |
289 </p> |
|
290 |
293 <dl> |
291 <dl> |
294 <dt>Return:</dt> |
292 <dt>Return:</dt> |
295 <dd> |
293 <dd> |
296 flag indicating an empty object |
294 flag indicating an empty object |
297 </dd> |
295 </dd> |
303 </dd> |
301 </dd> |
304 </dl> |
302 </dl> |
305 <a NAME="WebHitTestResult.linkTitle" ID="WebHitTestResult.linkTitle"></a> |
303 <a NAME="WebHitTestResult.linkTitle" ID="WebHitTestResult.linkTitle"></a> |
306 <h4>WebHitTestResult.linkTitle</h4> |
304 <h4>WebHitTestResult.linkTitle</h4> |
307 <b>linkTitle</b>(<i></i>) |
305 <b>linkTitle</b>(<i></i>) |
308 |
|
309 <p> |
306 <p> |
310 Public method to get the title for a link element. |
307 Public method to get the title for a link element. |
311 </p> |
308 </p> |
|
309 |
312 <dl> |
310 <dl> |
313 <dt>Return:</dt> |
311 <dt>Return:</dt> |
314 <dd> |
312 <dd> |
315 title for a link element |
313 title for a link element |
316 </dd> |
314 </dd> |
322 </dd> |
320 </dd> |
323 </dl> |
321 </dl> |
324 <a NAME="WebHitTestResult.linkUrl" ID="WebHitTestResult.linkUrl"></a> |
322 <a NAME="WebHitTestResult.linkUrl" ID="WebHitTestResult.linkUrl"></a> |
325 <h4>WebHitTestResult.linkUrl</h4> |
323 <h4>WebHitTestResult.linkUrl</h4> |
326 <b>linkUrl</b>(<i></i>) |
324 <b>linkUrl</b>(<i></i>) |
327 |
|
328 <p> |
325 <p> |
329 Public method to get the URL for a link element. |
326 Public method to get the URL for a link element. |
330 </p> |
327 </p> |
|
328 |
331 <dl> |
329 <dl> |
332 <dt>Return:</dt> |
330 <dt>Return:</dt> |
333 <dd> |
331 <dd> |
334 URL for a link element |
332 URL for a link element |
335 </dd> |
333 </dd> |
341 </dd> |
339 </dd> |
342 </dl> |
340 </dl> |
343 <a NAME="WebHitTestResult.mediaMuted" ID="WebHitTestResult.mediaMuted"></a> |
341 <a NAME="WebHitTestResult.mediaMuted" ID="WebHitTestResult.mediaMuted"></a> |
344 <h4>WebHitTestResult.mediaMuted</h4> |
342 <h4>WebHitTestResult.mediaMuted</h4> |
345 <b>mediaMuted</b>(<i></i>) |
343 <b>mediaMuted</b>(<i></i>) |
346 |
|
347 <p> |
344 <p> |
348 Public method to check, if a media element is muted. |
345 Public method to check, if a media element is muted. |
349 </p> |
346 </p> |
|
347 |
350 <dl> |
348 <dl> |
351 <dt>Return:</dt> |
349 <dt>Return:</dt> |
352 <dd> |
350 <dd> |
353 flag indicating a muted media element |
351 flag indicating a muted media element |
354 </dd> |
352 </dd> |
360 </dd> |
358 </dd> |
361 </dl> |
359 </dl> |
362 <a NAME="WebHitTestResult.mediaPaused" ID="WebHitTestResult.mediaPaused"></a> |
360 <a NAME="WebHitTestResult.mediaPaused" ID="WebHitTestResult.mediaPaused"></a> |
363 <h4>WebHitTestResult.mediaPaused</h4> |
361 <h4>WebHitTestResult.mediaPaused</h4> |
364 <b>mediaPaused</b>(<i></i>) |
362 <b>mediaPaused</b>(<i></i>) |
365 |
|
366 <p> |
363 <p> |
367 Public method to check, if a media element is paused. |
364 Public method to check, if a media element is paused. |
368 </p> |
365 </p> |
|
366 |
369 <dl> |
367 <dl> |
370 <dt>Return:</dt> |
368 <dt>Return:</dt> |
371 <dd> |
369 <dd> |
372 flag indicating a paused media element |
370 flag indicating a paused media element |
373 </dd> |
371 </dd> |
379 </dd> |
377 </dd> |
380 </dl> |
378 </dl> |
381 <a NAME="WebHitTestResult.mediaUrl" ID="WebHitTestResult.mediaUrl"></a> |
379 <a NAME="WebHitTestResult.mediaUrl" ID="WebHitTestResult.mediaUrl"></a> |
382 <h4>WebHitTestResult.mediaUrl</h4> |
380 <h4>WebHitTestResult.mediaUrl</h4> |
383 <b>mediaUrl</b>(<i></i>) |
381 <b>mediaUrl</b>(<i></i>) |
384 |
|
385 <p> |
382 <p> |
386 Public method to get the URL for a media element. |
383 Public method to get the URL for a media element. |
387 </p> |
384 </p> |
|
385 |
388 <dl> |
386 <dl> |
389 <dt>Return:</dt> |
387 <dt>Return:</dt> |
390 <dd> |
388 <dd> |
391 URL for a media element |
389 URL for a media element |
392 </dd> |
390 </dd> |
417 </dd> |
415 </dd> |
418 </dl> |
416 </dl> |
419 <a NAME="WebHitTestResult.tagName" ID="WebHitTestResult.tagName"></a> |
417 <a NAME="WebHitTestResult.tagName" ID="WebHitTestResult.tagName"></a> |
420 <h4>WebHitTestResult.tagName</h4> |
418 <h4>WebHitTestResult.tagName</h4> |
421 <b>tagName</b>(<i></i>) |
419 <b>tagName</b>(<i></i>) |
422 |
|
423 <p> |
420 <p> |
424 Public method to get the name of the tested tag. |
421 Public method to get the name of the tested tag. |
425 </p> |
422 </p> |
|
423 |
426 <dl> |
424 <dl> |
427 <dt>Return:</dt> |
425 <dt>Return:</dt> |
428 <dd> |
426 <dd> |
429 name of the tested tag |
427 name of the tested tag |
430 </dd> |
428 </dd> |
436 </dd> |
434 </dd> |
437 </dl> |
435 </dl> |
438 <a NAME="WebHitTestResult.updateWithContextMenuData" ID="WebHitTestResult.updateWithContextMenuData"></a> |
436 <a NAME="WebHitTestResult.updateWithContextMenuData" ID="WebHitTestResult.updateWithContextMenuData"></a> |
439 <h4>WebHitTestResult.updateWithContextMenuData</h4> |
437 <h4>WebHitTestResult.updateWithContextMenuData</h4> |
440 <b>updateWithContextMenuData</b>(<i>data</i>) |
438 <b>updateWithContextMenuData</b>(<i>data</i>) |
441 |
|
442 <p> |
439 <p> |
443 Public method to update the hit test data with data from the context |
440 Public method to update the hit test data with data from the context |
444 menu event. |
441 menu event. |
445 </p> |
442 </p> |
|
443 |
446 <dl> |
444 <dl> |
447 |
445 |
448 <dt><i>data</i> (QWebEngineContextMenuRequest)</dt> |
446 <dt><i>data</i> (QWebEngineContextMenuRequest)</dt> |
449 <dd> |
447 <dd> |
450 context menu data |
448 context menu data |
451 </dd> |
449 </dd> |
452 </dl> |
450 </dl> |
453 <a NAME="WebHitTestResult.viewportPos" ID="WebHitTestResult.viewportPos"></a> |
451 <a NAME="WebHitTestResult.viewportPos" ID="WebHitTestResult.viewportPos"></a> |
454 <h4>WebHitTestResult.viewportPos</h4> |
452 <h4>WebHitTestResult.viewportPos</h4> |
455 <b>viewportPos</b>(<i></i>) |
453 <b>viewportPos</b>(<i></i>) |
456 |
|
457 <p> |
454 <p> |
458 Public method to get the viewport position. |
455 Public method to get the viewport position. |
459 </p> |
456 </p> |
|
457 |
460 <dl> |
458 <dl> |
461 <dt>Return:</dt> |
459 <dt>Return:</dt> |
462 <dd> |
460 <dd> |
463 viewport position |
461 viewport position |
464 </dd> |
462 </dd> |