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 10436
- f6881d10e995
- parent 9209
- b99e7fd55fd3
- child 10479
- 856476537696
equal
deleted
inserted
replaced
| 10435:c712d09cc839 | 10436:f6881d10e995 |
|---|---|
| 209 <p> | 209 <p> |
| 210 Constructor | 210 Constructor |
| 211 </p> | 211 </p> |
| 212 <dl> | 212 <dl> |
| 213 | 213 |
| 214 <dt><i>manager</i></dt> | 214 <dt><i>manager</i> (GreaseMonkeyManager)</dt> |
| 215 <dd> | 215 <dd> |
| 216 reference to the manager object (GreaseMonkeyManager) | 216 reference to the manager object |
| 217 </dd> | 217 </dd> |
| 218 <dt><i>path</i></dt> | 218 <dt><i>path</i> (str)</dt> |
| 219 <dd> | 219 <dd> |
| 220 path of the Javascript file (string) | 220 path of the Javascript file |
| 221 </dd> | 221 </dd> |
| 222 </dl> | 222 </dl> |
| 223 <a NAME="GreaseMonkeyScript.__downloadIcon" ID="GreaseMonkeyScript.__downloadIcon"></a> | 223 <a NAME="GreaseMonkeyScript.__downloadIcon" ID="GreaseMonkeyScript.__downloadIcon"></a> |
| 224 <h4>GreaseMonkeyScript.__downloadIcon</h4> | 224 <h4>GreaseMonkeyScript.__downloadIcon</h4> |
| 225 <b>__downloadIcon</b>(<i></i>) | 225 <b>__downloadIcon</b>(<i></i>) |
| 341 Public method to get the description of the script. | 341 Public method to get the description of the script. |
| 342 </p> | 342 </p> |
| 343 <dl> | 343 <dl> |
| 344 <dt>Return:</dt> | 344 <dt>Return:</dt> |
| 345 <dd> | 345 <dd> |
| 346 description of the script (string) | 346 description of the script |
| 347 </dd> | |
| 348 </dl> | |
| 349 <dl> | |
| 350 <dt>Return Type:</dt> | |
| 351 <dd> | |
| 352 str | |
| 347 </dd> | 353 </dd> |
| 348 </dl> | 354 </dl> |
| 349 <a NAME="GreaseMonkeyScript.downloadUrl" ID="GreaseMonkeyScript.downloadUrl"></a> | 355 <a NAME="GreaseMonkeyScript.downloadUrl" ID="GreaseMonkeyScript.downloadUrl"></a> |
| 350 <h4>GreaseMonkeyScript.downloadUrl</h4> | 356 <h4>GreaseMonkeyScript.downloadUrl</h4> |
| 351 <b>downloadUrl</b>(<i></i>) | 357 <b>downloadUrl</b>(<i></i>) |
| 354 Public method to get the download URL of the script. | 360 Public method to get the download URL of the script. |
| 355 </p> | 361 </p> |
| 356 <dl> | 362 <dl> |
| 357 <dt>Return:</dt> | 363 <dt>Return:</dt> |
| 358 <dd> | 364 <dd> |
| 359 download URL of the script (QUrl) | 365 download URL of the script |
| 366 </dd> | |
| 367 </dl> | |
| 368 <dl> | |
| 369 <dt>Return Type:</dt> | |
| 370 <dd> | |
| 371 QUrl | |
| 360 </dd> | 372 </dd> |
| 361 </dl> | 373 </dl> |
| 362 <a NAME="GreaseMonkeyScript.exclude" ID="GreaseMonkeyScript.exclude"></a> | 374 <a NAME="GreaseMonkeyScript.exclude" ID="GreaseMonkeyScript.exclude"></a> |
| 363 <h4>GreaseMonkeyScript.exclude</h4> | 375 <h4>GreaseMonkeyScript.exclude</h4> |
| 364 <b>exclude</b>(<i></i>) | 376 <b>exclude</b>(<i></i>) |
| 367 Public method to get the list of excluded URLs. | 379 Public method to get the list of excluded URLs. |
| 368 </p> | 380 </p> |
| 369 <dl> | 381 <dl> |
| 370 <dt>Return:</dt> | 382 <dt>Return:</dt> |
| 371 <dd> | 383 <dd> |
| 372 list of excluded URLs (list of strings) | 384 list of excluded URLs |
| 385 </dd> | |
| 386 </dl> | |
| 387 <dl> | |
| 388 <dt>Return Type:</dt> | |
| 389 <dd> | |
| 390 list of str | |
| 373 </dd> | 391 </dd> |
| 374 </dl> | 392 </dl> |
| 375 <a NAME="GreaseMonkeyScript.fileName" ID="GreaseMonkeyScript.fileName"></a> | 393 <a NAME="GreaseMonkeyScript.fileName" ID="GreaseMonkeyScript.fileName"></a> |
| 376 <h4>GreaseMonkeyScript.fileName</h4> | 394 <h4>GreaseMonkeyScript.fileName</h4> |
| 377 <b>fileName</b>(<i></i>) | 395 <b>fileName</b>(<i></i>) |
| 380 Public method to get the path of the Javascript file. | 398 Public method to get the path of the Javascript file. |
| 381 </p> | 399 </p> |
| 382 <dl> | 400 <dl> |
| 383 <dt>Return:</dt> | 401 <dt>Return:</dt> |
| 384 <dd> | 402 <dd> |
| 385 path of the Javascript file (string) | 403 path of the Javascript file |
| 404 </dd> | |
| 405 </dl> | |
| 406 <dl> | |
| 407 <dt>Return Type:</dt> | |
| 408 <dd> | |
| 409 str | |
| 386 </dd> | 410 </dd> |
| 387 </dl> | 411 </dl> |
| 388 <a NAME="GreaseMonkeyScript.fullName" ID="GreaseMonkeyScript.fullName"></a> | 412 <a NAME="GreaseMonkeyScript.fullName" ID="GreaseMonkeyScript.fullName"></a> |
| 389 <h4>GreaseMonkeyScript.fullName</h4> | 413 <h4>GreaseMonkeyScript.fullName</h4> |
| 390 <b>fullName</b>(<i></i>) | 414 <b>fullName</b>(<i></i>) |
| 393 Public method to get the full name of the script. | 417 Public method to get the full name of the script. |
| 394 </p> | 418 </p> |
| 395 <dl> | 419 <dl> |
| 396 <dt>Return:</dt> | 420 <dt>Return:</dt> |
| 397 <dd> | 421 <dd> |
| 398 full name of the script (string) | 422 full name of the script |
| 423 </dd> | |
| 424 </dl> | |
| 425 <dl> | |
| 426 <dt>Return Type:</dt> | |
| 427 <dd> | |
| 428 str | |
| 399 </dd> | 429 </dd> |
| 400 </dl> | 430 </dl> |
| 401 <a NAME="GreaseMonkeyScript.icon" ID="GreaseMonkeyScript.icon"></a> | 431 <a NAME="GreaseMonkeyScript.icon" ID="GreaseMonkeyScript.icon"></a> |
| 402 <h4>GreaseMonkeyScript.icon</h4> | 432 <h4>GreaseMonkeyScript.icon</h4> |
| 403 <b>icon</b>(<i></i>) | 433 <b>icon</b>(<i></i>) |
| 425 Public method to get the icon URL of the script. | 455 Public method to get the icon URL of the script. |
| 426 </p> | 456 </p> |
| 427 <dl> | 457 <dl> |
| 428 <dt>Return:</dt> | 458 <dt>Return:</dt> |
| 429 <dd> | 459 <dd> |
| 430 icon URL of the script (QUrl) | 460 icon URL of the script |
| 461 </dd> | |
| 462 </dl> | |
| 463 <dl> | |
| 464 <dt>Return Type:</dt> | |
| 465 <dd> | |
| 466 QUrl | |
| 431 </dd> | 467 </dd> |
| 432 </dl> | 468 </dl> |
| 433 <a NAME="GreaseMonkeyScript.include" ID="GreaseMonkeyScript.include"></a> | 469 <a NAME="GreaseMonkeyScript.include" ID="GreaseMonkeyScript.include"></a> |
| 434 <h4>GreaseMonkeyScript.include</h4> | 470 <h4>GreaseMonkeyScript.include</h4> |
| 435 <b>include</b>(<i></i>) | 471 <b>include</b>(<i></i>) |
| 438 Public method to get the list of included URLs. | 474 Public method to get the list of included URLs. |
| 439 </p> | 475 </p> |
| 440 <dl> | 476 <dl> |
| 441 <dt>Return:</dt> | 477 <dt>Return:</dt> |
| 442 <dd> | 478 <dd> |
| 443 list of included URLs (list of strings) | 479 list of included URLs |
| 480 </dd> | |
| 481 </dl> | |
| 482 <dl> | |
| 483 <dt>Return Type:</dt> | |
| 484 <dd> | |
| 485 list of str | |
| 444 </dd> | 486 </dd> |
| 445 </dl> | 487 </dl> |
| 446 <a NAME="GreaseMonkeyScript.isEnabled" ID="GreaseMonkeyScript.isEnabled"></a> | 488 <a NAME="GreaseMonkeyScript.isEnabled" ID="GreaseMonkeyScript.isEnabled"></a> |
| 447 <h4>GreaseMonkeyScript.isEnabled</h4> | 489 <h4>GreaseMonkeyScript.isEnabled</h4> |
| 448 <b>isEnabled</b>(<i></i>) | 490 <b>isEnabled</b>(<i></i>) |
| 451 Public method to check, if the script is enabled. | 493 Public method to check, if the script is enabled. |
| 452 </p> | 494 </p> |
| 453 <dl> | 495 <dl> |
| 454 <dt>Return:</dt> | 496 <dt>Return:</dt> |
| 455 <dd> | 497 <dd> |
| 456 flag indicating an enabled state (boolean) | 498 flag indicating an enabled state |
| 499 </dd> | |
| 500 </dl> | |
| 501 <dl> | |
| 502 <dt>Return Type:</dt> | |
| 503 <dd> | |
| 504 bool | |
| 457 </dd> | 505 </dd> |
| 458 </dl> | 506 </dl> |
| 459 <a NAME="GreaseMonkeyScript.isUpdating" ID="GreaseMonkeyScript.isUpdating"></a> | 507 <a NAME="GreaseMonkeyScript.isUpdating" ID="GreaseMonkeyScript.isUpdating"></a> |
| 460 <h4>GreaseMonkeyScript.isUpdating</h4> | 508 <h4>GreaseMonkeyScript.isUpdating</h4> |
| 461 <b>isUpdating</b>(<i></i>) | 509 <b>isUpdating</b>(<i></i>) |
| 483 Public method to check the validity of the script. | 531 Public method to check the validity of the script. |
| 484 </p> | 532 </p> |
| 485 <dl> | 533 <dl> |
| 486 <dt>Return:</dt> | 534 <dt>Return:</dt> |
| 487 <dd> | 535 <dd> |
| 488 flag indicating a valid script (boolean) | 536 flag indicating a valid script |
| 537 </dd> | |
| 538 </dl> | |
| 539 <dl> | |
| 540 <dt>Return Type:</dt> | |
| 541 <dd> | |
| 542 bool | |
| 489 </dd> | 543 </dd> |
| 490 </dl> | 544 </dl> |
| 491 <a NAME="GreaseMonkeyScript.name" ID="GreaseMonkeyScript.name"></a> | 545 <a NAME="GreaseMonkeyScript.name" ID="GreaseMonkeyScript.name"></a> |
| 492 <h4>GreaseMonkeyScript.name</h4> | 546 <h4>GreaseMonkeyScript.name</h4> |
| 493 <b>name</b>(<i></i>) | 547 <b>name</b>(<i></i>) |
| 496 Public method to get the name of the script. | 550 Public method to get the name of the script. |
| 497 </p> | 551 </p> |
| 498 <dl> | 552 <dl> |
| 499 <dt>Return:</dt> | 553 <dt>Return:</dt> |
| 500 <dd> | 554 <dd> |
| 501 name of the script (string) | 555 name of the script |
| 556 </dd> | |
| 557 </dl> | |
| 558 <dl> | |
| 559 <dt>Return Type:</dt> | |
| 560 <dd> | |
| 561 str | |
| 502 </dd> | 562 </dd> |
| 503 </dl> | 563 </dl> |
| 504 <a NAME="GreaseMonkeyScript.nameSpace" ID="GreaseMonkeyScript.nameSpace"></a> | 564 <a NAME="GreaseMonkeyScript.nameSpace" ID="GreaseMonkeyScript.nameSpace"></a> |
| 505 <h4>GreaseMonkeyScript.nameSpace</h4> | 565 <h4>GreaseMonkeyScript.nameSpace</h4> |
| 506 <b>nameSpace</b>(<i></i>) | 566 <b>nameSpace</b>(<i></i>) |
| 509 Public method to get the name space of the script. | 569 Public method to get the name space of the script. |
| 510 </p> | 570 </p> |
| 511 <dl> | 571 <dl> |
| 512 <dt>Return:</dt> | 572 <dt>Return:</dt> |
| 513 <dd> | 573 <dd> |
| 514 name space of the script (string) | 574 name space of the script |
| 575 </dd> | |
| 576 </dl> | |
| 577 <dl> | |
| 578 <dt>Return Type:</dt> | |
| 579 <dd> | |
| 580 str | |
| 515 </dd> | 581 </dd> |
| 516 </dl> | 582 </dl> |
| 517 <a NAME="GreaseMonkeyScript.noFrames" ID="GreaseMonkeyScript.noFrames"></a> | 583 <a NAME="GreaseMonkeyScript.noFrames" ID="GreaseMonkeyScript.noFrames"></a> |
| 518 <h4>GreaseMonkeyScript.noFrames</h4> | 584 <h4>GreaseMonkeyScript.noFrames</h4> |
| 519 <b>noFrames</b>(<i></i>) | 585 <b>noFrames</b>(<i></i>) |
| 541 Public method to get the list of required scripts. | 607 Public method to get the list of required scripts. |
| 542 </p> | 608 </p> |
| 543 <dl> | 609 <dl> |
| 544 <dt>Return:</dt> | 610 <dt>Return:</dt> |
| 545 <dd> | 611 <dd> |
| 546 list of required scripts (list of strings) | 612 list of required scripts |
| 613 </dd> | |
| 614 </dl> | |
| 615 <dl> | |
| 616 <dt>Return Type:</dt> | |
| 617 <dd> | |
| 618 list of str | |
| 547 </dd> | 619 </dd> |
| 548 </dl> | 620 </dl> |
| 549 <a NAME="GreaseMonkeyScript.setEnabled" ID="GreaseMonkeyScript.setEnabled"></a> | 621 <a NAME="GreaseMonkeyScript.setEnabled" ID="GreaseMonkeyScript.setEnabled"></a> |
| 550 <h4>GreaseMonkeyScript.setEnabled</h4> | 622 <h4>GreaseMonkeyScript.setEnabled</h4> |
| 551 <b>setEnabled</b>(<i>enable</i>) | 623 <b>setEnabled</b>(<i>enable</i>) |
| 553 <p> | 625 <p> |
| 554 Public method to enable a script. | 626 Public method to enable a script. |
| 555 </p> | 627 </p> |
| 556 <dl> | 628 <dl> |
| 557 | 629 |
| 558 <dt><i>enable</i></dt> | 630 <dt><i>enable</i> (bool)</dt> |
| 559 <dd> | 631 <dd> |
| 560 flag indicating the new enabled state (boolean) | 632 flag indicating the new enabled state |
| 561 </dd> | 633 </dd> |
| 562 </dl> | 634 </dl> |
| 563 <a NAME="GreaseMonkeyScript.startAt" ID="GreaseMonkeyScript.startAt"></a> | 635 <a NAME="GreaseMonkeyScript.startAt" ID="GreaseMonkeyScript.startAt"></a> |
| 564 <h4>GreaseMonkeyScript.startAt</h4> | 636 <h4>GreaseMonkeyScript.startAt</h4> |
| 565 <b>startAt</b>(<i></i>) | 637 <b>startAt</b>(<i></i>) |
| 568 Public method to get the start point of the script. | 640 Public method to get the start point of the script. |
| 569 </p> | 641 </p> |
| 570 <dl> | 642 <dl> |
| 571 <dt>Return:</dt> | 643 <dt>Return:</dt> |
| 572 <dd> | 644 <dd> |
| 573 start point of the script (DocumentStart or DocumentEnd) | 645 start point of the script |
| 646 </dd> | |
| 647 </dl> | |
| 648 <dl> | |
| 649 <dt>Return Type:</dt> | |
| 650 <dd> | |
| 651 DocumentStart or DocumentEnd | |
| 574 </dd> | 652 </dd> |
| 575 </dl> | 653 </dl> |
| 576 <a NAME="GreaseMonkeyScript.updateScript" ID="GreaseMonkeyScript.updateScript"></a> | 654 <a NAME="GreaseMonkeyScript.updateScript" ID="GreaseMonkeyScript.updateScript"></a> |
| 577 <h4>GreaseMonkeyScript.updateScript</h4> | 655 <h4>GreaseMonkeyScript.updateScript</h4> |
| 578 <b>updateScript</b>(<i></i>) | 656 <b>updateScript</b>(<i></i>) |
| 588 Public method to get the update URL of the script. | 666 Public method to get the update URL of the script. |
| 589 </p> | 667 </p> |
| 590 <dl> | 668 <dl> |
| 591 <dt>Return:</dt> | 669 <dt>Return:</dt> |
| 592 <dd> | 670 <dd> |
| 593 update URL of the script (QUrl) | 671 update URL of the script |
| 672 </dd> | |
| 673 </dl> | |
| 674 <dl> | |
| 675 <dt>Return Type:</dt> | |
| 676 <dd> | |
| 677 QUrl | |
| 594 </dd> | 678 </dd> |
| 595 </dl> | 679 </dl> |
| 596 <a NAME="GreaseMonkeyScript.version" ID="GreaseMonkeyScript.version"></a> | 680 <a NAME="GreaseMonkeyScript.version" ID="GreaseMonkeyScript.version"></a> |
| 597 <h4>GreaseMonkeyScript.version</h4> | 681 <h4>GreaseMonkeyScript.version</h4> |
| 598 <b>version</b>(<i></i>) | 682 <b>version</b>(<i></i>) |
| 601 Public method to get the version of the script. | 685 Public method to get the version of the script. |
| 602 </p> | 686 </p> |
| 603 <dl> | 687 <dl> |
| 604 <dt>Return:</dt> | 688 <dt>Return:</dt> |
| 605 <dd> | 689 <dd> |
| 606 version of the script (string) | 690 version of the script |
| 691 </dd> | |
| 692 </dl> | |
| 693 <dl> | |
| 694 <dt>Return Type:</dt> | |
| 695 <dd> | |
| 696 str | |
| 607 </dd> | 697 </dd> |
| 608 </dl> | 698 </dl> |
| 609 <a NAME="GreaseMonkeyScript.webScript" ID="GreaseMonkeyScript.webScript"></a> | 699 <a NAME="GreaseMonkeyScript.webScript" ID="GreaseMonkeyScript.webScript"></a> |
| 610 <h4>GreaseMonkeyScript.webScript</h4> | 700 <h4>GreaseMonkeyScript.webScript</h4> |
| 611 <b>webScript</b>(<i></i>) | 701 <b>webScript</b>(<i></i>) |
