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