--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/eric7/Documentation/Source/eric7.WebBrowser.WebAuth.WebBrowserWebAuthDialog.html Mon Jul 22 17:08:40 2024 +0200 @@ -0,0 +1,239 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.WebBrowser.WebAuth.WebBrowserWebAuthDialog</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.WebBrowser.WebAuth.WebBrowserWebAuthDialog</h1> +<p> +Module implementing a dialog to handle the various WebAuth requests. +</p> + +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> + +<h3>Classes</h3> +<table> +<tr> +<td><a href="#WebBrowserWebAuthDialog">WebBrowserWebAuthDialog</a></td> +<td>Class implementing a dialog to handle the various WebAuth requests.</td> +</tr> +</table> + +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> + +<hr /> +<hr /> +<a NAME="WebBrowserWebAuthDialog" ID="WebBrowserWebAuthDialog"></a> +<h2>WebBrowserWebAuthDialog</h2> +<p> + Class implementing a dialog to handle the various WebAuth requests. +</p> + +<h3>Derived from</h3> +QDialog, Ui_WebBrowserWebAuthDialog +<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="#WebBrowserWebAuthDialog.__init__">WebBrowserWebAuthDialog</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#WebBrowserWebAuthDialog.__acceptRequest">__acceptRequest</a></td> +<td>Private slot to accept the WebAuth request.</td> +</tr> +<tr> +<td><a href="#WebBrowserWebAuthDialog.__cancelRequest">__cancelRequest</a></td> +<td>Private slot to cancel the WebAuth request.</td> +</tr> +<tr> +<td><a href="#WebBrowserWebAuthDialog.__clearSelectAccountButtons">__clearSelectAccountButtons</a></td> +<td>Private method to remove the account selection buttons.</td> +</tr> +<tr> +<td><a href="#WebBrowserWebAuthDialog.__retry">__retry</a></td> +<td>Private slot to retry the WebAuth request.</td> +</tr> +<tr> +<td><a href="#WebBrowserWebAuthDialog.__setupCollectPinUi">__setupCollectPinUi</a></td> +<td>Private method to configure the 'Collect PIN' UI.</td> +</tr> +<tr> +<td><a href="#WebBrowserWebAuthDialog.__setupErrorUi">__setupErrorUi</a></td> +<td>Private method to configure the 'Error' UI.</td> +</tr> +<tr> +<td><a href="#WebBrowserWebAuthDialog.__setupFinishCollectTokenUi">__setupFinishCollectTokenUi</a></td> +<td>Private method to configure the 'Finish Collect Token' UI.</td> +</tr> +<tr> +<td><a href="#WebBrowserWebAuthDialog.__setupSelectAccountUi">__setupSelectAccountUi</a></td> +<td>Private method to configure the 'Select Account' UI.</td> +</tr> +<tr> +<td><a href="#WebBrowserWebAuthDialog.on_confirmPinEdit_textEdited">on_confirmPinEdit_textEdited</a></td> +<td>Private slot handling entering of a confirmation PIN.</td> +</tr> +<tr> +<td><a href="#WebBrowserWebAuthDialog.on_pinButton_toggled">on_pinButton_toggled</a></td> +<td>Private slot to handle the toggling of the PIN visibility.</td> +</tr> +<tr> +<td><a href="#WebBrowserWebAuthDialog.on_pinEdit_textEdited">on_pinEdit_textEdited</a></td> +<td>Private slot handling entering a PIN.</td> +</tr> +<tr> +<td><a href="#WebBrowserWebAuthDialog.updateDialog">updateDialog</a></td> +<td>Public slot to update the dialog depending on the current WebAuth request state.</td> +</tr> +</table> + +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> + + +<a NAME="WebBrowserWebAuthDialog.__init__" ID="WebBrowserWebAuthDialog.__init__"></a> +<h4>WebBrowserWebAuthDialog (Constructor)</h4> +<b>WebBrowserWebAuthDialog</b>(<i>uxRequest, parent=None</i>) +<p> + Constructor +</p> + +<dl> + +<dt><i>uxRequest</i> (QWebEngineWebAuthUxRequest)</dt> +<dd> +reference to the WebAuth request object +</dd> +<dt><i>parent</i> (QWidget (optional))</dt> +<dd> +reference to the parent widget (defaults to None) +</dd> +</dl> +<a NAME="WebBrowserWebAuthDialog.__acceptRequest" ID="WebBrowserWebAuthDialog.__acceptRequest"></a> +<h4>WebBrowserWebAuthDialog.__acceptRequest</h4> +<b>__acceptRequest</b>(<i></i>) +<p> + Private slot to accept the WebAuth request. +</p> + +<a NAME="WebBrowserWebAuthDialog.__cancelRequest" ID="WebBrowserWebAuthDialog.__cancelRequest"></a> +<h4>WebBrowserWebAuthDialog.__cancelRequest</h4> +<b>__cancelRequest</b>(<i></i>) +<p> + Private slot to cancel the WebAuth request. +</p> + +<a NAME="WebBrowserWebAuthDialog.__clearSelectAccountButtons" ID="WebBrowserWebAuthDialog.__clearSelectAccountButtons"></a> +<h4>WebBrowserWebAuthDialog.__clearSelectAccountButtons</h4> +<b>__clearSelectAccountButtons</b>(<i></i>) +<p> + Private method to remove the account selection buttons. +</p> + +<a NAME="WebBrowserWebAuthDialog.__retry" ID="WebBrowserWebAuthDialog.__retry"></a> +<h4>WebBrowserWebAuthDialog.__retry</h4> +<b>__retry</b>(<i></i>) +<p> + Private slot to retry the WebAuth request. +</p> + +<a NAME="WebBrowserWebAuthDialog.__setupCollectPinUi" ID="WebBrowserWebAuthDialog.__setupCollectPinUi"></a> +<h4>WebBrowserWebAuthDialog.__setupCollectPinUi</h4> +<b>__setupCollectPinUi</b>(<i></i>) +<p> + Private method to configure the 'Collect PIN' UI. +</p> + +<a NAME="WebBrowserWebAuthDialog.__setupErrorUi" ID="WebBrowserWebAuthDialog.__setupErrorUi"></a> +<h4>WebBrowserWebAuthDialog.__setupErrorUi</h4> +<b>__setupErrorUi</b>(<i></i>) +<p> + Private method to configure the 'Error' UI. +</p> + +<a NAME="WebBrowserWebAuthDialog.__setupFinishCollectTokenUi" ID="WebBrowserWebAuthDialog.__setupFinishCollectTokenUi"></a> +<h4>WebBrowserWebAuthDialog.__setupFinishCollectTokenUi</h4> +<b>__setupFinishCollectTokenUi</b>(<i></i>) +<p> + Private method to configure the 'Finish Collect Token' UI. +</p> + +<a NAME="WebBrowserWebAuthDialog.__setupSelectAccountUi" ID="WebBrowserWebAuthDialog.__setupSelectAccountUi"></a> +<h4>WebBrowserWebAuthDialog.__setupSelectAccountUi</h4> +<b>__setupSelectAccountUi</b>(<i></i>) +<p> + Private method to configure the 'Select Account' UI. +</p> + +<a NAME="WebBrowserWebAuthDialog.on_confirmPinEdit_textEdited" ID="WebBrowserWebAuthDialog.on_confirmPinEdit_textEdited"></a> +<h4>WebBrowserWebAuthDialog.on_confirmPinEdit_textEdited</h4> +<b>on_confirmPinEdit_textEdited</b>(<i>pin</i>) +<p> + Private slot handling entering of a confirmation PIN. +</p> + +<dl> + +<dt><i>pin</i> (str)</dt> +<dd> +entered confirmation PIN +</dd> +</dl> +<a NAME="WebBrowserWebAuthDialog.on_pinButton_toggled" ID="WebBrowserWebAuthDialog.on_pinButton_toggled"></a> +<h4>WebBrowserWebAuthDialog.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> +<a NAME="WebBrowserWebAuthDialog.on_pinEdit_textEdited" ID="WebBrowserWebAuthDialog.on_pinEdit_textEdited"></a> +<h4>WebBrowserWebAuthDialog.on_pinEdit_textEdited</h4> +<b>on_pinEdit_textEdited</b>(<i>pin</i>) +<p> + Private slot handling entering a PIN. +</p> + +<dl> + +<dt><i>pin</i> (str)</dt> +<dd> +entered PIN +</dd> +</dl> +<a NAME="WebBrowserWebAuthDialog.updateDialog" ID="WebBrowserWebAuthDialog.updateDialog"></a> +<h4>WebBrowserWebAuthDialog.updateDialog</h4> +<b>updateDialog</b>(<i></i>) +<p> + Public slot to update the dialog depending on the current WebAuth request state. +</p> + +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html>