src/eric7/Documentation/Source/eric7.WebBrowser.Passwords.PasswordWriter.html

<!DOCTYPE html>
<html><head>
<title>eric7.WebBrowser.Passwords.PasswordWriter</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.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 />
<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>
<td><a href="#PasswordWriter.__write">__write</a></td>
<td>Private method to write an login data file.</td>
</tr>
<tr>
<td><a href="#PasswordWriter.__writeForms">__writeForms</a></td>
<td>Private method to write forms data.</td>
</tr>
<tr>
<td><a href="#PasswordWriter.__writeLogins">__writeLogins</a></td>
<td>Private method to write the login data.</td>
</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>
<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>
<h4>PasswordWriter.__write</h4>
<b>__write</b>(<i>logins, forms, nevers</i>)
<p>
        Private method to write an login data file.
</p>

<dl>

<dt><i>logins</i> (dict)</dt>
<dd>
dictionary with login data (user name, password)
</dd>
<dt><i>forms</i> (list of LoginForm)</dt>
<dd>
list of forms data
</dd>
<dt><i>nevers</i> (list of str)</dt>
<dd>
list of URLs to never store data for
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
flag indicating success
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</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>

<dt><i>forms</i> (list of LoginForm)</dt>
<dd>
list of forms data
</dd>
</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>

<dt><i>logins</i> (dict)</dt>
<dd>
dictionary with login data (user name, password)
</dd>
</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>

<dt><i>nevers</i> (list of str)</dt>
<dd>
list of URLs to never store data for
</dd>
</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>

<dt><i>fileNameOrDevice</i> (str or QIODevice)</dt>
<dd>
name of the file to write or device to write to
</dd>
<dt><i>logins</i> (dict)</dt>
<dd>
dictionary with login data (user name, password)
</dd>
<dt><i>forms</i> (list of LoginForm)</dt>
<dd>
list of forms data
</dd>
<dt><i>nevers</i> (list of str)</dt>
<dd>
list of URLs to never store data for
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
flag indicating success
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>