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

branch
eric7
changeset 10479
856476537696
parent 10015
9352f33732ae
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.MicroPython.MicroPythonReplWidget</h1> 9 <h1>eric7.MicroPython.MicroPythonReplWidget</h1>
10
11 <p> 10 <p>
12 Module implementing the MicroPython REPL widget. 11 Module implementing the MicroPython REPL widget.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15
16 <table> 15 <table>
17 <tr><td>AnsiColorSchemes</td></tr> 16 <tr><td>AnsiColorSchemes</td></tr>
18 </table> 17 </table>
18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#MicroPythonReplEdit">MicroPythonReplEdit</a></td> 22 <td><a href="#MicroPythonReplEdit">MicroPythonReplEdit</a></td>
25 <td>Class implementing the REPL edit pane.</td> 23 <td>Class implementing the REPL edit pane.</td>
26 </tr> 24 </tr>
27 <tr> 25 <tr>
28 <td><a href="#MicroPythonReplWidget">MicroPythonReplWidget</a></td> 26 <td><a href="#MicroPythonReplWidget">MicroPythonReplWidget</a></td>
29 <td>Class implementing the MicroPython REPL widget.</td> 27 <td>Class implementing the MicroPython REPL widget.</td>
30 </tr> 28 </tr>
31 </table> 29 </table>
30
32 <h3>Functions</h3> 31 <h3>Functions</h3>
33 32 <table>
34 <table> 33 <tr><td>None</td></tr>
35 <tr><td>None</td></tr> 34 </table>
36 </table> 35
37 <hr /> 36 <hr />
38 <hr /> 37 <hr />
39 <a NAME="MicroPythonReplEdit" ID="MicroPythonReplEdit"></a> 38 <a NAME="MicroPythonReplEdit" ID="MicroPythonReplEdit"></a>
40 <h2>MicroPythonReplEdit</h2> 39 <h2>MicroPythonReplEdit</h2>
41
42 <p> 40 <p>
43 Class implementing the REPL edit pane. 41 Class implementing the REPL edit pane.
44 </p> 42 </p>
43
45 <h3>Signals</h3> 44 <h3>Signals</h3>
46 <dl> 45 <dl>
47 46
48 <dt>osdInfo(str)</dt> 47 <dt>osdInfo(str)</dt>
49 <dd> 48 <dd>
51 </dd> 50 </dd>
52 </dl> 51 </dl>
53 <h3>Derived from</h3> 52 <h3>Derived from</h3>
54 QTextEdit 53 QTextEdit
55 <h3>Class Attributes</h3> 54 <h3>Class Attributes</h3>
56 55 <table>
57 <table> 56 <tr><td>None</td></tr>
58 <tr><td>None</td></tr> 57 </table>
59 </table> 58
60 <h3>Class Methods</h3> 59 <h3>Class Methods</h3>
61 60 <table>
62 <table> 61 <tr><td>None</td></tr>
63 <tr><td>None</td></tr> 62 </table>
64 </table> 63
65 <h3>Methods</h3> 64 <h3>Methods</h3>
66 65 <table>
67 <table>
68
69 <tr> 66 <tr>
70 <td><a href="#MicroPythonReplEdit.__init__">MicroPythonReplEdit</a></td> 67 <td><a href="#MicroPythonReplEdit.__init__">MicroPythonReplEdit</a></td>
71 <td>Constructor</td> 68 <td>Constructor</td>
72 </tr> 69 </tr>
73 <tr> 70 <tr>
109 <tr> 106 <tr>
110 <td><a href="#MicroPythonReplEdit.setInterface">setInterface</a></td> 107 <td><a href="#MicroPythonReplEdit.setInterface">setInterface</a></td>
111 <td>Public method to set the reference to the device interface object.</td> 108 <td>Public method to set the reference to the device interface object.</td>
112 </tr> 109 </tr>
113 </table> 110 </table>
111
114 <h3>Static Methods</h3> 112 <h3>Static Methods</h3>
115 113 <table>
116 <table> 114 <tr><td>None</td></tr>
117 <tr><td>None</td></tr> 115 </table>
118 </table> 116
119 117
120 <a NAME="MicroPythonReplEdit.__init__" ID="MicroPythonReplEdit.__init__"></a> 118 <a NAME="MicroPythonReplEdit.__init__" ID="MicroPythonReplEdit.__init__"></a>
121 <h4>MicroPythonReplEdit (Constructor)</h4> 119 <h4>MicroPythonReplEdit (Constructor)</h4>
122 <b>MicroPythonReplEdit</b>(<i>parent=None</i>) 120 <b>MicroPythonReplEdit</b>(<i>parent=None</i>)
123
124 <p> 121 <p>
125 Constructor 122 Constructor
126 </p> 123 </p>
124
127 <dl> 125 <dl>
128 126
129 <dt><i>parent</i> (QWidget (optional))</dt> 127 <dt><i>parent</i> (QWidget (optional))</dt>
130 <dd> 128 <dd>
131 reference to the parent widget (defaults to None) 129 reference to the parent widget (defaults to None)
132 </dd> 130 </dd>
133 </dl> 131 </dl>
134 <a NAME="MicroPythonReplEdit.__clear" ID="MicroPythonReplEdit.__clear"></a> 132 <a NAME="MicroPythonReplEdit.__clear" ID="MicroPythonReplEdit.__clear"></a>
135 <h4>MicroPythonReplEdit.__clear</h4> 133 <h4>MicroPythonReplEdit.__clear</h4>
136 <b>__clear</b>(<i></i>) 134 <b>__clear</b>(<i></i>)
137
138 <p> 135 <p>
139 Private slot to clear the REPL pane. 136 Private slot to clear the REPL pane.
140 </p> 137 </p>
138
141 <a NAME="MicroPythonReplEdit.__paste" ID="MicroPythonReplEdit.__paste"></a> 139 <a NAME="MicroPythonReplEdit.__paste" ID="MicroPythonReplEdit.__paste"></a>
142 <h4>MicroPythonReplEdit.__paste</h4> 140 <h4>MicroPythonReplEdit.__paste</h4>
143 <b>__paste</b>(<i>mode=QClipboard.Mode.Clipboard</i>) 141 <b>__paste</b>(<i>mode=QClipboard.Mode.Clipboard</i>)
144
145 <p> 142 <p>
146 Private slot to perform a paste operation. 143 Private slot to perform a paste operation.
147 </p> 144 </p>
145
148 <dl> 146 <dl>
149 147
150 <dt><i>mode</i> (QClipboard.Mode (optional))</dt> 148 <dt><i>mode</i> (QClipboard.Mode (optional))</dt>
151 <dd> 149 <dd>
152 paste mode (defaults to QClipboard.Mode.Clipboard) 150 paste mode (defaults to QClipboard.Mode.Clipboard)
153 </dd> 151 </dd>
154 </dl> 152 </dl>
155 <a NAME="MicroPythonReplEdit.__setCharFormat" ID="MicroPythonReplEdit.__setCharFormat"></a> 153 <a NAME="MicroPythonReplEdit.__setCharFormat" ID="MicroPythonReplEdit.__setCharFormat"></a>
156 <h4>MicroPythonReplEdit.__setCharFormat</h4> 154 <h4>MicroPythonReplEdit.__setCharFormat</h4>
157 <b>__setCharFormat</b>(<i>formatCodes, textCursor</i>) 155 <b>__setCharFormat</b>(<i>formatCodes, textCursor</i>)
158
159 <p> 156 <p>
160 Private method setting the current text format of the REPL pane based 157 Private method setting the current text format of the REPL pane based
161 on the passed ANSI codes. 158 on the passed ANSI codes.
162 </p> 159 </p>
163 <p> 160 <p>
210 <li>105: bright background Magenta</li> 207 <li>105: bright background Magenta</li>
211 <li>106: bright background Cyan</li> 208 <li>106: bright background Cyan</li>
212 <li>107: bright background White</li> 209 <li>107: bright background White</li>
213 </ul> 210 </ul>
214 </p> 211 </p>
212
215 <dl> 213 <dl>
216 214
217 <dt><i>formatCodes</i> (list of str)</dt> 215 <dt><i>formatCodes</i> (list of str)</dt>
218 <dd> 216 <dd>
219 list of format codes 217 list of format codes
224 </dd> 222 </dd>
225 </dl> 223 </dl>
226 <a NAME="MicroPythonReplEdit.__showContextMenu" ID="MicroPythonReplEdit.__showContextMenu"></a> 224 <a NAME="MicroPythonReplEdit.__showContextMenu" ID="MicroPythonReplEdit.__showContextMenu"></a>
227 <h4>MicroPythonReplEdit.__showContextMenu</h4> 225 <h4>MicroPythonReplEdit.__showContextMenu</h4>
228 <b>__showContextMenu</b>(<i>pos</i>) 226 <b>__showContextMenu</b>(<i>pos</i>)
229
230 <p> 227 <p>
231 Private slot to show the REPL context menu. 228 Private slot to show the REPL context menu.
232 </p> 229 </p>
230
233 <dl> 231 <dl>
234 232
235 <dt><i>pos</i> (QPoint)</dt> 233 <dt><i>pos</i> (QPoint)</dt>
236 <dd> 234 <dd>
237 position to show the menu at 235 position to show the menu at
238 </dd> 236 </dd>
239 </dl> 237 </dl>
240 <a NAME="MicroPythonReplEdit.doZoom" ID="MicroPythonReplEdit.doZoom"></a> 238 <a NAME="MicroPythonReplEdit.doZoom" ID="MicroPythonReplEdit.doZoom"></a>
241 <h4>MicroPythonReplEdit.doZoom</h4> 239 <h4>MicroPythonReplEdit.doZoom</h4>
242 <b>doZoom</b>(<i>value</i>) 240 <b>doZoom</b>(<i>value</i>)
243
244 <p> 241 <p>
245 Public slot to zoom in or out. 242 Public slot to zoom in or out.
246 </p> 243 </p>
244
247 <dl> 245 <dl>
248 246
249 <dt><i>value</i> (int)</dt> 247 <dt><i>value</i> (int)</dt>
250 <dd> 248 <dd>
251 zoom value 249 zoom value
252 </dd> 250 </dd>
253 </dl> 251 </dl>
254 <a NAME="MicroPythonReplEdit.handlePreferencesChanged" ID="MicroPythonReplEdit.handlePreferencesChanged"></a> 252 <a NAME="MicroPythonReplEdit.handlePreferencesChanged" ID="MicroPythonReplEdit.handlePreferencesChanged"></a>
255 <h4>MicroPythonReplEdit.handlePreferencesChanged</h4> 253 <h4>MicroPythonReplEdit.handlePreferencesChanged</h4>
256 <b>handlePreferencesChanged</b>(<i></i>) 254 <b>handlePreferencesChanged</b>(<i></i>)
257
258 <p> 255 <p>
259 Public slot to handle a change in preferences. 256 Public slot to handle a change in preferences.
260 </p> 257 </p>
258
261 <a NAME="MicroPythonReplEdit.keyPressEvent" ID="MicroPythonReplEdit.keyPressEvent"></a> 259 <a NAME="MicroPythonReplEdit.keyPressEvent" ID="MicroPythonReplEdit.keyPressEvent"></a>
262 <h4>MicroPythonReplEdit.keyPressEvent</h4> 260 <h4>MicroPythonReplEdit.keyPressEvent</h4>
263 <b>keyPressEvent</b>(<i>evt</i>) 261 <b>keyPressEvent</b>(<i>evt</i>)
264
265 <p> 262 <p>
266 Protected method to handle key press events. 263 Protected method to handle key press events.
267 </p> 264 </p>
265
268 <dl> 266 <dl>
269 267
270 <dt><i>evt</i> (QKeyEvent)</dt> 268 <dt><i>evt</i> (QKeyEvent)</dt>
271 <dd> 269 <dd>
272 reference to the key press event 270 reference to the key press event
273 </dd> 271 </dd>
274 </dl> 272 </dl>
275 <a NAME="MicroPythonReplEdit.mouseReleaseEvent" ID="MicroPythonReplEdit.mouseReleaseEvent"></a> 273 <a NAME="MicroPythonReplEdit.mouseReleaseEvent" ID="MicroPythonReplEdit.mouseReleaseEvent"></a>
276 <h4>MicroPythonReplEdit.mouseReleaseEvent</h4> 274 <h4>MicroPythonReplEdit.mouseReleaseEvent</h4>
277 <b>mouseReleaseEvent</b>(<i>evt</i>) 275 <b>mouseReleaseEvent</b>(<i>evt</i>)
278
279 <p> 276 <p>
280 Protected method to handle mouse release events. 277 Protected method to handle mouse release events.
281 </p> 278 </p>
279
282 <dl> 280 <dl>
283 281
284 <dt><i>evt</i> (QMouseEvent)</dt> 282 <dt><i>evt</i> (QMouseEvent)</dt>
285 <dd> 283 <dd>
286 reference to the event object 284 reference to the event object
287 </dd> 285 </dd>
288 </dl> 286 </dl>
289 <a NAME="MicroPythonReplEdit.processData" ID="MicroPythonReplEdit.processData"></a> 287 <a NAME="MicroPythonReplEdit.processData" ID="MicroPythonReplEdit.processData"></a>
290 <h4>MicroPythonReplEdit.processData</h4> 288 <h4>MicroPythonReplEdit.processData</h4>
291 <b>processData</b>(<i>data</i>) 289 <b>processData</b>(<i>data</i>)
292
293 <p> 290 <p>
294 Public slot to process the data received from the device. 291 Public slot to process the data received from the device.
295 </p> 292 </p>
293
296 <dl> 294 <dl>
297 295
298 <dt><i>data</i> (bytes)</dt> 296 <dt><i>data</i> (bytes)</dt>
299 <dd> 297 <dd>
300 data received from the device 298 data received from the device
301 </dd> 299 </dd>
302 </dl> 300 </dl>
303 <a NAME="MicroPythonReplEdit.setInterface" ID="MicroPythonReplEdit.setInterface"></a> 301 <a NAME="MicroPythonReplEdit.setInterface" ID="MicroPythonReplEdit.setInterface"></a>
304 <h4>MicroPythonReplEdit.setInterface</h4> 302 <h4>MicroPythonReplEdit.setInterface</h4>
305 <b>setInterface</b>(<i>deviceInterface</i>) 303 <b>setInterface</b>(<i>deviceInterface</i>)
306
307 <p> 304 <p>
308 Public method to set the reference to the device interface object. 305 Public method to set the reference to the device interface object.
309 </p> 306 </p>
307
310 <dl> 308 <dl>
311 309
312 <dt><i>deviceInterface</i> (MicroPythonDeviceInterface)</dt> 310 <dt><i>deviceInterface</i> (MicroPythonDeviceInterface)</dt>
313 <dd> 311 <dd>
314 reference to the device interface object 312 reference to the device interface object
317 <div align="right"><a href="#top">Up</a></div> 315 <div align="right"><a href="#top">Up</a></div>
318 <hr /> 316 <hr />
319 <hr /> 317 <hr />
320 <a NAME="MicroPythonReplWidget" ID="MicroPythonReplWidget"></a> 318 <a NAME="MicroPythonReplWidget" ID="MicroPythonReplWidget"></a>
321 <h2>MicroPythonReplWidget</h2> 319 <h2>MicroPythonReplWidget</h2>
322
323 <p> 320 <p>
324 Class implementing the MicroPython REPL widget. 321 Class implementing the MicroPython REPL widget.
325 </p> 322 </p>
323
326 <h3>Derived from</h3> 324 <h3>Derived from</h3>
327 QWidget 325 QWidget
328 <h3>Class Attributes</h3> 326 <h3>Class Attributes</h3>
329 327 <table>
330 <table> 328 <tr><td>ZoomMax</td></tr>
331 <tr><td>ZoomMax</td></tr><tr><td>ZoomMin</td></tr> 329 <tr><td>ZoomMin</td></tr>
332 </table> 330 </table>
331
333 <h3>Class Methods</h3> 332 <h3>Class Methods</h3>
334 333 <table>
335 <table> 334 <tr><td>None</td></tr>
336 <tr><td>None</td></tr> 335 </table>
337 </table> 336
338 <h3>Methods</h3> 337 <h3>Methods</h3>
339 338 <table>
340 <table>
341
342 <tr> 339 <tr>
343 <td><a href="#MicroPythonReplWidget.__init__">MicroPythonReplWidget</a></td> 340 <td><a href="#MicroPythonReplWidget.__init__">MicroPythonReplWidget</a></td>
344 <td>Constructor</td> 341 <td>Constructor</td>
345 </tr> 342 </tr>
346 <tr> 343 <tr>
354 <tr> 351 <tr>
355 <td><a href="#MicroPythonReplWidget.setOSDInfo">setOSDInfo</a></td> 352 <td><a href="#MicroPythonReplWidget.setOSDInfo">setOSDInfo</a></td>
356 <td>Public slot to set the OSD information.</td> 353 <td>Public slot to set the OSD information.</td>
357 </tr> 354 </tr>
358 </table> 355 </table>
356
359 <h3>Static Methods</h3> 357 <h3>Static Methods</h3>
360 358 <table>
361 <table> 359 <tr><td>None</td></tr>
362 <tr><td>None</td></tr> 360 </table>
363 </table> 361
364 362
365 <a NAME="MicroPythonReplWidget.__init__" ID="MicroPythonReplWidget.__init__"></a> 363 <a NAME="MicroPythonReplWidget.__init__" ID="MicroPythonReplWidget.__init__"></a>
366 <h4>MicroPythonReplWidget (Constructor)</h4> 364 <h4>MicroPythonReplWidget (Constructor)</h4>
367 <b>MicroPythonReplWidget</b>(<i>parent=None</i>) 365 <b>MicroPythonReplWidget</b>(<i>parent=None</i>)
368
369 <p> 366 <p>
370 Constructor 367 Constructor
371 </p> 368 </p>
369
372 <dl> 370 <dl>
373 371
374 <dt><i>parent</i> (QWidget (optional))</dt> 372 <dt><i>parent</i> (QWidget (optional))</dt>
375 <dd> 373 <dd>
376 reference to the parent widget (defaults to None) 374 reference to the parent widget (defaults to None)
377 </dd> 375 </dd>
378 </dl> 376 </dl>
379 <a NAME="MicroPythonReplWidget.clearOSD" ID="MicroPythonReplWidget.clearOSD"></a> 377 <a NAME="MicroPythonReplWidget.clearOSD" ID="MicroPythonReplWidget.clearOSD"></a>
380 <h4>MicroPythonReplWidget.clearOSD</h4> 378 <h4>MicroPythonReplWidget.clearOSD</h4>
381 <b>clearOSD</b>(<i></i>) 379 <b>clearOSD</b>(<i></i>)
382
383 <p> 380 <p>
384 Public slot to clear the OSD info. 381 Public slot to clear the OSD info.
385 </p> 382 </p>
383
386 <a NAME="MicroPythonReplWidget.replEdit" ID="MicroPythonReplWidget.replEdit"></a> 384 <a NAME="MicroPythonReplWidget.replEdit" ID="MicroPythonReplWidget.replEdit"></a>
387 <h4>MicroPythonReplWidget.replEdit</h4> 385 <h4>MicroPythonReplWidget.replEdit</h4>
388 <b>replEdit</b>(<i></i>) 386 <b>replEdit</b>(<i></i>)
389
390 <p> 387 <p>
391 Public method to get a reference to the REPL edit. 388 Public method to get a reference to the REPL edit.
392 </p> 389 </p>
390
393 <dl> 391 <dl>
394 <dt>Return:</dt> 392 <dt>Return:</dt>
395 <dd> 393 <dd>
396 reference to the REPL edit 394 reference to the REPL edit
397 </dd> 395 </dd>
403 </dd> 401 </dd>
404 </dl> 402 </dl>
405 <a NAME="MicroPythonReplWidget.setOSDInfo" ID="MicroPythonReplWidget.setOSDInfo"></a> 403 <a NAME="MicroPythonReplWidget.setOSDInfo" ID="MicroPythonReplWidget.setOSDInfo"></a>
406 <h4>MicroPythonReplWidget.setOSDInfo</h4> 404 <h4>MicroPythonReplWidget.setOSDInfo</h4>
407 <b>setOSDInfo</b>(<i>infoStr</i>) 405 <b>setOSDInfo</b>(<i>infoStr</i>)
408
409 <p> 406 <p>
410 Public slot to set the OSD information. 407 Public slot to set the OSD information.
411 </p> 408 </p>
409
412 <dl> 410 <dl>
413 411
414 <dt><i>infoStr</i> (str)</dt> 412 <dt><i>infoStr</i> (str)</dt>
415 <dd> 413 <dd>
416 string to be shown 414 string to be shown

eric ide

mercurial