src/eric7/Documentation/Source/eric7.MicroPython.ConnectionSelectionDialog.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.ConnectionSelectionDialog</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.ConnectionSelectionDialog</h1>
10
11 <p>
12 Module implementing a dialog to select the port to connect to and the type of
13 the attached device.
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="#ConnectionSelectionDialog">ConnectionSelectionDialog</a></td>
26 <td>Class implementing a dialog to select the port to connect to and the type of the attached device.</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="ConnectionSelectionDialog" ID="ConnectionSelectionDialog"></a>
37 <h2>ConnectionSelectionDialog</h2>
38
39 <p>
40 Class implementing a dialog to select the port to connect to and the type
41 of the attached device.
42 </p>
43 <h3>Derived from</h3>
44 QDialog, Ui_ConnectionSelectionDialog
45 <h3>Class Attributes</h3>
46
47 <table>
48 <tr><td>PortNameRole</td></tr><tr><td>VidPidRole</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="#ConnectionSelectionDialog.__init__">ConnectionSelectionDialog</a></td>
61 <td>Constructor</td>
62 </tr>
63 <tr>
64 <td><a href="#ConnectionSelectionDialog.__updateOK">__updateOK</a></td>
65 <td>Private method to update the status of the OK button.</td>
66 </tr>
67 <tr>
68 <td><a href="#ConnectionSelectionDialog.getData">getData</a></td>
69 <td>Public method to get the entered data.</td>
70 </tr>
71 <tr>
72 <td><a href="#ConnectionSelectionDialog.on_deviceTypeComboBox_currentTextChanged">on_deviceTypeComboBox_currentTextChanged</a></td>
73 <td>Private slot to handle the selection of a device type.</td>
74 </tr>
75 <tr>
76 <td><a href="#ConnectionSelectionDialog.on_portNameComboBox_currentTextChanged">on_portNameComboBox_currentTextChanged</a></td>
77 <td>Private slot to handle the selection of a port name.</td>
78 </tr>
79 </table>
80 <h3>Static Methods</h3>
81
82 <table>
83 <tr><td>None</td></tr>
84 </table>
85
86 <a NAME="ConnectionSelectionDialog.__init__" ID="ConnectionSelectionDialog.__init__"></a>
87 <h4>ConnectionSelectionDialog (Constructor)</h4>
88 <b>ConnectionSelectionDialog</b>(<i>ports, currentPort, currentType, parent=None</i>)
89
90 <p>
91 Constructor
92 </p>
93 <dl>
94
95 <dt><i>ports</i> (list of str)</dt>
96 <dd>
97 list of detected ports
98 </dd>
99 <dt><i>currentPort</i> (str)</dt>
100 <dd>
101 port most recently selected
102 </dd>
103 <dt><i>currentType</i> (str)</dt>
104 <dd>
105 device type most recently selected
106 </dd>
107 <dt><i>parent</i> (QWidget (optional))</dt>
108 <dd>
109 reference to the parent widget (defaults to None)
110 </dd>
111 </dl>
112 <a NAME="ConnectionSelectionDialog.__updateOK" ID="ConnectionSelectionDialog.__updateOK"></a>
113 <h4>ConnectionSelectionDialog.__updateOK</h4>
114 <b>__updateOK</b>(<i></i>)
115
116 <p>
117 Private method to update the status of the OK button.
118 </p>
119 <a NAME="ConnectionSelectionDialog.getData" ID="ConnectionSelectionDialog.getData"></a>
120 <h4>ConnectionSelectionDialog.getData</h4>
121 <b>getData</b>(<i></i>)
122
123 <p>
124 Public method to get the entered data.
125 </p>
126 <dl>
127 <dt>Return:</dt>
128 <dd>
129 tuple containing the VID, PID and name of the selected port
130 and the selected device type
131 </dd>
132 </dl>
133 <dl>
134 <dt>Return Type:</dt>
135 <dd>
136 tuple of (int, int, str, str)
137 </dd>
138 </dl>
139 <a NAME="ConnectionSelectionDialog.on_deviceTypeComboBox_currentTextChanged" ID="ConnectionSelectionDialog.on_deviceTypeComboBox_currentTextChanged"></a>
140 <h4>ConnectionSelectionDialog.on_deviceTypeComboBox_currentTextChanged</h4>
141 <b>on_deviceTypeComboBox_currentTextChanged</b>(<i>txt</i>)
142
143 <p>
144 Private slot to handle the selection of a device type.
145 </p>
146 <dl>
147
148 <dt><i>txt</i> (str)</dt>
149 <dd>
150 selected device description
151 </dd>
152 </dl>
153 <a NAME="ConnectionSelectionDialog.on_portNameComboBox_currentTextChanged" ID="ConnectionSelectionDialog.on_portNameComboBox_currentTextChanged"></a>
154 <h4>ConnectionSelectionDialog.on_portNameComboBox_currentTextChanged</h4>
155 <b>on_portNameComboBox_currentTextChanged</b>(<i>txt</i>)
156
157 <p>
158 Private slot to handle the selection of a port name.
159 </p>
160 <dl>
161
162 <dt><i>txt</i> (str)</dt>
163 <dd>
164 selected port
165 </dd>
166 </dl>
167 <div align="right"><a href="#top">Up</a></div>
168 <hr />
169 </body></html>

eric ide

mercurial