--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/eric7/Documentation/Source/eric7.MicroPython.WifiDialogs.WifiConnectionDialog.html Sat Feb 25 19:18:43 2023 +0100 @@ -0,0 +1,146 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.MicroPython.WifiDialogs.WifiConnectionDialog</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.MicroPython.WifiDialogs.WifiConnectionDialog</h1> + +<p> +Module implementing a dialog to enter the parameters needed to connect to a WiFi +network. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#WifiConnectionDialog">WifiConnectionDialog</a></td> +<td>Class implementing a dialog to enter the parameters needed to connect to a WiFi network.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="WifiConnectionDialog" ID="WifiConnectionDialog"></a> +<h2>WifiConnectionDialog</h2> + +<p> + Class implementing a dialog to enter the parameters needed to connect to a WiFi + network. +</p> +<h3>Derived from</h3> +QDialog, Ui_WifiConnectionDialog +<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="#WifiConnectionDialog.__init__">WifiConnectionDialog</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#WifiConnectionDialog.getConnectionParameters">getConnectionParameters</a></td> +<td>Public method to get the entered connection parameters.</td> +</tr> +<tr> +<td><a href="#WifiConnectionDialog.on_showPasswordButton_clicked">on_showPasswordButton_clicked</a></td> +<td>Private slot to show or hide the password.</td> +</tr> +<tr> +<td><a href="#WifiConnectionDialog.on_ssidEdit_textChanged">on_ssidEdit_textChanged</a></td> +<td>Private slot handling a change of the SSID.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="WifiConnectionDialog.__init__" ID="WifiConnectionDialog.__init__"></a> +<h4>WifiConnectionDialog (Constructor)</h4> +<b>WifiConnectionDialog</b>(<i>parent=None</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>parent</i> (QWidget (optional))</dt> +<dd> +reference to the parent widget (defaults to None) +</dd> +</dl> +<a NAME="WifiConnectionDialog.getConnectionParameters" ID="WifiConnectionDialog.getConnectionParameters"></a> +<h4>WifiConnectionDialog.getConnectionParameters</h4> +<b>getConnectionParameters</b>(<i></i>) + +<p> + Public method to get the entered connection parameters. +</p> +<dl> +<dt>Return:</dt> +<dd> +tuple containing the SSID, password and a flag indicating, if the + parameters shall be saved to the preferences +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, str, bool) +</dd> +</dl> +<a NAME="WifiConnectionDialog.on_showPasswordButton_clicked" ID="WifiConnectionDialog.on_showPasswordButton_clicked"></a> +<h4>WifiConnectionDialog.on_showPasswordButton_clicked</h4> +<b>on_showPasswordButton_clicked</b>(<i>checked</i>) + +<p> + Private slot to show or hide the password. +</p> +<dl> + +<dt><i>checked</i> (bool)</dt> +<dd> +state of the button +</dd> +</dl> +<a NAME="WifiConnectionDialog.on_ssidEdit_textChanged" ID="WifiConnectionDialog.on_ssidEdit_textChanged"></a> +<h4>WifiConnectionDialog.on_ssidEdit_textChanged</h4> +<b>on_ssidEdit_textChanged</b>(<i>ssid</i>) + +<p> + Private slot handling a change of the SSID. +</p> +<dl> + +<dt><i>ssid</i> (str)</dt> +<dd> +entered SSID +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file