Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.WebBrowser.GreaseMonkey.GreaseMonkeyScript.html

eric6/Documentation/Source/eric6.WebBrowser.GreaseMonkey.GreaseMonkeyScript.html

changeset 7273
391d6b7b1eff
parent 7232
0b840f7ed593
child 7989
a21d673a8f99
equal deleted inserted replaced
7272:1779dc278077 7273:391d6b7b1eff
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>eric6.WebBrowser.GreaseMonkey.GreaseMonkeyScript</h1> 23 <h1>eric6.WebBrowser.GreaseMonkey.GreaseMonkeyScript</h1>
24
23 <p> 25 <p>
24 Module implementing the GreaseMonkey script. 26 Module implementing the GreaseMonkey script.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>None</td></tr> 31 <tr><td>None</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
34
31 <table> 35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#GreaseMonkeyScript">GreaseMonkeyScript</a></td> 38 <td><a href="#GreaseMonkeyScript">GreaseMonkeyScript</a></td>
34 <td>Class implementing the GreaseMonkey script.</td> 39 <td>Class implementing the GreaseMonkey script.</td>
35 </tr> 40 </tr>
36 </table> 41 </table>
37 <h3>Functions</h3> 42 <h3>Functions</h3>
43
38 <table> 44 <table>
39 <tr><td>None</td></tr> 45 <tr><td>None</td></tr>
40 </table> 46 </table>
41 <hr /><hr /> 47 <hr />
48 <hr />
42 <a NAME="GreaseMonkeyScript" ID="GreaseMonkeyScript"></a> 49 <a NAME="GreaseMonkeyScript" ID="GreaseMonkeyScript"></a>
43 <h2>GreaseMonkeyScript</h2> 50 <h2>GreaseMonkeyScript</h2>
51
44 <p> 52 <p>
45 Class implementing the GreaseMonkey script. 53 Class implementing the GreaseMonkey script.
46 </p><h3>Signals</h3> 54 </p>
47 <dl> 55 <h3>Signals</h3>
56 <dl>
57
48 <dt>scriptChanged()</dt> 58 <dt>scriptChanged()</dt>
49 <dd> 59 <dd>
50 emitted to indicate a script change 60 emitted to indicate a script change
51 </dd><dt>updatingChanged(bool)</dt> 61 </dd>
62 <dt>updatingChanged(bool)</dt>
52 <dd> 63 <dd>
53 emitted to indicate a change of the 64 emitted to indicate a change of the
54 updating state 65 updating state
55 </dd> 66 </dd>
56 </dl> 67 </dl>
57 <h3>Derived from</h3> 68 <h3>Derived from</h3>
58 QObject 69 QObject
59 <h3>Class Attributes</h3> 70 <h3>Class Attributes</h3>
71
60 <table> 72 <table>
61 <tr><td>DocumentEnd</td></tr><tr><td>DocumentIdle</td></tr><tr><td>DocumentStart</td></tr> 73 <tr><td>DocumentEnd</td></tr><tr><td>DocumentIdle</td></tr><tr><td>DocumentStart</td></tr>
62 </table> 74 </table>
63 <h3>Class Methods</h3> 75 <h3>Class Methods</h3>
76
64 <table> 77 <table>
65 <tr><td>None</td></tr> 78 <tr><td>None</td></tr>
66 </table> 79 </table>
67 <h3>Methods</h3> 80 <h3>Methods</h3>
81
68 <table> 82 <table>
83
69 <tr> 84 <tr>
70 <td><a href="#GreaseMonkeyScript.__init__">GreaseMonkeyScript</a></td> 85 <td><a href="#GreaseMonkeyScript.__init__">GreaseMonkeyScript</a></td>
71 <td>Constructor</td> 86 <td>Constructor</td>
72 </tr><tr> 87 </tr>
88 <tr>
73 <td><a href="#GreaseMonkeyScript.__downloadIcon">__downloadIcon</a></td> 89 <td><a href="#GreaseMonkeyScript.__downloadIcon">__downloadIcon</a></td>
74 <td>Private slot to download the script icon.</td> 90 <td>Private slot to download the script icon.</td>
75 </tr><tr> 91 </tr>
92 <tr>
76 <td><a href="#GreaseMonkeyScript.__downloadRequires">__downloadRequires</a></td> 93 <td><a href="#GreaseMonkeyScript.__downloadRequires">__downloadRequires</a></td>
77 <td>Private method to download the required scripts.</td> 94 <td>Private method to download the required scripts.</td>
78 </tr><tr> 95 </tr>
96 <tr>
79 <td><a href="#GreaseMonkeyScript.__downloaderError">__downloaderError</a></td> 97 <td><a href="#GreaseMonkeyScript.__downloaderError">__downloaderError</a></td>
80 <td>Private slot to handle a downloader error.</td> 98 <td>Private slot to handle a downloader error.</td>
81 </tr><tr> 99 </tr>
100 <tr>
82 <td><a href="#GreaseMonkeyScript.__downloaderFinished">__downloaderFinished</a></td> 101 <td><a href="#GreaseMonkeyScript.__downloaderFinished">__downloaderFinished</a></td>
83 <td>Private slot to handle a finished download.</td> 102 <td>Private slot to handle a finished download.</td>
84 </tr><tr> 103 </tr>
104 <tr>
85 <td><a href="#GreaseMonkeyScript.__iconDownloaded">__iconDownloaded</a></td> 105 <td><a href="#GreaseMonkeyScript.__iconDownloaded">__iconDownloaded</a></td>
86 <td>Private slot to handle a finished download of a script icon.</td> 106 <td>Private slot to handle a finished download of a script icon.</td>
87 </tr><tr> 107 </tr>
108 <tr>
88 <td><a href="#GreaseMonkeyScript.__parseScript">__parseScript</a></td> 109 <td><a href="#GreaseMonkeyScript.__parseScript">__parseScript</a></td>
89 <td>Private method to parse the given script and populate the data structure.</td> 110 <td>Private method to parse the given script and populate the data structure.</td>
90 </tr><tr> 111 </tr>
112 <tr>
91 <td><a href="#GreaseMonkeyScript.__reloadScript">__reloadScript</a></td> 113 <td><a href="#GreaseMonkeyScript.__reloadScript">__reloadScript</a></td>
92 <td>Private method to reload the script.</td> 114 <td>Private method to reload the script.</td>
93 </tr><tr> 115 </tr>
116 <tr>
94 <td><a href="#GreaseMonkeyScript.__requireDownloadError">__requireDownloadError</a></td> 117 <td><a href="#GreaseMonkeyScript.__requireDownloadError">__requireDownloadError</a></td>
95 <td>Private slot to handle a downloader error.</td> 118 <td>Private slot to handle a downloader error.</td>
96 </tr><tr> 119 </tr>
120 <tr>
97 <td><a href="#GreaseMonkeyScript.__requireDownloaded">__requireDownloaded</a></td> 121 <td><a href="#GreaseMonkeyScript.__requireDownloaded">__requireDownloaded</a></td>
98 <td>Private slot to handle a finished download of a required script.</td> 122 <td>Private slot to handle a finished download of a required script.</td>
99 </tr><tr> 123 </tr>
124 <tr>
100 <td><a href="#GreaseMonkeyScript.__watchedFileChanged">__watchedFileChanged</a></td> 125 <td><a href="#GreaseMonkeyScript.__watchedFileChanged">__watchedFileChanged</a></td>
101 <td>Private slot handling changes of the script file.</td> 126 <td>Private slot handling changes of the script file.</td>
102 </tr><tr> 127 </tr>
128 <tr>
103 <td><a href="#GreaseMonkeyScript.description">description</a></td> 129 <td><a href="#GreaseMonkeyScript.description">description</a></td>
104 <td>Public method to get the description of the script.</td> 130 <td>Public method to get the description of the script.</td>
105 </tr><tr> 131 </tr>
132 <tr>
106 <td><a href="#GreaseMonkeyScript.downloadUrl">downloadUrl</a></td> 133 <td><a href="#GreaseMonkeyScript.downloadUrl">downloadUrl</a></td>
107 <td>Public method to get the download URL of the script.</td> 134 <td>Public method to get the download URL of the script.</td>
108 </tr><tr> 135 </tr>
136 <tr>
109 <td><a href="#GreaseMonkeyScript.exclude">exclude</a></td> 137 <td><a href="#GreaseMonkeyScript.exclude">exclude</a></td>
110 <td>Public method to get the list of excluded URLs.</td> 138 <td>Public method to get the list of excluded URLs.</td>
111 </tr><tr> 139 </tr>
140 <tr>
112 <td><a href="#GreaseMonkeyScript.fileName">fileName</a></td> 141 <td><a href="#GreaseMonkeyScript.fileName">fileName</a></td>
113 <td>Public method to get the path of the Javascript file.</td> 142 <td>Public method to get the path of the Javascript file.</td>
114 </tr><tr> 143 </tr>
144 <tr>
115 <td><a href="#GreaseMonkeyScript.fullName">fullName</a></td> 145 <td><a href="#GreaseMonkeyScript.fullName">fullName</a></td>
116 <td>Public method to get the full name of the script.</td> 146 <td>Public method to get the full name of the script.</td>
117 </tr><tr> 147 </tr>
148 <tr>
118 <td><a href="#GreaseMonkeyScript.icon">icon</a></td> 149 <td><a href="#GreaseMonkeyScript.icon">icon</a></td>
119 <td>Public method to get the icon of the script.</td> 150 <td>Public method to get the icon of the script.</td>
120 </tr><tr> 151 </tr>
152 <tr>
121 <td><a href="#GreaseMonkeyScript.iconUrl">iconUrl</a></td> 153 <td><a href="#GreaseMonkeyScript.iconUrl">iconUrl</a></td>
122 <td>Public method to get the icon URL of the script.</td> 154 <td>Public method to get the icon URL of the script.</td>
123 </tr><tr> 155 </tr>
156 <tr>
124 <td><a href="#GreaseMonkeyScript.include">include</a></td> 157 <td><a href="#GreaseMonkeyScript.include">include</a></td>
125 <td>Public method to get the list of included URLs.</td> 158 <td>Public method to get the list of included URLs.</td>
126 </tr><tr> 159 </tr>
160 <tr>
127 <td><a href="#GreaseMonkeyScript.isEnabled">isEnabled</a></td> 161 <td><a href="#GreaseMonkeyScript.isEnabled">isEnabled</a></td>
128 <td>Public method to check, if the script is enabled.</td> 162 <td>Public method to check, if the script is enabled.</td>
129 </tr><tr> 163 </tr>
164 <tr>
130 <td><a href="#GreaseMonkeyScript.isUpdating">isUpdating</a></td> 165 <td><a href="#GreaseMonkeyScript.isUpdating">isUpdating</a></td>
131 <td>Public method to get the updating flag.</td> 166 <td>Public method to get the updating flag.</td>
132 </tr><tr> 167 </tr>
168 <tr>
133 <td><a href="#GreaseMonkeyScript.isValid">isValid</a></td> 169 <td><a href="#GreaseMonkeyScript.isValid">isValid</a></td>
134 <td>Public method to check the validity of the script.</td> 170 <td>Public method to check the validity of the script.</td>
135 </tr><tr> 171 </tr>
172 <tr>
136 <td><a href="#GreaseMonkeyScript.name">name</a></td> 173 <td><a href="#GreaseMonkeyScript.name">name</a></td>
137 <td>Public method to get the name of the script.</td> 174 <td>Public method to get the name of the script.</td>
138 </tr><tr> 175 </tr>
176 <tr>
139 <td><a href="#GreaseMonkeyScript.nameSpace">nameSpace</a></td> 177 <td><a href="#GreaseMonkeyScript.nameSpace">nameSpace</a></td>
140 <td>Public method to get the name space of the script.</td> 178 <td>Public method to get the name space of the script.</td>
141 </tr><tr> 179 </tr>
180 <tr>
142 <td><a href="#GreaseMonkeyScript.noFrames">noFrames</a></td> 181 <td><a href="#GreaseMonkeyScript.noFrames">noFrames</a></td>
143 <td>Public method to get the noFrames flag.</td> 182 <td>Public method to get the noFrames flag.</td>
144 </tr><tr> 183 </tr>
184 <tr>
145 <td><a href="#GreaseMonkeyScript.require">require</a></td> 185 <td><a href="#GreaseMonkeyScript.require">require</a></td>
146 <td>Public method to get the list of required scripts.</td> 186 <td>Public method to get the list of required scripts.</td>
147 </tr><tr> 187 </tr>
188 <tr>
148 <td><a href="#GreaseMonkeyScript.setEnabled">setEnabled</a></td> 189 <td><a href="#GreaseMonkeyScript.setEnabled">setEnabled</a></td>
149 <td>Public method to enable a script.</td> 190 <td>Public method to enable a script.</td>
150 </tr><tr> 191 </tr>
192 <tr>
151 <td><a href="#GreaseMonkeyScript.startAt">startAt</a></td> 193 <td><a href="#GreaseMonkeyScript.startAt">startAt</a></td>
152 <td>Public method to get the start point of the script.</td> 194 <td>Public method to get the start point of the script.</td>
153 </tr><tr> 195 </tr>
196 <tr>
154 <td><a href="#GreaseMonkeyScript.updateScript">updateScript</a></td> 197 <td><a href="#GreaseMonkeyScript.updateScript">updateScript</a></td>
155 <td>Public method to updated the script.</td> 198 <td>Public method to updated the script.</td>
156 </tr><tr> 199 </tr>
200 <tr>
157 <td><a href="#GreaseMonkeyScript.updateUrl">updateUrl</a></td> 201 <td><a href="#GreaseMonkeyScript.updateUrl">updateUrl</a></td>
158 <td>Public method to get the update URL of the script.</td> 202 <td>Public method to get the update URL of the script.</td>
159 </tr><tr> 203 </tr>
204 <tr>
160 <td><a href="#GreaseMonkeyScript.version">version</a></td> 205 <td><a href="#GreaseMonkeyScript.version">version</a></td>
161 <td>Public method to get the version of the script.</td> 206 <td>Public method to get the version of the script.</td>
162 </tr><tr> 207 </tr>
208 <tr>
163 <td><a href="#GreaseMonkeyScript.webScript">webScript</a></td> 209 <td><a href="#GreaseMonkeyScript.webScript">webScript</a></td>
164 <td>Public method to create a script object.</td> 210 <td>Public method to create a script object.</td>
165 </tr> 211 </tr>
166 </table> 212 </table>
167 <h3>Static Methods</h3> 213 <h3>Static Methods</h3>
214
168 <table> 215 <table>
169 <tr><td>None</td></tr> 216 <tr><td>None</td></tr>
170 </table> 217 </table>
218
171 <a NAME="GreaseMonkeyScript.__init__" ID="GreaseMonkeyScript.__init__"></a> 219 <a NAME="GreaseMonkeyScript.__init__" ID="GreaseMonkeyScript.__init__"></a>
172 <h4>GreaseMonkeyScript (Constructor)</h4> 220 <h4>GreaseMonkeyScript (Constructor)</h4>
173 <b>GreaseMonkeyScript</b>(<i>manager, path</i>) 221 <b>GreaseMonkeyScript</b>(<i>manager, path</i>)
222
174 <p> 223 <p>
175 Constructor 224 Constructor
176 </p><dl> 225 </p>
226 <dl>
227
177 <dt><i>manager</i></dt> 228 <dt><i>manager</i></dt>
178 <dd> 229 <dd>
179 reference to the manager object (GreaseMonkeyManager) 230 reference to the manager object (GreaseMonkeyManager)
180 </dd><dt><i>path</i></dt> 231 </dd>
232 <dt><i>path</i></dt>
181 <dd> 233 <dd>
182 path of the Javascript file (string) 234 path of the Javascript file (string)
183 </dd> 235 </dd>
184 </dl><a NAME="GreaseMonkeyScript.__downloadIcon" ID="GreaseMonkeyScript.__downloadIcon"></a> 236 </dl>
237 <a NAME="GreaseMonkeyScript.__downloadIcon" ID="GreaseMonkeyScript.__downloadIcon"></a>
185 <h4>GreaseMonkeyScript.__downloadIcon</h4> 238 <h4>GreaseMonkeyScript.__downloadIcon</h4>
186 <b>__downloadIcon</b>(<i></i>) 239 <b>__downloadIcon</b>(<i></i>)
240
187 <p> 241 <p>
188 Private slot to download the script icon. 242 Private slot to download the script icon.
189 </p><a NAME="GreaseMonkeyScript.__downloadRequires" ID="GreaseMonkeyScript.__downloadRequires"></a> 243 </p>
244 <a NAME="GreaseMonkeyScript.__downloadRequires" ID="GreaseMonkeyScript.__downloadRequires"></a>
190 <h4>GreaseMonkeyScript.__downloadRequires</h4> 245 <h4>GreaseMonkeyScript.__downloadRequires</h4>
191 <b>__downloadRequires</b>(<i></i>) 246 <b>__downloadRequires</b>(<i></i>)
247
192 <p> 248 <p>
193 Private method to download the required scripts. 249 Private method to download the required scripts.
194 </p><a NAME="GreaseMonkeyScript.__downloaderError" ID="GreaseMonkeyScript.__downloaderError"></a> 250 </p>
251 <a NAME="GreaseMonkeyScript.__downloaderError" ID="GreaseMonkeyScript.__downloaderError"></a>
195 <h4>GreaseMonkeyScript.__downloaderError</h4> 252 <h4>GreaseMonkeyScript.__downloaderError</h4>
196 <b>__downloaderError</b>(<i>downloader</i>) 253 <b>__downloaderError</b>(<i>downloader</i>)
254
197 <p> 255 <p>
198 Private slot to handle a downloader error. 256 Private slot to handle a downloader error.
199 </p><dl> 257 </p>
258 <dl>
259
200 <dt><i>downloader</i> (GreaseMonkeyDownloader)</dt> 260 <dt><i>downloader</i> (GreaseMonkeyDownloader)</dt>
201 <dd> 261 <dd>
202 reference to the downloader object 262 reference to the downloader object
203 </dd> 263 </dd>
204 </dl><a NAME="GreaseMonkeyScript.__downloaderFinished" ID="GreaseMonkeyScript.__downloaderFinished"></a> 264 </dl>
265 <a NAME="GreaseMonkeyScript.__downloaderFinished" ID="GreaseMonkeyScript.__downloaderFinished"></a>
205 <h4>GreaseMonkeyScript.__downloaderFinished</h4> 266 <h4>GreaseMonkeyScript.__downloaderFinished</h4>
206 <b>__downloaderFinished</b>(<i>downloader</i>) 267 <b>__downloaderFinished</b>(<i>downloader</i>)
268
207 <p> 269 <p>
208 Private slot to handle a finished download. 270 Private slot to handle a finished download.
209 </p><dl> 271 </p>
272 <dl>
273
210 <dt><i>downloader</i> (GreaseMonkeyDownloader)</dt> 274 <dt><i>downloader</i> (GreaseMonkeyDownloader)</dt>
211 <dd> 275 <dd>
212 reference to the downloader object 276 reference to the downloader object
213 </dd> 277 </dd>
214 </dl><a NAME="GreaseMonkeyScript.__iconDownloaded" ID="GreaseMonkeyScript.__iconDownloaded"></a> 278 </dl>
279 <a NAME="GreaseMonkeyScript.__iconDownloaded" ID="GreaseMonkeyScript.__iconDownloaded"></a>
215 <h4>GreaseMonkeyScript.__iconDownloaded</h4> 280 <h4>GreaseMonkeyScript.__iconDownloaded</h4>
216 <b>__iconDownloaded</b>(<i>reply</i>) 281 <b>__iconDownloaded</b>(<i>reply</i>)
282
217 <p> 283 <p>
218 Private slot to handle a finished download of a script icon. 284 Private slot to handle a finished download of a script icon.
219 </p><dl> 285 </p>
286 <dl>
287
220 <dt><i>reply</i> (QNetworkReply)</dt> 288 <dt><i>reply</i> (QNetworkReply)</dt>
221 <dd> 289 <dd>
222 reference to the network reply 290 reference to the network reply
223 </dd> 291 </dd>
224 </dl><a NAME="GreaseMonkeyScript.__parseScript" ID="GreaseMonkeyScript.__parseScript"></a> 292 </dl>
293 <a NAME="GreaseMonkeyScript.__parseScript" ID="GreaseMonkeyScript.__parseScript"></a>
225 <h4>GreaseMonkeyScript.__parseScript</h4> 294 <h4>GreaseMonkeyScript.__parseScript</h4>
226 <b>__parseScript</b>(<i></i>) 295 <b>__parseScript</b>(<i></i>)
296
227 <p> 297 <p>
228 Private method to parse the given script and populate the data 298 Private method to parse the given script and populate the data
229 structure. 299 structure.
230 </p><a NAME="GreaseMonkeyScript.__reloadScript" ID="GreaseMonkeyScript.__reloadScript"></a> 300 </p>
301 <a NAME="GreaseMonkeyScript.__reloadScript" ID="GreaseMonkeyScript.__reloadScript"></a>
231 <h4>GreaseMonkeyScript.__reloadScript</h4> 302 <h4>GreaseMonkeyScript.__reloadScript</h4>
232 <b>__reloadScript</b>(<i></i>) 303 <b>__reloadScript</b>(<i></i>)
304
233 <p> 305 <p>
234 Private method to reload the script. 306 Private method to reload the script.
235 </p><a NAME="GreaseMonkeyScript.__requireDownloadError" ID="GreaseMonkeyScript.__requireDownloadError"></a> 307 </p>
308 <a NAME="GreaseMonkeyScript.__requireDownloadError" ID="GreaseMonkeyScript.__requireDownloadError"></a>
236 <h4>GreaseMonkeyScript.__requireDownloadError</h4> 309 <h4>GreaseMonkeyScript.__requireDownloadError</h4>
237 <b>__requireDownloadError</b>(<i>downloader</i>) 310 <b>__requireDownloadError</b>(<i>downloader</i>)
311
238 <p> 312 <p>
239 Private slot to handle a downloader error. 313 Private slot to handle a downloader error.
240 </p><dl> 314 </p>
315 <dl>
316
241 <dt><i>downloader</i> (GreaseMonkeyDownloader)</dt> 317 <dt><i>downloader</i> (GreaseMonkeyDownloader)</dt>
242 <dd> 318 <dd>
243 reference to the downloader object 319 reference to the downloader object
244 </dd> 320 </dd>
245 </dl><a NAME="GreaseMonkeyScript.__requireDownloaded" ID="GreaseMonkeyScript.__requireDownloaded"></a> 321 </dl>
322 <a NAME="GreaseMonkeyScript.__requireDownloaded" ID="GreaseMonkeyScript.__requireDownloaded"></a>
246 <h4>GreaseMonkeyScript.__requireDownloaded</h4> 323 <h4>GreaseMonkeyScript.__requireDownloaded</h4>
247 <b>__requireDownloaded</b>(<i>downloader</i>) 324 <b>__requireDownloaded</b>(<i>downloader</i>)
325
248 <p> 326 <p>
249 Private slot to handle a finished download of a required script. 327 Private slot to handle a finished download of a required script.
250 </p><dl> 328 </p>
329 <dl>
330
251 <dt><i>downloader</i> (GreaseMonkeyDownloader)</dt> 331 <dt><i>downloader</i> (GreaseMonkeyDownloader)</dt>
252 <dd> 332 <dd>
253 reference to the downloader object 333 reference to the downloader object
254 </dd> 334 </dd>
255 </dl><a NAME="GreaseMonkeyScript.__watchedFileChanged" ID="GreaseMonkeyScript.__watchedFileChanged"></a> 335 </dl>
336 <a NAME="GreaseMonkeyScript.__watchedFileChanged" ID="GreaseMonkeyScript.__watchedFileChanged"></a>
256 <h4>GreaseMonkeyScript.__watchedFileChanged</h4> 337 <h4>GreaseMonkeyScript.__watchedFileChanged</h4>
257 <b>__watchedFileChanged</b>(<i>fileName</i>) 338 <b>__watchedFileChanged</b>(<i>fileName</i>)
339
258 <p> 340 <p>
259 Private slot handling changes of the script file. 341 Private slot handling changes of the script file.
260 </p><dl> 342 </p>
343 <dl>
344
261 <dt><i>fileName</i> (str)</dt> 345 <dt><i>fileName</i> (str)</dt>
262 <dd> 346 <dd>
263 path of the script file 347 path of the script file
264 </dd> 348 </dd>
265 </dl><a NAME="GreaseMonkeyScript.description" ID="GreaseMonkeyScript.description"></a> 349 </dl>
350 <a NAME="GreaseMonkeyScript.description" ID="GreaseMonkeyScript.description"></a>
266 <h4>GreaseMonkeyScript.description</h4> 351 <h4>GreaseMonkeyScript.description</h4>
267 <b>description</b>(<i></i>) 352 <b>description</b>(<i></i>)
353
268 <p> 354 <p>
269 Public method to get the description of the script. 355 Public method to get the description of the script.
270 </p><dl> 356 </p>
357 <dl>
271 <dt>Returns:</dt> 358 <dt>Returns:</dt>
272 <dd> 359 <dd>
273 description of the script (string) 360 description of the script (string)
274 </dd> 361 </dd>
275 </dl><a NAME="GreaseMonkeyScript.downloadUrl" ID="GreaseMonkeyScript.downloadUrl"></a> 362 </dl>
363 <a NAME="GreaseMonkeyScript.downloadUrl" ID="GreaseMonkeyScript.downloadUrl"></a>
276 <h4>GreaseMonkeyScript.downloadUrl</h4> 364 <h4>GreaseMonkeyScript.downloadUrl</h4>
277 <b>downloadUrl</b>(<i></i>) 365 <b>downloadUrl</b>(<i></i>)
366
278 <p> 367 <p>
279 Public method to get the download URL of the script. 368 Public method to get the download URL of the script.
280 </p><dl> 369 </p>
370 <dl>
281 <dt>Returns:</dt> 371 <dt>Returns:</dt>
282 <dd> 372 <dd>
283 download URL of the script (QUrl) 373 download URL of the script (QUrl)
284 </dd> 374 </dd>
285 </dl><a NAME="GreaseMonkeyScript.exclude" ID="GreaseMonkeyScript.exclude"></a> 375 </dl>
376 <a NAME="GreaseMonkeyScript.exclude" ID="GreaseMonkeyScript.exclude"></a>
286 <h4>GreaseMonkeyScript.exclude</h4> 377 <h4>GreaseMonkeyScript.exclude</h4>
287 <b>exclude</b>(<i></i>) 378 <b>exclude</b>(<i></i>)
379
288 <p> 380 <p>
289 Public method to get the list of excluded URLs. 381 Public method to get the list of excluded URLs.
290 </p><dl> 382 </p>
383 <dl>
291 <dt>Returns:</dt> 384 <dt>Returns:</dt>
292 <dd> 385 <dd>
293 list of excluded URLs (list of strings) 386 list of excluded URLs (list of strings)
294 </dd> 387 </dd>
295 </dl><a NAME="GreaseMonkeyScript.fileName" ID="GreaseMonkeyScript.fileName"></a> 388 </dl>
389 <a NAME="GreaseMonkeyScript.fileName" ID="GreaseMonkeyScript.fileName"></a>
296 <h4>GreaseMonkeyScript.fileName</h4> 390 <h4>GreaseMonkeyScript.fileName</h4>
297 <b>fileName</b>(<i></i>) 391 <b>fileName</b>(<i></i>)
392
298 <p> 393 <p>
299 Public method to get the path of the Javascript file. 394 Public method to get the path of the Javascript file.
300 </p><dl> 395 </p>
396 <dl>
301 <dt>Returns:</dt> 397 <dt>Returns:</dt>
302 <dd> 398 <dd>
303 path of the Javascript file (string) 399 path of the Javascript file (string)
304 </dd> 400 </dd>
305 </dl><a NAME="GreaseMonkeyScript.fullName" ID="GreaseMonkeyScript.fullName"></a> 401 </dl>
402 <a NAME="GreaseMonkeyScript.fullName" ID="GreaseMonkeyScript.fullName"></a>
306 <h4>GreaseMonkeyScript.fullName</h4> 403 <h4>GreaseMonkeyScript.fullName</h4>
307 <b>fullName</b>(<i></i>) 404 <b>fullName</b>(<i></i>)
405
308 <p> 406 <p>
309 Public method to get the full name of the script. 407 Public method to get the full name of the script.
310 </p><dl> 408 </p>
409 <dl>
311 <dt>Returns:</dt> 410 <dt>Returns:</dt>
312 <dd> 411 <dd>
313 full name of the script (string) 412 full name of the script (string)
314 </dd> 413 </dd>
315 </dl><a NAME="GreaseMonkeyScript.icon" ID="GreaseMonkeyScript.icon"></a> 414 </dl>
415 <a NAME="GreaseMonkeyScript.icon" ID="GreaseMonkeyScript.icon"></a>
316 <h4>GreaseMonkeyScript.icon</h4> 416 <h4>GreaseMonkeyScript.icon</h4>
317 <b>icon</b>(<i></i>) 417 <b>icon</b>(<i></i>)
418
318 <p> 419 <p>
319 Public method to get the icon of the script. 420 Public method to get the icon of the script.
320 </p><dl> 421 </p>
422 <dl>
321 <dt>Returns:</dt> 423 <dt>Returns:</dt>
322 <dd> 424 <dd>
323 script icon 425 script icon
324 </dd> 426 </dd>
325 </dl><dl> 427 </dl>
428 <dl>
326 <dt>Return Type:</dt> 429 <dt>Return Type:</dt>
327 <dd> 430 <dd>
328 QIcon 431 QIcon
329 </dd> 432 </dd>
330 </dl><a NAME="GreaseMonkeyScript.iconUrl" ID="GreaseMonkeyScript.iconUrl"></a> 433 </dl>
434 <a NAME="GreaseMonkeyScript.iconUrl" ID="GreaseMonkeyScript.iconUrl"></a>
331 <h4>GreaseMonkeyScript.iconUrl</h4> 435 <h4>GreaseMonkeyScript.iconUrl</h4>
332 <b>iconUrl</b>(<i></i>) 436 <b>iconUrl</b>(<i></i>)
437
333 <p> 438 <p>
334 Public method to get the icon URL of the script. 439 Public method to get the icon URL of the script.
335 </p><dl> 440 </p>
441 <dl>
336 <dt>Returns:</dt> 442 <dt>Returns:</dt>
337 <dd> 443 <dd>
338 icon URL of the script (QUrl) 444 icon URL of the script (QUrl)
339 </dd> 445 </dd>
340 </dl><a NAME="GreaseMonkeyScript.include" ID="GreaseMonkeyScript.include"></a> 446 </dl>
447 <a NAME="GreaseMonkeyScript.include" ID="GreaseMonkeyScript.include"></a>
341 <h4>GreaseMonkeyScript.include</h4> 448 <h4>GreaseMonkeyScript.include</h4>
342 <b>include</b>(<i></i>) 449 <b>include</b>(<i></i>)
450
343 <p> 451 <p>
344 Public method to get the list of included URLs. 452 Public method to get the list of included URLs.
345 </p><dl> 453 </p>
454 <dl>
346 <dt>Returns:</dt> 455 <dt>Returns:</dt>
347 <dd> 456 <dd>
348 list of included URLs (list of strings) 457 list of included URLs (list of strings)
349 </dd> 458 </dd>
350 </dl><a NAME="GreaseMonkeyScript.isEnabled" ID="GreaseMonkeyScript.isEnabled"></a> 459 </dl>
460 <a NAME="GreaseMonkeyScript.isEnabled" ID="GreaseMonkeyScript.isEnabled"></a>
351 <h4>GreaseMonkeyScript.isEnabled</h4> 461 <h4>GreaseMonkeyScript.isEnabled</h4>
352 <b>isEnabled</b>(<i></i>) 462 <b>isEnabled</b>(<i></i>)
463
353 <p> 464 <p>
354 Public method to check, if the script is enabled. 465 Public method to check, if the script is enabled.
355 </p><dl> 466 </p>
467 <dl>
356 <dt>Returns:</dt> 468 <dt>Returns:</dt>
357 <dd> 469 <dd>
358 flag indicating an enabled state (boolean) 470 flag indicating an enabled state (boolean)
359 </dd> 471 </dd>
360 </dl><a NAME="GreaseMonkeyScript.isUpdating" ID="GreaseMonkeyScript.isUpdating"></a> 472 </dl>
473 <a NAME="GreaseMonkeyScript.isUpdating" ID="GreaseMonkeyScript.isUpdating"></a>
361 <h4>GreaseMonkeyScript.isUpdating</h4> 474 <h4>GreaseMonkeyScript.isUpdating</h4>
362 <b>isUpdating</b>(<i></i>) 475 <b>isUpdating</b>(<i></i>)
476
363 <p> 477 <p>
364 Public method to get the updating flag. 478 Public method to get the updating flag.
365 </p><dl> 479 </p>
480 <dl>
366 <dt>Returns:</dt> 481 <dt>Returns:</dt>
367 <dd> 482 <dd>
368 updating flag 483 updating flag
369 </dd> 484 </dd>
370 </dl><dl> 485 </dl>
486 <dl>
371 <dt>Return Type:</dt> 487 <dt>Return Type:</dt>
372 <dd> 488 <dd>
373 bool 489 bool
374 </dd> 490 </dd>
375 </dl><a NAME="GreaseMonkeyScript.isValid" ID="GreaseMonkeyScript.isValid"></a> 491 </dl>
492 <a NAME="GreaseMonkeyScript.isValid" ID="GreaseMonkeyScript.isValid"></a>
376 <h4>GreaseMonkeyScript.isValid</h4> 493 <h4>GreaseMonkeyScript.isValid</h4>
377 <b>isValid</b>(<i></i>) 494 <b>isValid</b>(<i></i>)
495
378 <p> 496 <p>
379 Public method to check the validity of the script. 497 Public method to check the validity of the script.
380 </p><dl> 498 </p>
499 <dl>
381 <dt>Returns:</dt> 500 <dt>Returns:</dt>
382 <dd> 501 <dd>
383 flag indicating a valid script (boolean) 502 flag indicating a valid script (boolean)
384 </dd> 503 </dd>
385 </dl><a NAME="GreaseMonkeyScript.name" ID="GreaseMonkeyScript.name"></a> 504 </dl>
505 <a NAME="GreaseMonkeyScript.name" ID="GreaseMonkeyScript.name"></a>
386 <h4>GreaseMonkeyScript.name</h4> 506 <h4>GreaseMonkeyScript.name</h4>
387 <b>name</b>(<i></i>) 507 <b>name</b>(<i></i>)
508
388 <p> 509 <p>
389 Public method to get the name of the script. 510 Public method to get the name of the script.
390 </p><dl> 511 </p>
512 <dl>
391 <dt>Returns:</dt> 513 <dt>Returns:</dt>
392 <dd> 514 <dd>
393 name of the script (string) 515 name of the script (string)
394 </dd> 516 </dd>
395 </dl><a NAME="GreaseMonkeyScript.nameSpace" ID="GreaseMonkeyScript.nameSpace"></a> 517 </dl>
518 <a NAME="GreaseMonkeyScript.nameSpace" ID="GreaseMonkeyScript.nameSpace"></a>
396 <h4>GreaseMonkeyScript.nameSpace</h4> 519 <h4>GreaseMonkeyScript.nameSpace</h4>
397 <b>nameSpace</b>(<i></i>) 520 <b>nameSpace</b>(<i></i>)
521
398 <p> 522 <p>
399 Public method to get the name space of the script. 523 Public method to get the name space of the script.
400 </p><dl> 524 </p>
525 <dl>
401 <dt>Returns:</dt> 526 <dt>Returns:</dt>
402 <dd> 527 <dd>
403 name space of the script (string) 528 name space of the script (string)
404 </dd> 529 </dd>
405 </dl><a NAME="GreaseMonkeyScript.noFrames" ID="GreaseMonkeyScript.noFrames"></a> 530 </dl>
531 <a NAME="GreaseMonkeyScript.noFrames" ID="GreaseMonkeyScript.noFrames"></a>
406 <h4>GreaseMonkeyScript.noFrames</h4> 532 <h4>GreaseMonkeyScript.noFrames</h4>
407 <b>noFrames</b>(<i></i>) 533 <b>noFrames</b>(<i></i>)
534
408 <p> 535 <p>
409 Public method to get the noFrames flag. 536 Public method to get the noFrames flag.
410 </p><dl> 537 </p>
538 <dl>
411 <dt>Returns:</dt> 539 <dt>Returns:</dt>
412 <dd> 540 <dd>
413 flag indicating to not run on sub frames 541 flag indicating to not run on sub frames
414 </dd> 542 </dd>
415 </dl><dl> 543 </dl>
544 <dl>
416 <dt>Return Type:</dt> 545 <dt>Return Type:</dt>
417 <dd> 546 <dd>
418 bool 547 bool
419 </dd> 548 </dd>
420 </dl><a NAME="GreaseMonkeyScript.require" ID="GreaseMonkeyScript.require"></a> 549 </dl>
550 <a NAME="GreaseMonkeyScript.require" ID="GreaseMonkeyScript.require"></a>
421 <h4>GreaseMonkeyScript.require</h4> 551 <h4>GreaseMonkeyScript.require</h4>
422 <b>require</b>(<i></i>) 552 <b>require</b>(<i></i>)
553
423 <p> 554 <p>
424 Public method to get the list of required scripts. 555 Public method to get the list of required scripts.
425 </p><dl> 556 </p>
557 <dl>
426 <dt>Returns:</dt> 558 <dt>Returns:</dt>
427 <dd> 559 <dd>
428 list of required scripts (list of strings) 560 list of required scripts (list of strings)
429 </dd> 561 </dd>
430 </dl><a NAME="GreaseMonkeyScript.setEnabled" ID="GreaseMonkeyScript.setEnabled"></a> 562 </dl>
563 <a NAME="GreaseMonkeyScript.setEnabled" ID="GreaseMonkeyScript.setEnabled"></a>
431 <h4>GreaseMonkeyScript.setEnabled</h4> 564 <h4>GreaseMonkeyScript.setEnabled</h4>
432 <b>setEnabled</b>(<i>enable</i>) 565 <b>setEnabled</b>(<i>enable</i>)
566
433 <p> 567 <p>
434 Public method to enable a script. 568 Public method to enable a script.
435 </p><dl> 569 </p>
570 <dl>
571
436 <dt><i>enable</i></dt> 572 <dt><i>enable</i></dt>
437 <dd> 573 <dd>
438 flag indicating the new enabled state (boolean) 574 flag indicating the new enabled state (boolean)
439 </dd> 575 </dd>
440 </dl><a NAME="GreaseMonkeyScript.startAt" ID="GreaseMonkeyScript.startAt"></a> 576 </dl>
577 <a NAME="GreaseMonkeyScript.startAt" ID="GreaseMonkeyScript.startAt"></a>
441 <h4>GreaseMonkeyScript.startAt</h4> 578 <h4>GreaseMonkeyScript.startAt</h4>
442 <b>startAt</b>(<i></i>) 579 <b>startAt</b>(<i></i>)
580
443 <p> 581 <p>
444 Public method to get the start point of the script. 582 Public method to get the start point of the script.
445 </p><dl> 583 </p>
584 <dl>
446 <dt>Returns:</dt> 585 <dt>Returns:</dt>
447 <dd> 586 <dd>
448 start point of the script (DocumentStart or DocumentEnd) 587 start point of the script (DocumentStart or DocumentEnd)
449 </dd> 588 </dd>
450 </dl><a NAME="GreaseMonkeyScript.updateScript" ID="GreaseMonkeyScript.updateScript"></a> 589 </dl>
590 <a NAME="GreaseMonkeyScript.updateScript" ID="GreaseMonkeyScript.updateScript"></a>
451 <h4>GreaseMonkeyScript.updateScript</h4> 591 <h4>GreaseMonkeyScript.updateScript</h4>
452 <b>updateScript</b>(<i></i>) 592 <b>updateScript</b>(<i></i>)
593
453 <p> 594 <p>
454 Public method to updated the script. 595 Public method to updated the script.
455 </p><a NAME="GreaseMonkeyScript.updateUrl" ID="GreaseMonkeyScript.updateUrl"></a> 596 </p>
597 <a NAME="GreaseMonkeyScript.updateUrl" ID="GreaseMonkeyScript.updateUrl"></a>
456 <h4>GreaseMonkeyScript.updateUrl</h4> 598 <h4>GreaseMonkeyScript.updateUrl</h4>
457 <b>updateUrl</b>(<i></i>) 599 <b>updateUrl</b>(<i></i>)
600
458 <p> 601 <p>
459 Public method to get the update URL of the script. 602 Public method to get the update URL of the script.
460 </p><dl> 603 </p>
604 <dl>
461 <dt>Returns:</dt> 605 <dt>Returns:</dt>
462 <dd> 606 <dd>
463 update URL of the script (QUrl) 607 update URL of the script (QUrl)
464 </dd> 608 </dd>
465 </dl><a NAME="GreaseMonkeyScript.version" ID="GreaseMonkeyScript.version"></a> 609 </dl>
610 <a NAME="GreaseMonkeyScript.version" ID="GreaseMonkeyScript.version"></a>
466 <h4>GreaseMonkeyScript.version</h4> 611 <h4>GreaseMonkeyScript.version</h4>
467 <b>version</b>(<i></i>) 612 <b>version</b>(<i></i>)
613
468 <p> 614 <p>
469 Public method to get the version of the script. 615 Public method to get the version of the script.
470 </p><dl> 616 </p>
617 <dl>
471 <dt>Returns:</dt> 618 <dt>Returns:</dt>
472 <dd> 619 <dd>
473 version of the script (string) 620 version of the script (string)
474 </dd> 621 </dd>
475 </dl><a NAME="GreaseMonkeyScript.webScript" ID="GreaseMonkeyScript.webScript"></a> 622 </dl>
623 <a NAME="GreaseMonkeyScript.webScript" ID="GreaseMonkeyScript.webScript"></a>
476 <h4>GreaseMonkeyScript.webScript</h4> 624 <h4>GreaseMonkeyScript.webScript</h4>
477 <b>webScript</b>(<i></i>) 625 <b>webScript</b>(<i></i>)
626
478 <p> 627 <p>
479 Public method to create a script object. 628 Public method to create a script object.
480 </p><dl> 629 </p>
630 <dl>
481 <dt>Returns:</dt> 631 <dt>Returns:</dt>
482 <dd> 632 <dd>
483 prepared script object 633 prepared script object
484 </dd> 634 </dd>
485 </dl><dl> 635 </dl>
636 <dl>
486 <dt>Return Type:</dt> 637 <dt>Return Type:</dt>
487 <dd> 638 <dd>
488 QWebEngineScript 639 QWebEngineScript
489 </dd> 640 </dd>
490 </dl> 641 </dl>

Mercurial Repository: eric

eric ide

mercurial