Mercurial Repositories > eric / file comparison

comparison: eric7/Documentation/Source/eric7.WebBrowser.UserAgent.UserAgentManager.html

eric7/Documentation/Source/eric7.WebBrowser.UserAgent.UserAgentManager.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.UserAgent.UserAgentManager</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.UserAgent.UserAgentManager</h1>
24
25 <p>
26 Module implementing a user agent manager.
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
37 <tr>
38 <td><a href="#UserAgentManager">UserAgentManager</a></td>
39 <td>Class implementing a user agent manager.</td>
40 </tr>
41 </table>
42 <h3>Functions</h3>
43
44 <table>
45 <tr><td>None</td></tr>
46 </table>
47 <hr />
48 <hr />
49 <a NAME="UserAgentManager" ID="UserAgentManager"></a>
50 <h2>UserAgentManager</h2>
51
52 <p>
53 Class implementing a user agent manager.
54 </p>
55 <h3>Signals</h3>
56 <dl>
57
58 <dt>changed()</dt>
59 <dd>
60 emitted to indicate a change
61 </dd>
62 <dt>userAgentSettingsSaved()</dt>
63 <dd>
64 emitted after the user agent settings
65 were saved
66 </dd>
67 </dl>
68 <h3>Derived from</h3>
69 QObject
70 <h3>Class Attributes</h3>
71
72 <table>
73 <tr><td>None</td></tr>
74 </table>
75 <h3>Class Methods</h3>
76
77 <table>
78 <tr><td>None</td></tr>
79 </table>
80 <h3>Methods</h3>
81
82 <table>
83
84 <tr>
85 <td><a href="#UserAgentManager.__init__">UserAgentManager</a></td>
86 <td>Constructor</td>
87 </tr>
88 <tr>
89 <td><a href="#UserAgentManager.__load">__load</a></td>
90 <td>Private method to load the saved user agent settings.</td>
91 </tr>
92 <tr>
93 <td><a href="#UserAgentManager.allHostNames">allHostNames</a></td>
94 <td>Public method to get a list of all host names we a user agent setting for.</td>
95 </tr>
96 <tr>
97 <td><a href="#UserAgentManager.close">close</a></td>
98 <td>Public method to close the user agents manager.</td>
99 </tr>
100 <tr>
101 <td><a href="#UserAgentManager.getFileName">getFileName</a></td>
102 <td>Public method to get the file name of the user agents file.</td>
103 </tr>
104 <tr>
105 <td><a href="#UserAgentManager.hostsCount">hostsCount</a></td>
106 <td>Public method to get the number of available user agent settings.</td>
107 </tr>
108 <tr>
109 <td><a href="#UserAgentManager.reload">reload</a></td>
110 <td>Public method to reload the user agent settings.</td>
111 </tr>
112 <tr>
113 <td><a href="#UserAgentManager.removeUserAgent">removeUserAgent</a></td>
114 <td>Public method to remove a user agent entry.</td>
115 </tr>
116 <tr>
117 <td><a href="#UserAgentManager.save">save</a></td>
118 <td>Public slot to save the user agent entries to disk.</td>
119 </tr>
120 <tr>
121 <td><a href="#UserAgentManager.setUserAgent">setUserAgent</a></td>
122 <td>Public method to set the user agent string for a host.</td>
123 </tr>
124 <tr>
125 <td><a href="#UserAgentManager.setUserAgentForUrl">setUserAgentForUrl</a></td>
126 <td>Public method to set the user agent string for an URL.</td>
127 </tr>
128 <tr>
129 <td><a href="#UserAgentManager.userAgent">userAgent</a></td>
130 <td>Public method to get the user agent setting for a host.</td>
131 </tr>
132 <tr>
133 <td><a href="#UserAgentManager.userAgentForUrl">userAgentForUrl</a></td>
134 <td>Public method to determine the user agent for the given URL.</td>
135 </tr>
136 </table>
137 <h3>Static Methods</h3>
138
139 <table>
140 <tr><td>None</td></tr>
141 </table>
142
143 <a NAME="UserAgentManager.__init__" ID="UserAgentManager.__init__"></a>
144 <h4>UserAgentManager (Constructor)</h4>
145 <b>UserAgentManager</b>(<i>parent=None</i>)
146
147 <p>
148 Constructor
149 </p>
150 <dl>
151
152 <dt><i>parent</i></dt>
153 <dd>
154 reference to the parent object (QObject)
155 </dd>
156 </dl>
157 <a NAME="UserAgentManager.__load" ID="UserAgentManager.__load"></a>
158 <h4>UserAgentManager.__load</h4>
159 <b>__load</b>(<i></i>)
160
161 <p>
162 Private method to load the saved user agent settings.
163 </p>
164 <a NAME="UserAgentManager.allHostNames" ID="UserAgentManager.allHostNames"></a>
165 <h4>UserAgentManager.allHostNames</h4>
166 <b>allHostNames</b>(<i></i>)
167
168 <p>
169 Public method to get a list of all host names we a user agent setting
170 for.
171 </p>
172 <dl>
173 <dt>Return:</dt>
174 <dd>
175 sorted list of all host names (list of strings)
176 </dd>
177 </dl>
178 <a NAME="UserAgentManager.close" ID="UserAgentManager.close"></a>
179 <h4>UserAgentManager.close</h4>
180 <b>close</b>(<i></i>)
181
182 <p>
183 Public method to close the user agents manager.
184 </p>
185 <a NAME="UserAgentManager.getFileName" ID="UserAgentManager.getFileName"></a>
186 <h4>UserAgentManager.getFileName</h4>
187 <b>getFileName</b>(<i></i>)
188
189 <p>
190 Public method to get the file name of the user agents file.
191 </p>
192 <dl>
193 <dt>Return:</dt>
194 <dd>
195 name of the user agents file (string)
196 </dd>
197 </dl>
198 <a NAME="UserAgentManager.hostsCount" ID="UserAgentManager.hostsCount"></a>
199 <h4>UserAgentManager.hostsCount</h4>
200 <b>hostsCount</b>(<i></i>)
201
202 <p>
203 Public method to get the number of available user agent settings.
204 </p>
205 <dl>
206 <dt>Return:</dt>
207 <dd>
208 number of user agent settings (integer)
209 </dd>
210 </dl>
211 <a NAME="UserAgentManager.reload" ID="UserAgentManager.reload"></a>
212 <h4>UserAgentManager.reload</h4>
213 <b>reload</b>(<i></i>)
214
215 <p>
216 Public method to reload the user agent settings.
217 </p>
218 <a NAME="UserAgentManager.removeUserAgent" ID="UserAgentManager.removeUserAgent"></a>
219 <h4>UserAgentManager.removeUserAgent</h4>
220 <b>removeUserAgent</b>(<i>host</i>)
221
222 <p>
223 Public method to remove a user agent entry.
224 </p>
225 <dl>
226
227 <dt><i>host</i></dt>
228 <dd>
229 host name (string)
230 </dd>
231 </dl>
232 <a NAME="UserAgentManager.save" ID="UserAgentManager.save"></a>
233 <h4>UserAgentManager.save</h4>
234 <b>save</b>(<i></i>)
235
236 <p>
237 Public slot to save the user agent entries to disk.
238 </p>
239 <a NAME="UserAgentManager.setUserAgent" ID="UserAgentManager.setUserAgent"></a>
240 <h4>UserAgentManager.setUserAgent</h4>
241 <b>setUserAgent</b>(<i>host, agent</i>)
242
243 <p>
244 Public method to set the user agent string for a host.
245 </p>
246 <dl>
247
248 <dt><i>host</i></dt>
249 <dd>
250 host name (string)
251 </dd>
252 <dt><i>agent</i></dt>
253 <dd>
254 user agent string (string)
255 </dd>
256 </dl>
257 <a NAME="UserAgentManager.setUserAgentForUrl" ID="UserAgentManager.setUserAgentForUrl"></a>
258 <h4>UserAgentManager.setUserAgentForUrl</h4>
259 <b>setUserAgentForUrl</b>(<i>url, agent</i>)
260
261 <p>
262 Public method to set the user agent string for an URL.
263 </p>
264 <dl>
265
266 <dt><i>url</i></dt>
267 <dd>
268 URL to register user agent setting for (QUrl)
269 </dd>
270 <dt><i>agent</i></dt>
271 <dd>
272 new current user agent string (string)
273 </dd>
274 </dl>
275 <a NAME="UserAgentManager.userAgent" ID="UserAgentManager.userAgent"></a>
276 <h4>UserAgentManager.userAgent</h4>
277 <b>userAgent</b>(<i>host</i>)
278
279 <p>
280 Public method to get the user agent setting for a host.
281 </p>
282 <dl>
283
284 <dt><i>host</i></dt>
285 <dd>
286 host name (string)
287 </dd>
288 </dl>
289 <dl>
290 <dt>Return:</dt>
291 <dd>
292 user agent string (string)
293 </dd>
294 </dl>
295 <a NAME="UserAgentManager.userAgentForUrl" ID="UserAgentManager.userAgentForUrl"></a>
296 <h4>UserAgentManager.userAgentForUrl</h4>
297 <b>userAgentForUrl</b>(<i>url</i>)
298
299 <p>
300 Public method to determine the user agent for the given URL.
301 </p>
302 <dl>
303
304 <dt><i>url</i></dt>
305 <dd>
306 URL to determine user agent for (QUrl)
307 </dd>
308 </dl>
309 <dl>
310 <dt>Return:</dt>
311 <dd>
312 user agent string (string)
313 </dd>
314 </dl>
315 <div align="right"><a href="#top">Up</a></div>
316 <hr />
317 </body></html>

Mercurial Repository: eric

eric ide

mercurial