Mercurial Repositories > eric / file comparison

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

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

changeset 6942
2602857055c5
parent 5532
3a7c5deab9b7
child 7204
cbf6d88004ce
equal deleted inserted replaced
6941:f99d60d6b59b 6942:2602857055c5
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.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><a NAME="top" ID="top"></a>
22 <h1>eric6.WebBrowser.Tools.WebHitTestResult</h1>
23 <p>
24 Module implementing an object for testing certain aspects of a web page.
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="#WebHitTestResult">WebHitTestResult</a></td>
34 <td>Class implementing an object for testing certain aspects of a 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="WebHitTestResult" ID="WebHitTestResult"></a>
43 <h2>WebHitTestResult</h2>
44 <p>
45 Class implementing an object for testing certain aspects of a web page.
46 </p>
47 <h3>Derived from</h3>
48 object
49 <h3>Class Attributes</h3>
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <h3>Class Methods</h3>
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Methods</h3>
58 <table>
59 <tr>
60 <td><a href="#WebHitTestResult.__init__">WebHitTestResult</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#WebHitTestResult.__populate">__populate</a></td>
64 <td>Private method to populate the object.</td>
65 </tr><tr>
66 <td><a href="#WebHitTestResult.alternateText">alternateText</a></td>
67 <td>Public method to get the alternate text.</td>
68 </tr><tr>
69 <td><a href="#WebHitTestResult.baseUrl">baseUrl</a></td>
70 <td>Public method to get the base URL of the page.</td>
71 </tr><tr>
72 <td><a href="#WebHitTestResult.boundingRect">boundingRect</a></td>
73 <td>Public method to get the bounding rectangle.</td>
74 </tr><tr>
75 <td><a href="#WebHitTestResult.imageUrl">imageUrl</a></td>
76 <td>Public method to get the URL of an image.</td>
77 </tr><tr>
78 <td><a href="#WebHitTestResult.isContentEditable">isContentEditable</a></td>
79 <td>Public method to check for editable content.</td>
80 </tr><tr>
81 <td><a href="#WebHitTestResult.isContentSelected">isContentSelected</a></td>
82 <td>Public method to check for selected content.</td>
83 </tr><tr>
84 <td><a href="#WebHitTestResult.isNull">isNull</a></td>
85 <td>Public method to test, if the hit test is empty.</td>
86 </tr><tr>
87 <td><a href="#WebHitTestResult.linkTitle">linkTitle</a></td>
88 <td>Public method to get the title for a link element.</td>
89 </tr><tr>
90 <td><a href="#WebHitTestResult.linkUrl">linkUrl</a></td>
91 <td>Public method to get the URL for a link element.</td>
92 </tr><tr>
93 <td><a href="#WebHitTestResult.mediaMuted">mediaMuted</a></td>
94 <td>Public method to check, if a media element is muted.</td>
95 </tr><tr>
96 <td><a href="#WebHitTestResult.mediaPaused">mediaPaused</a></td>
97 <td>Public method to check, if a media element is paused.</td>
98 </tr><tr>
99 <td><a href="#WebHitTestResult.mediaUrl">mediaUrl</a></td>
100 <td>Public method to get the URL for a media element.</td>
101 </tr><tr>
102 <td><a href="#WebHitTestResult.pos">pos</a></td>
103 <td>Public method to get the position of the hit test.</td>
104 </tr><tr>
105 <td><a href="#WebHitTestResult.tagName">tagName</a></td>
106 <td>Public method to get the name of the tested tag.</td>
107 </tr><tr>
108 <td><a href="#WebHitTestResult.updateWithContextMenuData">updateWithContextMenuData</a></td>
109 <td>Public method to update the hit test data with data from the context menu event.</td>
110 </tr><tr>
111 <td><a href="#WebHitTestResult.viewportPos">viewportPos</a></td>
112 <td>Public method to get the viewport position.</td>
113 </tr>
114 </table>
115 <h3>Static Methods</h3>
116 <table>
117 <tr><td>None</td></tr>
118 </table>
119 <a NAME="WebHitTestResult.__init__" ID="WebHitTestResult.__init__"></a>
120 <h4>WebHitTestResult (Constructor)</h4>
121 <b>WebHitTestResult</b>(<i>page, pos</i>)
122 <p>
123 Constructor
124 </p><dl>
125 <dt><i>page</i> (WebBrowserPage)</dt>
126 <dd>
127 reference to the web page
128 </dd><dt><i>pos</i> (QPoint)</dt>
129 <dd>
130 position to be tested
131 </dd>
132 </dl><a NAME="WebHitTestResult.__populate" ID="WebHitTestResult.__populate"></a>
133 <h4>WebHitTestResult.__populate</h4>
134 <b>__populate</b>(<i>url, res</i>)
135 <p>
136 Private method to populate the object.
137 </p><dl>
138 <dt><i>url</i> (QUrl)</dt>
139 <dd>
140 URL of the tested page
141 </dd><dt><i>res</i> (dict)</dt>
142 <dd>
143 dictionary with result data from JavaScript
144 </dd>
145 </dl><a NAME="WebHitTestResult.alternateText" ID="WebHitTestResult.alternateText"></a>
146 <h4>WebHitTestResult.alternateText</h4>
147 <b>alternateText</b>(<i></i>)
148 <p>
149 Public method to get the alternate text.
150 </p><dl>
151 <dt>Returns:</dt>
152 <dd>
153 alternate text
154 </dd>
155 </dl><dl>
156 <dt>Return Type:</dt>
157 <dd>
158 str
159 </dd>
160 </dl><a NAME="WebHitTestResult.baseUrl" ID="WebHitTestResult.baseUrl"></a>
161 <h4>WebHitTestResult.baseUrl</h4>
162 <b>baseUrl</b>(<i></i>)
163 <p>
164 Public method to get the base URL of the page.
165 </p><dl>
166 <dt>Returns:</dt>
167 <dd>
168 base URL
169 </dd>
170 </dl><dl>
171 <dt>Return Type:</dt>
172 <dd>
173 QUrl
174 </dd>
175 </dl><a NAME="WebHitTestResult.boundingRect" ID="WebHitTestResult.boundingRect"></a>
176 <h4>WebHitTestResult.boundingRect</h4>
177 <b>boundingRect</b>(<i></i>)
178 <p>
179 Public method to get the bounding rectangle.
180 </p><dl>
181 <dt>Returns:</dt>
182 <dd>
183 bounding rectangle
184 </dd>
185 </dl><dl>
186 <dt>Return Type:</dt>
187 <dd>
188 QRect
189 </dd>
190 </dl><a NAME="WebHitTestResult.imageUrl" ID="WebHitTestResult.imageUrl"></a>
191 <h4>WebHitTestResult.imageUrl</h4>
192 <b>imageUrl</b>(<i></i>)
193 <p>
194 Public method to get the URL of an image.
195 </p><dl>
196 <dt>Returns:</dt>
197 <dd>
198 image URL
199 </dd>
200 </dl><dl>
201 <dt>Return Type:</dt>
202 <dd>
203 QUrl
204 </dd>
205 </dl><a NAME="WebHitTestResult.isContentEditable" ID="WebHitTestResult.isContentEditable"></a>
206 <h4>WebHitTestResult.isContentEditable</h4>
207 <b>isContentEditable</b>(<i></i>)
208 <p>
209 Public method to check for editable content.
210 </p><dl>
211 <dt>Returns:</dt>
212 <dd>
213 flag indicating editable content
214 </dd>
215 </dl><dl>
216 <dt>Return Type:</dt>
217 <dd>
218 bool
219 </dd>
220 </dl><a NAME="WebHitTestResult.isContentSelected" ID="WebHitTestResult.isContentSelected"></a>
221 <h4>WebHitTestResult.isContentSelected</h4>
222 <b>isContentSelected</b>(<i></i>)
223 <p>
224 Public method to check for selected content.
225 </p><dl>
226 <dt>Returns:</dt>
227 <dd>
228 flag indicating selected content
229 </dd>
230 </dl><dl>
231 <dt>Return Type:</dt>
232 <dd>
233 bool
234 </dd>
235 </dl><a NAME="WebHitTestResult.isNull" ID="WebHitTestResult.isNull"></a>
236 <h4>WebHitTestResult.isNull</h4>
237 <b>isNull</b>(<i></i>)
238 <p>
239 Public method to test, if the hit test is empty.
240 </p><dl>
241 <dt>Returns:</dt>
242 <dd>
243 flag indicating an empty object
244 </dd>
245 </dl><dl>
246 <dt>Return Type:</dt>
247 <dd>
248 bool
249 </dd>
250 </dl><a NAME="WebHitTestResult.linkTitle" ID="WebHitTestResult.linkTitle"></a>
251 <h4>WebHitTestResult.linkTitle</h4>
252 <b>linkTitle</b>(<i></i>)
253 <p>
254 Public method to get the title for a link element.
255 </p><dl>
256 <dt>Returns:</dt>
257 <dd>
258 title for a link element
259 </dd>
260 </dl><dl>
261 <dt>Return Type:</dt>
262 <dd>
263 str
264 </dd>
265 </dl><a NAME="WebHitTestResult.linkUrl" ID="WebHitTestResult.linkUrl"></a>
266 <h4>WebHitTestResult.linkUrl</h4>
267 <b>linkUrl</b>(<i></i>)
268 <p>
269 Public method to get the URL for a link element.
270 </p><dl>
271 <dt>Returns:</dt>
272 <dd>
273 URL for a link element
274 </dd>
275 </dl><dl>
276 <dt>Return Type:</dt>
277 <dd>
278 QUrl
279 </dd>
280 </dl><a NAME="WebHitTestResult.mediaMuted" ID="WebHitTestResult.mediaMuted"></a>
281 <h4>WebHitTestResult.mediaMuted</h4>
282 <b>mediaMuted</b>(<i></i>)
283 <p>
284 Public method to check, if a media element is muted.
285 </p><dl>
286 <dt>Returns:</dt>
287 <dd>
288 flag indicating a muted media element
289 </dd>
290 </dl><dl>
291 <dt>Return Type:</dt>
292 <dd>
293 bool
294 </dd>
295 </dl><a NAME="WebHitTestResult.mediaPaused" ID="WebHitTestResult.mediaPaused"></a>
296 <h4>WebHitTestResult.mediaPaused</h4>
297 <b>mediaPaused</b>(<i></i>)
298 <p>
299 Public method to check, if a media element is paused.
300 </p><dl>
301 <dt>Returns:</dt>
302 <dd>
303 flag indicating a paused media element
304 </dd>
305 </dl><dl>
306 <dt>Return Type:</dt>
307 <dd>
308 bool
309 </dd>
310 </dl><a NAME="WebHitTestResult.mediaUrl" ID="WebHitTestResult.mediaUrl"></a>
311 <h4>WebHitTestResult.mediaUrl</h4>
312 <b>mediaUrl</b>(<i></i>)
313 <p>
314 Public method to get the URL for a media element.
315 </p><dl>
316 <dt>Returns:</dt>
317 <dd>
318 URL for a media element
319 </dd>
320 </dl><dl>
321 <dt>Return Type:</dt>
322 <dd>
323 QUrl
324 </dd>
325 </dl><a NAME="WebHitTestResult.pos" ID="WebHitTestResult.pos"></a>
326 <h4>WebHitTestResult.pos</h4>
327 <b>pos</b>(<i></i>)
328 <p>
329 Public method to get the position of the hit test.
330 </p><dl>
331 <dt>Returns:</dt>
332 <dd>
333 position of hit test
334 </dd>
335 </dl><dl>
336 <dt>Return Type:</dt>
337 <dd>
338 QPoint
339 </dd>
340 </dl><a NAME="WebHitTestResult.tagName" ID="WebHitTestResult.tagName"></a>
341 <h4>WebHitTestResult.tagName</h4>
342 <b>tagName</b>(<i></i>)
343 <p>
344 Public method to get the name of the tested tag.
345 </p><dl>
346 <dt>Returns:</dt>
347 <dd>
348 name of the tested tag
349 </dd>
350 </dl><dl>
351 <dt>Return Type:</dt>
352 <dd>
353 str
354 </dd>
355 </dl><a NAME="WebHitTestResult.updateWithContextMenuData" ID="WebHitTestResult.updateWithContextMenuData"></a>
356 <h4>WebHitTestResult.updateWithContextMenuData</h4>
357 <b>updateWithContextMenuData</b>(<i>data</i>)
358 <p>
359 Public method to update the hit test data with data from the context
360 menu event.
361 </p><p>
362 Note: This works for Qt >= 5.7.0.
363 </p><dl>
364 <dt><i>data</i> (QWebEngineContextMenuData)</dt>
365 <dd>
366 context menu data
367 </dd>
368 </dl><a NAME="WebHitTestResult.viewportPos" ID="WebHitTestResult.viewportPos"></a>
369 <h4>WebHitTestResult.viewportPos</h4>
370 <b>viewportPos</b>(<i></i>)
371 <p>
372 Public method to get the viewport position.
373 </p><dl>
374 <dt>Returns:</dt>
375 <dd>
376 viewport position
377 </dd>
378 </dl><dl>
379 <dt>Return Type:</dt>
380 <dd>
381 QPoint
382 </dd>
383 </dl>
384 <div align="right"><a href="#top">Up</a></div>
385 <hr />
386 </body></html>

Mercurial Repository: eric

eric ide

mercurial