Mercurial Repositories > eric / file comparison

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

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

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

Mercurial Repository: eric

eric ide

mercurial