--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/eric7/Documentation/Source/eric7.MicroPython.ConnectionSelectionDialog.html Mon May 24 11:19:57 2021 +0200 @@ -0,0 +1,183 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.MicroPython.ConnectionSelectionDialog</title> +<meta charset="UTF-8"> +<style> +body { + background: #EDECE6; + margin: 0em 1em 10em 1em; + color: black; +} + +h1 { color: white; background: #85774A; } +h2 { color: white; background: #85774A; } +h3 { color: white; background: #9D936E; } +h4 { color: white; background: #9D936E; } + +a { color: #BA6D36; } + +</style> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.MicroPython.ConnectionSelectionDialog</h1> + +<p> +Module implementing a dialog to select the port to connect to and the type of +the attached device. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#ConnectionSelectionDialog">ConnectionSelectionDialog</a></td> +<td>Class implementing a dialog to select the port to connect to and the type of the attached device.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="ConnectionSelectionDialog" ID="ConnectionSelectionDialog"></a> +<h2>ConnectionSelectionDialog</h2> + +<p> + Class implementing a dialog to select the port to connect to and the type + of the attached device. +</p> +<h3>Derived from</h3> +QDialog, Ui_ConnectionSelectionDialog +<h3>Class Attributes</h3> + +<table> +<tr><td>PortNameRole</td></tr><tr><td>VidPidRole</td></tr> +</table> +<h3>Class Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> + +<table> + +<tr> +<td><a href="#ConnectionSelectionDialog.__init__">ConnectionSelectionDialog</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#ConnectionSelectionDialog.__updateOK">__updateOK</a></td> +<td>Private method to update the status of the OK button.</td> +</tr> +<tr> +<td><a href="#ConnectionSelectionDialog.getData">getData</a></td> +<td>Public method to get the entered data.</td> +</tr> +<tr> +<td><a href="#ConnectionSelectionDialog.on_deviceTypeComboBox_currentTextChanged">on_deviceTypeComboBox_currentTextChanged</a></td> +<td>Private slot to handle the selection of a device type.</td> +</tr> +<tr> +<td><a href="#ConnectionSelectionDialog.on_portNameComboBox_currentTextChanged">on_portNameComboBox_currentTextChanged</a></td> +<td>Private slot to handle the selection of a port name.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="ConnectionSelectionDialog.__init__" ID="ConnectionSelectionDialog.__init__"></a> +<h4>ConnectionSelectionDialog (Constructor)</h4> +<b>ConnectionSelectionDialog</b>(<i>ports, currentPort, currentType, parent=None</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>ports</i> (list of str)</dt> +<dd> +list of detected ports +</dd> +<dt><i>currentPort</i> (str)</dt> +<dd> +port most recently selected +</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="ConnectionSelectionDialog.__updateOK" ID="ConnectionSelectionDialog.__updateOK"></a> +<h4>ConnectionSelectionDialog.__updateOK</h4> +<b>__updateOK</b>(<i></i>) + +<p> + Private method to update the status of the OK button. +</p> +<a NAME="ConnectionSelectionDialog.getData" ID="ConnectionSelectionDialog.getData"></a> +<h4>ConnectionSelectionDialog.getData</h4> +<b>getData</b>(<i></i>) + +<p> + Public method to get the entered data. +</p> +<dl> +<dt>Return:</dt> +<dd> +tuple containing the VID, PID and name of the selected port + and the selected device type +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (int, int, str, str) +</dd> +</dl> +<a NAME="ConnectionSelectionDialog.on_deviceTypeComboBox_currentTextChanged" ID="ConnectionSelectionDialog.on_deviceTypeComboBox_currentTextChanged"></a> +<h4>ConnectionSelectionDialog.on_deviceTypeComboBox_currentTextChanged</h4> +<b>on_deviceTypeComboBox_currentTextChanged</b>(<i>txt</i>) + +<p> + Private slot to handle the selection of a device type. +</p> +<dl> + +<dt><i>txt</i> (str)</dt> +<dd> +selected device description +</dd> +</dl> +<a NAME="ConnectionSelectionDialog.on_portNameComboBox_currentTextChanged" ID="ConnectionSelectionDialog.on_portNameComboBox_currentTextChanged"></a> +<h4>ConnectionSelectionDialog.on_portNameComboBox_currentTextChanged</h4> +<b>on_portNameComboBox_currentTextChanged</b>(<i>txt</i>) + +<p> + Private slot to handle the selection of a port name. +</p> +<dl> + +<dt><i>txt</i> (str)</dt> +<dd> +selected port +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file