Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.WebBrowser.Passwords.PasswordManager.html
src/eric7/Documentation/Source/eric7.WebBrowser.Passwords.PasswordManager.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 9971
- 773ad1f1ed22
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.WebBrowser.Passwords.PasswordManager</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.Passwords.PasswordManager</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the password 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="#PasswordManager">PasswordManager</a></td> | |
| 25 <td>Class implementing the password 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="PasswordManager" ID="PasswordManager"></a> | |
| 36 <h2>PasswordManager</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing the password 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>passwordsSaved()</dt> | |
| 49 <dd> | |
| 50 emitted after the passwords were saved | |
| 51 </dd> | |
| 52 </dl> | |
| 53 <h3>Derived from</h3> | |
| 54 QObject | |
| 55 <h3>Class Attributes</h3> | |
| 56 | |
| 57 <table> | |
| 58 <tr><td>None</td></tr> | |
| 59 </table> | |
| 60 <h3>Class Methods</h3> | |
| 61 | |
| 62 <table> | |
| 63 <tr><td>None</td></tr> | |
| 64 </table> | |
| 65 <h3>Methods</h3> | |
| 66 | |
| 67 <table> | |
| 68 | |
| 69 <tr> | |
| 70 <td><a href="#PasswordManager.__init__">PasswordManager</a></td> | |
| 71 <td>Constructor</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#PasswordManager.__createKey">__createKey</a></td> | |
| 75 <td>Private method to create the key string for the login credentials.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#PasswordManager.__load">__load</a></td> | |
| 79 <td>Private method to load the saved login credentials.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#PasswordManager.__stripUrl">__stripUrl</a></td> | |
| 83 <td>Private method to strip off all unneeded parts of a URL.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#PasswordManager.allSiteNames">allSiteNames</a></td> | |
| 87 <td>Public method to get a list of all site names.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 90 <td><a href="#PasswordManager.clear">clear</a></td> | |
| 91 <td>Public slot to clear the saved passwords.</td> | |
| 92 </tr> | |
| 93 <tr> | |
| 94 <td><a href="#PasswordManager.close">close</a></td> | |
| 95 <td>Public method to close the passwords manager.</td> | |
| 96 </tr> | |
| 97 <tr> | |
| 98 <td><a href="#PasswordManager.completePage">completePage</a></td> | |
| 99 <td>Public slot to complete login forms with saved data.</td> | |
| 100 </tr> | |
| 101 <tr> | |
| 102 <td><a href="#PasswordManager.formSubmitted">formSubmitted</a></td> | |
| 103 <td>Public method to record login data.</td> | |
| 104 </tr> | |
| 105 <tr> | |
| 106 <td><a href="#PasswordManager.getFileName">getFileName</a></td> | |
| 107 <td>Public method to get the file name of the passwords file.</td> | |
| 108 </tr> | |
| 109 <tr> | |
| 110 <td><a href="#PasswordManager.getLogin">getLogin</a></td> | |
| 111 <td>Public method to get the login credentials.</td> | |
| 112 </tr> | |
| 113 <tr> | |
| 114 <td><a href="#PasswordManager.masterPasswordChanged">masterPasswordChanged</a></td> | |
| 115 <td>Public slot to handle the change of the master password.</td> | |
| 116 </tr> | |
| 117 <tr> | |
| 118 <td><a href="#PasswordManager.reload">reload</a></td> | |
| 119 <td>Public method to reload the login data.</td> | |
| 120 </tr> | |
| 121 <tr> | |
| 122 <td><a href="#PasswordManager.removePassword">removePassword</a></td> | |
| 123 <td>Public method to remove a password entry.</td> | |
| 124 </tr> | |
| 125 <tr> | |
| 126 <td><a href="#PasswordManager.save">save</a></td> | |
| 127 <td>Public slot to save the login entries to disk.</td> | |
| 128 </tr> | |
| 129 <tr> | |
| 130 <td><a href="#PasswordManager.setLogin">setLogin</a></td> | |
| 131 <td>Public method to set the login credentials.</td> | |
| 132 </tr> | |
| 133 <tr> | |
| 134 <td><a href="#PasswordManager.siteInfo">siteInfo</a></td> | |
| 135 <td>Public method to get a reference to the named site.</td> | |
| 136 </tr> | |
| 137 <tr> | |
| 138 <td><a href="#PasswordManager.sitesCount">sitesCount</a></td> | |
| 139 <td>Public method to get the number of available sites.</td> | |
| 140 </tr> | |
| 141 </table> | |
| 142 <h3>Static Methods</h3> | |
| 143 | |
| 144 <table> | |
| 145 <tr><td>None</td></tr> | |
| 146 </table> | |
| 147 | |
| 148 <a NAME="PasswordManager.__init__" ID="PasswordManager.__init__"></a> | |
| 149 <h4>PasswordManager (Constructor)</h4> | |
| 150 <b>PasswordManager</b>(<i>parent=None</i>) | |
| 151 | |
| 152 <p> | |
| 153 Constructor | |
| 154 </p> | |
| 155 <dl> | |
| 156 | |
| 157 <dt><i>parent</i></dt> | |
| 158 <dd> | |
| 159 reference to the parent object (QObject) | |
| 160 </dd> | |
| 161 </dl> | |
| 162 <a NAME="PasswordManager.__createKey" ID="PasswordManager.__createKey"></a> | |
| 163 <h4>PasswordManager.__createKey</h4> | |
| 164 <b>__createKey</b>(<i>url, realm</i>) | |
| 165 | |
| 166 <p> | |
| 167 Private method to create the key string for the login credentials. | |
| 168 </p> | |
| 169 <dl> | |
| 170 | |
| 171 <dt><i>url</i></dt> | |
| 172 <dd> | |
| 173 URL to get the credentials for (QUrl) | |
| 174 </dd> | |
| 175 <dt><i>realm</i></dt> | |
| 176 <dd> | |
| 177 realm to get the credentials for (string) | |
| 178 </dd> | |
| 179 </dl> | |
| 180 <dl> | |
| 181 <dt>Return:</dt> | |
| 182 <dd> | |
| 183 key string (string) | |
| 184 </dd> | |
| 185 </dl> | |
| 186 <a NAME="PasswordManager.__load" ID="PasswordManager.__load"></a> | |
| 187 <h4>PasswordManager.__load</h4> | |
| 188 <b>__load</b>(<i></i>) | |
| 189 | |
| 190 <p> | |
| 191 Private method to load the saved login credentials. | |
| 192 </p> | |
| 193 <a NAME="PasswordManager.__stripUrl" ID="PasswordManager.__stripUrl"></a> | |
| 194 <h4>PasswordManager.__stripUrl</h4> | |
| 195 <b>__stripUrl</b>(<i>url</i>) | |
| 196 | |
| 197 <p> | |
| 198 Private method to strip off all unneeded parts of a URL. | |
| 199 </p> | |
| 200 <dl> | |
| 201 | |
| 202 <dt><i>url</i></dt> | |
| 203 <dd> | |
| 204 URL to be stripped (QUrl) | |
| 205 </dd> | |
| 206 </dl> | |
| 207 <dl> | |
| 208 <dt>Return:</dt> | |
| 209 <dd> | |
| 210 stripped URL (QUrl) | |
| 211 </dd> | |
| 212 </dl> | |
| 213 <a NAME="PasswordManager.allSiteNames" ID="PasswordManager.allSiteNames"></a> | |
| 214 <h4>PasswordManager.allSiteNames</h4> | |
| 215 <b>allSiteNames</b>(<i></i>) | |
| 216 | |
| 217 <p> | |
| 218 Public method to get a list of all site names. | |
| 219 </p> | |
| 220 <dl> | |
| 221 <dt>Return:</dt> | |
| 222 <dd> | |
| 223 sorted list of all site names (list of strings) | |
| 224 </dd> | |
| 225 </dl> | |
| 226 <a NAME="PasswordManager.clear" ID="PasswordManager.clear"></a> | |
| 227 <h4>PasswordManager.clear</h4> | |
| 228 <b>clear</b>(<i></i>) | |
| 229 | |
| 230 <p> | |
| 231 Public slot to clear the saved passwords. | |
| 232 </p> | |
| 233 <a NAME="PasswordManager.close" ID="PasswordManager.close"></a> | |
| 234 <h4>PasswordManager.close</h4> | |
| 235 <b>close</b>(<i></i>) | |
| 236 | |
| 237 <p> | |
| 238 Public method to close the passwords manager. | |
| 239 </p> | |
| 240 <a NAME="PasswordManager.completePage" ID="PasswordManager.completePage"></a> | |
| 241 <h4>PasswordManager.completePage</h4> | |
| 242 <b>completePage</b>(<i>page</i>) | |
| 243 | |
| 244 <p> | |
| 245 Public slot to complete login forms with saved data. | |
| 246 </p> | |
| 247 <dl> | |
| 248 | |
| 249 <dt><i>page</i></dt> | |
| 250 <dd> | |
| 251 reference to the web page (WebBrowserPage) | |
| 252 </dd> | |
| 253 </dl> | |
| 254 <a NAME="PasswordManager.formSubmitted" ID="PasswordManager.formSubmitted"></a> | |
| 255 <h4>PasswordManager.formSubmitted</h4> | |
| 256 <b>formSubmitted</b>(<i>urlStr, userName, password, data, page</i>) | |
| 257 | |
| 258 <p> | |
| 259 Public method to record login data. | |
| 260 </p> | |
| 261 <dl> | |
| 262 | |
| 263 <dt><i>urlStr</i> (str)</dt> | |
| 264 <dd> | |
| 265 form submission URL | |
| 266 </dd> | |
| 267 <dt><i>userName</i> (str)</dt> | |
| 268 <dd> | |
| 269 name of the user | |
| 270 </dd> | |
| 271 <dt><i>password</i> (str)</dt> | |
| 272 <dd> | |
| 273 user password | |
| 274 </dd> | |
| 275 <dt><i>data</i> (QByteArray)</dt> | |
| 276 <dd> | |
| 277 data to be submitted | |
| 278 </dd> | |
| 279 <dt><i>page</i> (QWebEnginePage)</dt> | |
| 280 <dd> | |
| 281 reference to the calling page | |
| 282 </dd> | |
| 283 </dl> | |
| 284 <a NAME="PasswordManager.getFileName" ID="PasswordManager.getFileName"></a> | |
| 285 <h4>PasswordManager.getFileName</h4> | |
| 286 <b>getFileName</b>(<i></i>) | |
| 287 | |
| 288 <p> | |
| 289 Public method to get the file name of the passwords file. | |
| 290 </p> | |
| 291 <dl> | |
| 292 <dt>Return:</dt> | |
| 293 <dd> | |
| 294 name of the passwords file (string) | |
| 295 </dd> | |
| 296 </dl> | |
| 297 <a NAME="PasswordManager.getLogin" ID="PasswordManager.getLogin"></a> | |
| 298 <h4>PasswordManager.getLogin</h4> | |
| 299 <b>getLogin</b>(<i>url, realm</i>) | |
| 300 | |
| 301 <p> | |
| 302 Public method to get the login credentials. | |
| 303 </p> | |
| 304 <dl> | |
| 305 | |
| 306 <dt><i>url</i></dt> | |
| 307 <dd> | |
| 308 URL to get the credentials for (QUrl) | |
| 309 </dd> | |
| 310 <dt><i>realm</i></dt> | |
| 311 <dd> | |
| 312 realm to get the credentials for (string) | |
| 313 </dd> | |
| 314 </dl> | |
| 315 <dl> | |
| 316 <dt>Return:</dt> | |
| 317 <dd> | |
| 318 tuple containing the user name (string) and password (string) | |
| 319 </dd> | |
| 320 </dl> | |
| 321 <a NAME="PasswordManager.masterPasswordChanged" ID="PasswordManager.masterPasswordChanged"></a> | |
| 322 <h4>PasswordManager.masterPasswordChanged</h4> | |
| 323 <b>masterPasswordChanged</b>(<i>oldPassword, newPassword</i>) | |
| 324 | |
| 325 <p> | |
| 326 Public slot to handle the change of the master password. | |
| 327 </p> | |
| 328 <dl> | |
| 329 | |
| 330 <dt><i>oldPassword</i></dt> | |
| 331 <dd> | |
| 332 current master password (string) | |
| 333 </dd> | |
| 334 <dt><i>newPassword</i></dt> | |
| 335 <dd> | |
| 336 new master password (string) | |
| 337 </dd> | |
| 338 </dl> | |
| 339 <a NAME="PasswordManager.reload" ID="PasswordManager.reload"></a> | |
| 340 <h4>PasswordManager.reload</h4> | |
| 341 <b>reload</b>(<i></i>) | |
| 342 | |
| 343 <p> | |
| 344 Public method to reload the login data. | |
| 345 </p> | |
| 346 <a NAME="PasswordManager.removePassword" ID="PasswordManager.removePassword"></a> | |
| 347 <h4>PasswordManager.removePassword</h4> | |
| 348 <b>removePassword</b>(<i>site</i>) | |
| 349 | |
| 350 <p> | |
| 351 Public method to remove a password entry. | |
| 352 </p> | |
| 353 <dl> | |
| 354 | |
| 355 <dt><i>site</i></dt> | |
| 356 <dd> | |
| 357 web site name (string) | |
| 358 </dd> | |
| 359 </dl> | |
| 360 <a NAME="PasswordManager.save" ID="PasswordManager.save"></a> | |
| 361 <h4>PasswordManager.save</h4> | |
| 362 <b>save</b>(<i></i>) | |
| 363 | |
| 364 <p> | |
| 365 Public slot to save the login entries to disk. | |
| 366 </p> | |
| 367 <a NAME="PasswordManager.setLogin" ID="PasswordManager.setLogin"></a> | |
| 368 <h4>PasswordManager.setLogin</h4> | |
| 369 <b>setLogin</b>(<i>url, realm, username, password</i>) | |
| 370 | |
| 371 <p> | |
| 372 Public method to set the login credentials. | |
| 373 </p> | |
| 374 <dl> | |
| 375 | |
| 376 <dt><i>url</i></dt> | |
| 377 <dd> | |
| 378 URL to set the credentials for (QUrl) | |
| 379 </dd> | |
| 380 <dt><i>realm</i></dt> | |
| 381 <dd> | |
| 382 realm to set the credentials for (string) | |
| 383 </dd> | |
| 384 <dt><i>username</i></dt> | |
| 385 <dd> | |
| 386 username for the login (string) | |
| 387 </dd> | |
| 388 <dt><i>password</i></dt> | |
| 389 <dd> | |
| 390 password for the login (string) | |
| 391 </dd> | |
| 392 </dl> | |
| 393 <a NAME="PasswordManager.siteInfo" ID="PasswordManager.siteInfo"></a> | |
| 394 <h4>PasswordManager.siteInfo</h4> | |
| 395 <b>siteInfo</b>(<i>site</i>) | |
| 396 | |
| 397 <p> | |
| 398 Public method to get a reference to the named site. | |
| 399 </p> | |
| 400 <dl> | |
| 401 | |
| 402 <dt><i>site</i></dt> | |
| 403 <dd> | |
| 404 web site name (string) | |
| 405 </dd> | |
| 406 </dl> | |
| 407 <dl> | |
| 408 <dt>Return:</dt> | |
| 409 <dd> | |
| 410 tuple containing the user name (string) and password (string) | |
| 411 </dd> | |
| 412 </dl> | |
| 413 <a NAME="PasswordManager.sitesCount" ID="PasswordManager.sitesCount"></a> | |
| 414 <h4>PasswordManager.sitesCount</h4> | |
| 415 <b>sitesCount</b>(<i></i>) | |
| 416 | |
| 417 <p> | |
| 418 Public method to get the number of available sites. | |
| 419 </p> | |
| 420 <dl> | |
| 421 <dt>Return:</dt> | |
| 422 <dd> | |
| 423 number of sites (integer) | |
| 424 </dd> | |
| 425 </dl> | |
| 426 <div align="right"><a href="#top">Up</a></div> | |
| 427 <hr /> | |
| 428 </body></html> |
