--- a/eric6/Documentation/Source/eric6.WebBrowser.Passwords.PasswordWriter.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.WebBrowser.Passwords.PasswordWriter.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,145 +18,192 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.WebBrowser.Passwords.PasswordWriter</h1> + <p> Module implementing a class to write login data files. </p> <h3>Global Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#PasswordWriter">PasswordWriter</a></td> <td>Class implementing a writer object to generate login data files.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="PasswordWriter" ID="PasswordWriter"></a> <h2>PasswordWriter</h2> + <p> Class implementing a writer object to generate login data files. </p> <h3>Derived from</h3> QXmlStreamWriter <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="#PasswordWriter.__init__">PasswordWriter</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#PasswordWriter.__write">__write</a></td> <td>Private method to write an login data file.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PasswordWriter.__writeForms">__writeForms</a></td> <td>Private method to write forms data.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PasswordWriter.__writeLogins">__writeLogins</a></td> <td>Private method to write the login data.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PasswordWriter.__writeNevers">__writeNevers</a></td> <td>Private method to write the URLs never to store login data for.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PasswordWriter.write">write</a></td> <td>Public method to write an login data file.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="PasswordWriter.__init__" ID="PasswordWriter.__init__"></a> <h4>PasswordWriter (Constructor)</h4> <b>PasswordWriter</b>(<i></i>) + <p> Constructor -</p><a NAME="PasswordWriter.__write" ID="PasswordWriter.__write"></a> +</p> +<a NAME="PasswordWriter.__write" ID="PasswordWriter.__write"></a> <h4>PasswordWriter.__write</h4> <b>__write</b>(<i>logins, forms, nevers</i>) + <p> Private method to write an login data file. -</p><dl> +</p> +<dl> + <dt><i>logins</i></dt> <dd> dictionary with login data (user name, password) -</dd><dt><i>forms</i></dt> +</dd> +<dt><i>forms</i></dt> <dd> list of forms data (list of LoginForm) -</dd><dt><i>nevers</i></dt> +</dd> +<dt><i>nevers</i></dt> <dd> list of URLs to never store data for (list of strings) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> flag indicating success (boolean) </dd> -</dl><a NAME="PasswordWriter.__writeForms" ID="PasswordWriter.__writeForms"></a> +</dl> +<a NAME="PasswordWriter.__writeForms" ID="PasswordWriter.__writeForms"></a> <h4>PasswordWriter.__writeForms</h4> <b>__writeForms</b>(<i>forms</i>) + <p> Private method to write forms data. -</p><dl> +</p> +<dl> + <dt><i>forms</i></dt> <dd> list of forms data (list of LoginForm) </dd> -</dl><a NAME="PasswordWriter.__writeLogins" ID="PasswordWriter.__writeLogins"></a> +</dl> +<a NAME="PasswordWriter.__writeLogins" ID="PasswordWriter.__writeLogins"></a> <h4>PasswordWriter.__writeLogins</h4> <b>__writeLogins</b>(<i>logins</i>) + <p> Private method to write the login data. -</p><dl> +</p> +<dl> + <dt><i>logins</i></dt> <dd> dictionary with login data (user name, password) </dd> -</dl><a NAME="PasswordWriter.__writeNevers" ID="PasswordWriter.__writeNevers"></a> +</dl> +<a NAME="PasswordWriter.__writeNevers" ID="PasswordWriter.__writeNevers"></a> <h4>PasswordWriter.__writeNevers</h4> <b>__writeNevers</b>(<i>nevers</i>) + <p> Private method to write the URLs never to store login data for. -</p><dl> +</p> +<dl> + <dt><i>nevers</i></dt> <dd> list of URLs to never store data for (list of strings) </dd> -</dl><a NAME="PasswordWriter.write" ID="PasswordWriter.write"></a> +</dl> +<a NAME="PasswordWriter.write" ID="PasswordWriter.write"></a> <h4>PasswordWriter.write</h4> <b>write</b>(<i>fileNameOrDevice, logins, forms, nevers</i>) + <p> Public method to write an login data file. -</p><dl> +</p> +<dl> + <dt><i>fileNameOrDevice</i></dt> <dd> name of the file to write (string) or device to write to (QIODevice) -</dd><dt><i>logins</i></dt> +</dd> +<dt><i>logins</i></dt> <dd> dictionary with login data (user name, password) -</dd><dt><i>forms</i></dt> +</dd> +<dt><i>forms</i></dt> <dd> list of forms data (list of LoginForm) -</dd><dt><i>nevers</i></dt> +</dd> +<dt><i>nevers</i></dt> <dd> list of URLs to never store data for (list of strings) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> flag indicating success (boolean)