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

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10479
856476537696
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.MicroPython.AddEditDevicesDialog</title>
4 <meta charset="UTF-8">
5 <link rel="stylesheet" href="styles.css">
6 </head>
7 <body>
8 <a NAME="top" ID="top"></a>
9 <h1>eric7.MicroPython.AddEditDevicesDialog</h1>
10
11 <p>
12 Module implementing a dialog to add or edit data of unknown MicroPython
13 devices.
14 </p>
15 <h3>Global Attributes</h3>
16
17 <table>
18 <tr><td>None</td></tr>
19 </table>
20 <h3>Classes</h3>
21
22 <table>
23
24 <tr>
25 <td><a href="#AddEditDevicesDialog">AddEditDevicesDialog</a></td>
26 <td>Class implementing a dialog to add or edit data of unknown MicroPython devices.</td>
27 </tr>
28 </table>
29 <h3>Functions</h3>
30
31 <table>
32 <tr><td>None</td></tr>
33 </table>
34 <hr />
35 <hr />
36 <a NAME="AddEditDevicesDialog" ID="AddEditDevicesDialog"></a>
37 <h2>AddEditDevicesDialog</h2>
38
39 <p>
40 Class implementing a dialog to add or edit data of unknown MicroPython
41 devices.
42 </p>
43 <h3>Derived from</h3>
44 QDialog, Ui_AddEditDevicesDialog
45 <h3>Class Attributes</h3>
46
47 <table>
48 <tr><td>None</td></tr>
49 </table>
50 <h3>Class Methods</h3>
51
52 <table>
53 <tr><td>None</td></tr>
54 </table>
55 <h3>Methods</h3>
56
57 <table>
58
59 <tr>
60 <td><a href="#AddEditDevicesDialog.__init__">AddEditDevicesDialog</a></td>
61 <td>Constructor</td>
62 </tr>
63 <tr>
64 <td><a href="#AddEditDevicesDialog.getDeviceDict">getDeviceDict</a></td>
65 <td>Public method to get the entered data as a dictionary.</td>
66 </tr>
67 <tr>
68 <td><a href="#AddEditDevicesDialog.on_deviceTypeComboBox_currentIndexChanged">on_deviceTypeComboBox_currentIndexChanged</a></td>
69 <td>Private slot to handle the selection of a device type.</td>
70 </tr>
71 <tr>
72 <td><a href="#AddEditDevicesDialog.on_reportButton_clicked">on_reportButton_clicked</a></td>
73 <td>Private slot to report the entered data to the eric-bugs email address.</td>
74 </tr>
75 </table>
76 <h3>Static Methods</h3>
77
78 <table>
79 <tr><td>None</td></tr>
80 </table>
81
82 <a NAME="AddEditDevicesDialog.__init__" ID="AddEditDevicesDialog.__init__"></a>
83 <h4>AddEditDevicesDialog (Constructor)</h4>
84 <b>AddEditDevicesDialog</b>(<i>vid=0, pid=0, description=0, deviceData=None, parent=None</i>)
85
86 <p>
87 Constructor
88 </p>
89 <p>
90 Note: Either vid and pid and description or deviceData dictionary
91 must be given.
92 </p>
93 <dl>
94
95 <dt><i>vid</i> (int (optional))</dt>
96 <dd>
97 vendor ID of the device (defaults to 0)
98 </dd>
99 <dt><i>pid</i> (int (optional))</dt>
100 <dd>
101 product ID of the device (defaults to 0)
102 </dd>
103 <dt><i>description</i> (str (optional))</dt>
104 <dd>
105 description for the device (defaults to "")
106 </dd>
107 <dt><i>deviceData</i> (dict (optional))</dt>
108 <dd>
109 type of the device (defaults to None)
110 </dd>
111 <dt><i>parent</i> (QWidget (optional))</dt>
112 <dd>
113 reference to the parent widget (defaults to None)
114 </dd>
115 </dl>
116 <a NAME="AddEditDevicesDialog.getDeviceDict" ID="AddEditDevicesDialog.getDeviceDict"></a>
117 <h4>AddEditDevicesDialog.getDeviceDict</h4>
118 <b>getDeviceDict</b>(<i></i>)
119
120 <p>
121 Public method to get the entered data as a dictionary.
122 </p>
123 <dl>
124 <dt>Return:</dt>
125 <dd>
126 dictionary containing the entered data
127 </dd>
128 </dl>
129 <dl>
130 <dt>Return Type:</dt>
131 <dd>
132 dict
133 </dd>
134 </dl>
135 <a NAME="AddEditDevicesDialog.on_deviceTypeComboBox_currentIndexChanged" ID="AddEditDevicesDialog.on_deviceTypeComboBox_currentIndexChanged"></a>
136 <h4>AddEditDevicesDialog.on_deviceTypeComboBox_currentIndexChanged</h4>
137 <b>on_deviceTypeComboBox_currentIndexChanged</b>(<i>index</i>)
138
139 <p>
140 Private slot to handle the selection of a device type.
141 </p>
142 <dl>
143
144 <dt><i>index</i> (int)</dt>
145 <dd>
146 index of the current item
147 </dd>
148 </dl>
149 <a NAME="AddEditDevicesDialog.on_reportButton_clicked" ID="AddEditDevicesDialog.on_reportButton_clicked"></a>
150 <h4>AddEditDevicesDialog.on_reportButton_clicked</h4>
151 <b>on_reportButton_clicked</b>(<i></i>)
152
153 <p>
154 Private slot to report the entered data to the eric-bugs email address.
155 </p>
156 <div align="right"><a href="#top">Up</a></div>
157 <hr />
158 </body></html>

eric ide

mercurial