src/eric7/Documentation/Source/eric7.WebBrowser.WebAuth.WebBrowserWebAuthDialog.html

branch
eric7
changeset 10860
46d5db6cd55d
equal deleted inserted replaced
10859:399d19fc7eb5 10860:46d5db6cd55d
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.WebBrowser.WebAuth.WebBrowserWebAuthDialog</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.WebBrowser.WebAuth.WebBrowserWebAuthDialog</h1>
10 <p>
11 Module implementing a dialog to handle the various WebAuth requests.
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="#WebBrowserWebAuthDialog">WebBrowserWebAuthDialog</a></td>
23 <td>Class implementing a dialog to handle the various WebAuth requests.</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="WebBrowserWebAuthDialog" ID="WebBrowserWebAuthDialog"></a>
35 <h2>WebBrowserWebAuthDialog</h2>
36 <p>
37 Class implementing a dialog to handle the various WebAuth requests.
38 </p>
39
40 <h3>Derived from</h3>
41 QDialog, Ui_WebBrowserWebAuthDialog
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="#WebBrowserWebAuthDialog.__init__">WebBrowserWebAuthDialog</a></td>
56 <td>Constructor</td>
57 </tr>
58 <tr>
59 <td><a href="#WebBrowserWebAuthDialog.__acceptRequest">__acceptRequest</a></td>
60 <td>Private slot to accept the WebAuth request.</td>
61 </tr>
62 <tr>
63 <td><a href="#WebBrowserWebAuthDialog.__cancelRequest">__cancelRequest</a></td>
64 <td>Private slot to cancel the WebAuth request.</td>
65 </tr>
66 <tr>
67 <td><a href="#WebBrowserWebAuthDialog.__clearSelectAccountButtons">__clearSelectAccountButtons</a></td>
68 <td>Private method to remove the account selection buttons.</td>
69 </tr>
70 <tr>
71 <td><a href="#WebBrowserWebAuthDialog.__retry">__retry</a></td>
72 <td>Private slot to retry the WebAuth request.</td>
73 </tr>
74 <tr>
75 <td><a href="#WebBrowserWebAuthDialog.__setupCollectPinUi">__setupCollectPinUi</a></td>
76 <td>Private method to configure the 'Collect PIN' UI.</td>
77 </tr>
78 <tr>
79 <td><a href="#WebBrowserWebAuthDialog.__setupErrorUi">__setupErrorUi</a></td>
80 <td>Private method to configure the 'Error' UI.</td>
81 </tr>
82 <tr>
83 <td><a href="#WebBrowserWebAuthDialog.__setupFinishCollectTokenUi">__setupFinishCollectTokenUi</a></td>
84 <td>Private method to configure the 'Finish Collect Token' UI.</td>
85 </tr>
86 <tr>
87 <td><a href="#WebBrowserWebAuthDialog.__setupSelectAccountUi">__setupSelectAccountUi</a></td>
88 <td>Private method to configure the 'Select Account' UI.</td>
89 </tr>
90 <tr>
91 <td><a href="#WebBrowserWebAuthDialog.on_confirmPinEdit_textEdited">on_confirmPinEdit_textEdited</a></td>
92 <td>Private slot handling entering of a confirmation PIN.</td>
93 </tr>
94 <tr>
95 <td><a href="#WebBrowserWebAuthDialog.on_pinButton_toggled">on_pinButton_toggled</a></td>
96 <td>Private slot to handle the toggling of the PIN visibility.</td>
97 </tr>
98 <tr>
99 <td><a href="#WebBrowserWebAuthDialog.on_pinEdit_textEdited">on_pinEdit_textEdited</a></td>
100 <td>Private slot handling entering a PIN.</td>
101 </tr>
102 <tr>
103 <td><a href="#WebBrowserWebAuthDialog.updateDialog">updateDialog</a></td>
104 <td>Public slot to update the dialog depending on the current WebAuth request state.</td>
105 </tr>
106 </table>
107
108 <h3>Static Methods</h3>
109 <table>
110 <tr><td>None</td></tr>
111 </table>
112
113
114 <a NAME="WebBrowserWebAuthDialog.__init__" ID="WebBrowserWebAuthDialog.__init__"></a>
115 <h4>WebBrowserWebAuthDialog (Constructor)</h4>
116 <b>WebBrowserWebAuthDialog</b>(<i>uxRequest, parent=None</i>)
117 <p>
118 Constructor
119 </p>
120
121 <dl>
122
123 <dt><i>uxRequest</i> (QWebEngineWebAuthUxRequest)</dt>
124 <dd>
125 reference to the WebAuth request object
126 </dd>
127 <dt><i>parent</i> (QWidget (optional))</dt>
128 <dd>
129 reference to the parent widget (defaults to None)
130 </dd>
131 </dl>
132 <a NAME="WebBrowserWebAuthDialog.__acceptRequest" ID="WebBrowserWebAuthDialog.__acceptRequest"></a>
133 <h4>WebBrowserWebAuthDialog.__acceptRequest</h4>
134 <b>__acceptRequest</b>(<i></i>)
135 <p>
136 Private slot to accept the WebAuth request.
137 </p>
138
139 <a NAME="WebBrowserWebAuthDialog.__cancelRequest" ID="WebBrowserWebAuthDialog.__cancelRequest"></a>
140 <h4>WebBrowserWebAuthDialog.__cancelRequest</h4>
141 <b>__cancelRequest</b>(<i></i>)
142 <p>
143 Private slot to cancel the WebAuth request.
144 </p>
145
146 <a NAME="WebBrowserWebAuthDialog.__clearSelectAccountButtons" ID="WebBrowserWebAuthDialog.__clearSelectAccountButtons"></a>
147 <h4>WebBrowserWebAuthDialog.__clearSelectAccountButtons</h4>
148 <b>__clearSelectAccountButtons</b>(<i></i>)
149 <p>
150 Private method to remove the account selection buttons.
151 </p>
152
153 <a NAME="WebBrowserWebAuthDialog.__retry" ID="WebBrowserWebAuthDialog.__retry"></a>
154 <h4>WebBrowserWebAuthDialog.__retry</h4>
155 <b>__retry</b>(<i></i>)
156 <p>
157 Private slot to retry the WebAuth request.
158 </p>
159
160 <a NAME="WebBrowserWebAuthDialog.__setupCollectPinUi" ID="WebBrowserWebAuthDialog.__setupCollectPinUi"></a>
161 <h4>WebBrowserWebAuthDialog.__setupCollectPinUi</h4>
162 <b>__setupCollectPinUi</b>(<i></i>)
163 <p>
164 Private method to configure the 'Collect PIN' UI.
165 </p>
166
167 <a NAME="WebBrowserWebAuthDialog.__setupErrorUi" ID="WebBrowserWebAuthDialog.__setupErrorUi"></a>
168 <h4>WebBrowserWebAuthDialog.__setupErrorUi</h4>
169 <b>__setupErrorUi</b>(<i></i>)
170 <p>
171 Private method to configure the 'Error' UI.
172 </p>
173
174 <a NAME="WebBrowserWebAuthDialog.__setupFinishCollectTokenUi" ID="WebBrowserWebAuthDialog.__setupFinishCollectTokenUi"></a>
175 <h4>WebBrowserWebAuthDialog.__setupFinishCollectTokenUi</h4>
176 <b>__setupFinishCollectTokenUi</b>(<i></i>)
177 <p>
178 Private method to configure the 'Finish Collect Token' UI.
179 </p>
180
181 <a NAME="WebBrowserWebAuthDialog.__setupSelectAccountUi" ID="WebBrowserWebAuthDialog.__setupSelectAccountUi"></a>
182 <h4>WebBrowserWebAuthDialog.__setupSelectAccountUi</h4>
183 <b>__setupSelectAccountUi</b>(<i></i>)
184 <p>
185 Private method to configure the 'Select Account' UI.
186 </p>
187
188 <a NAME="WebBrowserWebAuthDialog.on_confirmPinEdit_textEdited" ID="WebBrowserWebAuthDialog.on_confirmPinEdit_textEdited"></a>
189 <h4>WebBrowserWebAuthDialog.on_confirmPinEdit_textEdited</h4>
190 <b>on_confirmPinEdit_textEdited</b>(<i>pin</i>)
191 <p>
192 Private slot handling entering of a confirmation PIN.
193 </p>
194
195 <dl>
196
197 <dt><i>pin</i> (str)</dt>
198 <dd>
199 entered confirmation PIN
200 </dd>
201 </dl>
202 <a NAME="WebBrowserWebAuthDialog.on_pinButton_toggled" ID="WebBrowserWebAuthDialog.on_pinButton_toggled"></a>
203 <h4>WebBrowserWebAuthDialog.on_pinButton_toggled</h4>
204 <b>on_pinButton_toggled</b>(<i>checked</i>)
205 <p>
206 Private slot to handle the toggling of the PIN visibility.
207 </p>
208
209 <dl>
210
211 <dt><i>checked</i> (bool)</dt>
212 <dd>
213 state of the PIN visibility button
214 </dd>
215 </dl>
216 <a NAME="WebBrowserWebAuthDialog.on_pinEdit_textEdited" ID="WebBrowserWebAuthDialog.on_pinEdit_textEdited"></a>
217 <h4>WebBrowserWebAuthDialog.on_pinEdit_textEdited</h4>
218 <b>on_pinEdit_textEdited</b>(<i>pin</i>)
219 <p>
220 Private slot handling entering a PIN.
221 </p>
222
223 <dl>
224
225 <dt><i>pin</i> (str)</dt>
226 <dd>
227 entered PIN
228 </dd>
229 </dl>
230 <a NAME="WebBrowserWebAuthDialog.updateDialog" ID="WebBrowserWebAuthDialog.updateDialog"></a>
231 <h4>WebBrowserWebAuthDialog.updateDialog</h4>
232 <b>updateDialog</b>(<i></i>)
233 <p>
234 Public slot to update the dialog depending on the current WebAuth request state.
235 </p>
236
237 <div align="right"><a href="#top">Up</a></div>
238 <hr />
239 </body></html>

eric ide

mercurial