Mercurial Repositories > eric / file comparison

comparison: eric7/Documentation/Source/eric7.WebBrowser.Tools.WebHitTestResult.html

eric7/Documentation/Source/eric7.WebBrowser.Tools.WebHitTestResult.html

branch
eric7
changeset 8372
e0227a7c850e
child 8583
aac629a05f8b
equal deleted inserted replaced
8371:d6062691d424 8372:e0227a7c850e
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.WebBrowser.Tools.WebHitTestResult</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>
22 <a NAME="top" ID="top"></a>
23 <h1>eric7.WebBrowser.Tools.WebHitTestResult</h1>
24
25 <p>
26 Module implementing an object for testing certain aspects of a web page.
27 </p>
28 <h3>Global Attributes</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <h3>Classes</h3>
34
35 <table>
36
37 <tr>
38 <td><a href="#WebHitTestResult">WebHitTestResult</a></td>
39 <td>Class implementing an object for testing certain aspects of a web page.</td>
40 </tr>
41 </table>
42 <h3>Functions</h3>
43
44 <table>
45 <tr><td>None</td></tr>
46 </table>
47 <hr />
48 <hr />
49 <a NAME="WebHitTestResult" ID="WebHitTestResult"></a>
50 <h2>WebHitTestResult</h2>
51
52 <p>
53 Class implementing an object for testing certain aspects of a web page.
54 </p>
55 <h3>Derived from</h3>
56 None
57 <h3>Class Attributes</h3>
58
59 <table>
60 <tr><td>None</td></tr>
61 </table>
62 <h3>Class Methods</h3>
63
64 <table>
65 <tr><td>None</td></tr>
66 </table>
67 <h3>Methods</h3>
68
69 <table>
70
71 <tr>
72 <td><a href="#WebHitTestResult.__init__">WebHitTestResult</a></td>
73 <td>Constructor</td>
74 </tr>
75 <tr>
76 <td><a href="#WebHitTestResult.__populate">__populate</a></td>
77 <td>Private method to populate the object.</td>
78 </tr>
79 <tr>
80 <td><a href="#WebHitTestResult.alternateText">alternateText</a></td>
81 <td>Public method to get the alternate text.</td>
82 </tr>
83 <tr>
84 <td><a href="#WebHitTestResult.baseUrl">baseUrl</a></td>
85 <td>Public method to get the base URL of the page.</td>
86 </tr>
87 <tr>
88 <td><a href="#WebHitTestResult.boundingRect">boundingRect</a></td>
89 <td>Public method to get the bounding rectangle.</td>
90 </tr>
91 <tr>
92 <td><a href="#WebHitTestResult.imageUrl">imageUrl</a></td>
93 <td>Public method to get the URL of an image.</td>
94 </tr>
95 <tr>
96 <td><a href="#WebHitTestResult.isContentEditable">isContentEditable</a></td>
97 <td>Public method to check for editable content.</td>
98 </tr>
99 <tr>
100 <td><a href="#WebHitTestResult.isContentSelected">isContentSelected</a></td>
101 <td>Public method to check for selected content.</td>
102 </tr>
103 <tr>
104 <td><a href="#WebHitTestResult.isNull">isNull</a></td>
105 <td>Public method to test, if the hit test is empty.</td>
106 </tr>
107 <tr>
108 <td><a href="#WebHitTestResult.linkTitle">linkTitle</a></td>
109 <td>Public method to get the title for a link element.</td>
110 </tr>
111 <tr>
112 <td><a href="#WebHitTestResult.linkUrl">linkUrl</a></td>
113 <td>Public method to get the URL for a link element.</td>
114 </tr>
115 <tr>
116 <td><a href="#WebHitTestResult.mediaMuted">mediaMuted</a></td>
117 <td>Public method to check, if a media element is muted.</td>
118 </tr>
119 <tr>
120 <td><a href="#WebHitTestResult.mediaPaused">mediaPaused</a></td>
121 <td>Public method to check, if a media element is paused.</td>
122 </tr>
123 <tr>
124 <td><a href="#WebHitTestResult.mediaUrl">mediaUrl</a></td>
125 <td>Public method to get the URL for a media element.</td>
126 </tr>
127 <tr>
128 <td><a href="#WebHitTestResult.pos">pos</a></td>
129 <td>Public method to get the position of the hit test.</td>
130 </tr>
131 <tr>
132 <td><a href="#WebHitTestResult.tagName">tagName</a></td>
133 <td>Public method to get the name of the tested tag.</td>
134 </tr>
135 <tr>
136 <td><a href="#WebHitTestResult.updateWithContextMenuData">updateWithContextMenuData</a></td>
137 <td>Public method to update the hit test data with data from the context menu event.</td>
138 </tr>
139 <tr>
140 <td><a href="#WebHitTestResult.viewportPos">viewportPos</a></td>
141 <td>Public method to get the viewport position.</td>
142 </tr>
143 </table>
144 <h3>Static Methods</h3>
145
146 <table>
147 <tr><td>None</td></tr>
148 </table>
149
150 <a NAME="WebHitTestResult.__init__" ID="WebHitTestResult.__init__"></a>
151 <h4>WebHitTestResult (Constructor)</h4>
152 <b>WebHitTestResult</b>(<i>page, pos</i>)
153
154 <p>
155 Constructor
156 </p>
157 <dl>
158
159 <dt><i>page</i> (WebBrowserPage)</dt>
160 <dd>
161 reference to the web page
162 </dd>
163 <dt><i>pos</i> (QPoint)</dt>
164 <dd>
165 position to be tested
166 </dd>
167 </dl>
168 <a NAME="WebHitTestResult.__populate" ID="WebHitTestResult.__populate"></a>
169 <h4>WebHitTestResult.__populate</h4>
170 <b>__populate</b>(<i>url, res</i>)
171
172 <p>
173 Private method to populate the object.
174 </p>
175 <dl>
176
177 <dt><i>url</i> (QUrl)</dt>
178 <dd>
179 URL of the tested page
180 </dd>
181 <dt><i>res</i> (dict)</dt>
182 <dd>
183 dictionary with result data from JavaScript
184 </dd>
185 </dl>
186 <a NAME="WebHitTestResult.alternateText" ID="WebHitTestResult.alternateText"></a>
187 <h4>WebHitTestResult.alternateText</h4>
188 <b>alternateText</b>(<i></i>)
189
190 <p>
191 Public method to get the alternate text.
192 </p>
193 <dl>
194 <dt>Return:</dt>
195 <dd>
196 alternate text
197 </dd>
198 </dl>
199 <dl>
200 <dt>Return Type:</dt>
201 <dd>
202 str
203 </dd>
204 </dl>
205 <a NAME="WebHitTestResult.baseUrl" ID="WebHitTestResult.baseUrl"></a>
206 <h4>WebHitTestResult.baseUrl</h4>
207 <b>baseUrl</b>(<i></i>)
208
209 <p>
210 Public method to get the base URL of the page.
211 </p>
212 <dl>
213 <dt>Return:</dt>
214 <dd>
215 base URL
216 </dd>
217 </dl>
218 <dl>
219 <dt>Return Type:</dt>
220 <dd>
221 QUrl
222 </dd>
223 </dl>
224 <a NAME="WebHitTestResult.boundingRect" ID="WebHitTestResult.boundingRect"></a>
225 <h4>WebHitTestResult.boundingRect</h4>
226 <b>boundingRect</b>(<i></i>)
227
228 <p>
229 Public method to get the bounding rectangle.
230 </p>
231 <dl>
232 <dt>Return:</dt>
233 <dd>
234 bounding rectangle
235 </dd>
236 </dl>
237 <dl>
238 <dt>Return Type:</dt>
239 <dd>
240 QRect
241 </dd>
242 </dl>
243 <a NAME="WebHitTestResult.imageUrl" ID="WebHitTestResult.imageUrl"></a>
244 <h4>WebHitTestResult.imageUrl</h4>
245 <b>imageUrl</b>(<i></i>)
246
247 <p>
248 Public method to get the URL of an image.
249 </p>
250 <dl>
251 <dt>Return:</dt>
252 <dd>
253 image URL
254 </dd>
255 </dl>
256 <dl>
257 <dt>Return Type:</dt>
258 <dd>
259 QUrl
260 </dd>
261 </dl>
262 <a NAME="WebHitTestResult.isContentEditable" ID="WebHitTestResult.isContentEditable"></a>
263 <h4>WebHitTestResult.isContentEditable</h4>
264 <b>isContentEditable</b>(<i></i>)
265
266 <p>
267 Public method to check for editable content.
268 </p>
269 <dl>
270 <dt>Return:</dt>
271 <dd>
272 flag indicating editable content
273 </dd>
274 </dl>
275 <dl>
276 <dt>Return Type:</dt>
277 <dd>
278 bool
279 </dd>
280 </dl>
281 <a NAME="WebHitTestResult.isContentSelected" ID="WebHitTestResult.isContentSelected"></a>
282 <h4>WebHitTestResult.isContentSelected</h4>
283 <b>isContentSelected</b>(<i></i>)
284
285 <p>
286 Public method to check for selected content.
287 </p>
288 <dl>
289 <dt>Return:</dt>
290 <dd>
291 flag indicating selected content
292 </dd>
293 </dl>
294 <dl>
295 <dt>Return Type:</dt>
296 <dd>
297 bool
298 </dd>
299 </dl>
300 <a NAME="WebHitTestResult.isNull" ID="WebHitTestResult.isNull"></a>
301 <h4>WebHitTestResult.isNull</h4>
302 <b>isNull</b>(<i></i>)
303
304 <p>
305 Public method to test, if the hit test is empty.
306 </p>
307 <dl>
308 <dt>Return:</dt>
309 <dd>
310 flag indicating an empty object
311 </dd>
312 </dl>
313 <dl>
314 <dt>Return Type:</dt>
315 <dd>
316 bool
317 </dd>
318 </dl>
319 <a NAME="WebHitTestResult.linkTitle" ID="WebHitTestResult.linkTitle"></a>
320 <h4>WebHitTestResult.linkTitle</h4>
321 <b>linkTitle</b>(<i></i>)
322
323 <p>
324 Public method to get the title for a link element.
325 </p>
326 <dl>
327 <dt>Return:</dt>
328 <dd>
329 title for a link element
330 </dd>
331 </dl>
332 <dl>
333 <dt>Return Type:</dt>
334 <dd>
335 str
336 </dd>
337 </dl>
338 <a NAME="WebHitTestResult.linkUrl" ID="WebHitTestResult.linkUrl"></a>
339 <h4>WebHitTestResult.linkUrl</h4>
340 <b>linkUrl</b>(<i></i>)
341
342 <p>
343 Public method to get the URL for a link element.
344 </p>
345 <dl>
346 <dt>Return:</dt>
347 <dd>
348 URL for a link element
349 </dd>
350 </dl>
351 <dl>
352 <dt>Return Type:</dt>
353 <dd>
354 QUrl
355 </dd>
356 </dl>
357 <a NAME="WebHitTestResult.mediaMuted" ID="WebHitTestResult.mediaMuted"></a>
358 <h4>WebHitTestResult.mediaMuted</h4>
359 <b>mediaMuted</b>(<i></i>)
360
361 <p>
362 Public method to check, if a media element is muted.
363 </p>
364 <dl>
365 <dt>Return:</dt>
366 <dd>
367 flag indicating a muted media element
368 </dd>
369 </dl>
370 <dl>
371 <dt>Return Type:</dt>
372 <dd>
373 bool
374 </dd>
375 </dl>
376 <a NAME="WebHitTestResult.mediaPaused" ID="WebHitTestResult.mediaPaused"></a>
377 <h4>WebHitTestResult.mediaPaused</h4>
378 <b>mediaPaused</b>(<i></i>)
379
380 <p>
381 Public method to check, if a media element is paused.
382 </p>
383 <dl>
384 <dt>Return:</dt>
385 <dd>
386 flag indicating a paused media element
387 </dd>
388 </dl>
389 <dl>
390 <dt>Return Type:</dt>
391 <dd>
392 bool
393 </dd>
394 </dl>
395 <a NAME="WebHitTestResult.mediaUrl" ID="WebHitTestResult.mediaUrl"></a>
396 <h4>WebHitTestResult.mediaUrl</h4>
397 <b>mediaUrl</b>(<i></i>)
398
399 <p>
400 Public method to get the URL for a media element.
401 </p>
402 <dl>
403 <dt>Return:</dt>
404 <dd>
405 URL for a media element
406 </dd>
407 </dl>
408 <dl>
409 <dt>Return Type:</dt>
410 <dd>
411 QUrl
412 </dd>
413 </dl>
414 <a NAME="WebHitTestResult.pos" ID="WebHitTestResult.pos"></a>
415 <h4>WebHitTestResult.pos</h4>
416 <b>pos</b>(<i></i>)
417
418 <p>
419 Public method to get the position of the hit test.
420 </p>
421 <dl>
422 <dt>Return:</dt>
423 <dd>
424 position of hit test
425 </dd>
426 </dl>
427 <dl>
428 <dt>Return Type:</dt>
429 <dd>
430 QPoint
431 </dd>
432 </dl>
433 <a NAME="WebHitTestResult.tagName" ID="WebHitTestResult.tagName"></a>
434 <h4>WebHitTestResult.tagName</h4>
435 <b>tagName</b>(<i></i>)
436
437 <p>
438 Public method to get the name of the tested tag.
439 </p>
440 <dl>
441 <dt>Return:</dt>
442 <dd>
443 name of the tested tag
444 </dd>
445 </dl>
446 <dl>
447 <dt>Return Type:</dt>
448 <dd>
449 str
450 </dd>
451 </dl>
452 <a NAME="WebHitTestResult.updateWithContextMenuData" ID="WebHitTestResult.updateWithContextMenuData"></a>
453 <h4>WebHitTestResult.updateWithContextMenuData</h4>
454 <b>updateWithContextMenuData</b>(<i>data</i>)
455
456 <p>
457 Public method to update the hit test data with data from the context
458 menu event.
459 </p>
460 <dl>
461
462 <dt><i>data</i> (QWebEngineContextMenuData)</dt>
463 <dd>
464 context menu data
465 </dd>
466 </dl>
467 <a NAME="WebHitTestResult.viewportPos" ID="WebHitTestResult.viewportPos"></a>
468 <h4>WebHitTestResult.viewportPos</h4>
469 <b>viewportPos</b>(<i></i>)
470
471 <p>
472 Public method to get the viewport position.
473 </p>
474 <dl>
475 <dt>Return:</dt>
476 <dd>
477 viewport position
478 </dd>
479 </dl>
480 <dl>
481 <dt>Return Type:</dt>
482 <dd>
483 QPoint
484 </dd>
485 </dl>
486 <div align="right"><a href="#top">Up</a></div>
487 <hr />
488 </body></html>

Mercurial Repository: eric

eric ide

mercurial