Mercurial Repositories > eric / file comparison

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

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

branch
maintenance
changeset 6989
8b8cadf8d7e9
parent 6942
2602857055c5
child 7273
391d6b7b1eff
equal deleted inserted replaced
6938:7926553b7509 6989:8b8cadf8d7e9
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.WebBrowser.Passwords.PasswordManager</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body><a NAME="top" ID="top"></a>
22 <h1>eric6.WebBrowser.Passwords.PasswordManager</h1>
23 <p>
24 Module implementing the password manager.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#PasswordManager">PasswordManager</a></td>
34 <td>Class implementing the password manager.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="PasswordManager" ID="PasswordManager"></a>
43 <h2>PasswordManager</h2>
44 <p>
45 Class implementing the password manager.
46 </p><h3>Signals</h3>
47 <dl>
48 <dt>changed()</dt>
49 <dd>
50 emitted to indicate a change
51 </dd><dt>passwordsSaved()</dt>
52 <dd>
53 emitted after the passwords were saved
54 </dd>
55 </dl>
56 <h3>Derived from</h3>
57 QObject
58 <h3>Class Attributes</h3>
59 <table>
60 <tr><td>None</td></tr>
61 </table>
62 <h3>Class Methods</h3>
63 <table>
64 <tr><td>None</td></tr>
65 </table>
66 <h3>Methods</h3>
67 <table>
68 <tr>
69 <td><a href="#PasswordManager.__init__">PasswordManager</a></td>
70 <td>Constructor</td>
71 </tr><tr>
72 <td><a href="#PasswordManager.__createKey">__createKey</a></td>
73 <td>Private method to create the key string for the login credentials.</td>
74 </tr><tr>
75 <td><a href="#PasswordManager.__load">__load</a></td>
76 <td>Private method to load the saved login credentials.</td>
77 </tr><tr>
78 <td><a href="#PasswordManager.__stripUrl">__stripUrl</a></td>
79 <td>Private method to strip off all unneeded parts of a URL.</td>
80 </tr><tr>
81 <td><a href="#PasswordManager.allSiteNames">allSiteNames</a></td>
82 <td>Public method to get a list of all site names.</td>
83 </tr><tr>
84 <td><a href="#PasswordManager.clear">clear</a></td>
85 <td>Public slot to clear the saved passwords.</td>
86 </tr><tr>
87 <td><a href="#PasswordManager.close">close</a></td>
88 <td>Public method to close the passwords manager.</td>
89 </tr><tr>
90 <td><a href="#PasswordManager.completePage">completePage</a></td>
91 <td>Public slot to complete login forms with saved data.</td>
92 </tr><tr>
93 <td><a href="#PasswordManager.formSubmitted">formSubmitted</a></td>
94 <td>Public method to record login data.</td>
95 </tr><tr>
96 <td><a href="#PasswordManager.getFileName">getFileName</a></td>
97 <td>Public method to get the file name of the passwords file.</td>
98 </tr><tr>
99 <td><a href="#PasswordManager.getLogin">getLogin</a></td>
100 <td>Public method to get the login credentials.</td>
101 </tr><tr>
102 <td><a href="#PasswordManager.masterPasswordChanged">masterPasswordChanged</a></td>
103 <td>Public slot to handle the change of the master password.</td>
104 </tr><tr>
105 <td><a href="#PasswordManager.reload">reload</a></td>
106 <td>Public method to reload the login data.</td>
107 </tr><tr>
108 <td><a href="#PasswordManager.removePassword">removePassword</a></td>
109 <td>Public method to remove a password entry.</td>
110 </tr><tr>
111 <td><a href="#PasswordManager.save">save</a></td>
112 <td>Public slot to save the login entries to disk.</td>
113 </tr><tr>
114 <td><a href="#PasswordManager.setLogin">setLogin</a></td>
115 <td>Public method to set the login credentials.</td>
116 </tr><tr>
117 <td><a href="#PasswordManager.siteInfo">siteInfo</a></td>
118 <td>Public method to get a reference to the named site.</td>
119 </tr><tr>
120 <td><a href="#PasswordManager.sitesCount">sitesCount</a></td>
121 <td>Public method to get the number of available sites.</td>
122 </tr>
123 </table>
124 <h3>Static Methods</h3>
125 <table>
126 <tr><td>None</td></tr>
127 </table>
128 <a NAME="PasswordManager.__init__" ID="PasswordManager.__init__"></a>
129 <h4>PasswordManager (Constructor)</h4>
130 <b>PasswordManager</b>(<i>parent=None</i>)
131 <p>
132 Constructor
133 </p><dl>
134 <dt><i>parent</i></dt>
135 <dd>
136 reference to the parent object (QObject)
137 </dd>
138 </dl><a NAME="PasswordManager.__createKey" ID="PasswordManager.__createKey"></a>
139 <h4>PasswordManager.__createKey</h4>
140 <b>__createKey</b>(<i>url, realm</i>)
141 <p>
142 Private method to create the key string for the login credentials.
143 </p><dl>
144 <dt><i>url</i></dt>
145 <dd>
146 URL to get the credentials for (QUrl)
147 </dd><dt><i>realm</i></dt>
148 <dd>
149 realm to get the credentials for (string)
150 </dd>
151 </dl><dl>
152 <dt>Returns:</dt>
153 <dd>
154 key string (string)
155 </dd>
156 </dl><a NAME="PasswordManager.__load" ID="PasswordManager.__load"></a>
157 <h4>PasswordManager.__load</h4>
158 <b>__load</b>(<i></i>)
159 <p>
160 Private method to load the saved login credentials.
161 </p><a NAME="PasswordManager.__stripUrl" ID="PasswordManager.__stripUrl"></a>
162 <h4>PasswordManager.__stripUrl</h4>
163 <b>__stripUrl</b>(<i>url</i>)
164 <p>
165 Private method to strip off all unneeded parts of a URL.
166 </p><dl>
167 <dt><i>url</i></dt>
168 <dd>
169 URL to be stripped (QUrl)
170 </dd>
171 </dl><dl>
172 <dt>Returns:</dt>
173 <dd>
174 stripped URL (QUrl)
175 </dd>
176 </dl><a NAME="PasswordManager.allSiteNames" ID="PasswordManager.allSiteNames"></a>
177 <h4>PasswordManager.allSiteNames</h4>
178 <b>allSiteNames</b>(<i></i>)
179 <p>
180 Public method to get a list of all site names.
181 </p><dl>
182 <dt>Returns:</dt>
183 <dd>
184 sorted list of all site names (list of strings)
185 </dd>
186 </dl><a NAME="PasswordManager.clear" ID="PasswordManager.clear"></a>
187 <h4>PasswordManager.clear</h4>
188 <b>clear</b>(<i></i>)
189 <p>
190 Public slot to clear the saved passwords.
191 </p><a NAME="PasswordManager.close" ID="PasswordManager.close"></a>
192 <h4>PasswordManager.close</h4>
193 <b>close</b>(<i></i>)
194 <p>
195 Public method to close the passwords manager.
196 </p><a NAME="PasswordManager.completePage" ID="PasswordManager.completePage"></a>
197 <h4>PasswordManager.completePage</h4>
198 <b>completePage</b>(<i>page</i>)
199 <p>
200 Public slot to complete login forms with saved data.
201 </p><dl>
202 <dt><i>page</i></dt>
203 <dd>
204 reference to the web page (WebBrowserPage)
205 </dd>
206 </dl><a NAME="PasswordManager.formSubmitted" ID="PasswordManager.formSubmitted"></a>
207 <h4>PasswordManager.formSubmitted</h4>
208 <b>formSubmitted</b>(<i>urlStr, userName, password, data, page</i>)
209 <p>
210 Public method to record login data.
211 </p><dl>
212 <dt><i>urlStr</i> (str)</dt>
213 <dd>
214 form submission URL
215 </dd><dt><i>userName</i> (str)</dt>
216 <dd>
217 name of the user
218 </dd><dt><i>password</i> (str)</dt>
219 <dd>
220 user password
221 </dd><dt><i>data</i> (QByteArray)</dt>
222 <dd>
223 data to be submitted
224 </dd><dt><i>page</i> (QWebEnginePage)</dt>
225 <dd>
226 reference to the calling page
227 </dd>
228 </dl><a NAME="PasswordManager.getFileName" ID="PasswordManager.getFileName"></a>
229 <h4>PasswordManager.getFileName</h4>
230 <b>getFileName</b>(<i></i>)
231 <p>
232 Public method to get the file name of the passwords file.
233 </p><dl>
234 <dt>Returns:</dt>
235 <dd>
236 name of the passwords file (string)
237 </dd>
238 </dl><a NAME="PasswordManager.getLogin" ID="PasswordManager.getLogin"></a>
239 <h4>PasswordManager.getLogin</h4>
240 <b>getLogin</b>(<i>url, realm</i>)
241 <p>
242 Public method to get the login credentials.
243 </p><dl>
244 <dt><i>url</i></dt>
245 <dd>
246 URL to get the credentials for (QUrl)
247 </dd><dt><i>realm</i></dt>
248 <dd>
249 realm to get the credentials for (string)
250 </dd>
251 </dl><dl>
252 <dt>Returns:</dt>
253 <dd>
254 tuple containing the user name (string) and password (string)
255 </dd>
256 </dl><a NAME="PasswordManager.masterPasswordChanged" ID="PasswordManager.masterPasswordChanged"></a>
257 <h4>PasswordManager.masterPasswordChanged</h4>
258 <b>masterPasswordChanged</b>(<i>oldPassword, newPassword</i>)
259 <p>
260 Public slot to handle the change of the master password.
261 </p><dl>
262 <dt><i>oldPassword</i></dt>
263 <dd>
264 current master password (string)
265 </dd><dt><i>newPassword</i></dt>
266 <dd>
267 new master password (string)
268 </dd>
269 </dl><a NAME="PasswordManager.reload" ID="PasswordManager.reload"></a>
270 <h4>PasswordManager.reload</h4>
271 <b>reload</b>(<i></i>)
272 <p>
273 Public method to reload the login data.
274 </p><a NAME="PasswordManager.removePassword" ID="PasswordManager.removePassword"></a>
275 <h4>PasswordManager.removePassword</h4>
276 <b>removePassword</b>(<i>site</i>)
277 <p>
278 Public method to remove a password entry.
279 </p><dl>
280 <dt><i>site</i></dt>
281 <dd>
282 web site name (string)
283 </dd>
284 </dl><a NAME="PasswordManager.save" ID="PasswordManager.save"></a>
285 <h4>PasswordManager.save</h4>
286 <b>save</b>(<i></i>)
287 <p>
288 Public slot to save the login entries to disk.
289 </p><a NAME="PasswordManager.setLogin" ID="PasswordManager.setLogin"></a>
290 <h4>PasswordManager.setLogin</h4>
291 <b>setLogin</b>(<i>url, realm, username, password</i>)
292 <p>
293 Public method to set the login credentials.
294 </p><dl>
295 <dt><i>url</i></dt>
296 <dd>
297 URL to set the credentials for (QUrl)
298 </dd><dt><i>realm</i></dt>
299 <dd>
300 realm to set the credentials for (string)
301 </dd><dt><i>username</i></dt>
302 <dd>
303 username for the login (string)
304 </dd><dt><i>password</i></dt>
305 <dd>
306 password for the login (string)
307 </dd>
308 </dl><a NAME="PasswordManager.siteInfo" ID="PasswordManager.siteInfo"></a>
309 <h4>PasswordManager.siteInfo</h4>
310 <b>siteInfo</b>(<i>site</i>)
311 <p>
312 Public method to get a reference to the named site.
313 </p><dl>
314 <dt><i>site</i></dt>
315 <dd>
316 web site name (string)
317 </dd>
318 </dl><dl>
319 <dt>Returns:</dt>
320 <dd>
321 tuple containing the user name (string) and password (string)
322 </dd>
323 </dl><a NAME="PasswordManager.sitesCount" ID="PasswordManager.sitesCount"></a>
324 <h4>PasswordManager.sitesCount</h4>
325 <b>sitesCount</b>(<i></i>)
326 <p>
327 Public method to get the number of available sites.
328 </p><dl>
329 <dt>Returns:</dt>
330 <dd>
331 number of sites (integer)
332 </dd>
333 </dl>
334 <div align="right"><a href="#top">Up</a></div>
335 <hr />
336 </body></html>

Mercurial Repository: eric

eric ide

mercurial