|
1 <?xml version="1.0" encoding="utf-8"?> |
|
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' |
|
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> |
|
4 <html><head> |
|
5 <title>eric5.UI.AuthenticationDialog</title> |
|
6 <style> |
|
7 b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' |
|
8 </style> |
|
9 </head> |
|
10 <body><a NAME="top" ID="top"></a> |
|
11 <h1>eric5.UI.AuthenticationDialog</h1> |
|
12 <p> |
|
13 Module implementing the authentication dialog for the help browser. |
|
14 </p> |
|
15 <h3>Global Attributes</h3> |
|
16 <table> |
|
17 <tr><td>None</td></tr> |
|
18 </table> |
|
19 <h3>Classes</h3> |
|
20 <table> |
|
21 <tr> |
|
22 <td><a href="#AuthenticationDialog">AuthenticationDialog</a></td> |
|
23 <td>Class implementing the authentication dialog for the help browser.</td> |
|
24 </tr> |
|
25 </table> |
|
26 <h3>Functions</h3> |
|
27 <table> |
|
28 <tr><td>None</td></tr> |
|
29 </table> |
|
30 <hr /><hr /> |
|
31 <a NAME="AuthenticationDialog" ID="AuthenticationDialog"></a> |
|
32 <h2>AuthenticationDialog</h2> |
|
33 <p> |
|
34 Class implementing the authentication dialog for the help browser. |
|
35 </p> |
|
36 <h3>Derived from</h3> |
|
37 QDialog, Ui_AuthenticationDialog |
|
38 <h3>Class Attributes</h3> |
|
39 <table> |
|
40 <tr><td>None</td></tr> |
|
41 </table> |
|
42 <h3>Methods</h3> |
|
43 <table> |
|
44 <tr> |
|
45 <td><a href="#AuthenticationDialog.__init__">AuthenticationDialog</a></td> |
|
46 <td>Constructor</td> |
|
47 </tr><tr> |
|
48 <td><a href="#AuthenticationDialog.getData">getData</a></td> |
|
49 <td>Public method to retrieve the login data.</td> |
|
50 </tr><tr> |
|
51 <td><a href="#AuthenticationDialog.setData">setData</a></td> |
|
52 <td>Public method to set the login data.</td> |
|
53 </tr><tr> |
|
54 <td><a href="#AuthenticationDialog.shallSave">shallSave</a></td> |
|
55 <td>Public method to check, if the login data shall be saved.</td> |
|
56 </tr> |
|
57 </table> |
|
58 <a NAME="AuthenticationDialog.__init__" ID="AuthenticationDialog.__init__"></a> |
|
59 <h4>AuthenticationDialog (Constructor)</h4> |
|
60 <b>AuthenticationDialog</b>(<i>info, username, showSave = False, saveIt = False, parent = None</i>) |
|
61 <p> |
|
62 Constructor |
|
63 </p><dl> |
|
64 <dt><i>info</i></dt> |
|
65 <dd> |
|
66 information to be shown (string) |
|
67 </dd><dt><i>username</i></dt> |
|
68 <dd> |
|
69 username as supplied by subversion (string) |
|
70 </dd><dt><i>showSave</i></dt> |
|
71 <dd> |
|
72 flag to indicate to show the save checkbox (boolean) |
|
73 </dd><dt><i>saveIt</i></dt> |
|
74 <dd> |
|
75 flag indicating the value for the save checkbox (boolean) |
|
76 </dd> |
|
77 </dl><a NAME="AuthenticationDialog.getData" ID="AuthenticationDialog.getData"></a> |
|
78 <h4>AuthenticationDialog.getData</h4> |
|
79 <b>getData</b>(<i></i>) |
|
80 <p> |
|
81 Public method to retrieve the login data. |
|
82 </p><dl> |
|
83 <dt>Returns:</dt> |
|
84 <dd> |
|
85 tuple of two string values (username, password) |
|
86 </dd> |
|
87 </dl><a NAME="AuthenticationDialog.setData" ID="AuthenticationDialog.setData"></a> |
|
88 <h4>AuthenticationDialog.setData</h4> |
|
89 <b>setData</b>(<i>username, password</i>) |
|
90 <p> |
|
91 Public method to set the login data. |
|
92 </p><dl> |
|
93 <dt><i>username</i></dt> |
|
94 <dd> |
|
95 username (string) |
|
96 </dd><dt><i>password</i></dt> |
|
97 <dd> |
|
98 password (string) |
|
99 </dd> |
|
100 </dl><a NAME="AuthenticationDialog.shallSave" ID="AuthenticationDialog.shallSave"></a> |
|
101 <h4>AuthenticationDialog.shallSave</h4> |
|
102 <b>shallSave</b>(<i></i>) |
|
103 <p> |
|
104 Public method to check, if the login data shall be saved. |
|
105 </p><dl> |
|
106 <dt>Returns:</dt> |
|
107 <dd> |
|
108 flag indicating that the login data shall be saved (boolean) |
|
109 </dd> |
|
110 </dl> |
|
111 <div align="right"><a href="#top">Up</a></div> |
|
112 <hr /> |
|
113 </body></html> |