src/eric7/Documentation/Source/eric7.MicroPython.MicroPythonWebreplConnectionDialog.html

Thu, 04 Jan 2024 18:02:25 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Thu, 04 Jan 2024 18:02:25 +0100
branch
eric7
changeset 10479
856476537696
parent 10015
9352f33732ae
permissions
-rw-r--r--

Fine tuned the source code documentation template and regenerated the source code documentation.

<!DOCTYPE html>
<html><head>
<title>eric7.MicroPython.MicroPythonWebreplConnectionDialog</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.MicroPython.MicroPythonWebreplConnectionDialog</h1>
<p>
Module implementing a dialog to enter the WebREPL connection parameters.
</p>

<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Classes</h3>
<table>
<tr>
<td><a href="#MicroPythonWebreplConnectionDialog">MicroPythonWebreplConnectionDialog</a></td>
<td>Class implementing a dialog to enter the WebREPL connection parameters.</td>
</tr>
</table>

<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>

<hr />
<hr />
<a NAME="MicroPythonWebreplConnectionDialog" ID="MicroPythonWebreplConnectionDialog"></a>
<h2>MicroPythonWebreplConnectionDialog</h2>
<p>
    Class implementing a dialog to enter the WebREPL connection parameters.
</p>

<h3>Derived from</h3>
QDialog, Ui_MicroPythonWebreplConnectionDialog
<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="#MicroPythonWebreplConnectionDialog.__init__">MicroPythonWebreplConnectionDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#MicroPythonWebreplConnectionDialog.__updateOkButton">__updateOkButton</a></td>
<td>Private slot to update the enabled state of the OK button.</td>
</tr>
<tr>
<td><a href="#MicroPythonWebreplConnectionDialog.getWebreplConnectionParameters">getWebreplConnectionParameters</a></td>
<td>Public method to retrieve the entered WebREPL connection data.</td>
</tr>
<tr>
<td><a href="#MicroPythonWebreplConnectionDialog.on_showPasswordButton_clicked">on_showPasswordButton_clicked</a></td>
<td>Private slot to show or hide the password.</td>
</tr>
</table>

<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>


<a NAME="MicroPythonWebreplConnectionDialog.__init__" ID="MicroPythonWebreplConnectionDialog.__init__"></a>
<h4>MicroPythonWebreplConnectionDialog (Constructor)</h4>
<b>MicroPythonWebreplConnectionDialog</b>(<i>currentWebreplUrl, currentType, parent=None</i>)
<p>
        Constructor
</p>

<dl>

<dt><i>currentWebreplUrl</i> (str)</dt>
<dd>
WebREPL URL most recently configured
</dd>
<dt><i>currentType</i> (str)</dt>
<dd>
device type most recently selected
</dd>
<dt><i>parent</i> (QWidget (optional))</dt>
<dd>
reference to the parent widget (defaults to None)
</dd>
</dl>
<a NAME="MicroPythonWebreplConnectionDialog.__updateOkButton" ID="MicroPythonWebreplConnectionDialog.__updateOkButton"></a>
<h4>MicroPythonWebreplConnectionDialog.__updateOkButton</h4>
<b>__updateOkButton</b>(<i></i>)
<p>
        Private slot to update the enabled state of the OK button.
</p>

<a NAME="MicroPythonWebreplConnectionDialog.getWebreplConnectionParameters" ID="MicroPythonWebreplConnectionDialog.getWebreplConnectionParameters"></a>
<h4>MicroPythonWebreplConnectionDialog.getWebreplConnectionParameters</h4>
<b>getWebreplConnectionParameters</b>(<i></i>)
<p>
        Public method to retrieve the entered WebREPL connection data.
</p>

<dl>
<dt>Return:</dt>
<dd>
tuple containing the URL and device type for the WebREPL connection
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
tuple of (str, str)
</dd>
</dl>
<a NAME="MicroPythonWebreplConnectionDialog.on_showPasswordButton_clicked" ID="MicroPythonWebreplConnectionDialog.on_showPasswordButton_clicked"></a>
<h4>MicroPythonWebreplConnectionDialog.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>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>

eric ide

mercurial