src/eric7/Documentation/Source/eric7.EricWidgets.EricAuthenticationDialog.html

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

eric ide

mercurial