|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric7.WebBrowser.Tools.Scripts</title> |
|
4 <meta charset="UTF-8"> |
|
5 <link rel="stylesheet" href="styles.css"> |
|
6 </head> |
|
7 <body> |
|
8 <a NAME="top" ID="top"></a> |
|
9 <h1>eric7.WebBrowser.Tools.Scripts</h1> |
|
10 |
|
11 <p> |
|
12 Module containing function to generate JavaScript code. |
|
13 </p> |
|
14 <h3>Global Attributes</h3> |
|
15 |
|
16 <table> |
|
17 <tr><td>None</td></tr> |
|
18 </table> |
|
19 <h3>Classes</h3> |
|
20 |
|
21 <table> |
|
22 <tr><td>None</td></tr> |
|
23 </table> |
|
24 <h3>Functions</h3> |
|
25 |
|
26 <table> |
|
27 |
|
28 <tr> |
|
29 <td><a href="#completeFormData">completeFormData</a></td> |
|
30 <td>Function generating a script to fill in form data.</td> |
|
31 </tr> |
|
32 <tr> |
|
33 <td><a href="#getAllImages">getAllImages</a></td> |
|
34 <td>Function generating a script to extract all image tags of a web page.</td> |
|
35 </tr> |
|
36 <tr> |
|
37 <td><a href="#getAllMetaAttributes">getAllMetaAttributes</a></td> |
|
38 <td>Function generating a script to extract all meta attributes of a web page.</td> |
|
39 </tr> |
|
40 <tr> |
|
41 <td><a href="#getFeedLinks">getFeedLinks</a></td> |
|
42 <td>Function generating a script to extract all RSS and Atom feed links.</td> |
|
43 </tr> |
|
44 <tr> |
|
45 <td><a href="#getFormData">getFormData</a></td> |
|
46 <td>Function generating a script to extract data for a form element.</td> |
|
47 </tr> |
|
48 <tr> |
|
49 <td><a href="#getOpenSearchLinks">getOpenSearchLinks</a></td> |
|
50 <td>Function generating a script to extract all open search links.</td> |
|
51 </tr> |
|
52 <tr> |
|
53 <td><a href="#scrollToAnchor">scrollToAnchor</a></td> |
|
54 <td>Function generating script to scroll to a given anchor.</td> |
|
55 </tr> |
|
56 <tr> |
|
57 <td><a href="#sendPostData">sendPostData</a></td> |
|
58 <td>Function generating a script to send Post data.</td> |
|
59 </tr> |
|
60 <tr> |
|
61 <td><a href="#setCss">setCss</a></td> |
|
62 <td>Function generating a script to set a given CSS style sheet.</td> |
|
63 </tr> |
|
64 <tr> |
|
65 <td><a href="#setStyleSheet">setStyleSheet</a></td> |
|
66 <td>Function generating a script to set a user style sheet.</td> |
|
67 </tr> |
|
68 <tr> |
|
69 <td><a href="#setupFormObserver">setupFormObserver</a></td> |
|
70 <td>Function generating a script to monitor a web form for user entries.</td> |
|
71 </tr> |
|
72 <tr> |
|
73 <td><a href="#setupWebChannel">setupWebChannel</a></td> |
|
74 <td>Function generating a script to setup the web channel.</td> |
|
75 </tr> |
|
76 <tr> |
|
77 <td><a href="#setupWindowObject">setupWindowObject</a></td> |
|
78 <td>Function generating a script to setup window.object add-ons.</td> |
|
79 </tr> |
|
80 </table> |
|
81 <hr /> |
|
82 <hr /> |
|
83 <a NAME="completeFormData" ID="completeFormData"></a> |
|
84 <h2>completeFormData</h2> |
|
85 <b>completeFormData</b>(<i>data</i>) |
|
86 |
|
87 <p> |
|
88 Function generating a script to fill in form data. |
|
89 </p> |
|
90 <dl> |
|
91 |
|
92 <dt><i>data</i> (QByteArray)</dt> |
|
93 <dd> |
|
94 data to be filled into the form |
|
95 </dd> |
|
96 </dl> |
|
97 <dl> |
|
98 <dt>Return:</dt> |
|
99 <dd> |
|
100 script to fill a form |
|
101 </dd> |
|
102 </dl> |
|
103 <dl> |
|
104 <dt>Return Type:</dt> |
|
105 <dd> |
|
106 str |
|
107 </dd> |
|
108 </dl> |
|
109 <div align="right"><a href="#top">Up</a></div> |
|
110 <hr /> |
|
111 <hr /> |
|
112 <a NAME="getAllImages" ID="getAllImages"></a> |
|
113 <h2>getAllImages</h2> |
|
114 <b>getAllImages</b>(<i></i>) |
|
115 |
|
116 <p> |
|
117 Function generating a script to extract all image tags of a web page. |
|
118 </p> |
|
119 <dl> |
|
120 <dt>Return:</dt> |
|
121 <dd> |
|
122 script to extract image tags |
|
123 </dd> |
|
124 </dl> |
|
125 <dl> |
|
126 <dt>Return Type:</dt> |
|
127 <dd> |
|
128 str |
|
129 </dd> |
|
130 </dl> |
|
131 <div align="right"><a href="#top">Up</a></div> |
|
132 <hr /> |
|
133 <hr /> |
|
134 <a NAME="getAllMetaAttributes" ID="getAllMetaAttributes"></a> |
|
135 <h2>getAllMetaAttributes</h2> |
|
136 <b>getAllMetaAttributes</b>(<i></i>) |
|
137 |
|
138 <p> |
|
139 Function generating a script to extract all meta attributes of a web page. |
|
140 </p> |
|
141 <dl> |
|
142 <dt>Return:</dt> |
|
143 <dd> |
|
144 script to extract meta attributes |
|
145 </dd> |
|
146 </dl> |
|
147 <dl> |
|
148 <dt>Return Type:</dt> |
|
149 <dd> |
|
150 str |
|
151 </dd> |
|
152 </dl> |
|
153 <div align="right"><a href="#top">Up</a></div> |
|
154 <hr /> |
|
155 <hr /> |
|
156 <a NAME="getFeedLinks" ID="getFeedLinks"></a> |
|
157 <h2>getFeedLinks</h2> |
|
158 <b>getFeedLinks</b>(<i></i>) |
|
159 |
|
160 <p> |
|
161 Function generating a script to extract all RSS and Atom feed links. |
|
162 </p> |
|
163 <dl> |
|
164 <dt>Return:</dt> |
|
165 <dd> |
|
166 script to extract all RSS and Atom feed links |
|
167 </dd> |
|
168 </dl> |
|
169 <dl> |
|
170 <dt>Return Type:</dt> |
|
171 <dd> |
|
172 str |
|
173 </dd> |
|
174 </dl> |
|
175 <div align="right"><a href="#top">Up</a></div> |
|
176 <hr /> |
|
177 <hr /> |
|
178 <a NAME="getFormData" ID="getFormData"></a> |
|
179 <h2>getFormData</h2> |
|
180 <b>getFormData</b>(<i>pos</i>) |
|
181 |
|
182 <p> |
|
183 Function generating a script to extract data for a form element. |
|
184 </p> |
|
185 <dl> |
|
186 |
|
187 <dt><i>pos</i> (QPoint)</dt> |
|
188 <dd> |
|
189 position to extract data at |
|
190 </dd> |
|
191 </dl> |
|
192 <dl> |
|
193 <dt>Return:</dt> |
|
194 <dd> |
|
195 script to extract form data |
|
196 </dd> |
|
197 </dl> |
|
198 <dl> |
|
199 <dt>Return Type:</dt> |
|
200 <dd> |
|
201 str |
|
202 </dd> |
|
203 </dl> |
|
204 <div align="right"><a href="#top">Up</a></div> |
|
205 <hr /> |
|
206 <hr /> |
|
207 <a NAME="getOpenSearchLinks" ID="getOpenSearchLinks"></a> |
|
208 <h2>getOpenSearchLinks</h2> |
|
209 <b>getOpenSearchLinks</b>(<i></i>) |
|
210 |
|
211 <p> |
|
212 Function generating a script to extract all open search links. |
|
213 </p> |
|
214 <dl> |
|
215 <dt>Return:</dt> |
|
216 <dd> |
|
217 script to extract all open serach links |
|
218 </dd> |
|
219 </dl> |
|
220 <dl> |
|
221 <dt>Return Type:</dt> |
|
222 <dd> |
|
223 str |
|
224 </dd> |
|
225 </dl> |
|
226 <div align="right"><a href="#top">Up</a></div> |
|
227 <hr /> |
|
228 <hr /> |
|
229 <a NAME="scrollToAnchor" ID="scrollToAnchor"></a> |
|
230 <h2>scrollToAnchor</h2> |
|
231 <b>scrollToAnchor</b>(<i>anchor</i>) |
|
232 |
|
233 <p> |
|
234 Function generating script to scroll to a given anchor. |
|
235 </p> |
|
236 <dl> |
|
237 |
|
238 <dt><i>anchor</i> (str)</dt> |
|
239 <dd> |
|
240 name of the anchor to scroll to |
|
241 </dd> |
|
242 </dl> |
|
243 <dl> |
|
244 <dt>Return:</dt> |
|
245 <dd> |
|
246 script to set the style sheet |
|
247 </dd> |
|
248 </dl> |
|
249 <dl> |
|
250 <dt>Return Type:</dt> |
|
251 <dd> |
|
252 str |
|
253 </dd> |
|
254 </dl> |
|
255 <div align="right"><a href="#top">Up</a></div> |
|
256 <hr /> |
|
257 <hr /> |
|
258 <a NAME="sendPostData" ID="sendPostData"></a> |
|
259 <h2>sendPostData</h2> |
|
260 <b>sendPostData</b>(<i>url, data</i>) |
|
261 |
|
262 <p> |
|
263 Function generating a script to send Post data. |
|
264 </p> |
|
265 <dl> |
|
266 |
|
267 <dt><i>url</i> (QUrl)</dt> |
|
268 <dd> |
|
269 URL to send the data to |
|
270 </dd> |
|
271 <dt><i>data</i> (QByteArray)</dt> |
|
272 <dd> |
|
273 data to be sent |
|
274 </dd> |
|
275 </dl> |
|
276 <dl> |
|
277 <dt>Return:</dt> |
|
278 <dd> |
|
279 script to send Post data |
|
280 </dd> |
|
281 </dl> |
|
282 <dl> |
|
283 <dt>Return Type:</dt> |
|
284 <dd> |
|
285 str |
|
286 </dd> |
|
287 </dl> |
|
288 <div align="right"><a href="#top">Up</a></div> |
|
289 <hr /> |
|
290 <hr /> |
|
291 <a NAME="setCss" ID="setCss"></a> |
|
292 <h2>setCss</h2> |
|
293 <b>setCss</b>(<i>css</i>) |
|
294 |
|
295 <p> |
|
296 Function generating a script to set a given CSS style sheet. |
|
297 </p> |
|
298 <dl> |
|
299 |
|
300 <dt><i>css</i> (str)</dt> |
|
301 <dd> |
|
302 style sheet |
|
303 </dd> |
|
304 </dl> |
|
305 <dl> |
|
306 <dt>Return:</dt> |
|
307 <dd> |
|
308 script to set the style sheet |
|
309 </dd> |
|
310 </dl> |
|
311 <dl> |
|
312 <dt>Return Type:</dt> |
|
313 <dd> |
|
314 str |
|
315 </dd> |
|
316 </dl> |
|
317 <div align="right"><a href="#top">Up</a></div> |
|
318 <hr /> |
|
319 <hr /> |
|
320 <a NAME="setStyleSheet" ID="setStyleSheet"></a> |
|
321 <h2>setStyleSheet</h2> |
|
322 <b>setStyleSheet</b>(<i>css</i>) |
|
323 |
|
324 <p> |
|
325 Function generating a script to set a user style sheet. |
|
326 </p> |
|
327 <dl> |
|
328 |
|
329 <dt><i>css</i> (str)</dt> |
|
330 <dd> |
|
331 style sheet to be applied |
|
332 </dd> |
|
333 </dl> |
|
334 <dl> |
|
335 <dt>Return:</dt> |
|
336 <dd> |
|
337 script to set a user style sheet |
|
338 </dd> |
|
339 </dl> |
|
340 <dl> |
|
341 <dt>Return Type:</dt> |
|
342 <dd> |
|
343 str |
|
344 </dd> |
|
345 </dl> |
|
346 <div align="right"><a href="#top">Up</a></div> |
|
347 <hr /> |
|
348 <hr /> |
|
349 <a NAME="setupFormObserver" ID="setupFormObserver"></a> |
|
350 <h2>setupFormObserver</h2> |
|
351 <b>setupFormObserver</b>(<i></i>) |
|
352 |
|
353 <p> |
|
354 Function generating a script to monitor a web form for user entries. |
|
355 </p> |
|
356 <dl> |
|
357 <dt>Return:</dt> |
|
358 <dd> |
|
359 script to monitor a web page |
|
360 </dd> |
|
361 </dl> |
|
362 <dl> |
|
363 <dt>Return Type:</dt> |
|
364 <dd> |
|
365 str |
|
366 </dd> |
|
367 </dl> |
|
368 <div align="right"><a href="#top">Up</a></div> |
|
369 <hr /> |
|
370 <hr /> |
|
371 <a NAME="setupWebChannel" ID="setupWebChannel"></a> |
|
372 <h2>setupWebChannel</h2> |
|
373 <b>setupWebChannel</b>(<i>worldId</i>) |
|
374 |
|
375 <p> |
|
376 Function generating a script to setup the web channel. |
|
377 </p> |
|
378 <dl> |
|
379 |
|
380 <dt><i>worldId</i> (int)</dt> |
|
381 <dd> |
|
382 world ID for which to setup the channel |
|
383 </dd> |
|
384 </dl> |
|
385 <dl> |
|
386 <dt>Return:</dt> |
|
387 <dd> |
|
388 script to setup the web channel |
|
389 </dd> |
|
390 </dl> |
|
391 <dl> |
|
392 <dt>Return Type:</dt> |
|
393 <dd> |
|
394 str |
|
395 </dd> |
|
396 </dl> |
|
397 <div align="right"><a href="#top">Up</a></div> |
|
398 <hr /> |
|
399 <hr /> |
|
400 <a NAME="setupWindowObject" ID="setupWindowObject"></a> |
|
401 <h2>setupWindowObject</h2> |
|
402 <b>setupWindowObject</b>(<i></i>) |
|
403 |
|
404 <p> |
|
405 Function generating a script to setup window.object add-ons. |
|
406 </p> |
|
407 <dl> |
|
408 <dt>Return:</dt> |
|
409 <dd> |
|
410 generated script |
|
411 </dd> |
|
412 </dl> |
|
413 <dl> |
|
414 <dt>Return Type:</dt> |
|
415 <dd> |
|
416 str |
|
417 </dd> |
|
418 </dl> |
|
419 <div align="right"><a href="#top">Up</a></div> |
|
420 <hr /> |
|
421 </body></html> |