eric6/Documentation/Source/eric6.WebBrowser.Passwords.PasswordManager.html

changeset 7273
391d6b7b1eff
parent 6942
2602857055c5
child 7989
a21d673a8f99
--- a/eric6/Documentation/Source/eric6.WebBrowser.Passwords.PasswordManager.html	Wed Sep 25 19:40:31 2019 +0200
+++ b/eric6/Documentation/Source/eric6.WebBrowser.Passwords.PasswordManager.html	Wed Sep 25 19:42:44 2019 +0200
@@ -18,37 +18,48 @@
 
 </style>
 </head>
-<body><a NAME="top" ID="top"></a>
+<body>
+<a NAME="top" ID="top"></a>
 <h1>eric6.WebBrowser.Passwords.PasswordManager</h1>
+
 <p>
 Module implementing the password manager.
 </p>
 <h3>Global Attributes</h3>
+
 <table>
 <tr><td>None</td></tr>
 </table>
 <h3>Classes</h3>
+
 <table>
+
 <tr>
 <td><a href="#PasswordManager">PasswordManager</a></td>
 <td>Class implementing the password manager.</td>
 </tr>
 </table>
 <h3>Functions</h3>
+
 <table>
 <tr><td>None</td></tr>
 </table>
-<hr /><hr />
+<hr />
+<hr />
 <a NAME="PasswordManager" ID="PasswordManager"></a>
 <h2>PasswordManager</h2>
+
 <p>
     Class implementing the password manager.
-</p><h3>Signals</h3>
+</p>
+<h3>Signals</h3>
 <dl>
+
 <dt>changed()</dt>
 <dd>
 emitted to indicate a change
-</dd><dt>passwordsSaved()</dt>
+</dd>
+<dt>passwordsSaved()</dt>
 <dd>
 emitted after the passwords were saved
 </dd>
@@ -56,276 +67,371 @@
 <h3>Derived from</h3>
 QObject
 <h3>Class Attributes</h3>
+
 <table>
 <tr><td>None</td></tr>
 </table>
 <h3>Class Methods</h3>
+
 <table>
 <tr><td>None</td></tr>
 </table>
 <h3>Methods</h3>
+
 <table>
+
 <tr>
 <td><a href="#PasswordManager.__init__">PasswordManager</a></td>
 <td>Constructor</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#PasswordManager.__createKey">__createKey</a></td>
 <td>Private method to create the key string for the login credentials.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#PasswordManager.__load">__load</a></td>
 <td>Private method to load the saved login credentials.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#PasswordManager.__stripUrl">__stripUrl</a></td>
 <td>Private method to strip off all unneeded parts of a URL.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#PasswordManager.allSiteNames">allSiteNames</a></td>
 <td>Public method to get a list of all site names.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#PasswordManager.clear">clear</a></td>
 <td>Public slot to clear the saved passwords.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#PasswordManager.close">close</a></td>
 <td>Public method to close the passwords manager.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#PasswordManager.completePage">completePage</a></td>
 <td>Public slot to complete login forms with saved data.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#PasswordManager.formSubmitted">formSubmitted</a></td>
 <td>Public method to record login data.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#PasswordManager.getFileName">getFileName</a></td>
 <td>Public method to get the file name of the passwords file.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#PasswordManager.getLogin">getLogin</a></td>
 <td>Public method to get the login credentials.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#PasswordManager.masterPasswordChanged">masterPasswordChanged</a></td>
 <td>Public slot to handle the change of the master password.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#PasswordManager.reload">reload</a></td>
 <td>Public method to reload the login data.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#PasswordManager.removePassword">removePassword</a></td>
 <td>Public method to remove a password entry.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#PasswordManager.save">save</a></td>
 <td>Public slot to save the login entries to disk.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#PasswordManager.setLogin">setLogin</a></td>
 <td>Public method to set the login credentials.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#PasswordManager.siteInfo">siteInfo</a></td>
 <td>Public method to get a reference to the named site.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#PasswordManager.sitesCount">sitesCount</a></td>
 <td>Public method to get the number of available sites.</td>
 </tr>
 </table>
 <h3>Static Methods</h3>
+
 <table>
 <tr><td>None</td></tr>
 </table>
+
 <a NAME="PasswordManager.__init__" ID="PasswordManager.__init__"></a>
 <h4>PasswordManager (Constructor)</h4>
 <b>PasswordManager</b>(<i>parent=None</i>)
+
 <p>
         Constructor
-</p><dl>
+</p>
+<dl>
+
 <dt><i>parent</i></dt>
 <dd>
 reference to the parent object (QObject)
 </dd>
-</dl><a NAME="PasswordManager.__createKey" ID="PasswordManager.__createKey"></a>
+</dl>
+<a NAME="PasswordManager.__createKey" ID="PasswordManager.__createKey"></a>
 <h4>PasswordManager.__createKey</h4>
 <b>__createKey</b>(<i>url, realm</i>)
+
 <p>
         Private method to create the key string for the login credentials.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>url</i></dt>
 <dd>
 URL to get the credentials for (QUrl)
-</dd><dt><i>realm</i></dt>
+</dd>
+<dt><i>realm</i></dt>
 <dd>
 realm to get the credentials for (string)
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Returns:</dt>
 <dd>
 key string (string)
 </dd>
-</dl><a NAME="PasswordManager.__load" ID="PasswordManager.__load"></a>
+</dl>
+<a NAME="PasswordManager.__load" ID="PasswordManager.__load"></a>
 <h4>PasswordManager.__load</h4>
 <b>__load</b>(<i></i>)
+
 <p>
         Private method to load the saved login credentials.
-</p><a NAME="PasswordManager.__stripUrl" ID="PasswordManager.__stripUrl"></a>
+</p>
+<a NAME="PasswordManager.__stripUrl" ID="PasswordManager.__stripUrl"></a>
 <h4>PasswordManager.__stripUrl</h4>
 <b>__stripUrl</b>(<i>url</i>)
+
 <p>
         Private method to strip off all unneeded parts of a URL.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>url</i></dt>
 <dd>
 URL to be stripped (QUrl)
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Returns:</dt>
 <dd>
 stripped URL (QUrl)
 </dd>
-</dl><a NAME="PasswordManager.allSiteNames" ID="PasswordManager.allSiteNames"></a>
+</dl>
+<a NAME="PasswordManager.allSiteNames" ID="PasswordManager.allSiteNames"></a>
 <h4>PasswordManager.allSiteNames</h4>
 <b>allSiteNames</b>(<i></i>)
+
 <p>
         Public method to get a list of all site names.
-</p><dl>
+</p>
+<dl>
 <dt>Returns:</dt>
 <dd>
 sorted list of all site names (list of strings)
 </dd>
-</dl><a NAME="PasswordManager.clear" ID="PasswordManager.clear"></a>
+</dl>
+<a NAME="PasswordManager.clear" ID="PasswordManager.clear"></a>
 <h4>PasswordManager.clear</h4>
 <b>clear</b>(<i></i>)
+
 <p>
         Public slot to clear the saved passwords.
-</p><a NAME="PasswordManager.close" ID="PasswordManager.close"></a>
+</p>
+<a NAME="PasswordManager.close" ID="PasswordManager.close"></a>
 <h4>PasswordManager.close</h4>
 <b>close</b>(<i></i>)
+
 <p>
         Public method to close the passwords manager.
-</p><a NAME="PasswordManager.completePage" ID="PasswordManager.completePage"></a>
+</p>
+<a NAME="PasswordManager.completePage" ID="PasswordManager.completePage"></a>
 <h4>PasswordManager.completePage</h4>
 <b>completePage</b>(<i>page</i>)
+
 <p>
         Public slot to complete login forms with saved data.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>page</i></dt>
 <dd>
 reference to the web page (WebBrowserPage)
 </dd>
-</dl><a NAME="PasswordManager.formSubmitted" ID="PasswordManager.formSubmitted"></a>
+</dl>
+<a NAME="PasswordManager.formSubmitted" ID="PasswordManager.formSubmitted"></a>
 <h4>PasswordManager.formSubmitted</h4>
 <b>formSubmitted</b>(<i>urlStr, userName, password, data, page</i>)
+
 <p>
         Public method to record login data.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>urlStr</i> (str)</dt>
 <dd>
 form submission URL
-</dd><dt><i>userName</i> (str)</dt>
+</dd>
+<dt><i>userName</i> (str)</dt>
 <dd>
 name of the user
-</dd><dt><i>password</i> (str)</dt>
+</dd>
+<dt><i>password</i> (str)</dt>
 <dd>
 user password
-</dd><dt><i>data</i> (QByteArray)</dt>
+</dd>
+<dt><i>data</i> (QByteArray)</dt>
 <dd>
 data to be submitted
-</dd><dt><i>page</i> (QWebEnginePage)</dt>
+</dd>
+<dt><i>page</i> (QWebEnginePage)</dt>
 <dd>
 reference to the calling page
 </dd>
-</dl><a NAME="PasswordManager.getFileName" ID="PasswordManager.getFileName"></a>
+</dl>
+<a NAME="PasswordManager.getFileName" ID="PasswordManager.getFileName"></a>
 <h4>PasswordManager.getFileName</h4>
 <b>getFileName</b>(<i></i>)
+
 <p>
         Public method to get the file name of the passwords file.
-</p><dl>
+</p>
+<dl>
 <dt>Returns:</dt>
 <dd>
 name of the passwords file (string)
 </dd>
-</dl><a NAME="PasswordManager.getLogin" ID="PasswordManager.getLogin"></a>
+</dl>
+<a NAME="PasswordManager.getLogin" ID="PasswordManager.getLogin"></a>
 <h4>PasswordManager.getLogin</h4>
 <b>getLogin</b>(<i>url, realm</i>)
+
 <p>
         Public method to get the login credentials.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>url</i></dt>
 <dd>
 URL to get the credentials for (QUrl)
-</dd><dt><i>realm</i></dt>
+</dd>
+<dt><i>realm</i></dt>
 <dd>
 realm to get the credentials for (string)
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Returns:</dt>
 <dd>
 tuple containing the user name (string) and password (string)
 </dd>
-</dl><a NAME="PasswordManager.masterPasswordChanged" ID="PasswordManager.masterPasswordChanged"></a>
+</dl>
+<a NAME="PasswordManager.masterPasswordChanged" ID="PasswordManager.masterPasswordChanged"></a>
 <h4>PasswordManager.masterPasswordChanged</h4>
 <b>masterPasswordChanged</b>(<i>oldPassword, newPassword</i>)
+
 <p>
         Public slot to handle the change of the master password.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>oldPassword</i></dt>
 <dd>
 current master password (string)
-</dd><dt><i>newPassword</i></dt>
+</dd>
+<dt><i>newPassword</i></dt>
 <dd>
 new master password (string)
 </dd>
-</dl><a NAME="PasswordManager.reload" ID="PasswordManager.reload"></a>
+</dl>
+<a NAME="PasswordManager.reload" ID="PasswordManager.reload"></a>
 <h4>PasswordManager.reload</h4>
 <b>reload</b>(<i></i>)
+
 <p>
         Public method to reload the login data.
-</p><a NAME="PasswordManager.removePassword" ID="PasswordManager.removePassword"></a>
+</p>
+<a NAME="PasswordManager.removePassword" ID="PasswordManager.removePassword"></a>
 <h4>PasswordManager.removePassword</h4>
 <b>removePassword</b>(<i>site</i>)
+
 <p>
         Public method to remove a password entry.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>site</i></dt>
 <dd>
 web site name (string)
 </dd>
-</dl><a NAME="PasswordManager.save" ID="PasswordManager.save"></a>
+</dl>
+<a NAME="PasswordManager.save" ID="PasswordManager.save"></a>
 <h4>PasswordManager.save</h4>
 <b>save</b>(<i></i>)
+
 <p>
         Public slot to save the login entries to disk.
-</p><a NAME="PasswordManager.setLogin" ID="PasswordManager.setLogin"></a>
+</p>
+<a NAME="PasswordManager.setLogin" ID="PasswordManager.setLogin"></a>
 <h4>PasswordManager.setLogin</h4>
 <b>setLogin</b>(<i>url, realm, username, password</i>)
+
 <p>
         Public method to set the login credentials.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>url</i></dt>
 <dd>
 URL to set the credentials for (QUrl)
-</dd><dt><i>realm</i></dt>
+</dd>
+<dt><i>realm</i></dt>
 <dd>
 realm to set the credentials for (string)
-</dd><dt><i>username</i></dt>
+</dd>
+<dt><i>username</i></dt>
 <dd>
 username for the login (string)
-</dd><dt><i>password</i></dt>
+</dd>
+<dt><i>password</i></dt>
 <dd>
 password for the login (string)
 </dd>
-</dl><a NAME="PasswordManager.siteInfo" ID="PasswordManager.siteInfo"></a>
+</dl>
+<a NAME="PasswordManager.siteInfo" ID="PasswordManager.siteInfo"></a>
 <h4>PasswordManager.siteInfo</h4>
 <b>siteInfo</b>(<i>site</i>)
+
 <p>
         Public method to get a reference to the named site.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>site</i></dt>
 <dd>
 web site name (string)
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Returns:</dt>
 <dd>
 tuple containing the user name (string) and password (string)
 </dd>
-</dl><a NAME="PasswordManager.sitesCount" ID="PasswordManager.sitesCount"></a>
+</dl>
+<a NAME="PasswordManager.sitesCount" ID="PasswordManager.sitesCount"></a>
 <h4>PasswordManager.sitesCount</h4>
 <b>sitesCount</b>(<i></i>)
+
 <p>
         Public method to get the number of available sites.
-</p><dl>
+</p>
+<dl>
 <dt>Returns:</dt>
 <dd>
 number of sites (integer)

eric ide

mercurial