Mercurial Repositories > eric / file comparison

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

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

changeset 6942
2602857055c5
parent 6692
c104c120e043
child 7273
391d6b7b1eff
equal deleted inserted replaced
6941:f99d60d6b59b 6942:2602857055c5
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.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><a NAME="top" ID="top"></a>
22 <h1>eric6.WebBrowser.Tools.Scripts</h1>
23 <p>
24 Module containing function to generate JavaScript code.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr><td>None</td></tr>
33 </table>
34 <h3>Functions</h3>
35 <table>
36 <tr>
37 <td><a href="#completeFormData">completeFormData</a></td>
38 <td>Function generating a script to fill in form data.</td>
39 </tr><tr>
40 <td><a href="#getAllImages">getAllImages</a></td>
41 <td>Function generating a script to extract all image tags of a web page.</td>
42 </tr><tr>
43 <td><a href="#getAllMetaAttributes">getAllMetaAttributes</a></td>
44 <td>Function generating a script to extract all meta attributes of a web page.</td>
45 </tr><tr>
46 <td><a href="#getFeedLinks">getFeedLinks</a></td>
47 <td>Function generating a script to extract all RSS and Atom feed links.</td>
48 </tr><tr>
49 <td><a href="#getFormData">getFormData</a></td>
50 <td>Function generating a script to extract data for a form element.</td>
51 </tr><tr>
52 <td><a href="#getOpenSearchLinks">getOpenSearchLinks</a></td>
53 <td>Function generating a script to extract all open search links.</td>
54 </tr><tr>
55 <td><a href="#scrollToAnchor">scrollToAnchor</a></td>
56 <td>Function generating script to scroll to a given anchor.</td>
57 </tr><tr>
58 <td><a href="#sendPostData">sendPostData</a></td>
59 <td>Function generating a script to send Post data.</td>
60 </tr><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><tr>
64 <td><a href="#setStyleSheet">setStyleSheet</a></td>
65 <td>Function generating a script to set a user style sheet.</td>
66 </tr><tr>
67 <td><a href="#setupFormObserver">setupFormObserver</a></td>
68 <td>Function generating a script to monitor a web form for user entries.</td>
69 </tr><tr>
70 <td><a href="#setupWebChannel">setupWebChannel</a></td>
71 <td>Function generating a script to setup the web channel.</td>
72 </tr><tr>
73 <td><a href="#setupWindowObject">setupWindowObject</a></td>
74 <td>Function generating a script to setup window.object add-ons.</td>
75 </tr>
76 </table>
77 <hr /><hr />
78 <a NAME="completeFormData" ID="completeFormData"></a>
79 <h2>completeFormData</h2>
80 <b>completeFormData</b>(<i>data</i>)
81 <p>
82 Function generating a script to fill in form data.
83 </p><dl>
84 <dt><i>data</i> (QByteArray)</dt>
85 <dd>
86 data to be filled into the form
87 </dd>
88 </dl><dl>
89 <dt>Returns:</dt>
90 <dd>
91 script to fill a form
92 </dd>
93 </dl><dl>
94 <dt>Return Type:</dt>
95 <dd>
96 str
97 </dd>
98 </dl>
99 <div align="right"><a href="#top">Up</a></div>
100 <hr /><hr />
101 <a NAME="getAllImages" ID="getAllImages"></a>
102 <h2>getAllImages</h2>
103 <b>getAllImages</b>(<i></i>)
104 <p>
105 Function generating a script to extract all image tags of a web page.
106 </p><dl>
107 <dt>Returns:</dt>
108 <dd>
109 script to extract image tags
110 </dd>
111 </dl><dl>
112 <dt>Return Type:</dt>
113 <dd>
114 str
115 </dd>
116 </dl>
117 <div align="right"><a href="#top">Up</a></div>
118 <hr /><hr />
119 <a NAME="getAllMetaAttributes" ID="getAllMetaAttributes"></a>
120 <h2>getAllMetaAttributes</h2>
121 <b>getAllMetaAttributes</b>(<i></i>)
122 <p>
123 Function generating a script to extract all meta attributes of a web page.
124 </p><dl>
125 <dt>Returns:</dt>
126 <dd>
127 script to extract meta attributes
128 </dd>
129 </dl><dl>
130 <dt>Return Type:</dt>
131 <dd>
132 str
133 </dd>
134 </dl>
135 <div align="right"><a href="#top">Up</a></div>
136 <hr /><hr />
137 <a NAME="getFeedLinks" ID="getFeedLinks"></a>
138 <h2>getFeedLinks</h2>
139 <b>getFeedLinks</b>(<i></i>)
140 <p>
141 Function generating a script to extract all RSS and Atom feed links.
142 </p><dl>
143 <dt>Returns:</dt>
144 <dd>
145 script to extract all RSS and Atom feed links
146 </dd>
147 </dl><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 /><hr />
155 <a NAME="getFormData" ID="getFormData"></a>
156 <h2>getFormData</h2>
157 <b>getFormData</b>(<i>pos</i>)
158 <p>
159 Function generating a script to extract data for a form element.
160 </p><dl>
161 <dt><i>pos</i> (QPoint)</dt>
162 <dd>
163 position to extract data at
164 </dd>
165 </dl><dl>
166 <dt>Returns:</dt>
167 <dd>
168 script to extract form data
169 </dd>
170 </dl><dl>
171 <dt>Return Type:</dt>
172 <dd>
173 str
174 </dd>
175 </dl>
176 <div align="right"><a href="#top">Up</a></div>
177 <hr /><hr />
178 <a NAME="getOpenSearchLinks" ID="getOpenSearchLinks"></a>
179 <h2>getOpenSearchLinks</h2>
180 <b>getOpenSearchLinks</b>(<i></i>)
181 <p>
182 Function generating a script to extract all open search links.
183 </p><dl>
184 <dt>Returns:</dt>
185 <dd>
186 script to extract all open serach links
187 </dd>
188 </dl><dl>
189 <dt>Return Type:</dt>
190 <dd>
191 str
192 </dd>
193 </dl>
194 <div align="right"><a href="#top">Up</a></div>
195 <hr /><hr />
196 <a NAME="scrollToAnchor" ID="scrollToAnchor"></a>
197 <h2>scrollToAnchor</h2>
198 <b>scrollToAnchor</b>(<i>anchor</i>)
199 <p>
200 Function generating script to scroll to a given anchor.
201 </p><dl>
202 <dt><i>anchor</i> (str)</dt>
203 <dd>
204 name of the anchor to scroll to
205 </dd>
206 </dl><dl>
207 <dt>Returns:</dt>
208 <dd>
209 script to set the style sheet
210 </dd>
211 </dl><dl>
212 <dt>Return Type:</dt>
213 <dd>
214 str
215 </dd>
216 </dl>
217 <div align="right"><a href="#top">Up</a></div>
218 <hr /><hr />
219 <a NAME="sendPostData" ID="sendPostData"></a>
220 <h2>sendPostData</h2>
221 <b>sendPostData</b>(<i>url, data</i>)
222 <p>
223 Function generating a script to send Post data.
224 </p><dl>
225 <dt><i>url</i> (QUrl)</dt>
226 <dd>
227 URL to send the data to
228 </dd><dt><i>data</i> (QByteArray)</dt>
229 <dd>
230 data to be sent
231 </dd>
232 </dl><dl>
233 <dt>Returns:</dt>
234 <dd>
235 script to send Post data
236 </dd>
237 </dl><dl>
238 <dt>Return Type:</dt>
239 <dd>
240 str
241 </dd>
242 </dl>
243 <div align="right"><a href="#top">Up</a></div>
244 <hr /><hr />
245 <a NAME="setCss" ID="setCss"></a>
246 <h2>setCss</h2>
247 <b>setCss</b>(<i>css</i>)
248 <p>
249 Function generating a script to set a given CSS style sheet.
250 </p><dl>
251 <dt><i>css</i> (str)</dt>
252 <dd>
253 style sheet
254 </dd>
255 </dl><dl>
256 <dt>Returns:</dt>
257 <dd>
258 script to set the style sheet
259 </dd>
260 </dl><dl>
261 <dt>Return Type:</dt>
262 <dd>
263 str
264 </dd>
265 </dl>
266 <div align="right"><a href="#top">Up</a></div>
267 <hr /><hr />
268 <a NAME="setStyleSheet" ID="setStyleSheet"></a>
269 <h2>setStyleSheet</h2>
270 <b>setStyleSheet</b>(<i>css</i>)
271 <p>
272 Function generating a script to set a user style sheet.
273 </p><dl>
274 <dt><i>css</i> (str)</dt>
275 <dd>
276 style sheet to be applied
277 </dd>
278 </dl><dl>
279 <dt>Returns:</dt>
280 <dd>
281 script to set a user style sheet
282 </dd>
283 </dl><dl>
284 <dt>Return Type:</dt>
285 <dd>
286 str
287 </dd>
288 </dl>
289 <div align="right"><a href="#top">Up</a></div>
290 <hr /><hr />
291 <a NAME="setupFormObserver" ID="setupFormObserver"></a>
292 <h2>setupFormObserver</h2>
293 <b>setupFormObserver</b>(<i></i>)
294 <p>
295 Function generating a script to monitor a web form for user entries.
296 </p><dl>
297 <dt>Returns:</dt>
298 <dd>
299 script to monitor a web page
300 </dd>
301 </dl><dl>
302 <dt>Return Type:</dt>
303 <dd>
304 str
305 </dd>
306 </dl>
307 <div align="right"><a href="#top">Up</a></div>
308 <hr /><hr />
309 <a NAME="setupWebChannel" ID="setupWebChannel"></a>
310 <h2>setupWebChannel</h2>
311 <b>setupWebChannel</b>(<i>worldId</i>)
312 <p>
313 Function generating a script to setup the web channel.
314 </p><dl>
315 <dt><i>worldId</i> (int)</dt>
316 <dd>
317 world ID for which to setup the channel
318 </dd>
319 </dl><dl>
320 <dt>Returns:</dt>
321 <dd>
322 script to setup the web channel
323 </dd>
324 </dl><dl>
325 <dt>Return Type:</dt>
326 <dd>
327 str
328 </dd>
329 </dl>
330 <div align="right"><a href="#top">Up</a></div>
331 <hr /><hr />
332 <a NAME="setupWindowObject" ID="setupWindowObject"></a>
333 <h2>setupWindowObject</h2>
334 <b>setupWindowObject</b>(<i></i>)
335 <p>
336 Function generating a script to setup window.object add-ons.
337 </p><dl>
338 <dt>Returns:</dt>
339 <dd>
340 generated script
341 </dd>
342 </dl><dl>
343 <dt>Return Type:</dt>
344 <dd>
345 str
346 </dd>
347 </dl>
348 <div align="right"><a href="#top">Up</a></div>
349 <hr />
350 </body></html>

Mercurial Repository: eric

eric ide

mercurial