eric6/Documentation/Source/eric6.MicroPython.CircuitPythonFirmwareSelectionDialog.html

changeset 8098
36d5f6786a9f
parent 8097
5af9c426c46b
child 8099
522946e53835
equal deleted inserted replaced
8097:5af9c426c46b 8098:36d5f6786a9f
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.MicroPython.CircuitPythonFirmwareSelectionDialog</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body>
22 <a NAME="top" ID="top"></a>
23 <h1>eric6.MicroPython.CircuitPythonFirmwareSelectionDialog</h1>
24
25 <p>
26 Module implementing a dialog to enter the firmware flashing data.
27 </p>
28 <h3>Global Attributes</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <h3>Classes</h3>
34
35 <table>
36
37 <tr>
38 <td><a href="#CircuitPythonFirmwareSelectionDialog">CircuitPythonFirmwareSelectionDialog</a></td>
39 <td>Class implementing a dialog to enter the firmware flashing data.</td>
40 </tr>
41 </table>
42 <h3>Functions</h3>
43
44 <table>
45 <tr><td>None</td></tr>
46 </table>
47 <hr />
48 <hr />
49 <a NAME="CircuitPythonFirmwareSelectionDialog" ID="CircuitPythonFirmwareSelectionDialog"></a>
50 <h2>CircuitPythonFirmwareSelectionDialog</h2>
51
52 <p>
53 Class implementing a dialog to enter the firmware flashing data.
54 </p>
55 <h3>Derived from</h3>
56 QDialog, Ui_CircuitPythonFirmwareSelectionDialog
57 <h3>Class Attributes</h3>
58
59 <table>
60 <tr><td>Boards</td></tr>
61 </table>
62 <h3>Class Methods</h3>
63
64 <table>
65 <tr><td>None</td></tr>
66 </table>
67 <h3>Methods</h3>
68
69 <table>
70
71 <tr>
72 <td><a href="#CircuitPythonFirmwareSelectionDialog.__init__">CircuitPythonFirmwareSelectionDialog</a></td>
73 <td>Constructor</td>
74 </tr>
75 <tr>
76 <td><a href="#CircuitPythonFirmwareSelectionDialog.__updateOkButton">__updateOkButton</a></td>
77 <td>Private method to update the state of the OK button and the retest button.</td>
78 </tr>
79 <tr>
80 <td><a href="#CircuitPythonFirmwareSelectionDialog.getData">getData</a></td>
81 <td>Public method to obtain the entered data.</td>
82 </tr>
83 <tr>
84 <td><a href="#CircuitPythonFirmwareSelectionDialog.on_boardComboBox_currentIndexChanged">on_boardComboBox_currentIndexChanged</a></td>
85 <td>Private slot to handle the selection of a board type.</td>
86 </tr>
87 <tr>
88 <td><a href="#CircuitPythonFirmwareSelectionDialog.on_bootPicker_textChanged">on_bootPicker_textChanged</a></td>
89 <td>Private slot handling a change of the device path.</td>
90 </tr>
91 <tr>
92 <td><a href="#CircuitPythonFirmwareSelectionDialog.on_firmwarePicker_textChanged">on_firmwarePicker_textChanged</a></td>
93 <td>Private slot handling a change of the firmware path.</td>
94 </tr>
95 <tr>
96 <td><a href="#CircuitPythonFirmwareSelectionDialog.on_retestButton_clicked">on_retestButton_clicked</a></td>
97 <td>Private slot to research for the selected volume.</td>
98 </tr>
99 </table>
100 <h3>Static Methods</h3>
101
102 <table>
103 <tr><td>None</td></tr>
104 </table>
105
106 <a NAME="CircuitPythonFirmwareSelectionDialog.__init__" ID="CircuitPythonFirmwareSelectionDialog.__init__"></a>
107 <h4>CircuitPythonFirmwareSelectionDialog (Constructor)</h4>
108 <b>CircuitPythonFirmwareSelectionDialog</b>(<i>parent=None</i>)
109
110 <p>
111 Constructor
112 </p>
113 <dl>
114
115 <dt><i>parent</i> (QWidget)</dt>
116 <dd>
117 reference to the parent widget
118 </dd>
119 </dl>
120 <a NAME="CircuitPythonFirmwareSelectionDialog.__updateOkButton" ID="CircuitPythonFirmwareSelectionDialog.__updateOkButton"></a>
121 <h4>CircuitPythonFirmwareSelectionDialog.__updateOkButton</h4>
122 <b>__updateOkButton</b>(<i></i>)
123
124 <p>
125 Private method to update the state of the OK button and the retest
126 button.
127 </p>
128 <a NAME="CircuitPythonFirmwareSelectionDialog.getData" ID="CircuitPythonFirmwareSelectionDialog.getData"></a>
129 <h4>CircuitPythonFirmwareSelectionDialog.getData</h4>
130 <b>getData</b>(<i></i>)
131
132 <p>
133 Public method to obtain the entered data.
134 </p>
135 <dl>
136 <dt>Return:</dt>
137 <dd>
138 tuple containing the path to the CircuitPython firmware file
139 and the path to the device
140 </dd>
141 </dl>
142 <dl>
143 <dt>Return Type:</dt>
144 <dd>
145 tuple of (str, str)
146 </dd>
147 </dl>
148 <a NAME="CircuitPythonFirmwareSelectionDialog.on_boardComboBox_currentIndexChanged" ID="CircuitPythonFirmwareSelectionDialog.on_boardComboBox_currentIndexChanged"></a>
149 <h4>CircuitPythonFirmwareSelectionDialog.on_boardComboBox_currentIndexChanged</h4>
150 <b>on_boardComboBox_currentIndexChanged</b>(<i>index</i>)
151
152 <p>
153 Private slot to handle the selection of a board type.
154 </p>
155 <dl>
156
157 <dt><i>index</i> (int)</dt>
158 <dd>
159 index of the selected board type
160 </dd>
161 </dl>
162 <a NAME="CircuitPythonFirmwareSelectionDialog.on_bootPicker_textChanged" ID="CircuitPythonFirmwareSelectionDialog.on_bootPicker_textChanged"></a>
163 <h4>CircuitPythonFirmwareSelectionDialog.on_bootPicker_textChanged</h4>
164 <b>on_bootPicker_textChanged</b>(<i>devicePath</i>)
165
166 <p>
167 Private slot handling a change of the device path.
168 </p>
169 <dl>
170
171 <dt><i>devicePath</i> (str)</dt>
172 <dd>
173 path to the device
174 </dd>
175 </dl>
176 <a NAME="CircuitPythonFirmwareSelectionDialog.on_firmwarePicker_textChanged" ID="CircuitPythonFirmwareSelectionDialog.on_firmwarePicker_textChanged"></a>
177 <h4>CircuitPythonFirmwareSelectionDialog.on_firmwarePicker_textChanged</h4>
178 <b>on_firmwarePicker_textChanged</b>(<i>firmware</i>)
179
180 <p>
181 Private slot handling a change of the firmware path.
182 </p>
183 <dl>
184
185 <dt><i>firmware</i> (str)</dt>
186 <dd>
187 path to the firmware
188 </dd>
189 </dl>
190 <a NAME="CircuitPythonFirmwareSelectionDialog.on_retestButton_clicked" ID="CircuitPythonFirmwareSelectionDialog.on_retestButton_clicked"></a>
191 <h4>CircuitPythonFirmwareSelectionDialog.on_retestButton_clicked</h4>
192 <b>on_retestButton_clicked</b>(<i></i>)
193
194 <p>
195 Private slot to research for the selected volume.
196 </p>
197 <div align="right"><a href="#top">Up</a></div>
198 <hr />
199 </body></html>

eric ide

mercurial