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

branch
eric7
changeset 10860
46d5db6cd55d
diff -r 399d19fc7eb5 -r 46d5db6cd55d src/eric7/Documentation/Source/eric7.WebBrowser.WebAuth.Fido2PinDialog.html
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/eric7/Documentation/Source/eric7.WebBrowser.WebAuth.Fido2PinDialog.html	Mon Jul 22 17:08:40 2024 +0200
@@ -0,0 +1,232 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.WebBrowser.WebAuth.Fido2PinDialog</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.WebBrowser.WebAuth.Fido2PinDialog</h1>
+<p>
+Module implementing a dialog to enter the current and potentially new PIN.
+</p>
+
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#Fido2PinDialog">Fido2PinDialog</a></td>
+<td>Class implementing a dialog to enter the current and potentially new PIN.</td>
+</tr>
+<tr>
+<td><a href="#Fido2PinDialogMode">Fido2PinDialogMode</a></td>
+<td>Class defining the various PIN dialog mode.</td>
+</tr>
+</table>
+
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<hr />
+<hr />
+<a NAME="Fido2PinDialog" ID="Fido2PinDialog"></a>
+<h2>Fido2PinDialog</h2>
+<p>
+    Class implementing a dialog to enter the current and potentially new PIN.
+</p>
+
+<h3>Derived from</h3>
+QDialog, Ui_Fido2PinDialog
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Class Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#Fido2PinDialog.__init__">Fido2PinDialog</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#Fido2PinDialog.__checkPins">__checkPins</a></td>
+<td>Private slot to check the entered PIN(s).</td>
+</tr>
+<tr>
+<td><a href="#Fido2PinDialog.__showPinErrors">__showPinErrors</a></td>
+<td>Private method to show some error messages.</td>
+</tr>
+<tr>
+<td><a href="#Fido2PinDialog.getPins">getPins</a></td>
+<td>Public method to get the entered PINs.</td>
+</tr>
+<tr>
+<td><a href="#Fido2PinDialog.on_newPinButton_toggled">on_newPinButton_toggled</a></td>
+<td>Private slot to handle the toggling of the new PIN visibility.</td>
+</tr>
+<tr>
+<td><a href="#Fido2PinDialog.on_pinButton_toggled">on_pinButton_toggled</a></td>
+<td>Private slot to handle the toggling of the PIN visibility.</td>
+</tr>
+</table>
+
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+
+<a NAME="Fido2PinDialog.__init__" ID="Fido2PinDialog.__init__"></a>
+<h4>Fido2PinDialog (Constructor)</h4>
+<b>Fido2PinDialog</b>(<i>mode, title, message, minLength, retries, parent=None</i>)
+<p>
+        Constructor
+</p>
+
+<dl>
+
+<dt><i>mode</i> (Fido2PinDialogMode)</dt>
+<dd>
+mode of the dialog
+</dd>
+<dt><i>title</i> (str)</dt>
+<dd>
+header title to be shown
+</dd>
+<dt><i>message</i> (str)</dt>
+<dd>
+more decriptive text to be shown
+</dd>
+<dt><i>minLength</i> (int)</dt>
+<dd>
+minimum PIN length
+</dd>
+<dt><i>retries</i> (int)</dt>
+<dd>
+number of attempts remaining before the security key get locked
+</dd>
+<dt><i>parent</i> (QWidget (optional))</dt>
+<dd>
+reference to the parent widget (defaults to None)
+</dd>
+</dl>
+<a NAME="Fido2PinDialog.__checkPins" ID="Fido2PinDialog.__checkPins"></a>
+<h4>Fido2PinDialog.__checkPins</h4>
+<b>__checkPins</b>(<i></i>)
+<p>
+        Private slot to check the entered PIN(s).
+</p>
+<p>
+        Appropriate error messages are shown in case of issues and the state of
+        the OK button is set accordingly.
+</p>
+
+<a NAME="Fido2PinDialog.__showPinErrors" ID="Fido2PinDialog.__showPinErrors"></a>
+<h4>Fido2PinDialog.__showPinErrors</h4>
+<b>__showPinErrors</b>(<i>errorMessages</i>)
+<p>
+        Private method to show some error messages.
+</p>
+
+<dl>
+
+<dt><i>errorMessages</i> (list of str)</dt>
+<dd>
+list of error messages
+</dd>
+</dl>
+<a NAME="Fido2PinDialog.getPins" ID="Fido2PinDialog.getPins"></a>
+<h4>Fido2PinDialog.getPins</h4>
+<b>getPins</b>(<i></i>)
+<p>
+        Public method to get the entered PINs.
+</p>
+
+<dl>
+<dt>Return:</dt>
+<dd>
+tuple containing the current and new PIN
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (str, str)
+</dd>
+</dl>
+<a NAME="Fido2PinDialog.on_newPinButton_toggled" ID="Fido2PinDialog.on_newPinButton_toggled"></a>
+<h4>Fido2PinDialog.on_newPinButton_toggled</h4>
+<b>on_newPinButton_toggled</b>(<i>checked</i>)
+<p>
+        Private slot to handle the toggling of the new PIN visibility.
+</p>
+
+<dl>
+
+<dt><i>checked</i> (bool)</dt>
+<dd>
+state of the new PIN visibility button
+</dd>
+</dl>
+<a NAME="Fido2PinDialog.on_pinButton_toggled" ID="Fido2PinDialog.on_pinButton_toggled"></a>
+<h4>Fido2PinDialog.on_pinButton_toggled</h4>
+<b>on_pinButton_toggled</b>(<i>checked</i>)
+<p>
+        Private slot to handle the toggling of the PIN visibility.
+</p>
+
+<dl>
+
+<dt><i>checked</i> (bool)</dt>
+<dd>
+state of the PIN visibility button
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="Fido2PinDialogMode" ID="Fido2PinDialogMode"></a>
+<h2>Fido2PinDialogMode</h2>
+<p>
+    Class defining the various PIN dialog mode.
+</p>
+
+<h3>Derived from</h3>
+enum.Enum
+<h3>Class Attributes</h3>
+<table>
+<tr><td>CHANGE</td></tr>
+<tr><td>GET</td></tr>
+<tr><td>SET</td></tr>
+</table>
+
+<h3>Class Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>

eric ide

mercurial