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

changeset 4918
71caf42a13d8
child 6153
0b18c86c03a1
equal deleted inserted replaced
4917:682750cc7bd5 4918:71caf42a13d8
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="#sendPostData">sendPostData</a></td>
56 <td>Function generating a script to send Post data.</td>
57 </tr><tr>
58 <td><a href="#setCss">setCss</a></td>
59 <td>Function generating a script to set a given CSS style sheet.</td>
60 </tr><tr>
61 <td><a href="#setStyleSheet">setStyleSheet</a></td>
62 <td>Function generating a script to set a user style sheet.</td>
63 </tr><tr>
64 <td><a href="#setupFormObserver">setupFormObserver</a></td>
65 <td>Function generating a script to monitor a web form for user entries.</td>
66 </tr><tr>
67 <td><a href="#setupWebChannel">setupWebChannel</a></td>
68 <td>Function generating a script to setup the web channel.</td>
69 </tr>
70 </table>
71 <hr /><hr />
72 <a NAME="completeFormData" ID="completeFormData"></a>
73 <h2>completeFormData</h2>
74 <b>completeFormData</b>(<i>data</i>)
75 <p>
76 Function generating a script to fill in form data.
77 </p><dl>
78 <dt><i>data</i> (QByteArray)</dt>
79 <dd>
80 data to be filled into the form
81 </dd>
82 </dl><dl>
83 <dt>Returns:</dt>
84 <dd>
85 script to fill a form
86 </dd>
87 </dl><dl>
88 <dt>Return Type:</dt>
89 <dd>
90 str
91 </dd>
92 </dl>
93 <div align="right"><a href="#top">Up</a></div>
94 <hr /><hr />
95 <a NAME="getAllImages" ID="getAllImages"></a>
96 <h2>getAllImages</h2>
97 <b>getAllImages</b>(<i></i>)
98 <p>
99 Function generating a script to extract all image tags of a web page.
100 </p><dl>
101 <dt>Returns:</dt>
102 <dd>
103 script to extract image tags
104 </dd>
105 </dl><dl>
106 <dt>Return Type:</dt>
107 <dd>
108 str
109 </dd>
110 </dl>
111 <div align="right"><a href="#top">Up</a></div>
112 <hr /><hr />
113 <a NAME="getAllMetaAttributes" ID="getAllMetaAttributes"></a>
114 <h2>getAllMetaAttributes</h2>
115 <b>getAllMetaAttributes</b>(<i></i>)
116 <p>
117 Function generating a script to extract all meta attributes of a web page.
118 </p><dl>
119 <dt>Returns:</dt>
120 <dd>
121 script to extract meta attributes
122 </dd>
123 </dl><dl>
124 <dt>Return Type:</dt>
125 <dd>
126 str
127 </dd>
128 </dl>
129 <div align="right"><a href="#top">Up</a></div>
130 <hr /><hr />
131 <a NAME="getFeedLinks" ID="getFeedLinks"></a>
132 <h2>getFeedLinks</h2>
133 <b>getFeedLinks</b>(<i></i>)
134 <p>
135 Function generating a script to extract all RSS and Atom feed links.
136 </p><dl>
137 <dt>Returns:</dt>
138 <dd>
139 script to extract all RSS and Atom feed links
140 </dd>
141 </dl><dl>
142 <dt>Return Type:</dt>
143 <dd>
144 str
145 </dd>
146 </dl>
147 <div align="right"><a href="#top">Up</a></div>
148 <hr /><hr />
149 <a NAME="getFormData" ID="getFormData"></a>
150 <h2>getFormData</h2>
151 <b>getFormData</b>(<i>pos</i>)
152 <p>
153 Function generating a script to extract data for a form element.
154 </p><dl>
155 <dt><i>pos</i> (QPoint)</dt>
156 <dd>
157 position to extract data at
158 </dd>
159 </dl><dl>
160 <dt>Returns:</dt>
161 <dd>
162 script to extract form data
163 </dd>
164 </dl><dl>
165 <dt>Return Type:</dt>
166 <dd>
167 str
168 </dd>
169 </dl>
170 <div align="right"><a href="#top">Up</a></div>
171 <hr /><hr />
172 <a NAME="getOpenSearchLinks" ID="getOpenSearchLinks"></a>
173 <h2>getOpenSearchLinks</h2>
174 <b>getOpenSearchLinks</b>(<i></i>)
175 <p>
176 Function generating a script to extract all open search links.
177 </p><dl>
178 <dt>Returns:</dt>
179 <dd>
180 script to extract all open serach links
181 </dd>
182 </dl><dl>
183 <dt>Return Type:</dt>
184 <dd>
185 str
186 </dd>
187 </dl>
188 <div align="right"><a href="#top">Up</a></div>
189 <hr /><hr />
190 <a NAME="sendPostData" ID="sendPostData"></a>
191 <h2>sendPostData</h2>
192 <b>sendPostData</b>(<i>url, data</i>)
193 <p>
194 Function generating a script to send Post data.
195 </p><dl>
196 <dt><i>url</i> (QUrl)</dt>
197 <dd>
198 URL to send the data to
199 </dd><dt><i>data</i> (QByteArray)</dt>
200 <dd>
201 data to be sent
202 </dd>
203 </dl><dl>
204 <dt>Returns:</dt>
205 <dd>
206 script to send Post data
207 </dd>
208 </dl><dl>
209 <dt>Return Type:</dt>
210 <dd>
211 str
212 </dd>
213 </dl>
214 <div align="right"><a href="#top">Up</a></div>
215 <hr /><hr />
216 <a NAME="setCss" ID="setCss"></a>
217 <h2>setCss</h2>
218 <b>setCss</b>(<i>css</i>)
219 <p>
220 Function generating a script to set a given CSS style sheet.
221 </p><dl>
222 <dt><i>css</i> (str)</dt>
223 <dd>
224 style sheet
225 </dd>
226 </dl><dl>
227 <dt>Returns:</dt>
228 <dd>
229 script to set the style sheet
230 </dd>
231 </dl><dl>
232 <dt>Return Type:</dt>
233 <dd>
234 str
235 </dd>
236 </dl>
237 <div align="right"><a href="#top">Up</a></div>
238 <hr /><hr />
239 <a NAME="setStyleSheet" ID="setStyleSheet"></a>
240 <h2>setStyleSheet</h2>
241 <b>setStyleSheet</b>(<i>css</i>)
242 <p>
243 Function generating a script to set a user style sheet.
244 </p><dl>
245 <dt><i>css</i> (str)</dt>
246 <dd>
247 style sheet to be applied
248 </dd>
249 </dl><dl>
250 <dt>Returns:</dt>
251 <dd>
252 script to set a user style sheet
253 </dd>
254 </dl><dl>
255 <dt>Return Type:</dt>
256 <dd>
257 str
258 </dd>
259 </dl>
260 <div align="right"><a href="#top">Up</a></div>
261 <hr /><hr />
262 <a NAME="setupFormObserver" ID="setupFormObserver"></a>
263 <h2>setupFormObserver</h2>
264 <b>setupFormObserver</b>(<i></i>)
265 <p>
266 Function generating a script to monitor a web form for user entries.
267 </p><dl>
268 <dt>Returns:</dt>
269 <dd>
270 script to monitor a web page
271 </dd>
272 </dl><dl>
273 <dt>Return Type:</dt>
274 <dd>
275 str
276 </dd>
277 </dl>
278 <div align="right"><a href="#top">Up</a></div>
279 <hr /><hr />
280 <a NAME="setupWebChannel" ID="setupWebChannel"></a>
281 <h2>setupWebChannel</h2>
282 <b>setupWebChannel</b>(<i></i>)
283 <p>
284 Function generating a script to setup the web channel.
285 </p><dl>
286 <dt>Returns:</dt>
287 <dd>
288 script to setup the web channel
289 </dd>
290 </dl><dl>
291 <dt>Return Type:</dt>
292 <dd>
293 str
294 </dd>
295 </dl>
296 <div align="right"><a href="#top">Up</a></div>
297 <hr />
298 </body></html>

eric ide

mercurial