--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/eric7/Documentation/Source/eric7.MicroPython.MicroPythonWebreplUrlAddEditDialog.html Thu May 04 17:34:24 2023 +0200 @@ -0,0 +1,146 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.MicroPython.MicroPythonWebreplUrlAddEditDialog</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.MicroPython.MicroPythonWebreplUrlAddEditDialog</h1> + +<p> +Module implementing a dialog to edit the parameters for a WebREPL connection. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#MicroPythonWebreplUrlAddEditDialog">MicroPythonWebreplUrlAddEditDialog</a></td> +<td>Class implementing a dialog to edit the parameters for a WebREPL connection.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="MicroPythonWebreplUrlAddEditDialog" ID="MicroPythonWebreplUrlAddEditDialog"></a> +<h2>MicroPythonWebreplUrlAddEditDialog</h2> + +<p> + Class implementing a dialog to edit the parameters for a WebREPL connection. +</p> +<h3>Derived from</h3> +QDialog, Ui_MicroPythonWebreplUrlAddEditDialog +<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="#MicroPythonWebreplUrlAddEditDialog.__init__">MicroPythonWebreplUrlAddEditDialog</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#MicroPythonWebreplUrlAddEditDialog.__populateFields">__populateFields</a></td> +<td>Private method to populate the various dialog fields with the given parameters.</td> +</tr> +<tr> +<td><a href="#MicroPythonWebreplUrlAddEditDialog.__updateOkButton">__updateOkButton</a></td> +<td>Private slot to update the enabled state of the OK button.</td> +</tr> +<tr> +<td><a href="#MicroPythonWebreplUrlAddEditDialog.getWebreplUrl">getWebreplUrl</a></td> +<td>Public method to retrieve the entered WebREPL connection data.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="MicroPythonWebreplUrlAddEditDialog.__init__" ID="MicroPythonWebreplUrlAddEditDialog.__init__"></a> +<h4>MicroPythonWebreplUrlAddEditDialog (Constructor)</h4> +<b>MicroPythonWebreplUrlAddEditDialog</b>(<i>definedNames, connectionParams=None, parent=None</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>definedNames</i> (list of str)</dt> +<dd> +list of already define WebREPL connection names +</dd> +<dt><i>connectionParams</i> (tuple of (str, str, str) (optional))</dt> +<dd> +parameters for the WebREPL connection to be edited + (default to None) +</dd> +<dt><i>parent</i> (QWidget (optional))</dt> +<dd> +reference to the parent widget (defaults to None) +</dd> +</dl> +<a NAME="MicroPythonWebreplUrlAddEditDialog.__populateFields" ID="MicroPythonWebreplUrlAddEditDialog.__populateFields"></a> +<h4>MicroPythonWebreplUrlAddEditDialog.__populateFields</h4> +<b>__populateFields</b>(<i>params</i>) + +<p> + Private method to populate the various dialog fields with the given parameters. +</p> +<dl> + +<dt><i>params</i> (tuple of (str, str, str))</dt> +<dd> +arameters for the WebREPL connection to be edited +</dd> +</dl> +<a NAME="MicroPythonWebreplUrlAddEditDialog.__updateOkButton" ID="MicroPythonWebreplUrlAddEditDialog.__updateOkButton"></a> +<h4>MicroPythonWebreplUrlAddEditDialog.__updateOkButton</h4> +<b>__updateOkButton</b>(<i></i>) + +<p> + Private slot to update the enabled state of the OK button. +</p> +<a NAME="MicroPythonWebreplUrlAddEditDialog.getWebreplUrl" ID="MicroPythonWebreplUrlAddEditDialog.getWebreplUrl"></a> +<h4>MicroPythonWebreplUrlAddEditDialog.getWebreplUrl</h4> +<b>getWebreplUrl</b>(<i></i>) + +<p> + Public method to retrieve the entered WebREPL connection data. +</p> +<dl> +<dt>Return:</dt> +<dd> +tuple containing the name, description, URL and device type for + the WebREPL connection +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, str, str, str) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file