src/eric7/Documentation/Source/eric7.MicroPython.UnknownDevicesDialog.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.UnknownDevicesDialog</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.UnknownDevicesDialog</h1>
10
11 <p>
12 Module implementing a dialog to manage the list of unknown devices.
13 </p>
14 <h3>Global Attributes</h3>
15
16 <table>
17 <tr><td>None</td></tr>
18 </table>
19 <h3>Classes</h3>
20
21 <table>
22
23 <tr>
24 <td><a href="#UnknownDevicesDialog">UnknownDevicesDialog</a></td>
25 <td>Class implementing a dialog to manage the list of unknown devices.</td>
26 </tr>
27 </table>
28 <h3>Functions</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <hr />
34 <hr />
35 <a NAME="UnknownDevicesDialog" ID="UnknownDevicesDialog"></a>
36 <h2>UnknownDevicesDialog</h2>
37
38 <p>
39 Class implementing a dialog to manage the list of unknown devices.
40 </p>
41 <h3>Derived from</h3>
42 QDialog, Ui_UnknownDevicesDialog
43 <h3>Class Attributes</h3>
44
45 <table>
46 <tr><td>DeviceDataRole</td></tr><tr><td>ModifiedRole</td></tr>
47 </table>
48 <h3>Class Methods</h3>
49
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <h3>Methods</h3>
54
55 <table>
56
57 <tr>
58 <td><a href="#UnknownDevicesDialog.__init__">UnknownDevicesDialog</a></td>
59 <td>Constructor</td>
60 </tr>
61 <tr>
62 <td><a href="#UnknownDevicesDialog.__checkButtons">__checkButtons</a></td>
63 <td>Private slot to set the enabled state of the buttons.</td>
64 </tr>
65 <tr>
66 <td><a href="#UnknownDevicesDialog.__editItem">__editItem</a></td>
67 <td>Private method to edit the given item.</td>
68 </tr>
69 <tr>
70 <td><a href="#UnknownDevicesDialog.__isDirty">__isDirty</a></td>
71 <td>Private method to check, if the dialog contains unsaved data.</td>
72 </tr>
73 <tr>
74 <td><a href="#UnknownDevicesDialog.__loadDevices">__loadDevices</a></td>
75 <td>Private method to load the list of unknown devices.</td>
76 </tr>
77 <tr>
78 <td><a href="#UnknownDevicesDialog.__saveDeviceData">__saveDeviceData</a></td>
79 <td>Private method to save the device data.</td>
80 </tr>
81 <tr>
82 <td><a href="#UnknownDevicesDialog.on_buttonBox_accepted">on_buttonBox_accepted</a></td>
83 <td>Private slot to handle the OK button press.</td>
84 </tr>
85 <tr>
86 <td><a href="#UnknownDevicesDialog.on_buttonBox_rejected">on_buttonBox_rejected</a></td>
87 <td>Private slot handling the cancellation of the dialog.</td>
88 </tr>
89 <tr>
90 <td><a href="#UnknownDevicesDialog.on_deleteAllButton_clicked">on_deleteAllButton_clicked</a></td>
91 <td>Private slot to delete all devices.</td>
92 </tr>
93 <tr>
94 <td><a href="#UnknownDevicesDialog.on_deleteButton_clicked">on_deleteButton_clicked</a></td>
95 <td>Private slot to delete the selected entries.</td>
96 </tr>
97 <tr>
98 <td><a href="#UnknownDevicesDialog.on_deviceList_itemActivated">on_deviceList_itemActivated</a></td>
99 <td>Private slot to edit the data of the activated item.</td>
100 </tr>
101 <tr>
102 <td><a href="#UnknownDevicesDialog.on_deviceList_itemSelectionChanged">on_deviceList_itemSelectionChanged</a></td>
103 <td>Private slot to handle a change of selected items.</td>
104 </tr>
105 <tr>
106 <td><a href="#UnknownDevicesDialog.on_editButton_clicked">on_editButton_clicked</a></td>
107 <td>Private slot to edit the selected item.</td>
108 </tr>
109 <tr>
110 <td><a href="#UnknownDevicesDialog.on_reportButton_clicked">on_reportButton_clicked</a></td>
111 <td>Private slot to report the data of all boards to the eric-bugs email address.</td>
112 </tr>
113 <tr>
114 <td><a href="#UnknownDevicesDialog.on_restoreButton_clicked">on_restoreButton_clicked</a></td>
115 <td>Private slot to restore the list of unknown devices.</td>
116 </tr>
117 </table>
118 <h3>Static Methods</h3>
119
120 <table>
121 <tr><td>None</td></tr>
122 </table>
123
124 <a NAME="UnknownDevicesDialog.__init__" ID="UnknownDevicesDialog.__init__"></a>
125 <h4>UnknownDevicesDialog (Constructor)</h4>
126 <b>UnknownDevicesDialog</b>(<i>parent=None</i>)
127
128 <p>
129 Constructor
130 </p>
131 <dl>
132
133 <dt><i>parent</i> (QWidget (optional))</dt>
134 <dd>
135 reference to the parent widget (defaults to None)
136 </dd>
137 </dl>
138 <a NAME="UnknownDevicesDialog.__checkButtons" ID="UnknownDevicesDialog.__checkButtons"></a>
139 <h4>UnknownDevicesDialog.__checkButtons</h4>
140 <b>__checkButtons</b>(<i></i>)
141
142 <p>
143 Private slot to set the enabled state of the buttons.
144 </p>
145 <a NAME="UnknownDevicesDialog.__editItem" ID="UnknownDevicesDialog.__editItem"></a>
146 <h4>UnknownDevicesDialog.__editItem</h4>
147 <b>__editItem</b>(<i>item</i>)
148
149 <p>
150 Private method to edit the given item.
151 </p>
152 <dl>
153
154 <dt><i>item</i> (QListWidgetItem)</dt>
155 <dd>
156 reference to the item to be edited
157 </dd>
158 </dl>
159 <a NAME="UnknownDevicesDialog.__isDirty" ID="UnknownDevicesDialog.__isDirty"></a>
160 <h4>UnknownDevicesDialog.__isDirty</h4>
161 <b>__isDirty</b>(<i></i>)
162
163 <p>
164 Private method to check, if the dialog contains unsaved data.
165 </p>
166 <dl>
167 <dt>Return:</dt>
168 <dd>
169 flag indicating the presence of unsaved data
170 </dd>
171 </dl>
172 <dl>
173 <dt>Return Type:</dt>
174 <dd>
175 bool
176 </dd>
177 </dl>
178 <a NAME="UnknownDevicesDialog.__loadDevices" ID="UnknownDevicesDialog.__loadDevices"></a>
179 <h4>UnknownDevicesDialog.__loadDevices</h4>
180 <b>__loadDevices</b>(<i></i>)
181
182 <p>
183 Private method to load the list of unknown devices.
184 </p>
185 <a NAME="UnknownDevicesDialog.__saveDeviceData" ID="UnknownDevicesDialog.__saveDeviceData"></a>
186 <h4>UnknownDevicesDialog.__saveDeviceData</h4>
187 <b>__saveDeviceData</b>(<i></i>)
188
189 <p>
190 Private method to save the device data.
191 </p>
192 <dl>
193 <dt>Return:</dt>
194 <dd>
195 flag indicating a successful save
196 </dd>
197 </dl>
198 <dl>
199 <dt>Return Type:</dt>
200 <dd>
201 bool
202 </dd>
203 </dl>
204 <a NAME="UnknownDevicesDialog.on_buttonBox_accepted" ID="UnknownDevicesDialog.on_buttonBox_accepted"></a>
205 <h4>UnknownDevicesDialog.on_buttonBox_accepted</h4>
206 <b>on_buttonBox_accepted</b>(<i></i>)
207
208 <p>
209 Private slot to handle the OK button press.
210 </p>
211 <p>
212 This action saves the edited list to the preferences store.
213 </p>
214 <a NAME="UnknownDevicesDialog.on_buttonBox_rejected" ID="UnknownDevicesDialog.on_buttonBox_rejected"></a>
215 <h4>UnknownDevicesDialog.on_buttonBox_rejected</h4>
216 <b>on_buttonBox_rejected</b>(<i></i>)
217
218 <p>
219 Private slot handling the cancellation of the dialog.
220 </p>
221 <a NAME="UnknownDevicesDialog.on_deleteAllButton_clicked" ID="UnknownDevicesDialog.on_deleteAllButton_clicked"></a>
222 <h4>UnknownDevicesDialog.on_deleteAllButton_clicked</h4>
223 <b>on_deleteAllButton_clicked</b>(<i></i>)
224
225 <p>
226 Private slot to delete all devices.
227 </p>
228 <a NAME="UnknownDevicesDialog.on_deleteButton_clicked" ID="UnknownDevicesDialog.on_deleteButton_clicked"></a>
229 <h4>UnknownDevicesDialog.on_deleteButton_clicked</h4>
230 <b>on_deleteButton_clicked</b>(<i></i>)
231
232 <p>
233 Private slot to delete the selected entries.
234 </p>
235 <a NAME="UnknownDevicesDialog.on_deviceList_itemActivated" ID="UnknownDevicesDialog.on_deviceList_itemActivated"></a>
236 <h4>UnknownDevicesDialog.on_deviceList_itemActivated</h4>
237 <b>on_deviceList_itemActivated</b>(<i>item</i>)
238
239 <p>
240 Private slot to edit the data of the activated item.
241 </p>
242 <dl>
243
244 <dt><i>item</i> (QListWidgetItem)</dt>
245 <dd>
246 reference to the activated item
247 </dd>
248 </dl>
249 <a NAME="UnknownDevicesDialog.on_deviceList_itemSelectionChanged" ID="UnknownDevicesDialog.on_deviceList_itemSelectionChanged"></a>
250 <h4>UnknownDevicesDialog.on_deviceList_itemSelectionChanged</h4>
251 <b>on_deviceList_itemSelectionChanged</b>(<i></i>)
252
253 <p>
254 Private slot to handle a change of selected items.
255 </p>
256 <a NAME="UnknownDevicesDialog.on_editButton_clicked" ID="UnknownDevicesDialog.on_editButton_clicked"></a>
257 <h4>UnknownDevicesDialog.on_editButton_clicked</h4>
258 <b>on_editButton_clicked</b>(<i></i>)
259
260 <p>
261 Private slot to edit the selected item.
262 </p>
263 <a NAME="UnknownDevicesDialog.on_reportButton_clicked" ID="UnknownDevicesDialog.on_reportButton_clicked"></a>
264 <h4>UnknownDevicesDialog.on_reportButton_clicked</h4>
265 <b>on_reportButton_clicked</b>(<i></i>)
266
267 <p>
268 Private slot to report the data of all boards to the eric-bugs email
269 address.
270 </p>
271 <a NAME="UnknownDevicesDialog.on_restoreButton_clicked" ID="UnknownDevicesDialog.on_restoreButton_clicked"></a>
272 <h4>UnknownDevicesDialog.on_restoreButton_clicked</h4>
273 <b>on_restoreButton_clicked</b>(<i></i>)
274
275 <p>
276 Private slot to restore the list of unknown devices.
277 </p>
278 <div align="right"><a href="#top">Up</a></div>
279 <hr />
280 </body></html>

eric ide

mercurial