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

changeset 4918
71caf42a13d8
diff -r 682750cc7bd5 -r 71caf42a13d8 Documentation/Source/eric6.WebBrowser.Passwords.PasswordWriter.html
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric6.WebBrowser.Passwords.PasswordWriter.html	Sun Apr 03 17:10:43 2016 +0200
@@ -0,0 +1,167 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric6.WebBrowser.Passwords.PasswordWriter</title>
+<meta charset="UTF-8">
+<style>
+body {
+    background: #EDECE6;
+    margin: 0em 1em 10em 1em;
+    color: black;
+}
+
+h1 { color: white; background: #85774A; }
+h2 { color: white; background: #85774A; }
+h3 { color: white; background: #9D936E; }
+h4 { color: white; background: #9D936E; }
+    
+a { color: #BA6D36; }
+
+</style>
+</head>
+<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 />
+<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></dt>
+<dd>
+dictionary with login data (user name, password)
+</dd><dt><i>forms</i></dt>
+<dd>
+list of forms data (list of LoginForm)
+</dd><dt><i>nevers</i></dt>
+<dd>
+list of URLs to never store data for (list of strings)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating success (boolean)
+</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></dt>
+<dd>
+list of forms data (list of LoginForm)
+</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></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></dt>
+<dd>
+list of URLs to never store data for (list of strings)
+</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></dt>
+<dd>
+name of the file to write (string)
+            or device to write to (QIODevice)
+</dd><dt><i>logins</i></dt>
+<dd>
+dictionary with login data (user name, password)
+</dd><dt><i>forms</i></dt>
+<dd>
+list of forms data (list of LoginForm)
+</dd><dt><i>nevers</i></dt>
+<dd>
+list of URLs to never store data for (list of strings)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating success (boolean)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial