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

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10479
856476537696
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/eric7/Documentation/Source/eric7.MicroPython.AddEditDevicesDialog.html	Thu Jul 07 11:23:56 2022 +0200
@@ -0,0 +1,158 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.MicroPython.AddEditDevicesDialog</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.MicroPython.AddEditDevicesDialog</h1>
+
+<p>
+Module implementing a dialog to add or edit data of unknown MicroPython
+devices.
+</p>
+<h3>Global Attributes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+
+<table>
+
+<tr>
+<td><a href="#AddEditDevicesDialog">AddEditDevicesDialog</a></td>
+<td>Class implementing a dialog to add or edit data of unknown MicroPython devices.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr />
+<hr />
+<a NAME="AddEditDevicesDialog" ID="AddEditDevicesDialog"></a>
+<h2>AddEditDevicesDialog</h2>
+
+<p>
+    Class implementing a dialog to add or edit data of unknown MicroPython
+    devices.
+</p>
+<h3>Derived from</h3>
+QDialog, Ui_AddEditDevicesDialog
+<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="#AddEditDevicesDialog.__init__">AddEditDevicesDialog</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#AddEditDevicesDialog.getDeviceDict">getDeviceDict</a></td>
+<td>Public method to get the entered data as a dictionary.</td>
+</tr>
+<tr>
+<td><a href="#AddEditDevicesDialog.on_deviceTypeComboBox_currentIndexChanged">on_deviceTypeComboBox_currentIndexChanged</a></td>
+<td>Private slot to handle the selection of a device type.</td>
+</tr>
+<tr>
+<td><a href="#AddEditDevicesDialog.on_reportButton_clicked">on_reportButton_clicked</a></td>
+<td>Private slot to report the entered data to the eric-bugs email address.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<a NAME="AddEditDevicesDialog.__init__" ID="AddEditDevicesDialog.__init__"></a>
+<h4>AddEditDevicesDialog (Constructor)</h4>
+<b>AddEditDevicesDialog</b>(<i>vid=0, pid=0, description=0, deviceData=None, parent=None</i>)
+
+<p>
+        Constructor
+</p>
+<p>
+        Note: Either vid and pid and description or deviceData dictionary
+        must be given.
+</p>
+<dl>
+
+<dt><i>vid</i> (int (optional))</dt>
+<dd>
+vendor ID of the device (defaults to 0)
+</dd>
+<dt><i>pid</i> (int (optional))</dt>
+<dd>
+product ID of the device (defaults to 0)
+</dd>
+<dt><i>description</i> (str (optional))</dt>
+<dd>
+description for the device (defaults to "")
+</dd>
+<dt><i>deviceData</i> (dict (optional))</dt>
+<dd>
+type of the device (defaults to None)
+</dd>
+<dt><i>parent</i> (QWidget (optional))</dt>
+<dd>
+reference to the parent widget (defaults to None)
+</dd>
+</dl>
+<a NAME="AddEditDevicesDialog.getDeviceDict" ID="AddEditDevicesDialog.getDeviceDict"></a>
+<h4>AddEditDevicesDialog.getDeviceDict</h4>
+<b>getDeviceDict</b>(<i></i>)
+
+<p>
+        Public method to get the entered data as a dictionary.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+dictionary containing the entered data
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+dict
+</dd>
+</dl>
+<a NAME="AddEditDevicesDialog.on_deviceTypeComboBox_currentIndexChanged" ID="AddEditDevicesDialog.on_deviceTypeComboBox_currentIndexChanged"></a>
+<h4>AddEditDevicesDialog.on_deviceTypeComboBox_currentIndexChanged</h4>
+<b>on_deviceTypeComboBox_currentIndexChanged</b>(<i>index</i>)
+
+<p>
+        Private slot to handle the selection of a device type.
+</p>
+<dl>
+
+<dt><i>index</i> (int)</dt>
+<dd>
+index of the current item
+</dd>
+</dl>
+<a NAME="AddEditDevicesDialog.on_reportButton_clicked" ID="AddEditDevicesDialog.on_reportButton_clicked"></a>
+<h4>AddEditDevicesDialog.on_reportButton_clicked</h4>
+<b>on_reportButton_clicked</b>(<i></i>)
+
+<p>
+        Private slot to report the entered data to the eric-bugs email address.
+</p>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial