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

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

eric ide

mercurial