eric7/Documentation/Source/eric7.UI.AuthenticationDialog.html

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
equal deleted inserted replaced
8371:d6062691d424 8372:e0227a7c850e
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.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>
22 <a NAME="top" ID="top"></a>
23 <h1>eric7.UI.AuthenticationDialog</h1>
24
25 <p>
26 Module implementing the authentication dialog for the help browser.
27 </p>
28 <h3>Global Attributes</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <h3>Classes</h3>
34
35 <table>
36
37 <tr>
38 <td><a href="#AuthenticationDialog">AuthenticationDialog</a></td>
39 <td>Class implementing the authentication dialog for the help browser.</td>
40 </tr>
41 </table>
42 <h3>Functions</h3>
43
44 <table>
45 <tr><td>None</td></tr>
46 </table>
47 <hr />
48 <hr />
49 <a NAME="AuthenticationDialog" ID="AuthenticationDialog"></a>
50 <h2>AuthenticationDialog</h2>
51
52 <p>
53 Class implementing the authentication dialog for the help browser.
54 </p>
55 <h3>Derived from</h3>
56 QDialog, Ui_AuthenticationDialog
57 <h3>Class Attributes</h3>
58
59 <table>
60 <tr><td>None</td></tr>
61 </table>
62 <h3>Class Methods</h3>
63
64 <table>
65 <tr><td>None</td></tr>
66 </table>
67 <h3>Methods</h3>
68
69 <table>
70
71 <tr>
72 <td><a href="#AuthenticationDialog.__init__">AuthenticationDialog</a></td>
73 <td>Constructor</td>
74 </tr>
75 <tr>
76 <td><a href="#AuthenticationDialog.getData">getData</a></td>
77 <td>Public method to retrieve the login data.</td>
78 </tr>
79 <tr>
80 <td><a href="#AuthenticationDialog.setData">setData</a></td>
81 <td>Public method to set the login data.</td>
82 </tr>
83 <tr>
84 <td><a href="#AuthenticationDialog.shallSave">shallSave</a></td>
85 <td>Public method to check, if the login data shall be saved.</td>
86 </tr>
87 </table>
88 <h3>Static Methods</h3>
89
90 <table>
91 <tr><td>None</td></tr>
92 </table>
93
94 <a NAME="AuthenticationDialog.__init__" ID="AuthenticationDialog.__init__"></a>
95 <h4>AuthenticationDialog (Constructor)</h4>
96 <b>AuthenticationDialog</b>(<i>info, username, showSave=False, saveIt=False, parent=None</i>)
97
98 <p>
99 Constructor
100 </p>
101 <dl>
102
103 <dt><i>info</i></dt>
104 <dd>
105 information to be shown (string)
106 </dd>
107 <dt><i>username</i></dt>
108 <dd>
109 username as supplied by subversion (string)
110 </dd>
111 <dt><i>showSave</i></dt>
112 <dd>
113 flag to indicate to show the save checkbox (boolean)
114 </dd>
115 <dt><i>saveIt</i></dt>
116 <dd>
117 flag indicating the value for the save checkbox (boolean)
118 </dd>
119 <dt><i>parent</i></dt>
120 <dd>
121 reference to the parent widget (QWidget)
122 </dd>
123 </dl>
124 <a NAME="AuthenticationDialog.getData" ID="AuthenticationDialog.getData"></a>
125 <h4>AuthenticationDialog.getData</h4>
126 <b>getData</b>(<i></i>)
127
128 <p>
129 Public method to retrieve the login data.
130 </p>
131 <dl>
132 <dt>Return:</dt>
133 <dd>
134 tuple of two string values (username, password)
135 </dd>
136 </dl>
137 <a NAME="AuthenticationDialog.setData" ID="AuthenticationDialog.setData"></a>
138 <h4>AuthenticationDialog.setData</h4>
139 <b>setData</b>(<i>username, password</i>)
140
141 <p>
142 Public method to set the login data.
143 </p>
144 <dl>
145
146 <dt><i>username</i></dt>
147 <dd>
148 username (string)
149 </dd>
150 <dt><i>password</i></dt>
151 <dd>
152 password (string)
153 </dd>
154 </dl>
155 <a NAME="AuthenticationDialog.shallSave" ID="AuthenticationDialog.shallSave"></a>
156 <h4>AuthenticationDialog.shallSave</h4>
157 <b>shallSave</b>(<i></i>)
158
159 <p>
160 Public method to check, if the login data shall be saved.
161 </p>
162 <dl>
163 <dt>Return:</dt>
164 <dd>
165 flag indicating that the login data shall be saved (boolean)
166 </dd>
167 </dl>
168 <div align="right"><a href="#top">Up</a></div>
169 <hr />
170 </body></html>

eric ide

mercurial