Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.WebBrowser.GreaseMonkey.GreaseMonkeyScript.html
src/eric7/Documentation/Source/eric7.WebBrowser.GreaseMonkey.GreaseMonkeyScript.html
- branch
- eric7
- changeset 10493
- f795d68d8e09
- parent 10479
- 856476537696
equal
deleted
inserted
replaced
| 10492:53eac4c7d10b | 10493:f795d68d8e09 |
|---|---|
| 20 <table> | 20 <table> |
| 21 <tr> | 21 <tr> |
| 22 <td><a href="#GreaseMonkeyScript">GreaseMonkeyScript</a></td> | 22 <td><a href="#GreaseMonkeyScript">GreaseMonkeyScript</a></td> |
| 23 <td>Class implementing the GreaseMonkey script.</td> | 23 <td>Class implementing the GreaseMonkey script.</td> |
| 24 </tr> | 24 </tr> |
| 25 <tr> | |
| 26 <td><a href="#GreaseMonkeyScriptStartPoint">GreaseMonkeyScriptStartPoint</a></td> | |
| 27 <td>Class defining the script start points.</td> | |
| 28 </tr> | |
| 25 </table> | 29 </table> |
| 26 | 30 |
| 27 <h3>Functions</h3> | 31 <h3>Functions</h3> |
| 28 <table> | 32 <table> |
| 29 <tr><td>None</td></tr> | 33 <tr><td>None</td></tr> |
| 52 </dl> | 56 </dl> |
| 53 <h3>Derived from</h3> | 57 <h3>Derived from</h3> |
| 54 QObject | 58 QObject |
| 55 <h3>Class Attributes</h3> | 59 <h3>Class Attributes</h3> |
| 56 <table> | 60 <table> |
| 61 <tr><td>None</td></tr> | |
| 62 </table> | |
| 63 | |
| 64 <h3>Class Methods</h3> | |
| 65 <table> | |
| 66 <tr><td>None</td></tr> | |
| 67 </table> | |
| 68 | |
| 69 <h3>Methods</h3> | |
| 70 <table> | |
| 71 <tr> | |
| 72 <td><a href="#GreaseMonkeyScript.__init__">GreaseMonkeyScript</a></td> | |
| 73 <td>Constructor</td> | |
| 74 </tr> | |
| 75 <tr> | |
| 76 <td><a href="#GreaseMonkeyScript.__downloadIcon">__downloadIcon</a></td> | |
| 77 <td>Private slot to download the script icon.</td> | |
| 78 </tr> | |
| 79 <tr> | |
| 80 <td><a href="#GreaseMonkeyScript.__downloadRequires">__downloadRequires</a></td> | |
| 81 <td>Private method to download the required scripts.</td> | |
| 82 </tr> | |
| 83 <tr> | |
| 84 <td><a href="#GreaseMonkeyScript.__downloaderError">__downloaderError</a></td> | |
| 85 <td>Private slot to handle a downloader error.</td> | |
| 86 </tr> | |
| 87 <tr> | |
| 88 <td><a href="#GreaseMonkeyScript.__downloaderFinished">__downloaderFinished</a></td> | |
| 89 <td>Private slot to handle a finished download.</td> | |
| 90 </tr> | |
| 91 <tr> | |
| 92 <td><a href="#GreaseMonkeyScript.__iconDownloaded">__iconDownloaded</a></td> | |
| 93 <td>Private slot to handle a finished download of a script icon.</td> | |
| 94 </tr> | |
| 95 <tr> | |
| 96 <td><a href="#GreaseMonkeyScript.__parseScript">__parseScript</a></td> | |
| 97 <td>Private method to parse the given script and populate the data structure.</td> | |
| 98 </tr> | |
| 99 <tr> | |
| 100 <td><a href="#GreaseMonkeyScript.__reloadScript">__reloadScript</a></td> | |
| 101 <td>Private method to reload the script.</td> | |
| 102 </tr> | |
| 103 <tr> | |
| 104 <td><a href="#GreaseMonkeyScript.__requireDownloadError">__requireDownloadError</a></td> | |
| 105 <td>Private slot to handle a downloader error.</td> | |
| 106 </tr> | |
| 107 <tr> | |
| 108 <td><a href="#GreaseMonkeyScript.__requireDownloaded">__requireDownloaded</a></td> | |
| 109 <td>Private slot to handle a finished download of a required script.</td> | |
| 110 </tr> | |
| 111 <tr> | |
| 112 <td><a href="#GreaseMonkeyScript.__watchedFileChanged">__watchedFileChanged</a></td> | |
| 113 <td>Private slot handling changes of the script file.</td> | |
| 114 </tr> | |
| 115 <tr> | |
| 116 <td><a href="#GreaseMonkeyScript.description">description</a></td> | |
| 117 <td>Public method to get the description of the script.</td> | |
| 118 </tr> | |
| 119 <tr> | |
| 120 <td><a href="#GreaseMonkeyScript.downloadUrl">downloadUrl</a></td> | |
| 121 <td>Public method to get the download URL of the script.</td> | |
| 122 </tr> | |
| 123 <tr> | |
| 124 <td><a href="#GreaseMonkeyScript.exclude">exclude</a></td> | |
| 125 <td>Public method to get the list of excluded URLs.</td> | |
| 126 </tr> | |
| 127 <tr> | |
| 128 <td><a href="#GreaseMonkeyScript.fileName">fileName</a></td> | |
| 129 <td>Public method to get the path of the Javascript file.</td> | |
| 130 </tr> | |
| 131 <tr> | |
| 132 <td><a href="#GreaseMonkeyScript.fullName">fullName</a></td> | |
| 133 <td>Public method to get the full name of the script.</td> | |
| 134 </tr> | |
| 135 <tr> | |
| 136 <td><a href="#GreaseMonkeyScript.icon">icon</a></td> | |
| 137 <td>Public method to get the icon of the script.</td> | |
| 138 </tr> | |
| 139 <tr> | |
| 140 <td><a href="#GreaseMonkeyScript.iconUrl">iconUrl</a></td> | |
| 141 <td>Public method to get the icon URL of the script.</td> | |
| 142 </tr> | |
| 143 <tr> | |
| 144 <td><a href="#GreaseMonkeyScript.include">include</a></td> | |
| 145 <td>Public method to get the list of included URLs.</td> | |
| 146 </tr> | |
| 147 <tr> | |
| 148 <td><a href="#GreaseMonkeyScript.isEnabled">isEnabled</a></td> | |
| 149 <td>Public method to check, if the script is enabled.</td> | |
| 150 </tr> | |
| 151 <tr> | |
| 152 <td><a href="#GreaseMonkeyScript.isUpdating">isUpdating</a></td> | |
| 153 <td>Public method to get the updating flag.</td> | |
| 154 </tr> | |
| 155 <tr> | |
| 156 <td><a href="#GreaseMonkeyScript.isValid">isValid</a></td> | |
| 157 <td>Public method to check the validity of the script.</td> | |
| 158 </tr> | |
| 159 <tr> | |
| 160 <td><a href="#GreaseMonkeyScript.name">name</a></td> | |
| 161 <td>Public method to get the name of the script.</td> | |
| 162 </tr> | |
| 163 <tr> | |
| 164 <td><a href="#GreaseMonkeyScript.nameSpace">nameSpace</a></td> | |
| 165 <td>Public method to get the name space of the script.</td> | |
| 166 </tr> | |
| 167 <tr> | |
| 168 <td><a href="#GreaseMonkeyScript.noFrames">noFrames</a></td> | |
| 169 <td>Public method to get the noFrames flag.</td> | |
| 170 </tr> | |
| 171 <tr> | |
| 172 <td><a href="#GreaseMonkeyScript.require">require</a></td> | |
| 173 <td>Public method to get the list of required scripts.</td> | |
| 174 </tr> | |
| 175 <tr> | |
| 176 <td><a href="#GreaseMonkeyScript.setEnabled">setEnabled</a></td> | |
| 177 <td>Public method to enable a script.</td> | |
| 178 </tr> | |
| 179 <tr> | |
| 180 <td><a href="#GreaseMonkeyScript.startAt">startAt</a></td> | |
| 181 <td>Public method to get the start point of the script.</td> | |
| 182 </tr> | |
| 183 <tr> | |
| 184 <td><a href="#GreaseMonkeyScript.updateScript">updateScript</a></td> | |
| 185 <td>Public method to updated the script.</td> | |
| 186 </tr> | |
| 187 <tr> | |
| 188 <td><a href="#GreaseMonkeyScript.updateUrl">updateUrl</a></td> | |
| 189 <td>Public method to get the update URL of the script.</td> | |
| 190 </tr> | |
| 191 <tr> | |
| 192 <td><a href="#GreaseMonkeyScript.version">version</a></td> | |
| 193 <td>Public method to get the version of the script.</td> | |
| 194 </tr> | |
| 195 <tr> | |
| 196 <td><a href="#GreaseMonkeyScript.webScript">webScript</a></td> | |
| 197 <td>Public method to create a script object.</td> | |
| 198 </tr> | |
| 199 </table> | |
| 200 | |
| 201 <h3>Static Methods</h3> | |
| 202 <table> | |
| 203 <tr><td>None</td></tr> | |
| 204 </table> | |
| 205 | |
| 206 | |
| 207 <a NAME="GreaseMonkeyScript.__init__" ID="GreaseMonkeyScript.__init__"></a> | |
| 208 <h4>GreaseMonkeyScript (Constructor)</h4> | |
| 209 <b>GreaseMonkeyScript</b>(<i>manager, path</i>) | |
| 210 <p> | |
| 211 Constructor | |
| 212 </p> | |
| 213 | |
| 214 <dl> | |
| 215 | |
| 216 <dt><i>manager</i> (GreaseMonkeyManager)</dt> | |
| 217 <dd> | |
| 218 reference to the manager object | |
| 219 </dd> | |
| 220 <dt><i>path</i> (str)</dt> | |
| 221 <dd> | |
| 222 path of the Javascript file | |
| 223 </dd> | |
| 224 </dl> | |
| 225 <a NAME="GreaseMonkeyScript.__downloadIcon" ID="GreaseMonkeyScript.__downloadIcon"></a> | |
| 226 <h4>GreaseMonkeyScript.__downloadIcon</h4> | |
| 227 <b>__downloadIcon</b>(<i></i>) | |
| 228 <p> | |
| 229 Private slot to download the script icon. | |
| 230 </p> | |
| 231 | |
| 232 <a NAME="GreaseMonkeyScript.__downloadRequires" ID="GreaseMonkeyScript.__downloadRequires"></a> | |
| 233 <h4>GreaseMonkeyScript.__downloadRequires</h4> | |
| 234 <b>__downloadRequires</b>(<i></i>) | |
| 235 <p> | |
| 236 Private method to download the required scripts. | |
| 237 </p> | |
| 238 | |
| 239 <a NAME="GreaseMonkeyScript.__downloaderError" ID="GreaseMonkeyScript.__downloaderError"></a> | |
| 240 <h4>GreaseMonkeyScript.__downloaderError</h4> | |
| 241 <b>__downloaderError</b>(<i>downloader</i>) | |
| 242 <p> | |
| 243 Private slot to handle a downloader error. | |
| 244 </p> | |
| 245 | |
| 246 <dl> | |
| 247 | |
| 248 <dt><i>downloader</i> (GreaseMonkeyDownloader)</dt> | |
| 249 <dd> | |
| 250 reference to the downloader object | |
| 251 </dd> | |
| 252 </dl> | |
| 253 <a NAME="GreaseMonkeyScript.__downloaderFinished" ID="GreaseMonkeyScript.__downloaderFinished"></a> | |
| 254 <h4>GreaseMonkeyScript.__downloaderFinished</h4> | |
| 255 <b>__downloaderFinished</b>(<i>downloader</i>) | |
| 256 <p> | |
| 257 Private slot to handle a finished download. | |
| 258 </p> | |
| 259 | |
| 260 <dl> | |
| 261 | |
| 262 <dt><i>downloader</i> (GreaseMonkeyDownloader)</dt> | |
| 263 <dd> | |
| 264 reference to the downloader object | |
| 265 </dd> | |
| 266 </dl> | |
| 267 <a NAME="GreaseMonkeyScript.__iconDownloaded" ID="GreaseMonkeyScript.__iconDownloaded"></a> | |
| 268 <h4>GreaseMonkeyScript.__iconDownloaded</h4> | |
| 269 <b>__iconDownloaded</b>(<i>reply</i>) | |
| 270 <p> | |
| 271 Private slot to handle a finished download of a script icon. | |
| 272 </p> | |
| 273 | |
| 274 <dl> | |
| 275 | |
| 276 <dt><i>reply</i> (QNetworkReply)</dt> | |
| 277 <dd> | |
| 278 reference to the network reply | |
| 279 </dd> | |
| 280 </dl> | |
| 281 <a NAME="GreaseMonkeyScript.__parseScript" ID="GreaseMonkeyScript.__parseScript"></a> | |
| 282 <h4>GreaseMonkeyScript.__parseScript</h4> | |
| 283 <b>__parseScript</b>(<i></i>) | |
| 284 <p> | |
| 285 Private method to parse the given script and populate the data | |
| 286 structure. | |
| 287 </p> | |
| 288 | |
| 289 <a NAME="GreaseMonkeyScript.__reloadScript" ID="GreaseMonkeyScript.__reloadScript"></a> | |
| 290 <h4>GreaseMonkeyScript.__reloadScript</h4> | |
| 291 <b>__reloadScript</b>(<i></i>) | |
| 292 <p> | |
| 293 Private method to reload the script. | |
| 294 </p> | |
| 295 | |
| 296 <a NAME="GreaseMonkeyScript.__requireDownloadError" ID="GreaseMonkeyScript.__requireDownloadError"></a> | |
| 297 <h4>GreaseMonkeyScript.__requireDownloadError</h4> | |
| 298 <b>__requireDownloadError</b>(<i>downloader</i>) | |
| 299 <p> | |
| 300 Private slot to handle a downloader error. | |
| 301 </p> | |
| 302 | |
| 303 <dl> | |
| 304 | |
| 305 <dt><i>downloader</i> (GreaseMonkeyDownloader)</dt> | |
| 306 <dd> | |
| 307 reference to the downloader object | |
| 308 </dd> | |
| 309 </dl> | |
| 310 <a NAME="GreaseMonkeyScript.__requireDownloaded" ID="GreaseMonkeyScript.__requireDownloaded"></a> | |
| 311 <h4>GreaseMonkeyScript.__requireDownloaded</h4> | |
| 312 <b>__requireDownloaded</b>(<i>downloader</i>) | |
| 313 <p> | |
| 314 Private slot to handle a finished download of a required script. | |
| 315 </p> | |
| 316 | |
| 317 <dl> | |
| 318 | |
| 319 <dt><i>downloader</i> (GreaseMonkeyDownloader)</dt> | |
| 320 <dd> | |
| 321 reference to the downloader object | |
| 322 </dd> | |
| 323 </dl> | |
| 324 <a NAME="GreaseMonkeyScript.__watchedFileChanged" ID="GreaseMonkeyScript.__watchedFileChanged"></a> | |
| 325 <h4>GreaseMonkeyScript.__watchedFileChanged</h4> | |
| 326 <b>__watchedFileChanged</b>(<i>fileName</i>) | |
| 327 <p> | |
| 328 Private slot handling changes of the script file. | |
| 329 </p> | |
| 330 | |
| 331 <dl> | |
| 332 | |
| 333 <dt><i>fileName</i> (str)</dt> | |
| 334 <dd> | |
| 335 path of the script file | |
| 336 </dd> | |
| 337 </dl> | |
| 338 <a NAME="GreaseMonkeyScript.description" ID="GreaseMonkeyScript.description"></a> | |
| 339 <h4>GreaseMonkeyScript.description</h4> | |
| 340 <b>description</b>(<i></i>) | |
| 341 <p> | |
| 342 Public method to get the description of the script. | |
| 343 </p> | |
| 344 | |
| 345 <dl> | |
| 346 <dt>Return:</dt> | |
| 347 <dd> | |
| 348 description of the script | |
| 349 </dd> | |
| 350 </dl> | |
| 351 <dl> | |
| 352 <dt>Return Type:</dt> | |
| 353 <dd> | |
| 354 str | |
| 355 </dd> | |
| 356 </dl> | |
| 357 <a NAME="GreaseMonkeyScript.downloadUrl" ID="GreaseMonkeyScript.downloadUrl"></a> | |
| 358 <h4>GreaseMonkeyScript.downloadUrl</h4> | |
| 359 <b>downloadUrl</b>(<i></i>) | |
| 360 <p> | |
| 361 Public method to get the download URL of the script. | |
| 362 </p> | |
| 363 | |
| 364 <dl> | |
| 365 <dt>Return:</dt> | |
| 366 <dd> | |
| 367 download URL of the script | |
| 368 </dd> | |
| 369 </dl> | |
| 370 <dl> | |
| 371 <dt>Return Type:</dt> | |
| 372 <dd> | |
| 373 QUrl | |
| 374 </dd> | |
| 375 </dl> | |
| 376 <a NAME="GreaseMonkeyScript.exclude" ID="GreaseMonkeyScript.exclude"></a> | |
| 377 <h4>GreaseMonkeyScript.exclude</h4> | |
| 378 <b>exclude</b>(<i></i>) | |
| 379 <p> | |
| 380 Public method to get the list of excluded URLs. | |
| 381 </p> | |
| 382 | |
| 383 <dl> | |
| 384 <dt>Return:</dt> | |
| 385 <dd> | |
| 386 list of excluded URLs | |
| 387 </dd> | |
| 388 </dl> | |
| 389 <dl> | |
| 390 <dt>Return Type:</dt> | |
| 391 <dd> | |
| 392 list of str | |
| 393 </dd> | |
| 394 </dl> | |
| 395 <a NAME="GreaseMonkeyScript.fileName" ID="GreaseMonkeyScript.fileName"></a> | |
| 396 <h4>GreaseMonkeyScript.fileName</h4> | |
| 397 <b>fileName</b>(<i></i>) | |
| 398 <p> | |
| 399 Public method to get the path of the Javascript file. | |
| 400 </p> | |
| 401 | |
| 402 <dl> | |
| 403 <dt>Return:</dt> | |
| 404 <dd> | |
| 405 path of the Javascript file | |
| 406 </dd> | |
| 407 </dl> | |
| 408 <dl> | |
| 409 <dt>Return Type:</dt> | |
| 410 <dd> | |
| 411 str | |
| 412 </dd> | |
| 413 </dl> | |
| 414 <a NAME="GreaseMonkeyScript.fullName" ID="GreaseMonkeyScript.fullName"></a> | |
| 415 <h4>GreaseMonkeyScript.fullName</h4> | |
| 416 <b>fullName</b>(<i></i>) | |
| 417 <p> | |
| 418 Public method to get the full name of the script. | |
| 419 </p> | |
| 420 | |
| 421 <dl> | |
| 422 <dt>Return:</dt> | |
| 423 <dd> | |
| 424 full name of the script | |
| 425 </dd> | |
| 426 </dl> | |
| 427 <dl> | |
| 428 <dt>Return Type:</dt> | |
| 429 <dd> | |
| 430 str | |
| 431 </dd> | |
| 432 </dl> | |
| 433 <a NAME="GreaseMonkeyScript.icon" ID="GreaseMonkeyScript.icon"></a> | |
| 434 <h4>GreaseMonkeyScript.icon</h4> | |
| 435 <b>icon</b>(<i></i>) | |
| 436 <p> | |
| 437 Public method to get the icon of the script. | |
| 438 </p> | |
| 439 | |
| 440 <dl> | |
| 441 <dt>Return:</dt> | |
| 442 <dd> | |
| 443 script icon | |
| 444 </dd> | |
| 445 </dl> | |
| 446 <dl> | |
| 447 <dt>Return Type:</dt> | |
| 448 <dd> | |
| 449 QIcon | |
| 450 </dd> | |
| 451 </dl> | |
| 452 <a NAME="GreaseMonkeyScript.iconUrl" ID="GreaseMonkeyScript.iconUrl"></a> | |
| 453 <h4>GreaseMonkeyScript.iconUrl</h4> | |
| 454 <b>iconUrl</b>(<i></i>) | |
| 455 <p> | |
| 456 Public method to get the icon URL of the script. | |
| 457 </p> | |
| 458 | |
| 459 <dl> | |
| 460 <dt>Return:</dt> | |
| 461 <dd> | |
| 462 icon URL of the script | |
| 463 </dd> | |
| 464 </dl> | |
| 465 <dl> | |
| 466 <dt>Return Type:</dt> | |
| 467 <dd> | |
| 468 QUrl | |
| 469 </dd> | |
| 470 </dl> | |
| 471 <a NAME="GreaseMonkeyScript.include" ID="GreaseMonkeyScript.include"></a> | |
| 472 <h4>GreaseMonkeyScript.include</h4> | |
| 473 <b>include</b>(<i></i>) | |
| 474 <p> | |
| 475 Public method to get the list of included URLs. | |
| 476 </p> | |
| 477 | |
| 478 <dl> | |
| 479 <dt>Return:</dt> | |
| 480 <dd> | |
| 481 list of included URLs | |
| 482 </dd> | |
| 483 </dl> | |
| 484 <dl> | |
| 485 <dt>Return Type:</dt> | |
| 486 <dd> | |
| 487 list of str | |
| 488 </dd> | |
| 489 </dl> | |
| 490 <a NAME="GreaseMonkeyScript.isEnabled" ID="GreaseMonkeyScript.isEnabled"></a> | |
| 491 <h4>GreaseMonkeyScript.isEnabled</h4> | |
| 492 <b>isEnabled</b>(<i></i>) | |
| 493 <p> | |
| 494 Public method to check, if the script is enabled. | |
| 495 </p> | |
| 496 | |
| 497 <dl> | |
| 498 <dt>Return:</dt> | |
| 499 <dd> | |
| 500 flag indicating an enabled state | |
| 501 </dd> | |
| 502 </dl> | |
| 503 <dl> | |
| 504 <dt>Return Type:</dt> | |
| 505 <dd> | |
| 506 bool | |
| 507 </dd> | |
| 508 </dl> | |
| 509 <a NAME="GreaseMonkeyScript.isUpdating" ID="GreaseMonkeyScript.isUpdating"></a> | |
| 510 <h4>GreaseMonkeyScript.isUpdating</h4> | |
| 511 <b>isUpdating</b>(<i></i>) | |
| 512 <p> | |
| 513 Public method to get the updating flag. | |
| 514 </p> | |
| 515 | |
| 516 <dl> | |
| 517 <dt>Return:</dt> | |
| 518 <dd> | |
| 519 updating flag | |
| 520 </dd> | |
| 521 </dl> | |
| 522 <dl> | |
| 523 <dt>Return Type:</dt> | |
| 524 <dd> | |
| 525 bool | |
| 526 </dd> | |
| 527 </dl> | |
| 528 <a NAME="GreaseMonkeyScript.isValid" ID="GreaseMonkeyScript.isValid"></a> | |
| 529 <h4>GreaseMonkeyScript.isValid</h4> | |
| 530 <b>isValid</b>(<i></i>) | |
| 531 <p> | |
| 532 Public method to check the validity of the script. | |
| 533 </p> | |
| 534 | |
| 535 <dl> | |
| 536 <dt>Return:</dt> | |
| 537 <dd> | |
| 538 flag indicating a valid script | |
| 539 </dd> | |
| 540 </dl> | |
| 541 <dl> | |
| 542 <dt>Return Type:</dt> | |
| 543 <dd> | |
| 544 bool | |
| 545 </dd> | |
| 546 </dl> | |
| 547 <a NAME="GreaseMonkeyScript.name" ID="GreaseMonkeyScript.name"></a> | |
| 548 <h4>GreaseMonkeyScript.name</h4> | |
| 549 <b>name</b>(<i></i>) | |
| 550 <p> | |
| 551 Public method to get the name of the script. | |
| 552 </p> | |
| 553 | |
| 554 <dl> | |
| 555 <dt>Return:</dt> | |
| 556 <dd> | |
| 557 name of the script | |
| 558 </dd> | |
| 559 </dl> | |
| 560 <dl> | |
| 561 <dt>Return Type:</dt> | |
| 562 <dd> | |
| 563 str | |
| 564 </dd> | |
| 565 </dl> | |
| 566 <a NAME="GreaseMonkeyScript.nameSpace" ID="GreaseMonkeyScript.nameSpace"></a> | |
| 567 <h4>GreaseMonkeyScript.nameSpace</h4> | |
| 568 <b>nameSpace</b>(<i></i>) | |
| 569 <p> | |
| 570 Public method to get the name space of the script. | |
| 571 </p> | |
| 572 | |
| 573 <dl> | |
| 574 <dt>Return:</dt> | |
| 575 <dd> | |
| 576 name space of the script | |
| 577 </dd> | |
| 578 </dl> | |
| 579 <dl> | |
| 580 <dt>Return Type:</dt> | |
| 581 <dd> | |
| 582 str | |
| 583 </dd> | |
| 584 </dl> | |
| 585 <a NAME="GreaseMonkeyScript.noFrames" ID="GreaseMonkeyScript.noFrames"></a> | |
| 586 <h4>GreaseMonkeyScript.noFrames</h4> | |
| 587 <b>noFrames</b>(<i></i>) | |
| 588 <p> | |
| 589 Public method to get the noFrames flag. | |
| 590 </p> | |
| 591 | |
| 592 <dl> | |
| 593 <dt>Return:</dt> | |
| 594 <dd> | |
| 595 flag indicating to not run on sub frames | |
| 596 </dd> | |
| 597 </dl> | |
| 598 <dl> | |
| 599 <dt>Return Type:</dt> | |
| 600 <dd> | |
| 601 bool | |
| 602 </dd> | |
| 603 </dl> | |
| 604 <a NAME="GreaseMonkeyScript.require" ID="GreaseMonkeyScript.require"></a> | |
| 605 <h4>GreaseMonkeyScript.require</h4> | |
| 606 <b>require</b>(<i></i>) | |
| 607 <p> | |
| 608 Public method to get the list of required scripts. | |
| 609 </p> | |
| 610 | |
| 611 <dl> | |
| 612 <dt>Return:</dt> | |
| 613 <dd> | |
| 614 list of required scripts | |
| 615 </dd> | |
| 616 </dl> | |
| 617 <dl> | |
| 618 <dt>Return Type:</dt> | |
| 619 <dd> | |
| 620 list of str | |
| 621 </dd> | |
| 622 </dl> | |
| 623 <a NAME="GreaseMonkeyScript.setEnabled" ID="GreaseMonkeyScript.setEnabled"></a> | |
| 624 <h4>GreaseMonkeyScript.setEnabled</h4> | |
| 625 <b>setEnabled</b>(<i>enable</i>) | |
| 626 <p> | |
| 627 Public method to enable a script. | |
| 628 </p> | |
| 629 | |
| 630 <dl> | |
| 631 | |
| 632 <dt><i>enable</i> (bool)</dt> | |
| 633 <dd> | |
| 634 flag indicating the new enabled state | |
| 635 </dd> | |
| 636 </dl> | |
| 637 <a NAME="GreaseMonkeyScript.startAt" ID="GreaseMonkeyScript.startAt"></a> | |
| 638 <h4>GreaseMonkeyScript.startAt</h4> | |
| 639 <b>startAt</b>(<i></i>) | |
| 640 <p> | |
| 641 Public method to get the start point of the script. | |
| 642 </p> | |
| 643 | |
| 644 <dl> | |
| 645 <dt>Return:</dt> | |
| 646 <dd> | |
| 647 start point of the script | |
| 648 </dd> | |
| 649 </dl> | |
| 650 <dl> | |
| 651 <dt>Return Type:</dt> | |
| 652 <dd> | |
| 653 GreaseMonkeyScriptStartPoint | |
| 654 </dd> | |
| 655 </dl> | |
| 656 <a NAME="GreaseMonkeyScript.updateScript" ID="GreaseMonkeyScript.updateScript"></a> | |
| 657 <h4>GreaseMonkeyScript.updateScript</h4> | |
| 658 <b>updateScript</b>(<i></i>) | |
| 659 <p> | |
| 660 Public method to updated the script. | |
| 661 </p> | |
| 662 | |
| 663 <a NAME="GreaseMonkeyScript.updateUrl" ID="GreaseMonkeyScript.updateUrl"></a> | |
| 664 <h4>GreaseMonkeyScript.updateUrl</h4> | |
| 665 <b>updateUrl</b>(<i></i>) | |
| 666 <p> | |
| 667 Public method to get the update URL of the script. | |
| 668 </p> | |
| 669 | |
| 670 <dl> | |
| 671 <dt>Return:</dt> | |
| 672 <dd> | |
| 673 update URL of the script | |
| 674 </dd> | |
| 675 </dl> | |
| 676 <dl> | |
| 677 <dt>Return Type:</dt> | |
| 678 <dd> | |
| 679 QUrl | |
| 680 </dd> | |
| 681 </dl> | |
| 682 <a NAME="GreaseMonkeyScript.version" ID="GreaseMonkeyScript.version"></a> | |
| 683 <h4>GreaseMonkeyScript.version</h4> | |
| 684 <b>version</b>(<i></i>) | |
| 685 <p> | |
| 686 Public method to get the version of the script. | |
| 687 </p> | |
| 688 | |
| 689 <dl> | |
| 690 <dt>Return:</dt> | |
| 691 <dd> | |
| 692 version of the script | |
| 693 </dd> | |
| 694 </dl> | |
| 695 <dl> | |
| 696 <dt>Return Type:</dt> | |
| 697 <dd> | |
| 698 str | |
| 699 </dd> | |
| 700 </dl> | |
| 701 <a NAME="GreaseMonkeyScript.webScript" ID="GreaseMonkeyScript.webScript"></a> | |
| 702 <h4>GreaseMonkeyScript.webScript</h4> | |
| 703 <b>webScript</b>(<i></i>) | |
| 704 <p> | |
| 705 Public method to create a script object. | |
| 706 </p> | |
| 707 | |
| 708 <dl> | |
| 709 <dt>Return:</dt> | |
| 710 <dd> | |
| 711 prepared script object | |
| 712 </dd> | |
| 713 </dl> | |
| 714 <dl> | |
| 715 <dt>Return Type:</dt> | |
| 716 <dd> | |
| 717 QWebEngineScript | |
| 718 </dd> | |
| 719 </dl> | |
| 720 <div align="right"><a href="#top">Up</a></div> | |
| 721 <hr /> | |
| 722 <hr /> | |
| 723 <a NAME="GreaseMonkeyScriptStartPoint" ID="GreaseMonkeyScriptStartPoint"></a> | |
| 724 <h2>GreaseMonkeyScriptStartPoint</h2> | |
| 725 <p> | |
| 726 Class defining the script start points. | |
| 727 </p> | |
| 728 | |
| 729 <h3>Derived from</h3> | |
| 730 enum.Enum | |
| 731 <h3>Class Attributes</h3> | |
| 732 <table> | |
| 57 <tr><td>DocumentEnd</td></tr> | 733 <tr><td>DocumentEnd</td></tr> |
| 58 <tr><td>DocumentIdle</td></tr> | 734 <tr><td>DocumentIdle</td></tr> |
| 59 <tr><td>DocumentStart</td></tr> | 735 <tr><td>DocumentStart</td></tr> |
| 60 </table> | 736 </table> |
| 61 | 737 |
| 64 <tr><td>None</td></tr> | 740 <tr><td>None</td></tr> |
| 65 </table> | 741 </table> |
| 66 | 742 |
| 67 <h3>Methods</h3> | 743 <h3>Methods</h3> |
| 68 <table> | 744 <table> |
| 69 <tr> | 745 <tr><td>None</td></tr> |
| 70 <td><a href="#GreaseMonkeyScript.__init__">GreaseMonkeyScript</a></td> | |
| 71 <td>Constructor</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#GreaseMonkeyScript.__downloadIcon">__downloadIcon</a></td> | |
| 75 <td>Private slot to download the script icon.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#GreaseMonkeyScript.__downloadRequires">__downloadRequires</a></td> | |
| 79 <td>Private method to download the required scripts.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#GreaseMonkeyScript.__downloaderError">__downloaderError</a></td> | |
| 83 <td>Private slot to handle a downloader error.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#GreaseMonkeyScript.__downloaderFinished">__downloaderFinished</a></td> | |
| 87 <td>Private slot to handle a finished download.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 90 <td><a href="#GreaseMonkeyScript.__iconDownloaded">__iconDownloaded</a></td> | |
| 91 <td>Private slot to handle a finished download of a script icon.</td> | |
| 92 </tr> | |
| 93 <tr> | |
| 94 <td><a href="#GreaseMonkeyScript.__parseScript">__parseScript</a></td> | |
| 95 <td>Private method to parse the given script and populate the data structure.</td> | |
| 96 </tr> | |
| 97 <tr> | |
| 98 <td><a href="#GreaseMonkeyScript.__reloadScript">__reloadScript</a></td> | |
| 99 <td>Private method to reload the script.</td> | |
| 100 </tr> | |
| 101 <tr> | |
| 102 <td><a href="#GreaseMonkeyScript.__requireDownloadError">__requireDownloadError</a></td> | |
| 103 <td>Private slot to handle a downloader error.</td> | |
| 104 </tr> | |
| 105 <tr> | |
| 106 <td><a href="#GreaseMonkeyScript.__requireDownloaded">__requireDownloaded</a></td> | |
| 107 <td>Private slot to handle a finished download of a required script.</td> | |
| 108 </tr> | |
| 109 <tr> | |
| 110 <td><a href="#GreaseMonkeyScript.__watchedFileChanged">__watchedFileChanged</a></td> | |
| 111 <td>Private slot handling changes of the script file.</td> | |
| 112 </tr> | |
| 113 <tr> | |
| 114 <td><a href="#GreaseMonkeyScript.description">description</a></td> | |
| 115 <td>Public method to get the description of the script.</td> | |
| 116 </tr> | |
| 117 <tr> | |
| 118 <td><a href="#GreaseMonkeyScript.downloadUrl">downloadUrl</a></td> | |
| 119 <td>Public method to get the download URL of the script.</td> | |
| 120 </tr> | |
| 121 <tr> | |
| 122 <td><a href="#GreaseMonkeyScript.exclude">exclude</a></td> | |
| 123 <td>Public method to get the list of excluded URLs.</td> | |
| 124 </tr> | |
| 125 <tr> | |
| 126 <td><a href="#GreaseMonkeyScript.fileName">fileName</a></td> | |
| 127 <td>Public method to get the path of the Javascript file.</td> | |
| 128 </tr> | |
| 129 <tr> | |
| 130 <td><a href="#GreaseMonkeyScript.fullName">fullName</a></td> | |
| 131 <td>Public method to get the full name of the script.</td> | |
| 132 </tr> | |
| 133 <tr> | |
| 134 <td><a href="#GreaseMonkeyScript.icon">icon</a></td> | |
| 135 <td>Public method to get the icon of the script.</td> | |
| 136 </tr> | |
| 137 <tr> | |
| 138 <td><a href="#GreaseMonkeyScript.iconUrl">iconUrl</a></td> | |
| 139 <td>Public method to get the icon URL of the script.</td> | |
| 140 </tr> | |
| 141 <tr> | |
| 142 <td><a href="#GreaseMonkeyScript.include">include</a></td> | |
| 143 <td>Public method to get the list of included URLs.</td> | |
| 144 </tr> | |
| 145 <tr> | |
| 146 <td><a href="#GreaseMonkeyScript.isEnabled">isEnabled</a></td> | |
| 147 <td>Public method to check, if the script is enabled.</td> | |
| 148 </tr> | |
| 149 <tr> | |
| 150 <td><a href="#GreaseMonkeyScript.isUpdating">isUpdating</a></td> | |
| 151 <td>Public method to get the updating flag.</td> | |
| 152 </tr> | |
| 153 <tr> | |
| 154 <td><a href="#GreaseMonkeyScript.isValid">isValid</a></td> | |
| 155 <td>Public method to check the validity of the script.</td> | |
| 156 </tr> | |
| 157 <tr> | |
| 158 <td><a href="#GreaseMonkeyScript.name">name</a></td> | |
| 159 <td>Public method to get the name of the script.</td> | |
| 160 </tr> | |
| 161 <tr> | |
| 162 <td><a href="#GreaseMonkeyScript.nameSpace">nameSpace</a></td> | |
| 163 <td>Public method to get the name space of the script.</td> | |
| 164 </tr> | |
| 165 <tr> | |
| 166 <td><a href="#GreaseMonkeyScript.noFrames">noFrames</a></td> | |
| 167 <td>Public method to get the noFrames flag.</td> | |
| 168 </tr> | |
| 169 <tr> | |
| 170 <td><a href="#GreaseMonkeyScript.require">require</a></td> | |
| 171 <td>Public method to get the list of required scripts.</td> | |
| 172 </tr> | |
| 173 <tr> | |
| 174 <td><a href="#GreaseMonkeyScript.setEnabled">setEnabled</a></td> | |
| 175 <td>Public method to enable a script.</td> | |
| 176 </tr> | |
| 177 <tr> | |
| 178 <td><a href="#GreaseMonkeyScript.startAt">startAt</a></td> | |
| 179 <td>Public method to get the start point of the script.</td> | |
| 180 </tr> | |
| 181 <tr> | |
| 182 <td><a href="#GreaseMonkeyScript.updateScript">updateScript</a></td> | |
| 183 <td>Public method to updated the script.</td> | |
| 184 </tr> | |
| 185 <tr> | |
| 186 <td><a href="#GreaseMonkeyScript.updateUrl">updateUrl</a></td> | |
| 187 <td>Public method to get the update URL of the script.</td> | |
| 188 </tr> | |
| 189 <tr> | |
| 190 <td><a href="#GreaseMonkeyScript.version">version</a></td> | |
| 191 <td>Public method to get the version of the script.</td> | |
| 192 </tr> | |
| 193 <tr> | |
| 194 <td><a href="#GreaseMonkeyScript.webScript">webScript</a></td> | |
| 195 <td>Public method to create a script object.</td> | |
| 196 </tr> | |
| 197 </table> | 746 </table> |
| 198 | 747 |
| 199 <h3>Static Methods</h3> | 748 <h3>Static Methods</h3> |
| 200 <table> | 749 <table> |
| 201 <tr><td>None</td></tr> | 750 <tr><td>None</td></tr> |
| 202 </table> | 751 </table> |
| 203 | 752 |
| 204 | 753 |
| 205 <a NAME="GreaseMonkeyScript.__init__" ID="GreaseMonkeyScript.__init__"></a> | |
| 206 <h4>GreaseMonkeyScript (Constructor)</h4> | |
| 207 <b>GreaseMonkeyScript</b>(<i>manager, path</i>) | |
| 208 <p> | |
| 209 Constructor | |
| 210 </p> | |
| 211 | |
| 212 <dl> | |
| 213 | |
| 214 <dt><i>manager</i> (GreaseMonkeyManager)</dt> | |
| 215 <dd> | |
| 216 reference to the manager object | |
| 217 </dd> | |
| 218 <dt><i>path</i> (str)</dt> | |
| 219 <dd> | |
| 220 path of the Javascript file | |
| 221 </dd> | |
| 222 </dl> | |
| 223 <a NAME="GreaseMonkeyScript.__downloadIcon" ID="GreaseMonkeyScript.__downloadIcon"></a> | |
| 224 <h4>GreaseMonkeyScript.__downloadIcon</h4> | |
| 225 <b>__downloadIcon</b>(<i></i>) | |
| 226 <p> | |
| 227 Private slot to download the script icon. | |
| 228 </p> | |
| 229 | |
| 230 <a NAME="GreaseMonkeyScript.__downloadRequires" ID="GreaseMonkeyScript.__downloadRequires"></a> | |
| 231 <h4>GreaseMonkeyScript.__downloadRequires</h4> | |
| 232 <b>__downloadRequires</b>(<i></i>) | |
| 233 <p> | |
| 234 Private method to download the required scripts. | |
| 235 </p> | |
| 236 | |
| 237 <a NAME="GreaseMonkeyScript.__downloaderError" ID="GreaseMonkeyScript.__downloaderError"></a> | |
| 238 <h4>GreaseMonkeyScript.__downloaderError</h4> | |
| 239 <b>__downloaderError</b>(<i>downloader</i>) | |
| 240 <p> | |
| 241 Private slot to handle a downloader error. | |
| 242 </p> | |
| 243 | |
| 244 <dl> | |
| 245 | |
| 246 <dt><i>downloader</i> (GreaseMonkeyDownloader)</dt> | |
| 247 <dd> | |
| 248 reference to the downloader object | |
| 249 </dd> | |
| 250 </dl> | |
| 251 <a NAME="GreaseMonkeyScript.__downloaderFinished" ID="GreaseMonkeyScript.__downloaderFinished"></a> | |
| 252 <h4>GreaseMonkeyScript.__downloaderFinished</h4> | |
| 253 <b>__downloaderFinished</b>(<i>downloader</i>) | |
| 254 <p> | |
| 255 Private slot to handle a finished download. | |
| 256 </p> | |
| 257 | |
| 258 <dl> | |
| 259 | |
| 260 <dt><i>downloader</i> (GreaseMonkeyDownloader)</dt> | |
| 261 <dd> | |
| 262 reference to the downloader object | |
| 263 </dd> | |
| 264 </dl> | |
| 265 <a NAME="GreaseMonkeyScript.__iconDownloaded" ID="GreaseMonkeyScript.__iconDownloaded"></a> | |
| 266 <h4>GreaseMonkeyScript.__iconDownloaded</h4> | |
| 267 <b>__iconDownloaded</b>(<i>reply</i>) | |
| 268 <p> | |
| 269 Private slot to handle a finished download of a script icon. | |
| 270 </p> | |
| 271 | |
| 272 <dl> | |
| 273 | |
| 274 <dt><i>reply</i> (QNetworkReply)</dt> | |
| 275 <dd> | |
| 276 reference to the network reply | |
| 277 </dd> | |
| 278 </dl> | |
| 279 <a NAME="GreaseMonkeyScript.__parseScript" ID="GreaseMonkeyScript.__parseScript"></a> | |
| 280 <h4>GreaseMonkeyScript.__parseScript</h4> | |
| 281 <b>__parseScript</b>(<i></i>) | |
| 282 <p> | |
| 283 Private method to parse the given script and populate the data | |
| 284 structure. | |
| 285 </p> | |
| 286 | |
| 287 <a NAME="GreaseMonkeyScript.__reloadScript" ID="GreaseMonkeyScript.__reloadScript"></a> | |
| 288 <h4>GreaseMonkeyScript.__reloadScript</h4> | |
| 289 <b>__reloadScript</b>(<i></i>) | |
| 290 <p> | |
| 291 Private method to reload the script. | |
| 292 </p> | |
| 293 | |
| 294 <a NAME="GreaseMonkeyScript.__requireDownloadError" ID="GreaseMonkeyScript.__requireDownloadError"></a> | |
| 295 <h4>GreaseMonkeyScript.__requireDownloadError</h4> | |
| 296 <b>__requireDownloadError</b>(<i>downloader</i>) | |
| 297 <p> | |
| 298 Private slot to handle a downloader error. | |
| 299 </p> | |
| 300 | |
| 301 <dl> | |
| 302 | |
| 303 <dt><i>downloader</i> (GreaseMonkeyDownloader)</dt> | |
| 304 <dd> | |
| 305 reference to the downloader object | |
| 306 </dd> | |
| 307 </dl> | |
| 308 <a NAME="GreaseMonkeyScript.__requireDownloaded" ID="GreaseMonkeyScript.__requireDownloaded"></a> | |
| 309 <h4>GreaseMonkeyScript.__requireDownloaded</h4> | |
| 310 <b>__requireDownloaded</b>(<i>downloader</i>) | |
| 311 <p> | |
| 312 Private slot to handle a finished download of a required script. | |
| 313 </p> | |
| 314 | |
| 315 <dl> | |
| 316 | |
| 317 <dt><i>downloader</i> (GreaseMonkeyDownloader)</dt> | |
| 318 <dd> | |
| 319 reference to the downloader object | |
| 320 </dd> | |
| 321 </dl> | |
| 322 <a NAME="GreaseMonkeyScript.__watchedFileChanged" ID="GreaseMonkeyScript.__watchedFileChanged"></a> | |
| 323 <h4>GreaseMonkeyScript.__watchedFileChanged</h4> | |
| 324 <b>__watchedFileChanged</b>(<i>fileName</i>) | |
| 325 <p> | |
| 326 Private slot handling changes of the script file. | |
| 327 </p> | |
| 328 | |
| 329 <dl> | |
| 330 | |
| 331 <dt><i>fileName</i> (str)</dt> | |
| 332 <dd> | |
| 333 path of the script file | |
| 334 </dd> | |
| 335 </dl> | |
| 336 <a NAME="GreaseMonkeyScript.description" ID="GreaseMonkeyScript.description"></a> | |
| 337 <h4>GreaseMonkeyScript.description</h4> | |
| 338 <b>description</b>(<i></i>) | |
| 339 <p> | |
| 340 Public method to get the description of the script. | |
| 341 </p> | |
| 342 | |
| 343 <dl> | |
| 344 <dt>Return:</dt> | |
| 345 <dd> | |
| 346 description of the script | |
| 347 </dd> | |
| 348 </dl> | |
| 349 <dl> | |
| 350 <dt>Return Type:</dt> | |
| 351 <dd> | |
| 352 str | |
| 353 </dd> | |
| 354 </dl> | |
| 355 <a NAME="GreaseMonkeyScript.downloadUrl" ID="GreaseMonkeyScript.downloadUrl"></a> | |
| 356 <h4>GreaseMonkeyScript.downloadUrl</h4> | |
| 357 <b>downloadUrl</b>(<i></i>) | |
| 358 <p> | |
| 359 Public method to get the download URL of the script. | |
| 360 </p> | |
| 361 | |
| 362 <dl> | |
| 363 <dt>Return:</dt> | |
| 364 <dd> | |
| 365 download URL of the script | |
| 366 </dd> | |
| 367 </dl> | |
| 368 <dl> | |
| 369 <dt>Return Type:</dt> | |
| 370 <dd> | |
| 371 QUrl | |
| 372 </dd> | |
| 373 </dl> | |
| 374 <a NAME="GreaseMonkeyScript.exclude" ID="GreaseMonkeyScript.exclude"></a> | |
| 375 <h4>GreaseMonkeyScript.exclude</h4> | |
| 376 <b>exclude</b>(<i></i>) | |
| 377 <p> | |
| 378 Public method to get the list of excluded URLs. | |
| 379 </p> | |
| 380 | |
| 381 <dl> | |
| 382 <dt>Return:</dt> | |
| 383 <dd> | |
| 384 list of excluded URLs | |
| 385 </dd> | |
| 386 </dl> | |
| 387 <dl> | |
| 388 <dt>Return Type:</dt> | |
| 389 <dd> | |
| 390 list of str | |
| 391 </dd> | |
| 392 </dl> | |
| 393 <a NAME="GreaseMonkeyScript.fileName" ID="GreaseMonkeyScript.fileName"></a> | |
| 394 <h4>GreaseMonkeyScript.fileName</h4> | |
| 395 <b>fileName</b>(<i></i>) | |
| 396 <p> | |
| 397 Public method to get the path of the Javascript file. | |
| 398 </p> | |
| 399 | |
| 400 <dl> | |
| 401 <dt>Return:</dt> | |
| 402 <dd> | |
| 403 path of the Javascript file | |
| 404 </dd> | |
| 405 </dl> | |
| 406 <dl> | |
| 407 <dt>Return Type:</dt> | |
| 408 <dd> | |
| 409 str | |
| 410 </dd> | |
| 411 </dl> | |
| 412 <a NAME="GreaseMonkeyScript.fullName" ID="GreaseMonkeyScript.fullName"></a> | |
| 413 <h4>GreaseMonkeyScript.fullName</h4> | |
| 414 <b>fullName</b>(<i></i>) | |
| 415 <p> | |
| 416 Public method to get the full name of the script. | |
| 417 </p> | |
| 418 | |
| 419 <dl> | |
| 420 <dt>Return:</dt> | |
| 421 <dd> | |
| 422 full name of the script | |
| 423 </dd> | |
| 424 </dl> | |
| 425 <dl> | |
| 426 <dt>Return Type:</dt> | |
| 427 <dd> | |
| 428 str | |
| 429 </dd> | |
| 430 </dl> | |
| 431 <a NAME="GreaseMonkeyScript.icon" ID="GreaseMonkeyScript.icon"></a> | |
| 432 <h4>GreaseMonkeyScript.icon</h4> | |
| 433 <b>icon</b>(<i></i>) | |
| 434 <p> | |
| 435 Public method to get the icon of the script. | |
| 436 </p> | |
| 437 | |
| 438 <dl> | |
| 439 <dt>Return:</dt> | |
| 440 <dd> | |
| 441 script icon | |
| 442 </dd> | |
| 443 </dl> | |
| 444 <dl> | |
| 445 <dt>Return Type:</dt> | |
| 446 <dd> | |
| 447 QIcon | |
| 448 </dd> | |
| 449 </dl> | |
| 450 <a NAME="GreaseMonkeyScript.iconUrl" ID="GreaseMonkeyScript.iconUrl"></a> | |
| 451 <h4>GreaseMonkeyScript.iconUrl</h4> | |
| 452 <b>iconUrl</b>(<i></i>) | |
| 453 <p> | |
| 454 Public method to get the icon URL of the script. | |
| 455 </p> | |
| 456 | |
| 457 <dl> | |
| 458 <dt>Return:</dt> | |
| 459 <dd> | |
| 460 icon URL of the script | |
| 461 </dd> | |
| 462 </dl> | |
| 463 <dl> | |
| 464 <dt>Return Type:</dt> | |
| 465 <dd> | |
| 466 QUrl | |
| 467 </dd> | |
| 468 </dl> | |
| 469 <a NAME="GreaseMonkeyScript.include" ID="GreaseMonkeyScript.include"></a> | |
| 470 <h4>GreaseMonkeyScript.include</h4> | |
| 471 <b>include</b>(<i></i>) | |
| 472 <p> | |
| 473 Public method to get the list of included URLs. | |
| 474 </p> | |
| 475 | |
| 476 <dl> | |
| 477 <dt>Return:</dt> | |
| 478 <dd> | |
| 479 list of included URLs | |
| 480 </dd> | |
| 481 </dl> | |
| 482 <dl> | |
| 483 <dt>Return Type:</dt> | |
| 484 <dd> | |
| 485 list of str | |
| 486 </dd> | |
| 487 </dl> | |
| 488 <a NAME="GreaseMonkeyScript.isEnabled" ID="GreaseMonkeyScript.isEnabled"></a> | |
| 489 <h4>GreaseMonkeyScript.isEnabled</h4> | |
| 490 <b>isEnabled</b>(<i></i>) | |
| 491 <p> | |
| 492 Public method to check, if the script is enabled. | |
| 493 </p> | |
| 494 | |
| 495 <dl> | |
| 496 <dt>Return:</dt> | |
| 497 <dd> | |
| 498 flag indicating an enabled state | |
| 499 </dd> | |
| 500 </dl> | |
| 501 <dl> | |
| 502 <dt>Return Type:</dt> | |
| 503 <dd> | |
| 504 bool | |
| 505 </dd> | |
| 506 </dl> | |
| 507 <a NAME="GreaseMonkeyScript.isUpdating" ID="GreaseMonkeyScript.isUpdating"></a> | |
| 508 <h4>GreaseMonkeyScript.isUpdating</h4> | |
| 509 <b>isUpdating</b>(<i></i>) | |
| 510 <p> | |
| 511 Public method to get the updating flag. | |
| 512 </p> | |
| 513 | |
| 514 <dl> | |
| 515 <dt>Return:</dt> | |
| 516 <dd> | |
| 517 updating flag | |
| 518 </dd> | |
| 519 </dl> | |
| 520 <dl> | |
| 521 <dt>Return Type:</dt> | |
| 522 <dd> | |
| 523 bool | |
| 524 </dd> | |
| 525 </dl> | |
| 526 <a NAME="GreaseMonkeyScript.isValid" ID="GreaseMonkeyScript.isValid"></a> | |
| 527 <h4>GreaseMonkeyScript.isValid</h4> | |
| 528 <b>isValid</b>(<i></i>) | |
| 529 <p> | |
| 530 Public method to check the validity of the script. | |
| 531 </p> | |
| 532 | |
| 533 <dl> | |
| 534 <dt>Return:</dt> | |
| 535 <dd> | |
| 536 flag indicating a valid script | |
| 537 </dd> | |
| 538 </dl> | |
| 539 <dl> | |
| 540 <dt>Return Type:</dt> | |
| 541 <dd> | |
| 542 bool | |
| 543 </dd> | |
| 544 </dl> | |
| 545 <a NAME="GreaseMonkeyScript.name" ID="GreaseMonkeyScript.name"></a> | |
| 546 <h4>GreaseMonkeyScript.name</h4> | |
| 547 <b>name</b>(<i></i>) | |
| 548 <p> | |
| 549 Public method to get the name of the script. | |
| 550 </p> | |
| 551 | |
| 552 <dl> | |
| 553 <dt>Return:</dt> | |
| 554 <dd> | |
| 555 name of the script | |
| 556 </dd> | |
| 557 </dl> | |
| 558 <dl> | |
| 559 <dt>Return Type:</dt> | |
| 560 <dd> | |
| 561 str | |
| 562 </dd> | |
| 563 </dl> | |
| 564 <a NAME="GreaseMonkeyScript.nameSpace" ID="GreaseMonkeyScript.nameSpace"></a> | |
| 565 <h4>GreaseMonkeyScript.nameSpace</h4> | |
| 566 <b>nameSpace</b>(<i></i>) | |
| 567 <p> | |
| 568 Public method to get the name space of the script. | |
| 569 </p> | |
| 570 | |
| 571 <dl> | |
| 572 <dt>Return:</dt> | |
| 573 <dd> | |
| 574 name space of the script | |
| 575 </dd> | |
| 576 </dl> | |
| 577 <dl> | |
| 578 <dt>Return Type:</dt> | |
| 579 <dd> | |
| 580 str | |
| 581 </dd> | |
| 582 </dl> | |
| 583 <a NAME="GreaseMonkeyScript.noFrames" ID="GreaseMonkeyScript.noFrames"></a> | |
| 584 <h4>GreaseMonkeyScript.noFrames</h4> | |
| 585 <b>noFrames</b>(<i></i>) | |
| 586 <p> | |
| 587 Public method to get the noFrames flag. | |
| 588 </p> | |
| 589 | |
| 590 <dl> | |
| 591 <dt>Return:</dt> | |
| 592 <dd> | |
| 593 flag indicating to not run on sub frames | |
| 594 </dd> | |
| 595 </dl> | |
| 596 <dl> | |
| 597 <dt>Return Type:</dt> | |
| 598 <dd> | |
| 599 bool | |
| 600 </dd> | |
| 601 </dl> | |
| 602 <a NAME="GreaseMonkeyScript.require" ID="GreaseMonkeyScript.require"></a> | |
| 603 <h4>GreaseMonkeyScript.require</h4> | |
| 604 <b>require</b>(<i></i>) | |
| 605 <p> | |
| 606 Public method to get the list of required scripts. | |
| 607 </p> | |
| 608 | |
| 609 <dl> | |
| 610 <dt>Return:</dt> | |
| 611 <dd> | |
| 612 list of required scripts | |
| 613 </dd> | |
| 614 </dl> | |
| 615 <dl> | |
| 616 <dt>Return Type:</dt> | |
| 617 <dd> | |
| 618 list of str | |
| 619 </dd> | |
| 620 </dl> | |
| 621 <a NAME="GreaseMonkeyScript.setEnabled" ID="GreaseMonkeyScript.setEnabled"></a> | |
| 622 <h4>GreaseMonkeyScript.setEnabled</h4> | |
| 623 <b>setEnabled</b>(<i>enable</i>) | |
| 624 <p> | |
| 625 Public method to enable a script. | |
| 626 </p> | |
| 627 | |
| 628 <dl> | |
| 629 | |
| 630 <dt><i>enable</i> (bool)</dt> | |
| 631 <dd> | |
| 632 flag indicating the new enabled state | |
| 633 </dd> | |
| 634 </dl> | |
| 635 <a NAME="GreaseMonkeyScript.startAt" ID="GreaseMonkeyScript.startAt"></a> | |
| 636 <h4>GreaseMonkeyScript.startAt</h4> | |
| 637 <b>startAt</b>(<i></i>) | |
| 638 <p> | |
| 639 Public method to get the start point of the script. | |
| 640 </p> | |
| 641 | |
| 642 <dl> | |
| 643 <dt>Return:</dt> | |
| 644 <dd> | |
| 645 start point of the script | |
| 646 </dd> | |
| 647 </dl> | |
| 648 <dl> | |
| 649 <dt>Return Type:</dt> | |
| 650 <dd> | |
| 651 DocumentStart or DocumentEnd | |
| 652 </dd> | |
| 653 </dl> | |
| 654 <a NAME="GreaseMonkeyScript.updateScript" ID="GreaseMonkeyScript.updateScript"></a> | |
| 655 <h4>GreaseMonkeyScript.updateScript</h4> | |
| 656 <b>updateScript</b>(<i></i>) | |
| 657 <p> | |
| 658 Public method to updated the script. | |
| 659 </p> | |
| 660 | |
| 661 <a NAME="GreaseMonkeyScript.updateUrl" ID="GreaseMonkeyScript.updateUrl"></a> | |
| 662 <h4>GreaseMonkeyScript.updateUrl</h4> | |
| 663 <b>updateUrl</b>(<i></i>) | |
| 664 <p> | |
| 665 Public method to get the update URL of the script. | |
| 666 </p> | |
| 667 | |
| 668 <dl> | |
| 669 <dt>Return:</dt> | |
| 670 <dd> | |
| 671 update URL of the script | |
| 672 </dd> | |
| 673 </dl> | |
| 674 <dl> | |
| 675 <dt>Return Type:</dt> | |
| 676 <dd> | |
| 677 QUrl | |
| 678 </dd> | |
| 679 </dl> | |
| 680 <a NAME="GreaseMonkeyScript.version" ID="GreaseMonkeyScript.version"></a> | |
| 681 <h4>GreaseMonkeyScript.version</h4> | |
| 682 <b>version</b>(<i></i>) | |
| 683 <p> | |
| 684 Public method to get the version of the script. | |
| 685 </p> | |
| 686 | |
| 687 <dl> | |
| 688 <dt>Return:</dt> | |
| 689 <dd> | |
| 690 version of the script | |
| 691 </dd> | |
| 692 </dl> | |
| 693 <dl> | |
| 694 <dt>Return Type:</dt> | |
| 695 <dd> | |
| 696 str | |
| 697 </dd> | |
| 698 </dl> | |
| 699 <a NAME="GreaseMonkeyScript.webScript" ID="GreaseMonkeyScript.webScript"></a> | |
| 700 <h4>GreaseMonkeyScript.webScript</h4> | |
| 701 <b>webScript</b>(<i></i>) | |
| 702 <p> | |
| 703 Public method to create a script object. | |
| 704 </p> | |
| 705 | |
| 706 <dl> | |
| 707 <dt>Return:</dt> | |
| 708 <dd> | |
| 709 prepared script object | |
| 710 </dd> | |
| 711 </dl> | |
| 712 <dl> | |
| 713 <dt>Return Type:</dt> | |
| 714 <dd> | |
| 715 QWebEngineScript | |
| 716 </dd> | |
| 717 </dl> | |
| 718 <div align="right"><a href="#top">Up</a></div> | 754 <div align="right"><a href="#top">Up</a></div> |
| 719 <hr /> | 755 <hr /> |
| 720 </body></html> | 756 </body></html> |
