src/eric7/Documentation/Source/eric7.WebBrowser.WebAuth.Fido2PinDialog.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.Fido2PinDialog</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.Fido2PinDialog</h1>
10 <p>
11 Module implementing a dialog to enter the current and potentially new PIN.
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="#Fido2PinDialog">Fido2PinDialog</a></td>
23 <td>Class implementing a dialog to enter the current and potentially new PIN.</td>
24 </tr>
25 <tr>
26 <td><a href="#Fido2PinDialogMode">Fido2PinDialogMode</a></td>
27 <td>Class defining the various PIN dialog mode.</td>
28 </tr>
29 </table>
30
31 <h3>Functions</h3>
32 <table>
33 <tr><td>None</td></tr>
34 </table>
35
36 <hr />
37 <hr />
38 <a NAME="Fido2PinDialog" ID="Fido2PinDialog"></a>
39 <h2>Fido2PinDialog</h2>
40 <p>
41 Class implementing a dialog to enter the current and potentially new PIN.
42 </p>
43
44 <h3>Derived from</h3>
45 QDialog, Ui_Fido2PinDialog
46 <h3>Class Attributes</h3>
47 <table>
48 <tr><td>None</td></tr>
49 </table>
50
51 <h3>Class Methods</h3>
52 <table>
53 <tr><td>None</td></tr>
54 </table>
55
56 <h3>Methods</h3>
57 <table>
58 <tr>
59 <td><a href="#Fido2PinDialog.__init__">Fido2PinDialog</a></td>
60 <td>Constructor</td>
61 </tr>
62 <tr>
63 <td><a href="#Fido2PinDialog.__checkPins">__checkPins</a></td>
64 <td>Private slot to check the entered PIN(s).</td>
65 </tr>
66 <tr>
67 <td><a href="#Fido2PinDialog.__showPinErrors">__showPinErrors</a></td>
68 <td>Private method to show some error messages.</td>
69 </tr>
70 <tr>
71 <td><a href="#Fido2PinDialog.getPins">getPins</a></td>
72 <td>Public method to get the entered PINs.</td>
73 </tr>
74 <tr>
75 <td><a href="#Fido2PinDialog.on_newPinButton_toggled">on_newPinButton_toggled</a></td>
76 <td>Private slot to handle the toggling of the new PIN visibility.</td>
77 </tr>
78 <tr>
79 <td><a href="#Fido2PinDialog.on_pinButton_toggled">on_pinButton_toggled</a></td>
80 <td>Private slot to handle the toggling of the PIN visibility.</td>
81 </tr>
82 </table>
83
84 <h3>Static Methods</h3>
85 <table>
86 <tr><td>None</td></tr>
87 </table>
88
89
90 <a NAME="Fido2PinDialog.__init__" ID="Fido2PinDialog.__init__"></a>
91 <h4>Fido2PinDialog (Constructor)</h4>
92 <b>Fido2PinDialog</b>(<i>mode, title, message, minLength, retries, parent=None</i>)
93 <p>
94 Constructor
95 </p>
96
97 <dl>
98
99 <dt><i>mode</i> (Fido2PinDialogMode)</dt>
100 <dd>
101 mode of the dialog
102 </dd>
103 <dt><i>title</i> (str)</dt>
104 <dd>
105 header title to be shown
106 </dd>
107 <dt><i>message</i> (str)</dt>
108 <dd>
109 more decriptive text to be shown
110 </dd>
111 <dt><i>minLength</i> (int)</dt>
112 <dd>
113 minimum PIN length
114 </dd>
115 <dt><i>retries</i> (int)</dt>
116 <dd>
117 number of attempts remaining before the security key get locked
118 </dd>
119 <dt><i>parent</i> (QWidget (optional))</dt>
120 <dd>
121 reference to the parent widget (defaults to None)
122 </dd>
123 </dl>
124 <a NAME="Fido2PinDialog.__checkPins" ID="Fido2PinDialog.__checkPins"></a>
125 <h4>Fido2PinDialog.__checkPins</h4>
126 <b>__checkPins</b>(<i></i>)
127 <p>
128 Private slot to check the entered PIN(s).
129 </p>
130 <p>
131 Appropriate error messages are shown in case of issues and the state of
132 the OK button is set accordingly.
133 </p>
134
135 <a NAME="Fido2PinDialog.__showPinErrors" ID="Fido2PinDialog.__showPinErrors"></a>
136 <h4>Fido2PinDialog.__showPinErrors</h4>
137 <b>__showPinErrors</b>(<i>errorMessages</i>)
138 <p>
139 Private method to show some error messages.
140 </p>
141
142 <dl>
143
144 <dt><i>errorMessages</i> (list of str)</dt>
145 <dd>
146 list of error messages
147 </dd>
148 </dl>
149 <a NAME="Fido2PinDialog.getPins" ID="Fido2PinDialog.getPins"></a>
150 <h4>Fido2PinDialog.getPins</h4>
151 <b>getPins</b>(<i></i>)
152 <p>
153 Public method to get the entered PINs.
154 </p>
155
156 <dl>
157 <dt>Return:</dt>
158 <dd>
159 tuple containing the current and new PIN
160 </dd>
161 </dl>
162 <dl>
163 <dt>Return Type:</dt>
164 <dd>
165 tuple of (str, str)
166 </dd>
167 </dl>
168 <a NAME="Fido2PinDialog.on_newPinButton_toggled" ID="Fido2PinDialog.on_newPinButton_toggled"></a>
169 <h4>Fido2PinDialog.on_newPinButton_toggled</h4>
170 <b>on_newPinButton_toggled</b>(<i>checked</i>)
171 <p>
172 Private slot to handle the toggling of the new PIN visibility.
173 </p>
174
175 <dl>
176
177 <dt><i>checked</i> (bool)</dt>
178 <dd>
179 state of the new PIN visibility button
180 </dd>
181 </dl>
182 <a NAME="Fido2PinDialog.on_pinButton_toggled" ID="Fido2PinDialog.on_pinButton_toggled"></a>
183 <h4>Fido2PinDialog.on_pinButton_toggled</h4>
184 <b>on_pinButton_toggled</b>(<i>checked</i>)
185 <p>
186 Private slot to handle the toggling of the PIN visibility.
187 </p>
188
189 <dl>
190
191 <dt><i>checked</i> (bool)</dt>
192 <dd>
193 state of the PIN visibility button
194 </dd>
195 </dl>
196 <div align="right"><a href="#top">Up</a></div>
197 <hr />
198 <hr />
199 <a NAME="Fido2PinDialogMode" ID="Fido2PinDialogMode"></a>
200 <h2>Fido2PinDialogMode</h2>
201 <p>
202 Class defining the various PIN dialog mode.
203 </p>
204
205 <h3>Derived from</h3>
206 enum.Enum
207 <h3>Class Attributes</h3>
208 <table>
209 <tr><td>CHANGE</td></tr>
210 <tr><td>GET</td></tr>
211 <tr><td>SET</td></tr>
212 </table>
213
214 <h3>Class Methods</h3>
215 <table>
216 <tr><td>None</td></tr>
217 </table>
218
219 <h3>Methods</h3>
220 <table>
221 <tr><td>None</td></tr>
222 </table>
223
224 <h3>Static Methods</h3>
225 <table>
226 <tr><td>None</td></tr>
227 </table>
228
229
230 <div align="right"><a href="#top">Up</a></div>
231 <hr />
232 </body></html>

eric ide

mercurial