tip/src/eric7/Documentation/Source/eric7.MicroPython.WifiDialogs.WifiConnectionDialog.html

<!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.accept">accept</a></td>
<td>Public slot accepting the dialog.</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.getCountryCode">getCountryCode</a></td>
<td>Public method to get the entered country code.</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>withCountry=False, parent=None</i>)
<p>
        Constructor
</p>

<dl>

<dt><i>withCountry</i> (bool)</dt>
<dd>
flag indicating to show the country entry (defaults to False)
</dd>
<dt><i>parent</i> (QWidget (optional))</dt>
<dd>
reference to the parent widget (defaults to None)
</dd>
</dl>
<a NAME="WifiConnectionDialog.accept" ID="WifiConnectionDialog.accept"></a>
<h4>WifiConnectionDialog.accept</h4>
<b>accept</b>(<i></i>)
<p>
        Public slot accepting the dialog.
</p>

<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, the password and the host name
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
tuple of (str, str, str)
</dd>
</dl>
<a NAME="WifiConnectionDialog.getCountryCode" ID="WifiConnectionDialog.getCountryCode"></a>
<h4>WifiConnectionDialog.getCountryCode</h4>
<b>getCountryCode</b>(<i></i>)
<p>
        Public method to get the entered country code.
</p>

<dl>
<dt>Return:</dt>
<dd>
DESCRIPTION
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
TYPE
</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>