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