Mercurial Repositories > eric / file comparison

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

Documentation/Source/eric6.WebBrowser.Tools.WebHitTestResult.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.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.boundingRect">boundingRect</a></td>
70 <td>Public method to get the bounding rectangle.</td>
71 </tr><tr>
72 <td><a href="#WebHitTestResult.imageUrl">imageUrl</a></td>
73 <td>Public method to get the URL of an image.</td>
74 </tr><tr>
75 <td><a href="#WebHitTestResult.isContentEditable">isContentEditable</a></td>
76 <td>Public method to check for editable content.</td>
77 </tr><tr>
78 <td><a href="#WebHitTestResult.isContentSelected">isContentSelected</a></td>
79 <td>Public method to check for selected content.</td>
80 </tr><tr>
81 <td><a href="#WebHitTestResult.isNull">isNull</a></td>
82 <td>Public method to test, if the hit test is empty.</td>
83 </tr><tr>
84 <td><a href="#WebHitTestResult.linkTitle">linkTitle</a></td>
85 <td>Public method to get the title for a link element.</td>
86 </tr><tr>
87 <td><a href="#WebHitTestResult.linkUrl">linkUrl</a></td>
88 <td>Public method to get the URL for a link element.</td>
89 </tr><tr>
90 <td><a href="#WebHitTestResult.mediaMuted">mediaMuted</a></td>
91 <td>Public method to check, if a media element is muted.</td>
92 </tr><tr>
93 <td><a href="#WebHitTestResult.mediaPaused">mediaPaused</a></td>
94 <td>Public method to check, if a media element is paused.</td>
95 </tr><tr>
96 <td><a href="#WebHitTestResult.mediaUrl">mediaUrl</a></td>
97 <td>Public method to get the URL for a media element.</td>
98 </tr><tr>
99 <td><a href="#WebHitTestResult.pos">pos</a></td>
100 <td>Public method to get the position of the hit test.</td>
101 </tr><tr>
102 <td><a href="#WebHitTestResult.tagName">tagName</a></td>
103 <td>Public method to get the name of the tested tag.</td>
104 </tr>
105 </table>
106 <h3>Static Methods</h3>
107 <table>
108 <tr><td>None</td></tr>
109 </table>
110 <a NAME="WebHitTestResult.__init__" ID="WebHitTestResult.__init__"></a>
111 <h4>WebHitTestResult (Constructor)</h4>
112 <b>WebHitTestResult</b>(<i>page, pos</i>)
113 <p>
114 Constructor
115 </p><dl>
116 <dt><i>page</i> (WebBrowserPage)</dt>
117 <dd>
118 reference to the web page
119 </dd><dt><i>pos</i> (QPoint)</dt>
120 <dd>
121 position to be tested
122 </dd>
123 </dl><a NAME="WebHitTestResult.__populate" ID="WebHitTestResult.__populate"></a>
124 <h4>WebHitTestResult.__populate</h4>
125 <b>__populate</b>(<i>url, res</i>)
126 <p>
127 Private method to populate the object.
128 </p><dl>
129 <dt><i>url</i> (QUrl)</dt>
130 <dd>
131 URL of the tested page
132 </dd><dt><i>res</i> (dict)</dt>
133 <dd>
134 dictionary with result data from JavaScript
135 </dd>
136 </dl><a NAME="WebHitTestResult.alternateText" ID="WebHitTestResult.alternateText"></a>
137 <h4>WebHitTestResult.alternateText</h4>
138 <b>alternateText</b>(<i></i>)
139 <p>
140 Public method to get the alternate text.
141 </p><dl>
142 <dt>Returns:</dt>
143 <dd>
144 alternate text
145 </dd>
146 </dl><dl>
147 <dt>Return Type:</dt>
148 <dd>
149 str
150 </dd>
151 </dl><a NAME="WebHitTestResult.boundingRect" ID="WebHitTestResult.boundingRect"></a>
152 <h4>WebHitTestResult.boundingRect</h4>
153 <b>boundingRect</b>(<i></i>)
154 <p>
155 Public method to get the bounding rectangle.
156 </p><dl>
157 <dt>Returns:</dt>
158 <dd>
159 bounding rectangle
160 </dd>
161 </dl><dl>
162 <dt>Return Type:</dt>
163 <dd>
164 QRect
165 </dd>
166 </dl><a NAME="WebHitTestResult.imageUrl" ID="WebHitTestResult.imageUrl"></a>
167 <h4>WebHitTestResult.imageUrl</h4>
168 <b>imageUrl</b>(<i></i>)
169 <p>
170 Public method to get the URL of an image.
171 </p><dl>
172 <dt>Returns:</dt>
173 <dd>
174 image URL
175 </dd>
176 </dl><dl>
177 <dt>Return Type:</dt>
178 <dd>
179 QUrl
180 </dd>
181 </dl><a NAME="WebHitTestResult.isContentEditable" ID="WebHitTestResult.isContentEditable"></a>
182 <h4>WebHitTestResult.isContentEditable</h4>
183 <b>isContentEditable</b>(<i></i>)
184 <p>
185 Public method to check for editable content.
186 </p><dl>
187 <dt>Returns:</dt>
188 <dd>
189 flag indicating editable content
190 </dd>
191 </dl><dl>
192 <dt>Return Type:</dt>
193 <dd>
194 bool
195 </dd>
196 </dl><a NAME="WebHitTestResult.isContentSelected" ID="WebHitTestResult.isContentSelected"></a>
197 <h4>WebHitTestResult.isContentSelected</h4>
198 <b>isContentSelected</b>(<i></i>)
199 <p>
200 Public method to check for selected content.
201 </p><dl>
202 <dt>Returns:</dt>
203 <dd>
204 flag indicating selected content
205 </dd>
206 </dl><dl>
207 <dt>Return Type:</dt>
208 <dd>
209 bool
210 </dd>
211 </dl><a NAME="WebHitTestResult.isNull" ID="WebHitTestResult.isNull"></a>
212 <h4>WebHitTestResult.isNull</h4>
213 <b>isNull</b>(<i></i>)
214 <p>
215 Public method to test, if the hit test is empty.
216 </p><dl>
217 <dt>Returns:</dt>
218 <dd>
219 flag indicating an empty object
220 </dd>
221 </dl><dl>
222 <dt>Return Type:</dt>
223 <dd>
224 bool
225 </dd>
226 </dl><a NAME="WebHitTestResult.linkTitle" ID="WebHitTestResult.linkTitle"></a>
227 <h4>WebHitTestResult.linkTitle</h4>
228 <b>linkTitle</b>(<i></i>)
229 <p>
230 Public method to get the title for a link element.
231 </p><dl>
232 <dt>Returns:</dt>
233 <dd>
234 title for a link element
235 </dd>
236 </dl><dl>
237 <dt>Return Type:</dt>
238 <dd>
239 str
240 </dd>
241 </dl><a NAME="WebHitTestResult.linkUrl" ID="WebHitTestResult.linkUrl"></a>
242 <h4>WebHitTestResult.linkUrl</h4>
243 <b>linkUrl</b>(<i></i>)
244 <p>
245 Public method to get the URL for a link element.
246 </p><dl>
247 <dt>Returns:</dt>
248 <dd>
249 URL for a link element
250 </dd>
251 </dl><dl>
252 <dt>Return Type:</dt>
253 <dd>
254 QUrl
255 </dd>
256 </dl><a NAME="WebHitTestResult.mediaMuted" ID="WebHitTestResult.mediaMuted"></a>
257 <h4>WebHitTestResult.mediaMuted</h4>
258 <b>mediaMuted</b>(<i></i>)
259 <p>
260 Public method to check, if a media element is muted.
261 </p><dl>
262 <dt>Returns:</dt>
263 <dd>
264 flag indicating a muted media element
265 </dd>
266 </dl><dl>
267 <dt>Return Type:</dt>
268 <dd>
269 bool
270 </dd>
271 </dl><a NAME="WebHitTestResult.mediaPaused" ID="WebHitTestResult.mediaPaused"></a>
272 <h4>WebHitTestResult.mediaPaused</h4>
273 <b>mediaPaused</b>(<i></i>)
274 <p>
275 Public method to check, if a media element is paused.
276 </p><dl>
277 <dt>Returns:</dt>
278 <dd>
279 flag indicating a paused media element
280 </dd>
281 </dl><dl>
282 <dt>Return Type:</dt>
283 <dd>
284 bool
285 </dd>
286 </dl><a NAME="WebHitTestResult.mediaUrl" ID="WebHitTestResult.mediaUrl"></a>
287 <h4>WebHitTestResult.mediaUrl</h4>
288 <b>mediaUrl</b>(<i></i>)
289 <p>
290 Public method to get the URL for a media element.
291 </p><dl>
292 <dt>Returns:</dt>
293 <dd>
294 URL for a media element
295 </dd>
296 </dl><dl>
297 <dt>Return Type:</dt>
298 <dd>
299 QUrl
300 </dd>
301 </dl><a NAME="WebHitTestResult.pos" ID="WebHitTestResult.pos"></a>
302 <h4>WebHitTestResult.pos</h4>
303 <b>pos</b>(<i></i>)
304 <p>
305 Public method to get the position of the hit test.
306 </p><dl>
307 <dt>Returns:</dt>
308 <dd>
309 position of hit test
310 </dd>
311 </dl><dl>
312 <dt>Return Type:</dt>
313 <dd>
314 QPoint
315 </dd>
316 </dl><a NAME="WebHitTestResult.tagName" ID="WebHitTestResult.tagName"></a>
317 <h4>WebHitTestResult.tagName</h4>
318 <b>tagName</b>(<i></i>)
319 <p>
320 Public method to get the name of the tested tag.
321 </p><dl>
322 <dt>Returns:</dt>
323 <dd>
324 name of the tested tag
325 </dd>
326 </dl><dl>
327 <dt>Return Type:</dt>
328 <dd>
329 str
330 </dd>
331 </dl>
332 <div align="right"><a href="#top">Up</a></div>
333 <hr />
334 </body></html>

Mercurial Repository: eric

eric ide

mercurial