src/eric7/Documentation/Source/eric7.WebBrowser.GreaseMonkey.GreaseMonkeyScript.html

branch
eric7
changeset 10479
856476537696
parent 10436
f6881d10e995
child 10493
f795d68d8e09
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.WebBrowser.GreaseMonkey.GreaseMonkeyScript</h1> 9 <h1>eric7.WebBrowser.GreaseMonkey.GreaseMonkeyScript</h1>
10
11 <p> 10 <p>
12 Module implementing the GreaseMonkey script. 11 Module implementing the GreaseMonkey script.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15
16 <table> 15 <table>
17 <tr><td>None</td></tr> 16 <tr><td>None</td></tr>
18 </table> 17 </table>
18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20
21 <table> 20 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#GreaseMonkeyScript">GreaseMonkeyScript</a></td> 22 <td><a href="#GreaseMonkeyScript">GreaseMonkeyScript</a></td>
25 <td>Class implementing the GreaseMonkey script.</td> 23 <td>Class implementing the GreaseMonkey script.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29
30 <table> 28 <table>
31 <tr><td>None</td></tr> 29 <tr><td>None</td></tr>
32 </table> 30 </table>
31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="GreaseMonkeyScript" ID="GreaseMonkeyScript"></a> 34 <a NAME="GreaseMonkeyScript" ID="GreaseMonkeyScript"></a>
36 <h2>GreaseMonkeyScript</h2> 35 <h2>GreaseMonkeyScript</h2>
37
38 <p> 36 <p>
39 Class implementing the GreaseMonkey script. 37 Class implementing the GreaseMonkey script.
40 </p> 38 </p>
39
41 <h3>Signals</h3> 40 <h3>Signals</h3>
42 <dl> 41 <dl>
43 42
44 <dt>scriptChanged()</dt> 43 <dt>scriptChanged()</dt>
45 <dd> 44 <dd>
52 </dd> 51 </dd>
53 </dl> 52 </dl>
54 <h3>Derived from</h3> 53 <h3>Derived from</h3>
55 QObject 54 QObject
56 <h3>Class Attributes</h3> 55 <h3>Class Attributes</h3>
57
58 <table> 56 <table>
59 <tr><td>DocumentEnd</td></tr><tr><td>DocumentIdle</td></tr><tr><td>DocumentStart</td></tr> 57 <tr><td>DocumentEnd</td></tr>
58 <tr><td>DocumentIdle</td></tr>
59 <tr><td>DocumentStart</td></tr>
60 </table> 60 </table>
61
61 <h3>Class Methods</h3> 62 <h3>Class Methods</h3>
62
63 <table> 63 <table>
64 <tr><td>None</td></tr> 64 <tr><td>None</td></tr>
65 </table> 65 </table>
66
66 <h3>Methods</h3> 67 <h3>Methods</h3>
67
68 <table> 68 <table>
69
70 <tr> 69 <tr>
71 <td><a href="#GreaseMonkeyScript.__init__">GreaseMonkeyScript</a></td> 70 <td><a href="#GreaseMonkeyScript.__init__">GreaseMonkeyScript</a></td>
72 <td>Constructor</td> 71 <td>Constructor</td>
73 </tr> 72 </tr>
74 <tr> 73 <tr>
194 <tr> 193 <tr>
195 <td><a href="#GreaseMonkeyScript.webScript">webScript</a></td> 194 <td><a href="#GreaseMonkeyScript.webScript">webScript</a></td>
196 <td>Public method to create a script object.</td> 195 <td>Public method to create a script object.</td>
197 </tr> 196 </tr>
198 </table> 197 </table>
198
199 <h3>Static Methods</h3> 199 <h3>Static Methods</h3>
200
201 <table> 200 <table>
202 <tr><td>None</td></tr> 201 <tr><td>None</td></tr>
203 </table> 202 </table>
204 203
204
205 <a NAME="GreaseMonkeyScript.__init__" ID="GreaseMonkeyScript.__init__"></a> 205 <a NAME="GreaseMonkeyScript.__init__" ID="GreaseMonkeyScript.__init__"></a>
206 <h4>GreaseMonkeyScript (Constructor)</h4> 206 <h4>GreaseMonkeyScript (Constructor)</h4>
207 <b>GreaseMonkeyScript</b>(<i>manager, path</i>) 207 <b>GreaseMonkeyScript</b>(<i>manager, path</i>)
208
209 <p> 208 <p>
210 Constructor 209 Constructor
211 </p> 210 </p>
211
212 <dl> 212 <dl>
213 213
214 <dt><i>manager</i> (GreaseMonkeyManager)</dt> 214 <dt><i>manager</i> (GreaseMonkeyManager)</dt>
215 <dd> 215 <dd>
216 reference to the manager object 216 reference to the manager object
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>)
226
227 <p> 226 <p>
228 Private slot to download the script icon. 227 Private slot to download the script icon.
229 </p> 228 </p>
229
230 <a NAME="GreaseMonkeyScript.__downloadRequires" ID="GreaseMonkeyScript.__downloadRequires"></a> 230 <a NAME="GreaseMonkeyScript.__downloadRequires" ID="GreaseMonkeyScript.__downloadRequires"></a>
231 <h4>GreaseMonkeyScript.__downloadRequires</h4> 231 <h4>GreaseMonkeyScript.__downloadRequires</h4>
232 <b>__downloadRequires</b>(<i></i>) 232 <b>__downloadRequires</b>(<i></i>)
233
234 <p> 233 <p>
235 Private method to download the required scripts. 234 Private method to download the required scripts.
236 </p> 235 </p>
236
237 <a NAME="GreaseMonkeyScript.__downloaderError" ID="GreaseMonkeyScript.__downloaderError"></a> 237 <a NAME="GreaseMonkeyScript.__downloaderError" ID="GreaseMonkeyScript.__downloaderError"></a>
238 <h4>GreaseMonkeyScript.__downloaderError</h4> 238 <h4>GreaseMonkeyScript.__downloaderError</h4>
239 <b>__downloaderError</b>(<i>downloader</i>) 239 <b>__downloaderError</b>(<i>downloader</i>)
240
241 <p> 240 <p>
242 Private slot to handle a downloader error. 241 Private slot to handle a downloader error.
243 </p> 242 </p>
243
244 <dl> 244 <dl>
245 245
246 <dt><i>downloader</i> (GreaseMonkeyDownloader)</dt> 246 <dt><i>downloader</i> (GreaseMonkeyDownloader)</dt>
247 <dd> 247 <dd>
248 reference to the downloader object 248 reference to the downloader object
249 </dd> 249 </dd>
250 </dl> 250 </dl>
251 <a NAME="GreaseMonkeyScript.__downloaderFinished" ID="GreaseMonkeyScript.__downloaderFinished"></a> 251 <a NAME="GreaseMonkeyScript.__downloaderFinished" ID="GreaseMonkeyScript.__downloaderFinished"></a>
252 <h4>GreaseMonkeyScript.__downloaderFinished</h4> 252 <h4>GreaseMonkeyScript.__downloaderFinished</h4>
253 <b>__downloaderFinished</b>(<i>downloader</i>) 253 <b>__downloaderFinished</b>(<i>downloader</i>)
254
255 <p> 254 <p>
256 Private slot to handle a finished download. 255 Private slot to handle a finished download.
257 </p> 256 </p>
257
258 <dl> 258 <dl>
259 259
260 <dt><i>downloader</i> (GreaseMonkeyDownloader)</dt> 260 <dt><i>downloader</i> (GreaseMonkeyDownloader)</dt>
261 <dd> 261 <dd>
262 reference to the downloader object 262 reference to the downloader object
263 </dd> 263 </dd>
264 </dl> 264 </dl>
265 <a NAME="GreaseMonkeyScript.__iconDownloaded" ID="GreaseMonkeyScript.__iconDownloaded"></a> 265 <a NAME="GreaseMonkeyScript.__iconDownloaded" ID="GreaseMonkeyScript.__iconDownloaded"></a>
266 <h4>GreaseMonkeyScript.__iconDownloaded</h4> 266 <h4>GreaseMonkeyScript.__iconDownloaded</h4>
267 <b>__iconDownloaded</b>(<i>reply</i>) 267 <b>__iconDownloaded</b>(<i>reply</i>)
268
269 <p> 268 <p>
270 Private slot to handle a finished download of a script icon. 269 Private slot to handle a finished download of a script icon.
271 </p> 270 </p>
271
272 <dl> 272 <dl>
273 273
274 <dt><i>reply</i> (QNetworkReply)</dt> 274 <dt><i>reply</i> (QNetworkReply)</dt>
275 <dd> 275 <dd>
276 reference to the network reply 276 reference to the network reply
277 </dd> 277 </dd>
278 </dl> 278 </dl>
279 <a NAME="GreaseMonkeyScript.__parseScript" ID="GreaseMonkeyScript.__parseScript"></a> 279 <a NAME="GreaseMonkeyScript.__parseScript" ID="GreaseMonkeyScript.__parseScript"></a>
280 <h4>GreaseMonkeyScript.__parseScript</h4> 280 <h4>GreaseMonkeyScript.__parseScript</h4>
281 <b>__parseScript</b>(<i></i>) 281 <b>__parseScript</b>(<i></i>)
282
283 <p> 282 <p>
284 Private method to parse the given script and populate the data 283 Private method to parse the given script and populate the data
285 structure. 284 structure.
286 </p> 285 </p>
286
287 <a NAME="GreaseMonkeyScript.__reloadScript" ID="GreaseMonkeyScript.__reloadScript"></a> 287 <a NAME="GreaseMonkeyScript.__reloadScript" ID="GreaseMonkeyScript.__reloadScript"></a>
288 <h4>GreaseMonkeyScript.__reloadScript</h4> 288 <h4>GreaseMonkeyScript.__reloadScript</h4>
289 <b>__reloadScript</b>(<i></i>) 289 <b>__reloadScript</b>(<i></i>)
290
291 <p> 290 <p>
292 Private method to reload the script. 291 Private method to reload the script.
293 </p> 292 </p>
293
294 <a NAME="GreaseMonkeyScript.__requireDownloadError" ID="GreaseMonkeyScript.__requireDownloadError"></a> 294 <a NAME="GreaseMonkeyScript.__requireDownloadError" ID="GreaseMonkeyScript.__requireDownloadError"></a>
295 <h4>GreaseMonkeyScript.__requireDownloadError</h4> 295 <h4>GreaseMonkeyScript.__requireDownloadError</h4>
296 <b>__requireDownloadError</b>(<i>downloader</i>) 296 <b>__requireDownloadError</b>(<i>downloader</i>)
297
298 <p> 297 <p>
299 Private slot to handle a downloader error. 298 Private slot to handle a downloader error.
300 </p> 299 </p>
300
301 <dl> 301 <dl>
302 302
303 <dt><i>downloader</i> (GreaseMonkeyDownloader)</dt> 303 <dt><i>downloader</i> (GreaseMonkeyDownloader)</dt>
304 <dd> 304 <dd>
305 reference to the downloader object 305 reference to the downloader object
306 </dd> 306 </dd>
307 </dl> 307 </dl>
308 <a NAME="GreaseMonkeyScript.__requireDownloaded" ID="GreaseMonkeyScript.__requireDownloaded"></a> 308 <a NAME="GreaseMonkeyScript.__requireDownloaded" ID="GreaseMonkeyScript.__requireDownloaded"></a>
309 <h4>GreaseMonkeyScript.__requireDownloaded</h4> 309 <h4>GreaseMonkeyScript.__requireDownloaded</h4>
310 <b>__requireDownloaded</b>(<i>downloader</i>) 310 <b>__requireDownloaded</b>(<i>downloader</i>)
311
312 <p> 311 <p>
313 Private slot to handle a finished download of a required script. 312 Private slot to handle a finished download of a required script.
314 </p> 313 </p>
314
315 <dl> 315 <dl>
316 316
317 <dt><i>downloader</i> (GreaseMonkeyDownloader)</dt> 317 <dt><i>downloader</i> (GreaseMonkeyDownloader)</dt>
318 <dd> 318 <dd>
319 reference to the downloader object 319 reference to the downloader object
320 </dd> 320 </dd>
321 </dl> 321 </dl>
322 <a NAME="GreaseMonkeyScript.__watchedFileChanged" ID="GreaseMonkeyScript.__watchedFileChanged"></a> 322 <a NAME="GreaseMonkeyScript.__watchedFileChanged" ID="GreaseMonkeyScript.__watchedFileChanged"></a>
323 <h4>GreaseMonkeyScript.__watchedFileChanged</h4> 323 <h4>GreaseMonkeyScript.__watchedFileChanged</h4>
324 <b>__watchedFileChanged</b>(<i>fileName</i>) 324 <b>__watchedFileChanged</b>(<i>fileName</i>)
325
326 <p> 325 <p>
327 Private slot handling changes of the script file. 326 Private slot handling changes of the script file.
328 </p> 327 </p>
328
329 <dl> 329 <dl>
330 330
331 <dt><i>fileName</i> (str)</dt> 331 <dt><i>fileName</i> (str)</dt>
332 <dd> 332 <dd>
333 path of the script file 333 path of the script file
334 </dd> 334 </dd>
335 </dl> 335 </dl>
336 <a NAME="GreaseMonkeyScript.description" ID="GreaseMonkeyScript.description"></a> 336 <a NAME="GreaseMonkeyScript.description" ID="GreaseMonkeyScript.description"></a>
337 <h4>GreaseMonkeyScript.description</h4> 337 <h4>GreaseMonkeyScript.description</h4>
338 <b>description</b>(<i></i>) 338 <b>description</b>(<i></i>)
339
340 <p> 339 <p>
341 Public method to get the description of the script. 340 Public method to get the description of the script.
342 </p> 341 </p>
342
343 <dl> 343 <dl>
344 <dt>Return:</dt> 344 <dt>Return:</dt>
345 <dd> 345 <dd>
346 description of the script 346 description of the script
347 </dd> 347 </dd>
353 </dd> 353 </dd>
354 </dl> 354 </dl>
355 <a NAME="GreaseMonkeyScript.downloadUrl" ID="GreaseMonkeyScript.downloadUrl"></a> 355 <a NAME="GreaseMonkeyScript.downloadUrl" ID="GreaseMonkeyScript.downloadUrl"></a>
356 <h4>GreaseMonkeyScript.downloadUrl</h4> 356 <h4>GreaseMonkeyScript.downloadUrl</h4>
357 <b>downloadUrl</b>(<i></i>) 357 <b>downloadUrl</b>(<i></i>)
358
359 <p> 358 <p>
360 Public method to get the download URL of the script. 359 Public method to get the download URL of the script.
361 </p> 360 </p>
361
362 <dl> 362 <dl>
363 <dt>Return:</dt> 363 <dt>Return:</dt>
364 <dd> 364 <dd>
365 download URL of the script 365 download URL of the script
366 </dd> 366 </dd>
372 </dd> 372 </dd>
373 </dl> 373 </dl>
374 <a NAME="GreaseMonkeyScript.exclude" ID="GreaseMonkeyScript.exclude"></a> 374 <a NAME="GreaseMonkeyScript.exclude" ID="GreaseMonkeyScript.exclude"></a>
375 <h4>GreaseMonkeyScript.exclude</h4> 375 <h4>GreaseMonkeyScript.exclude</h4>
376 <b>exclude</b>(<i></i>) 376 <b>exclude</b>(<i></i>)
377
378 <p> 377 <p>
379 Public method to get the list of excluded URLs. 378 Public method to get the list of excluded URLs.
380 </p> 379 </p>
380
381 <dl> 381 <dl>
382 <dt>Return:</dt> 382 <dt>Return:</dt>
383 <dd> 383 <dd>
384 list of excluded URLs 384 list of excluded URLs
385 </dd> 385 </dd>
391 </dd> 391 </dd>
392 </dl> 392 </dl>
393 <a NAME="GreaseMonkeyScript.fileName" ID="GreaseMonkeyScript.fileName"></a> 393 <a NAME="GreaseMonkeyScript.fileName" ID="GreaseMonkeyScript.fileName"></a>
394 <h4>GreaseMonkeyScript.fileName</h4> 394 <h4>GreaseMonkeyScript.fileName</h4>
395 <b>fileName</b>(<i></i>) 395 <b>fileName</b>(<i></i>)
396
397 <p> 396 <p>
398 Public method to get the path of the Javascript file. 397 Public method to get the path of the Javascript file.
399 </p> 398 </p>
399
400 <dl> 400 <dl>
401 <dt>Return:</dt> 401 <dt>Return:</dt>
402 <dd> 402 <dd>
403 path of the Javascript file 403 path of the Javascript file
404 </dd> 404 </dd>
410 </dd> 410 </dd>
411 </dl> 411 </dl>
412 <a NAME="GreaseMonkeyScript.fullName" ID="GreaseMonkeyScript.fullName"></a> 412 <a NAME="GreaseMonkeyScript.fullName" ID="GreaseMonkeyScript.fullName"></a>
413 <h4>GreaseMonkeyScript.fullName</h4> 413 <h4>GreaseMonkeyScript.fullName</h4>
414 <b>fullName</b>(<i></i>) 414 <b>fullName</b>(<i></i>)
415
416 <p> 415 <p>
417 Public method to get the full name of the script. 416 Public method to get the full name of the script.
418 </p> 417 </p>
418
419 <dl> 419 <dl>
420 <dt>Return:</dt> 420 <dt>Return:</dt>
421 <dd> 421 <dd>
422 full name of the script 422 full name of the script
423 </dd> 423 </dd>
429 </dd> 429 </dd>
430 </dl> 430 </dl>
431 <a NAME="GreaseMonkeyScript.icon" ID="GreaseMonkeyScript.icon"></a> 431 <a NAME="GreaseMonkeyScript.icon" ID="GreaseMonkeyScript.icon"></a>
432 <h4>GreaseMonkeyScript.icon</h4> 432 <h4>GreaseMonkeyScript.icon</h4>
433 <b>icon</b>(<i></i>) 433 <b>icon</b>(<i></i>)
434
435 <p> 434 <p>
436 Public method to get the icon of the script. 435 Public method to get the icon of the script.
437 </p> 436 </p>
437
438 <dl> 438 <dl>
439 <dt>Return:</dt> 439 <dt>Return:</dt>
440 <dd> 440 <dd>
441 script icon 441 script icon
442 </dd> 442 </dd>
448 </dd> 448 </dd>
449 </dl> 449 </dl>
450 <a NAME="GreaseMonkeyScript.iconUrl" ID="GreaseMonkeyScript.iconUrl"></a> 450 <a NAME="GreaseMonkeyScript.iconUrl" ID="GreaseMonkeyScript.iconUrl"></a>
451 <h4>GreaseMonkeyScript.iconUrl</h4> 451 <h4>GreaseMonkeyScript.iconUrl</h4>
452 <b>iconUrl</b>(<i></i>) 452 <b>iconUrl</b>(<i></i>)
453
454 <p> 453 <p>
455 Public method to get the icon URL of the script. 454 Public method to get the icon URL of the script.
456 </p> 455 </p>
456
457 <dl> 457 <dl>
458 <dt>Return:</dt> 458 <dt>Return:</dt>
459 <dd> 459 <dd>
460 icon URL of the script 460 icon URL of the script
461 </dd> 461 </dd>
467 </dd> 467 </dd>
468 </dl> 468 </dl>
469 <a NAME="GreaseMonkeyScript.include" ID="GreaseMonkeyScript.include"></a> 469 <a NAME="GreaseMonkeyScript.include" ID="GreaseMonkeyScript.include"></a>
470 <h4>GreaseMonkeyScript.include</h4> 470 <h4>GreaseMonkeyScript.include</h4>
471 <b>include</b>(<i></i>) 471 <b>include</b>(<i></i>)
472
473 <p> 472 <p>
474 Public method to get the list of included URLs. 473 Public method to get the list of included URLs.
475 </p> 474 </p>
475
476 <dl> 476 <dl>
477 <dt>Return:</dt> 477 <dt>Return:</dt>
478 <dd> 478 <dd>
479 list of included URLs 479 list of included URLs
480 </dd> 480 </dd>
486 </dd> 486 </dd>
487 </dl> 487 </dl>
488 <a NAME="GreaseMonkeyScript.isEnabled" ID="GreaseMonkeyScript.isEnabled"></a> 488 <a NAME="GreaseMonkeyScript.isEnabled" ID="GreaseMonkeyScript.isEnabled"></a>
489 <h4>GreaseMonkeyScript.isEnabled</h4> 489 <h4>GreaseMonkeyScript.isEnabled</h4>
490 <b>isEnabled</b>(<i></i>) 490 <b>isEnabled</b>(<i></i>)
491
492 <p> 491 <p>
493 Public method to check, if the script is enabled. 492 Public method to check, if the script is enabled.
494 </p> 493 </p>
494
495 <dl> 495 <dl>
496 <dt>Return:</dt> 496 <dt>Return:</dt>
497 <dd> 497 <dd>
498 flag indicating an enabled state 498 flag indicating an enabled state
499 </dd> 499 </dd>
505 </dd> 505 </dd>
506 </dl> 506 </dl>
507 <a NAME="GreaseMonkeyScript.isUpdating" ID="GreaseMonkeyScript.isUpdating"></a> 507 <a NAME="GreaseMonkeyScript.isUpdating" ID="GreaseMonkeyScript.isUpdating"></a>
508 <h4>GreaseMonkeyScript.isUpdating</h4> 508 <h4>GreaseMonkeyScript.isUpdating</h4>
509 <b>isUpdating</b>(<i></i>) 509 <b>isUpdating</b>(<i></i>)
510
511 <p> 510 <p>
512 Public method to get the updating flag. 511 Public method to get the updating flag.
513 </p> 512 </p>
513
514 <dl> 514 <dl>
515 <dt>Return:</dt> 515 <dt>Return:</dt>
516 <dd> 516 <dd>
517 updating flag 517 updating flag
518 </dd> 518 </dd>
524 </dd> 524 </dd>
525 </dl> 525 </dl>
526 <a NAME="GreaseMonkeyScript.isValid" ID="GreaseMonkeyScript.isValid"></a> 526 <a NAME="GreaseMonkeyScript.isValid" ID="GreaseMonkeyScript.isValid"></a>
527 <h4>GreaseMonkeyScript.isValid</h4> 527 <h4>GreaseMonkeyScript.isValid</h4>
528 <b>isValid</b>(<i></i>) 528 <b>isValid</b>(<i></i>)
529
530 <p> 529 <p>
531 Public method to check the validity of the script. 530 Public method to check the validity of the script.
532 </p> 531 </p>
532
533 <dl> 533 <dl>
534 <dt>Return:</dt> 534 <dt>Return:</dt>
535 <dd> 535 <dd>
536 flag indicating a valid script 536 flag indicating a valid script
537 </dd> 537 </dd>
543 </dd> 543 </dd>
544 </dl> 544 </dl>
545 <a NAME="GreaseMonkeyScript.name" ID="GreaseMonkeyScript.name"></a> 545 <a NAME="GreaseMonkeyScript.name" ID="GreaseMonkeyScript.name"></a>
546 <h4>GreaseMonkeyScript.name</h4> 546 <h4>GreaseMonkeyScript.name</h4>
547 <b>name</b>(<i></i>) 547 <b>name</b>(<i></i>)
548
549 <p> 548 <p>
550 Public method to get the name of the script. 549 Public method to get the name of the script.
551 </p> 550 </p>
551
552 <dl> 552 <dl>
553 <dt>Return:</dt> 553 <dt>Return:</dt>
554 <dd> 554 <dd>
555 name of the script 555 name of the script
556 </dd> 556 </dd>
562 </dd> 562 </dd>
563 </dl> 563 </dl>
564 <a NAME="GreaseMonkeyScript.nameSpace" ID="GreaseMonkeyScript.nameSpace"></a> 564 <a NAME="GreaseMonkeyScript.nameSpace" ID="GreaseMonkeyScript.nameSpace"></a>
565 <h4>GreaseMonkeyScript.nameSpace</h4> 565 <h4>GreaseMonkeyScript.nameSpace</h4>
566 <b>nameSpace</b>(<i></i>) 566 <b>nameSpace</b>(<i></i>)
567
568 <p> 567 <p>
569 Public method to get the name space of the script. 568 Public method to get the name space of the script.
570 </p> 569 </p>
570
571 <dl> 571 <dl>
572 <dt>Return:</dt> 572 <dt>Return:</dt>
573 <dd> 573 <dd>
574 name space of the script 574 name space of the script
575 </dd> 575 </dd>
581 </dd> 581 </dd>
582 </dl> 582 </dl>
583 <a NAME="GreaseMonkeyScript.noFrames" ID="GreaseMonkeyScript.noFrames"></a> 583 <a NAME="GreaseMonkeyScript.noFrames" ID="GreaseMonkeyScript.noFrames"></a>
584 <h4>GreaseMonkeyScript.noFrames</h4> 584 <h4>GreaseMonkeyScript.noFrames</h4>
585 <b>noFrames</b>(<i></i>) 585 <b>noFrames</b>(<i></i>)
586
587 <p> 586 <p>
588 Public method to get the noFrames flag. 587 Public method to get the noFrames flag.
589 </p> 588 </p>
589
590 <dl> 590 <dl>
591 <dt>Return:</dt> 591 <dt>Return:</dt>
592 <dd> 592 <dd>
593 flag indicating to not run on sub frames 593 flag indicating to not run on sub frames
594 </dd> 594 </dd>
600 </dd> 600 </dd>
601 </dl> 601 </dl>
602 <a NAME="GreaseMonkeyScript.require" ID="GreaseMonkeyScript.require"></a> 602 <a NAME="GreaseMonkeyScript.require" ID="GreaseMonkeyScript.require"></a>
603 <h4>GreaseMonkeyScript.require</h4> 603 <h4>GreaseMonkeyScript.require</h4>
604 <b>require</b>(<i></i>) 604 <b>require</b>(<i></i>)
605
606 <p> 605 <p>
607 Public method to get the list of required scripts. 606 Public method to get the list of required scripts.
608 </p> 607 </p>
608
609 <dl> 609 <dl>
610 <dt>Return:</dt> 610 <dt>Return:</dt>
611 <dd> 611 <dd>
612 list of required scripts 612 list of required scripts
613 </dd> 613 </dd>
619 </dd> 619 </dd>
620 </dl> 620 </dl>
621 <a NAME="GreaseMonkeyScript.setEnabled" ID="GreaseMonkeyScript.setEnabled"></a> 621 <a NAME="GreaseMonkeyScript.setEnabled" ID="GreaseMonkeyScript.setEnabled"></a>
622 <h4>GreaseMonkeyScript.setEnabled</h4> 622 <h4>GreaseMonkeyScript.setEnabled</h4>
623 <b>setEnabled</b>(<i>enable</i>) 623 <b>setEnabled</b>(<i>enable</i>)
624
625 <p> 624 <p>
626 Public method to enable a script. 625 Public method to enable a script.
627 </p> 626 </p>
627
628 <dl> 628 <dl>
629 629
630 <dt><i>enable</i> (bool)</dt> 630 <dt><i>enable</i> (bool)</dt>
631 <dd> 631 <dd>
632 flag indicating the new enabled state 632 flag indicating the new enabled state
633 </dd> 633 </dd>
634 </dl> 634 </dl>
635 <a NAME="GreaseMonkeyScript.startAt" ID="GreaseMonkeyScript.startAt"></a> 635 <a NAME="GreaseMonkeyScript.startAt" ID="GreaseMonkeyScript.startAt"></a>
636 <h4>GreaseMonkeyScript.startAt</h4> 636 <h4>GreaseMonkeyScript.startAt</h4>
637 <b>startAt</b>(<i></i>) 637 <b>startAt</b>(<i></i>)
638
639 <p> 638 <p>
640 Public method to get the start point of the script. 639 Public method to get the start point of the script.
641 </p> 640 </p>
641
642 <dl> 642 <dl>
643 <dt>Return:</dt> 643 <dt>Return:</dt>
644 <dd> 644 <dd>
645 start point of the script 645 start point of the script
646 </dd> 646 </dd>
652 </dd> 652 </dd>
653 </dl> 653 </dl>
654 <a NAME="GreaseMonkeyScript.updateScript" ID="GreaseMonkeyScript.updateScript"></a> 654 <a NAME="GreaseMonkeyScript.updateScript" ID="GreaseMonkeyScript.updateScript"></a>
655 <h4>GreaseMonkeyScript.updateScript</h4> 655 <h4>GreaseMonkeyScript.updateScript</h4>
656 <b>updateScript</b>(<i></i>) 656 <b>updateScript</b>(<i></i>)
657
658 <p> 657 <p>
659 Public method to updated the script. 658 Public method to updated the script.
660 </p> 659 </p>
660
661 <a NAME="GreaseMonkeyScript.updateUrl" ID="GreaseMonkeyScript.updateUrl"></a> 661 <a NAME="GreaseMonkeyScript.updateUrl" ID="GreaseMonkeyScript.updateUrl"></a>
662 <h4>GreaseMonkeyScript.updateUrl</h4> 662 <h4>GreaseMonkeyScript.updateUrl</h4>
663 <b>updateUrl</b>(<i></i>) 663 <b>updateUrl</b>(<i></i>)
664
665 <p> 664 <p>
666 Public method to get the update URL of the script. 665 Public method to get the update URL of the script.
667 </p> 666 </p>
667
668 <dl> 668 <dl>
669 <dt>Return:</dt> 669 <dt>Return:</dt>
670 <dd> 670 <dd>
671 update URL of the script 671 update URL of the script
672 </dd> 672 </dd>
678 </dd> 678 </dd>
679 </dl> 679 </dl>
680 <a NAME="GreaseMonkeyScript.version" ID="GreaseMonkeyScript.version"></a> 680 <a NAME="GreaseMonkeyScript.version" ID="GreaseMonkeyScript.version"></a>
681 <h4>GreaseMonkeyScript.version</h4> 681 <h4>GreaseMonkeyScript.version</h4>
682 <b>version</b>(<i></i>) 682 <b>version</b>(<i></i>)
683
684 <p> 683 <p>
685 Public method to get the version of the script. 684 Public method to get the version of the script.
686 </p> 685 </p>
686
687 <dl> 687 <dl>
688 <dt>Return:</dt> 688 <dt>Return:</dt>
689 <dd> 689 <dd>
690 version of the script 690 version of the script
691 </dd> 691 </dd>
697 </dd> 697 </dd>
698 </dl> 698 </dl>
699 <a NAME="GreaseMonkeyScript.webScript" ID="GreaseMonkeyScript.webScript"></a> 699 <a NAME="GreaseMonkeyScript.webScript" ID="GreaseMonkeyScript.webScript"></a>
700 <h4>GreaseMonkeyScript.webScript</h4> 700 <h4>GreaseMonkeyScript.webScript</h4>
701 <b>webScript</b>(<i></i>) 701 <b>webScript</b>(<i></i>)
702
703 <p> 702 <p>
704 Public method to create a script object. 703 Public method to create a script object.
705 </p> 704 </p>
705
706 <dl> 706 <dl>
707 <dt>Return:</dt> 707 <dt>Return:</dt>
708 <dd> 708 <dd>
709 prepared script object 709 prepared script object
710 </dd> 710 </dd>

eric ide

mercurial