20 </style> |
20 </style> |
21 </head> |
21 </head> |
22 <body><a NAME="top" ID="top"></a> |
22 <body><a NAME="top" ID="top"></a> |
23 <h1>eric5.UI.AuthenticationDialog</h1> |
23 <h1>eric5.UI.AuthenticationDialog</h1> |
24 <p> |
24 <p> |
25 Module implementing the authentication dialog for the help browser. |
25 Module implementing the authentication dialog for the help browser. |
26 </p> |
26 </p> |
27 <h3>Global Attributes</h3> |
27 <h3>Global Attributes</h3> |
28 <table> |
28 <table> |
29 <tr><td>None</td></tr> |
29 <tr><td>None</td></tr> |
30 </table> |
30 </table> |
31 <h3>Classes</h3> |
31 <h3>Classes</h3> |
32 <table> |
32 <table> |
33 <tr> |
33 <tr> |
34 <td><a href="#AuthenticationDialog">AuthenticationDialog</a></td> |
34 <td><a href="#AuthenticationDialog">AuthenticationDialog</a></td> |
35 <td>Class implementing the authentication dialog for the help browser.</td> |
35 <td>Class implementing the authentication dialog for the help browser.</td> |
36 </tr> |
36 </tr> |
37 </table> |
37 </table> |
38 <h3>Functions</h3> |
38 <h3>Functions</h3> |
39 <table> |
39 <table> |
40 <tr><td>None</td></tr> |
40 <tr><td>None</td></tr> |
41 </table> |
41 </table> |
42 <hr /><hr /> |
42 <hr /><hr /> |
43 <a NAME="AuthenticationDialog" ID="AuthenticationDialog"></a> |
43 <a NAME="AuthenticationDialog" ID="AuthenticationDialog"></a> |
44 <h2>AuthenticationDialog</h2> |
44 <h2>AuthenticationDialog</h2> |
45 <p> |
45 <p> |
46 Class implementing the authentication dialog for the help browser. |
46 Class implementing the authentication dialog for the help browser. |
47 </p> |
47 </p> |
48 <h3>Derived from</h3> |
48 <h3>Derived from</h3> |
49 QDialog, Ui_AuthenticationDialog |
49 QDialog, Ui_AuthenticationDialog |
50 <h3>Class Attributes</h3> |
50 <h3>Class Attributes</h3> |
51 <table> |
51 <table> |
53 </table> |
53 </table> |
54 <h3>Methods</h3> |
54 <h3>Methods</h3> |
55 <table> |
55 <table> |
56 <tr> |
56 <tr> |
57 <td><a href="#AuthenticationDialog.__init__">AuthenticationDialog</a></td> |
57 <td><a href="#AuthenticationDialog.__init__">AuthenticationDialog</a></td> |
58 <td>Constructor</td> |
58 <td>Constructor</td> |
59 </tr><tr> |
59 </tr><tr> |
60 <td><a href="#AuthenticationDialog.getData">getData</a></td> |
60 <td><a href="#AuthenticationDialog.getData">getData</a></td> |
61 <td>Public method to retrieve the login data.</td> |
61 <td>Public method to retrieve the login data.</td> |
62 </tr><tr> |
62 </tr><tr> |
63 <td><a href="#AuthenticationDialog.setData">setData</a></td> |
63 <td><a href="#AuthenticationDialog.setData">setData</a></td> |
64 <td>Public method to set the login data.</td> |
64 <td>Public method to set the login data.</td> |
65 </tr><tr> |
65 </tr><tr> |
66 <td><a href="#AuthenticationDialog.shallSave">shallSave</a></td> |
66 <td><a href="#AuthenticationDialog.shallSave">shallSave</a></td> |
67 <td>Public method to check, if the login data shall be saved.</td> |
67 <td>Public method to check, if the login data shall be saved.</td> |
68 </tr> |
68 </tr> |
69 </table> |
69 </table> |
70 <a NAME="AuthenticationDialog.__init__" ID="AuthenticationDialog.__init__"></a> |
70 <a NAME="AuthenticationDialog.__init__" ID="AuthenticationDialog.__init__"></a> |
71 <h4>AuthenticationDialog (Constructor)</h4> |
71 <h4>AuthenticationDialog (Constructor)</h4> |
72 <b>AuthenticationDialog</b>(<i>info, username, showSave = False, saveIt = False, parent = None</i>) |
72 <b>AuthenticationDialog</b>(<i>info, username, showSave = False, saveIt = False, parent = None</i>) |
73 <p> |
73 <p> |
74 Constructor |
74 Constructor |
75 </p><dl> |
75 </p><dl> |
76 <dt><i>info</i></dt> |
76 <dt><i>info</i></dt> |
77 <dd> |
77 <dd> |
78 information to be shown (string) |
78 information to be shown (string) |
79 </dd><dt><i>username</i></dt> |
79 </dd><dt><i>username</i></dt> |
80 <dd> |
80 <dd> |
81 username as supplied by subversion (string) |
81 username as supplied by subversion (string) |
82 </dd><dt><i>showSave</i></dt> |
82 </dd><dt><i>showSave</i></dt> |
83 <dd> |
83 <dd> |
84 flag to indicate to show the save checkbox (boolean) |
84 flag to indicate to show the save checkbox (boolean) |
85 </dd><dt><i>saveIt</i></dt> |
85 </dd><dt><i>saveIt</i></dt> |
86 <dd> |
86 <dd> |
87 flag indicating the value for the save checkbox (boolean) |
87 flag indicating the value for the save checkbox (boolean) |
88 </dd> |
88 </dd> |
89 </dl><a NAME="AuthenticationDialog.getData" ID="AuthenticationDialog.getData"></a> |
89 </dl><a NAME="AuthenticationDialog.getData" ID="AuthenticationDialog.getData"></a> |
90 <h4>AuthenticationDialog.getData</h4> |
90 <h4>AuthenticationDialog.getData</h4> |
91 <b>getData</b>(<i></i>) |
91 <b>getData</b>(<i></i>) |
92 <p> |
92 <p> |
93 Public method to retrieve the login data. |
93 Public method to retrieve the login data. |
94 </p><dl> |
94 </p><dl> |
95 <dt>Returns:</dt> |
95 <dt>Returns:</dt> |
96 <dd> |
96 <dd> |
97 tuple of two string values (username, password) |
97 tuple of two string values (username, password) |
98 </dd> |
98 </dd> |
99 </dl><a NAME="AuthenticationDialog.setData" ID="AuthenticationDialog.setData"></a> |
99 </dl><a NAME="AuthenticationDialog.setData" ID="AuthenticationDialog.setData"></a> |
100 <h4>AuthenticationDialog.setData</h4> |
100 <h4>AuthenticationDialog.setData</h4> |
101 <b>setData</b>(<i>username, password</i>) |
101 <b>setData</b>(<i>username, password</i>) |
102 <p> |
102 <p> |
103 Public method to set the login data. |
103 Public method to set the login data. |
104 </p><dl> |
104 </p><dl> |
105 <dt><i>username</i></dt> |
105 <dt><i>username</i></dt> |
106 <dd> |
106 <dd> |
107 username (string) |
107 username (string) |
108 </dd><dt><i>password</i></dt> |
108 </dd><dt><i>password</i></dt> |
109 <dd> |
109 <dd> |
110 password (string) |
110 password (string) |
111 </dd> |
111 </dd> |
112 </dl><a NAME="AuthenticationDialog.shallSave" ID="AuthenticationDialog.shallSave"></a> |
112 </dl><a NAME="AuthenticationDialog.shallSave" ID="AuthenticationDialog.shallSave"></a> |
113 <h4>AuthenticationDialog.shallSave</h4> |
113 <h4>AuthenticationDialog.shallSave</h4> |
114 <b>shallSave</b>(<i></i>) |
114 <b>shallSave</b>(<i></i>) |
115 <p> |
115 <p> |
116 Public method to check, if the login data shall be saved. |
116 Public method to check, if the login data shall be saved. |
117 </p><dl> |
117 </p><dl> |
118 <dt>Returns:</dt> |
118 <dt>Returns:</dt> |
119 <dd> |
119 <dd> |
120 flag indicating that the login data shall be saved (boolean) |
120 flag indicating that the login data shall be saved (boolean) |
121 </dd> |
121 </dd> |
122 </dl> |
122 </dl> |
123 <div align="right"><a href="#top">Up</a></div> |
123 <div align="right"><a href="#top">Up</a></div> |
124 <hr /> |
124 <hr /> |
125 </body></html> |
125 </body></html> |