eric6/Documentation/Source/eric6.UI.AuthenticationDialog.html

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

eric ide

mercurial