Mercurial Repositories > eric / file comparison

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

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

Mercurial Repository: eric

eric ide

mercurial