5 <link rel="stylesheet" href="styles.css"> |
5 <link rel="stylesheet" href="styles.css"> |
6 </head> |
6 </head> |
7 <body> |
7 <body> |
8 <a NAME="top" ID="top"></a> |
8 <a NAME="top" ID="top"></a> |
9 <h1>eric7.WebBrowser.UserAgent.UserAgentManager</h1> |
9 <h1>eric7.WebBrowser.UserAgent.UserAgentManager</h1> |
10 |
|
11 <p> |
10 <p> |
12 Module implementing a user agent manager. |
11 Module implementing a user agent manager. |
13 </p> |
12 </p> |
|
13 |
14 <h3>Global Attributes</h3> |
14 <h3>Global Attributes</h3> |
15 |
15 <table> |
16 <table> |
16 <tr><td>None</td></tr> |
17 <tr><td>None</td></tr> |
17 </table> |
18 </table> |
18 |
19 <h3>Classes</h3> |
19 <h3>Classes</h3> |
20 |
20 <table> |
21 <table> |
|
22 |
|
23 <tr> |
21 <tr> |
24 <td><a href="#UserAgentManager">UserAgentManager</a></td> |
22 <td><a href="#UserAgentManager">UserAgentManager</a></td> |
25 <td>Class implementing a user agent manager.</td> |
23 <td>Class implementing a user agent manager.</td> |
26 </tr> |
24 </tr> |
27 </table> |
25 </table> |
|
26 |
28 <h3>Functions</h3> |
27 <h3>Functions</h3> |
29 |
28 <table> |
30 <table> |
29 <tr><td>None</td></tr> |
31 <tr><td>None</td></tr> |
30 </table> |
32 </table> |
31 |
33 <hr /> |
32 <hr /> |
34 <hr /> |
33 <hr /> |
35 <a NAME="UserAgentManager" ID="UserAgentManager"></a> |
34 <a NAME="UserAgentManager" ID="UserAgentManager"></a> |
36 <h2>UserAgentManager</h2> |
35 <h2>UserAgentManager</h2> |
37 |
|
38 <p> |
36 <p> |
39 Class implementing a user agent manager. |
37 Class implementing a user agent manager. |
40 </p> |
38 </p> |
|
39 |
41 <h3>Signals</h3> |
40 <h3>Signals</h3> |
42 <dl> |
41 <dl> |
43 |
42 |
44 <dt>changed()</dt> |
43 <dt>changed()</dt> |
45 <dd> |
44 <dd> |
52 </dd> |
51 </dd> |
53 </dl> |
52 </dl> |
54 <h3>Derived from</h3> |
53 <h3>Derived from</h3> |
55 QObject |
54 QObject |
56 <h3>Class Attributes</h3> |
55 <h3>Class Attributes</h3> |
57 |
56 <table> |
58 <table> |
57 <tr><td>None</td></tr> |
59 <tr><td>None</td></tr> |
58 </table> |
60 </table> |
59 |
61 <h3>Class Methods</h3> |
60 <h3>Class Methods</h3> |
62 |
61 <table> |
63 <table> |
62 <tr><td>None</td></tr> |
64 <tr><td>None</td></tr> |
63 </table> |
65 </table> |
64 |
66 <h3>Methods</h3> |
65 <h3>Methods</h3> |
67 |
66 <table> |
68 <table> |
|
69 |
|
70 <tr> |
67 <tr> |
71 <td><a href="#UserAgentManager.__init__">UserAgentManager</a></td> |
68 <td><a href="#UserAgentManager.__init__">UserAgentManager</a></td> |
72 <td>Constructor</td> |
69 <td>Constructor</td> |
73 </tr> |
70 </tr> |
74 <tr> |
71 <tr> |
118 <tr> |
115 <tr> |
119 <td><a href="#UserAgentManager.userAgentForUrl">userAgentForUrl</a></td> |
116 <td><a href="#UserAgentManager.userAgentForUrl">userAgentForUrl</a></td> |
120 <td>Public method to determine the user agent for the given URL.</td> |
117 <td>Public method to determine the user agent for the given URL.</td> |
121 </tr> |
118 </tr> |
122 </table> |
119 </table> |
|
120 |
123 <h3>Static Methods</h3> |
121 <h3>Static Methods</h3> |
124 |
122 <table> |
125 <table> |
123 <tr><td>None</td></tr> |
126 <tr><td>None</td></tr> |
124 </table> |
127 </table> |
125 |
128 |
126 |
129 <a NAME="UserAgentManager.__init__" ID="UserAgentManager.__init__"></a> |
127 <a NAME="UserAgentManager.__init__" ID="UserAgentManager.__init__"></a> |
130 <h4>UserAgentManager (Constructor)</h4> |
128 <h4>UserAgentManager (Constructor)</h4> |
131 <b>UserAgentManager</b>(<i>parent=None</i>) |
129 <b>UserAgentManager</b>(<i>parent=None</i>) |
132 |
|
133 <p> |
130 <p> |
134 Constructor |
131 Constructor |
135 </p> |
132 </p> |
|
133 |
136 <dl> |
134 <dl> |
137 |
135 |
138 <dt><i>parent</i> (QObject)</dt> |
136 <dt><i>parent</i> (QObject)</dt> |
139 <dd> |
137 <dd> |
140 reference to the parent object |
138 reference to the parent object |
141 </dd> |
139 </dd> |
142 </dl> |
140 </dl> |
143 <a NAME="UserAgentManager.__load" ID="UserAgentManager.__load"></a> |
141 <a NAME="UserAgentManager.__load" ID="UserAgentManager.__load"></a> |
144 <h4>UserAgentManager.__load</h4> |
142 <h4>UserAgentManager.__load</h4> |
145 <b>__load</b>(<i></i>) |
143 <b>__load</b>(<i></i>) |
146 |
|
147 <p> |
144 <p> |
148 Private method to load the saved user agent settings. |
145 Private method to load the saved user agent settings. |
149 </p> |
146 </p> |
|
147 |
150 <a NAME="UserAgentManager.allHostNames" ID="UserAgentManager.allHostNames"></a> |
148 <a NAME="UserAgentManager.allHostNames" ID="UserAgentManager.allHostNames"></a> |
151 <h4>UserAgentManager.allHostNames</h4> |
149 <h4>UserAgentManager.allHostNames</h4> |
152 <b>allHostNames</b>(<i></i>) |
150 <b>allHostNames</b>(<i></i>) |
153 |
|
154 <p> |
151 <p> |
155 Public method to get a list of all host names we a user agent setting |
152 Public method to get a list of all host names we a user agent setting |
156 for. |
153 for. |
157 </p> |
154 </p> |
|
155 |
158 <dl> |
156 <dl> |
159 <dt>Return:</dt> |
157 <dt>Return:</dt> |
160 <dd> |
158 <dd> |
161 sorted list of all host names |
159 sorted list of all host names |
162 </dd> |
160 </dd> |
168 </dd> |
166 </dd> |
169 </dl> |
167 </dl> |
170 <a NAME="UserAgentManager.close" ID="UserAgentManager.close"></a> |
168 <a NAME="UserAgentManager.close" ID="UserAgentManager.close"></a> |
171 <h4>UserAgentManager.close</h4> |
169 <h4>UserAgentManager.close</h4> |
172 <b>close</b>(<i></i>) |
170 <b>close</b>(<i></i>) |
173 |
|
174 <p> |
171 <p> |
175 Public method to close the user agents manager. |
172 Public method to close the user agents manager. |
176 </p> |
173 </p> |
|
174 |
177 <a NAME="UserAgentManager.getFileName" ID="UserAgentManager.getFileName"></a> |
175 <a NAME="UserAgentManager.getFileName" ID="UserAgentManager.getFileName"></a> |
178 <h4>UserAgentManager.getFileName</h4> |
176 <h4>UserAgentManager.getFileName</h4> |
179 <b>getFileName</b>(<i></i>) |
177 <b>getFileName</b>(<i></i>) |
180 |
|
181 <p> |
178 <p> |
182 Public method to get the file name of the user agents file. |
179 Public method to get the file name of the user agents file. |
183 </p> |
180 </p> |
|
181 |
184 <dl> |
182 <dl> |
185 <dt>Return:</dt> |
183 <dt>Return:</dt> |
186 <dd> |
184 <dd> |
187 name of the user agents file |
185 name of the user agents file |
188 </dd> |
186 </dd> |
194 </dd> |
192 </dd> |
195 </dl> |
193 </dl> |
196 <a NAME="UserAgentManager.hostsCount" ID="UserAgentManager.hostsCount"></a> |
194 <a NAME="UserAgentManager.hostsCount" ID="UserAgentManager.hostsCount"></a> |
197 <h4>UserAgentManager.hostsCount</h4> |
195 <h4>UserAgentManager.hostsCount</h4> |
198 <b>hostsCount</b>(<i></i>) |
196 <b>hostsCount</b>(<i></i>) |
199 |
|
200 <p> |
197 <p> |
201 Public method to get the number of available user agent settings. |
198 Public method to get the number of available user agent settings. |
202 </p> |
199 </p> |
|
200 |
203 <dl> |
201 <dl> |
204 <dt>Return:</dt> |
202 <dt>Return:</dt> |
205 <dd> |
203 <dd> |
206 number of user agent settings |
204 number of user agent settings |
207 </dd> |
205 </dd> |
213 </dd> |
211 </dd> |
214 </dl> |
212 </dl> |
215 <a NAME="UserAgentManager.reload" ID="UserAgentManager.reload"></a> |
213 <a NAME="UserAgentManager.reload" ID="UserAgentManager.reload"></a> |
216 <h4>UserAgentManager.reload</h4> |
214 <h4>UserAgentManager.reload</h4> |
217 <b>reload</b>(<i></i>) |
215 <b>reload</b>(<i></i>) |
218 |
|
219 <p> |
216 <p> |
220 Public method to reload the user agent settings. |
217 Public method to reload the user agent settings. |
221 </p> |
218 </p> |
|
219 |
222 <a NAME="UserAgentManager.removeUserAgent" ID="UserAgentManager.removeUserAgent"></a> |
220 <a NAME="UserAgentManager.removeUserAgent" ID="UserAgentManager.removeUserAgent"></a> |
223 <h4>UserAgentManager.removeUserAgent</h4> |
221 <h4>UserAgentManager.removeUserAgent</h4> |
224 <b>removeUserAgent</b>(<i>host</i>) |
222 <b>removeUserAgent</b>(<i>host</i>) |
225 |
|
226 <p> |
223 <p> |
227 Public method to remove a user agent entry. |
224 Public method to remove a user agent entry. |
228 </p> |
225 </p> |
|
226 |
229 <dl> |
227 <dl> |
230 |
228 |
231 <dt><i>host</i> (str)</dt> |
229 <dt><i>host</i> (str)</dt> |
232 <dd> |
230 <dd> |
233 host name |
231 host name |
234 </dd> |
232 </dd> |
235 </dl> |
233 </dl> |
236 <a NAME="UserAgentManager.save" ID="UserAgentManager.save"></a> |
234 <a NAME="UserAgentManager.save" ID="UserAgentManager.save"></a> |
237 <h4>UserAgentManager.save</h4> |
235 <h4>UserAgentManager.save</h4> |
238 <b>save</b>(<i></i>) |
236 <b>save</b>(<i></i>) |
239 |
|
240 <p> |
237 <p> |
241 Public slot to save the user agent entries to disk. |
238 Public slot to save the user agent entries to disk. |
242 </p> |
239 </p> |
|
240 |
243 <a NAME="UserAgentManager.setUserAgent" ID="UserAgentManager.setUserAgent"></a> |
241 <a NAME="UserAgentManager.setUserAgent" ID="UserAgentManager.setUserAgent"></a> |
244 <h4>UserAgentManager.setUserAgent</h4> |
242 <h4>UserAgentManager.setUserAgent</h4> |
245 <b>setUserAgent</b>(<i>host, agent</i>) |
243 <b>setUserAgent</b>(<i>host, agent</i>) |
246 |
|
247 <p> |
244 <p> |
248 Public method to set the user agent string for a host. |
245 Public method to set the user agent string for a host. |
249 </p> |
246 </p> |
|
247 |
250 <dl> |
248 <dl> |
251 |
249 |
252 <dt><i>host</i> (str)</dt> |
250 <dt><i>host</i> (str)</dt> |
253 <dd> |
251 <dd> |
254 host name |
252 host name |
259 </dd> |
257 </dd> |
260 </dl> |
258 </dl> |
261 <a NAME="UserAgentManager.setUserAgentForUrl" ID="UserAgentManager.setUserAgentForUrl"></a> |
259 <a NAME="UserAgentManager.setUserAgentForUrl" ID="UserAgentManager.setUserAgentForUrl"></a> |
262 <h4>UserAgentManager.setUserAgentForUrl</h4> |
260 <h4>UserAgentManager.setUserAgentForUrl</h4> |
263 <b>setUserAgentForUrl</b>(<i>url, agent</i>) |
261 <b>setUserAgentForUrl</b>(<i>url, agent</i>) |
264 |
|
265 <p> |
262 <p> |
266 Public method to set the user agent string for an URL. |
263 Public method to set the user agent string for an URL. |
267 </p> |
264 </p> |
|
265 |
268 <dl> |
266 <dl> |
269 |
267 |
270 <dt><i>url</i> (QUrl)</dt> |
268 <dt><i>url</i> (QUrl)</dt> |
271 <dd> |
269 <dd> |
272 URL to register user agent setting for |
270 URL to register user agent setting for |
277 </dd> |
275 </dd> |
278 </dl> |
276 </dl> |
279 <a NAME="UserAgentManager.userAgent" ID="UserAgentManager.userAgent"></a> |
277 <a NAME="UserAgentManager.userAgent" ID="UserAgentManager.userAgent"></a> |
280 <h4>UserAgentManager.userAgent</h4> |
278 <h4>UserAgentManager.userAgent</h4> |
281 <b>userAgent</b>(<i>host</i>) |
279 <b>userAgent</b>(<i>host</i>) |
282 |
|
283 <p> |
280 <p> |
284 Public method to get the user agent setting for a host. |
281 Public method to get the user agent setting for a host. |
285 </p> |
282 </p> |
|
283 |
286 <dl> |
284 <dl> |
287 |
285 |
288 <dt><i>host</i> (str)</dt> |
286 <dt><i>host</i> (str)</dt> |
289 <dd> |
287 <dd> |
290 host name |
288 host name |
303 </dd> |
301 </dd> |
304 </dl> |
302 </dl> |
305 <a NAME="UserAgentManager.userAgentForUrl" ID="UserAgentManager.userAgentForUrl"></a> |
303 <a NAME="UserAgentManager.userAgentForUrl" ID="UserAgentManager.userAgentForUrl"></a> |
306 <h4>UserAgentManager.userAgentForUrl</h4> |
304 <h4>UserAgentManager.userAgentForUrl</h4> |
307 <b>userAgentForUrl</b>(<i>url</i>) |
305 <b>userAgentForUrl</b>(<i>url</i>) |
308 |
|
309 <p> |
306 <p> |
310 Public method to determine the user agent for the given URL. |
307 Public method to determine the user agent for the given URL. |
311 </p> |
308 </p> |
|
309 |
312 <dl> |
310 <dl> |
313 |
311 |
314 <dt><i>url</i> (QUrl)</dt> |
312 <dt><i>url</i> (QUrl)</dt> |
315 <dd> |
313 <dd> |
316 URL to determine user agent for |
314 URL to determine user agent for |