58 <table> |
58 <table> |
59 <tr> |
59 <tr> |
60 <td><a href="#GreaseMonkeyScript.__init__">GreaseMonkeyScript</a></td> |
60 <td><a href="#GreaseMonkeyScript.__init__">GreaseMonkeyScript</a></td> |
61 <td>Constructor</td> |
61 <td>Constructor</td> |
62 </tr><tr> |
62 </tr><tr> |
|
63 <td><a href="#GreaseMonkeyScript.__downloadRequires">__downloadRequires</a></td> |
|
64 <td>Private method to download the required scripts.</td> |
|
65 </tr><tr> |
|
66 <td><a href="#GreaseMonkeyScript.__downloaderError">__downloaderError</a></td> |
|
67 <td>Private slot to handle a downloader error.</td> |
|
68 </tr><tr> |
|
69 <td><a href="#GreaseMonkeyScript.__downloaderFinished">__downloaderFinished</a></td> |
|
70 <td>Private slot to handle a finished download.</td> |
|
71 </tr><tr> |
63 <td><a href="#GreaseMonkeyScript.__parseScript">__parseScript</a></td> |
72 <td><a href="#GreaseMonkeyScript.__parseScript">__parseScript</a></td> |
64 <td>Private method to parse the given script and populate the data structure.</td> |
73 <td>Private method to parse the given script and populate the data structure.</td> |
65 </tr><tr> |
74 </tr><tr> |
|
75 <td><a href="#GreaseMonkeyScript.__reloadScript">__reloadScript</a></td> |
|
76 <td>Private method to reload the script.</td> |
|
77 </tr><tr> |
|
78 <td><a href="#GreaseMonkeyScript.__requireDownloadError">__requireDownloadError</a></td> |
|
79 <td>Private slot to handle a downloader error.</td> |
|
80 </tr><tr> |
|
81 <td><a href="#GreaseMonkeyScript.__requireDownloaded">__requireDownloaded</a></td> |
|
82 <td>Private slot to handle a finished download of a required script.</td> |
|
83 </tr><tr> |
66 <td><a href="#GreaseMonkeyScript.__toJavaScriptList">__toJavaScriptList</a></td> |
84 <td><a href="#GreaseMonkeyScript.__toJavaScriptList">__toJavaScriptList</a></td> |
67 <td>Private method to convert a list of str to a string containing a valid JavaScript list definition.</td> |
85 <td>Private method to convert a list of str to a string containing a valid JavaScript list definition.</td> |
68 </tr><tr> |
86 </tr><tr> |
69 <td><a href="#GreaseMonkeyScript.__watchedFileChanged">__watchedFileChanged</a></td> |
87 <td><a href="#GreaseMonkeyScript.__watchedFileChanged">__watchedFileChanged</a></td> |
70 <td>Private slot handling changes of the script file.</td> |
88 <td>Private slot handling changes of the script file.</td> |
88 <td>Public method to get the list of included URLs.</td> |
106 <td>Public method to get the list of included URLs.</td> |
89 </tr><tr> |
107 </tr><tr> |
90 <td><a href="#GreaseMonkeyScript.isEnabled">isEnabled</a></td> |
108 <td><a href="#GreaseMonkeyScript.isEnabled">isEnabled</a></td> |
91 <td>Public method to check, if the script is enabled.</td> |
109 <td>Public method to check, if the script is enabled.</td> |
92 </tr><tr> |
110 </tr><tr> |
|
111 <td><a href="#GreaseMonkeyScript.isUpdating">isUpdating</a></td> |
|
112 <td>Public method to get the updating flag.</td> |
|
113 </tr><tr> |
93 <td><a href="#GreaseMonkeyScript.isValid">isValid</a></td> |
114 <td><a href="#GreaseMonkeyScript.isValid">isValid</a></td> |
94 <td>Public method to check the validity of the script.</td> |
115 <td>Public method to check the validity of the script.</td> |
95 </tr><tr> |
116 </tr><tr> |
96 <td><a href="#GreaseMonkeyScript.name">name</a></td> |
117 <td><a href="#GreaseMonkeyScript.name">name</a></td> |
97 <td>Public method to get the name of the script.</td> |
118 <td>Public method to get the name of the script.</td> |
100 <td>Public method to get the name space of the script.</td> |
121 <td>Public method to get the name space of the script.</td> |
101 </tr><tr> |
122 </tr><tr> |
102 <td><a href="#GreaseMonkeyScript.noFrames">noFrames</a></td> |
123 <td><a href="#GreaseMonkeyScript.noFrames">noFrames</a></td> |
103 <td>Public method to get the noFrames flag.</td> |
124 <td>Public method to get the noFrames flag.</td> |
104 </tr><tr> |
125 </tr><tr> |
105 <td><a href="#GreaseMonkeyScript.script">script</a></td> |
126 <td><a href="#GreaseMonkeyScript.require">require</a></td> |
106 <td>Public method to get the Javascript source.</td> |
127 <td>Public method to get the list of required scripts.</td> |
107 </tr><tr> |
128 </tr><tr> |
108 <td><a href="#GreaseMonkeyScript.setEnabled">setEnabled</a></td> |
129 <td><a href="#GreaseMonkeyScript.setEnabled">setEnabled</a></td> |
109 <td>Public method to enable a script.</td> |
130 <td>Public method to enable a script.</td> |
110 </tr><tr> |
131 </tr><tr> |
111 <td><a href="#GreaseMonkeyScript.startAt">startAt</a></td> |
132 <td><a href="#GreaseMonkeyScript.startAt">startAt</a></td> |
112 <td>Public method to get the start point of the script.</td> |
133 <td>Public method to get the start point of the script.</td> |
|
134 </tr><tr> |
|
135 <td><a href="#GreaseMonkeyScript.updateScript">updateScript</a></td> |
|
136 <td>Public method to updated the script.</td> |
113 </tr><tr> |
137 </tr><tr> |
114 <td><a href="#GreaseMonkeyScript.updateUrl">updateUrl</a></td> |
138 <td><a href="#GreaseMonkeyScript.updateUrl">updateUrl</a></td> |
115 <td>Public method to get the update URL of the script.</td> |
139 <td>Public method to get the update URL of the script.</td> |
116 </tr><tr> |
140 </tr><tr> |
117 <td><a href="#GreaseMonkeyScript.version">version</a></td> |
141 <td><a href="#GreaseMonkeyScript.version">version</a></td> |
136 reference to the manager object (GreaseMonkeyManager) |
160 reference to the manager object (GreaseMonkeyManager) |
137 </dd><dt><i>path</i></dt> |
161 </dd><dt><i>path</i></dt> |
138 <dd> |
162 <dd> |
139 path of the Javascript file (string) |
163 path of the Javascript file (string) |
140 </dd> |
164 </dd> |
141 </dl><a NAME="GreaseMonkeyScript.__parseScript" ID="GreaseMonkeyScript.__parseScript"></a> |
165 </dl><a NAME="GreaseMonkeyScript.__downloadRequires" ID="GreaseMonkeyScript.__downloadRequires"></a> |
|
166 <h4>GreaseMonkeyScript.__downloadRequires</h4> |
|
167 <b>__downloadRequires</b>(<i></i>) |
|
168 <p> |
|
169 Private method to download the required scripts. |
|
170 </p><a NAME="GreaseMonkeyScript.__downloaderError" ID="GreaseMonkeyScript.__downloaderError"></a> |
|
171 <h4>GreaseMonkeyScript.__downloaderError</h4> |
|
172 <b>__downloaderError</b>(<i></i>) |
|
173 <p> |
|
174 Private slot to handle a downloader error. |
|
175 </p><a NAME="GreaseMonkeyScript.__downloaderFinished" ID="GreaseMonkeyScript.__downloaderFinished"></a> |
|
176 <h4>GreaseMonkeyScript.__downloaderFinished</h4> |
|
177 <b>__downloaderFinished</b>(<i></i>) |
|
178 <p> |
|
179 Private slot to handle a finished download. |
|
180 </p><a NAME="GreaseMonkeyScript.__parseScript" ID="GreaseMonkeyScript.__parseScript"></a> |
142 <h4>GreaseMonkeyScript.__parseScript</h4> |
181 <h4>GreaseMonkeyScript.__parseScript</h4> |
143 <b>__parseScript</b>(<i></i>) |
182 <b>__parseScript</b>(<i></i>) |
144 <p> |
183 <p> |
145 Private method to parse the given script and populate the data |
184 Private method to parse the given script and populate the data |
146 structure. |
185 structure. |
|
186 </p><a NAME="GreaseMonkeyScript.__reloadScript" ID="GreaseMonkeyScript.__reloadScript"></a> |
|
187 <h4>GreaseMonkeyScript.__reloadScript</h4> |
|
188 <b>__reloadScript</b>(<i></i>) |
|
189 <p> |
|
190 Private method to reload the script. |
|
191 </p><a NAME="GreaseMonkeyScript.__requireDownloadError" ID="GreaseMonkeyScript.__requireDownloadError"></a> |
|
192 <h4>GreaseMonkeyScript.__requireDownloadError</h4> |
|
193 <b>__requireDownloadError</b>(<i></i>) |
|
194 <p> |
|
195 Private slot to handle a downloader error. |
|
196 </p><a NAME="GreaseMonkeyScript.__requireDownloaded" ID="GreaseMonkeyScript.__requireDownloaded"></a> |
|
197 <h4>GreaseMonkeyScript.__requireDownloaded</h4> |
|
198 <b>__requireDownloaded</b>(<i></i>) |
|
199 <p> |
|
200 Private slot to handle a finished download of a required script. |
147 </p><a NAME="GreaseMonkeyScript.__toJavaScriptList" ID="GreaseMonkeyScript.__toJavaScriptList"></a> |
201 </p><a NAME="GreaseMonkeyScript.__toJavaScriptList" ID="GreaseMonkeyScript.__toJavaScriptList"></a> |
148 <h4>GreaseMonkeyScript.__toJavaScriptList</h4> |
202 <h4>GreaseMonkeyScript.__toJavaScriptList</h4> |
149 <b>__toJavaScriptList</b>(<i>patterns</i>) |
203 <b>__toJavaScriptList</b>(<i>patterns</i>) |
150 <p> |
204 <p> |
151 Private method to convert a list of str to a string containing a valid |
205 Private method to convert a list of str to a string containing a valid |
211 <p> |
265 <p> |
212 Public method to get the path of the Javascript file. |
266 Public method to get the path of the Javascript file. |
213 </p><dl> |
267 </p><dl> |
214 <dt>Returns:</dt> |
268 <dt>Returns:</dt> |
215 <dd> |
269 <dd> |
216 path path of the Javascript file (string) |
270 path of the Javascript file (string) |
217 </dd> |
271 </dd> |
218 </dl><a NAME="GreaseMonkeyScript.fullName" ID="GreaseMonkeyScript.fullName"></a> |
272 </dl><a NAME="GreaseMonkeyScript.fullName" ID="GreaseMonkeyScript.fullName"></a> |
219 <h4>GreaseMonkeyScript.fullName</h4> |
273 <h4>GreaseMonkeyScript.fullName</h4> |
220 <b>fullName</b>(<i></i>) |
274 <b>fullName</b>(<i></i>) |
221 <p> |
275 <p> |
243 </p><dl> |
297 </p><dl> |
244 <dt>Returns:</dt> |
298 <dt>Returns:</dt> |
245 <dd> |
299 <dd> |
246 flag indicating an enabled state (boolean) |
300 flag indicating an enabled state (boolean) |
247 </dd> |
301 </dd> |
|
302 </dl><a NAME="GreaseMonkeyScript.isUpdating" ID="GreaseMonkeyScript.isUpdating"></a> |
|
303 <h4>GreaseMonkeyScript.isUpdating</h4> |
|
304 <b>isUpdating</b>(<i></i>) |
|
305 <p> |
|
306 Public method to get the updating flag. |
|
307 </p><dl> |
|
308 <dt>Returns:</dt> |
|
309 <dd> |
|
310 updating flag |
|
311 </dd> |
|
312 </dl><dl> |
|
313 <dt>Return Type:</dt> |
|
314 <dd> |
|
315 bool |
|
316 </dd> |
248 </dl><a NAME="GreaseMonkeyScript.isValid" ID="GreaseMonkeyScript.isValid"></a> |
317 </dl><a NAME="GreaseMonkeyScript.isValid" ID="GreaseMonkeyScript.isValid"></a> |
249 <h4>GreaseMonkeyScript.isValid</h4> |
318 <h4>GreaseMonkeyScript.isValid</h4> |
250 <b>isValid</b>(<i></i>) |
319 <b>isValid</b>(<i></i>) |
251 <p> |
320 <p> |
252 Public method to check the validity of the script. |
321 Public method to check the validity of the script. |
288 </dl><dl> |
357 </dl><dl> |
289 <dt>Return Type:</dt> |
358 <dt>Return Type:</dt> |
290 <dd> |
359 <dd> |
291 bool |
360 bool |
292 </dd> |
361 </dd> |
293 </dl><a NAME="GreaseMonkeyScript.script" ID="GreaseMonkeyScript.script"></a> |
362 </dl><a NAME="GreaseMonkeyScript.require" ID="GreaseMonkeyScript.require"></a> |
294 <h4>GreaseMonkeyScript.script</h4> |
363 <h4>GreaseMonkeyScript.require</h4> |
295 <b>script</b>(<i></i>) |
364 <b>require</b>(<i></i>) |
296 <p> |
365 <p> |
297 Public method to get the Javascript source. |
366 Public method to get the list of required scripts. |
298 </p><dl> |
367 </p><dl> |
299 <dt>Returns:</dt> |
368 <dt>Returns:</dt> |
300 <dd> |
369 <dd> |
301 Javascript source (string) |
370 list of required scripts (list of strings) |
302 </dd> |
371 </dd> |
303 </dl><a NAME="GreaseMonkeyScript.setEnabled" ID="GreaseMonkeyScript.setEnabled"></a> |
372 </dl><a NAME="GreaseMonkeyScript.setEnabled" ID="GreaseMonkeyScript.setEnabled"></a> |
304 <h4>GreaseMonkeyScript.setEnabled</h4> |
373 <h4>GreaseMonkeyScript.setEnabled</h4> |
305 <b>setEnabled</b>(<i>enable</i>) |
374 <b>setEnabled</b>(<i>enable</i>) |
306 <p> |
375 <p> |
318 </p><dl> |
387 </p><dl> |
319 <dt>Returns:</dt> |
388 <dt>Returns:</dt> |
320 <dd> |
389 <dd> |
321 start point of the script (DocumentStart or DocumentEnd) |
390 start point of the script (DocumentStart or DocumentEnd) |
322 </dd> |
391 </dd> |
323 </dl><a NAME="GreaseMonkeyScript.updateUrl" ID="GreaseMonkeyScript.updateUrl"></a> |
392 </dl><a NAME="GreaseMonkeyScript.updateScript" ID="GreaseMonkeyScript.updateScript"></a> |
|
393 <h4>GreaseMonkeyScript.updateScript</h4> |
|
394 <b>updateScript</b>(<i></i>) |
|
395 <p> |
|
396 Public method to updated the script. |
|
397 </p><a NAME="GreaseMonkeyScript.updateUrl" ID="GreaseMonkeyScript.updateUrl"></a> |
324 <h4>GreaseMonkeyScript.updateUrl</h4> |
398 <h4>GreaseMonkeyScript.updateUrl</h4> |
325 <b>updateUrl</b>(<i></i>) |
399 <b>updateUrl</b>(<i></i>) |
326 <p> |
400 <p> |
327 Public method to get the update URL of the script. |
401 Public method to get the update URL of the script. |
328 </p><dl> |
402 </p><dl> |