Mercurial Repositories > eric / file comparison

comparison: eric7/Documentation/Source/eric7.WebBrowser.Tools.Scripts.html

eric7/Documentation/Source/eric7.WebBrowser.Tools.Scripts.html

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

Mercurial Repository: eric

eric ide

mercurial