|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric6.UI.AuthenticationDialog</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.UI.AuthenticationDialog</h1> |
|
23 <p> |
|
24 Module implementing the authentication dialog for the help browser. |
|
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="#AuthenticationDialog">AuthenticationDialog</a></td> |
|
34 <td>Class implementing the authentication dialog for the help browser.</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="AuthenticationDialog" ID="AuthenticationDialog"></a> |
|
43 <h2>AuthenticationDialog</h2> |
|
44 <p> |
|
45 Class implementing the authentication dialog for the help browser. |
|
46 </p> |
|
47 <h3>Derived from</h3> |
|
48 QDialog, Ui_AuthenticationDialog |
|
49 <h3>Class Attributes</h3> |
|
50 <table> |
|
51 <tr><td>None</td></tr> |
|
52 </table> |
|
53 <h3>Class Methods</h3> |
|
54 <table> |
|
55 <tr><td>None</td></tr> |
|
56 </table> |
|
57 <h3>Methods</h3> |
|
58 <table> |
|
59 <tr> |
|
60 <td><a href="#AuthenticationDialog.__init__">AuthenticationDialog</a></td> |
|
61 <td>Constructor</td> |
|
62 </tr><tr> |
|
63 <td><a href="#AuthenticationDialog.getData">getData</a></td> |
|
64 <td>Public method to retrieve the login data.</td> |
|
65 </tr><tr> |
|
66 <td><a href="#AuthenticationDialog.setData">setData</a></td> |
|
67 <td>Public method to set the login data.</td> |
|
68 </tr><tr> |
|
69 <td><a href="#AuthenticationDialog.shallSave">shallSave</a></td> |
|
70 <td>Public method to check, if the login data shall be saved.</td> |
|
71 </tr> |
|
72 </table> |
|
73 <h3>Static Methods</h3> |
|
74 <table> |
|
75 <tr><td>None</td></tr> |
|
76 </table> |
|
77 <a NAME="AuthenticationDialog.__init__" ID="AuthenticationDialog.__init__"></a> |
|
78 <h4>AuthenticationDialog (Constructor)</h4> |
|
79 <b>AuthenticationDialog</b>(<i>info, username, showSave=False, saveIt=False, parent=None</i>) |
|
80 <p> |
|
81 Constructor |
|
82 </p><dl> |
|
83 <dt><i>info</i></dt> |
|
84 <dd> |
|
85 information to be shown (string) |
|
86 </dd><dt><i>username</i></dt> |
|
87 <dd> |
|
88 username as supplied by subversion (string) |
|
89 </dd><dt><i>showSave</i></dt> |
|
90 <dd> |
|
91 flag to indicate to show the save checkbox (boolean) |
|
92 </dd><dt><i>saveIt</i></dt> |
|
93 <dd> |
|
94 flag indicating the value for the save checkbox (boolean) |
|
95 </dd><dt><i>parent</i></dt> |
|
96 <dd> |
|
97 reference to the parent widget (QWidget) |
|
98 </dd> |
|
99 </dl><a NAME="AuthenticationDialog.getData" ID="AuthenticationDialog.getData"></a> |
|
100 <h4>AuthenticationDialog.getData</h4> |
|
101 <b>getData</b>(<i></i>) |
|
102 <p> |
|
103 Public method to retrieve the login data. |
|
104 </p><dl> |
|
105 <dt>Returns:</dt> |
|
106 <dd> |
|
107 tuple of two string values (username, password) |
|
108 </dd> |
|
109 </dl><a NAME="AuthenticationDialog.setData" ID="AuthenticationDialog.setData"></a> |
|
110 <h4>AuthenticationDialog.setData</h4> |
|
111 <b>setData</b>(<i>username, password</i>) |
|
112 <p> |
|
113 Public method to set the login data. |
|
114 </p><dl> |
|
115 <dt><i>username</i></dt> |
|
116 <dd> |
|
117 username (string) |
|
118 </dd><dt><i>password</i></dt> |
|
119 <dd> |
|
120 password (string) |
|
121 </dd> |
|
122 </dl><a NAME="AuthenticationDialog.shallSave" ID="AuthenticationDialog.shallSave"></a> |
|
123 <h4>AuthenticationDialog.shallSave</h4> |
|
124 <b>shallSave</b>(<i></i>) |
|
125 <p> |
|
126 Public method to check, if the login data shall be saved. |
|
127 </p><dl> |
|
128 <dt>Returns:</dt> |
|
129 <dd> |
|
130 flag indicating that the login data shall be saved (boolean) |
|
131 </dd> |
|
132 </dl> |
|
133 <div align="right"><a href="#top">Up</a></div> |
|
134 <hr /> |
|
135 </body></html> |