Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric4.QScintilla.Shell.html

Documentation/Source/eric4.QScintilla.Shell.html

changeset 3
0d9daebf5b8c
equal deleted inserted replaced
2:bc6196164237 3:0d9daebf5b8c
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
4 <html><head>
5 <title>eric4.QScintilla.Shell</title>
6 <style>
7 body {
8 background:white;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #4FA4FF; }
14 h2 { color: white; background: #4FA4FF; }
15 h3 { color: white; background: #00557F; }
16 h4 { color: white; background: #00557F; }
17
18 a { color: #AA5500; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>eric4.QScintilla.Shell</h1>
24 <p>
25 Module implementing a graphical Python shell.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <tr><td>None</td></tr>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#Shell">Shell</a></td>
35 <td>Class implementing a graphical Python shell.</td>
36 </tr>
37 </table>
38 <h3>Functions</h3>
39 <table>
40 <tr><td>None</td></tr>
41 </table>
42 <hr /><hr />
43 <a NAME="Shell" ID="Shell"></a>
44 <h2>Shell</h2>
45 <p>
46 Class implementing a graphical Python shell.
47 </p><p>
48 A user can enter commands that are executed in the remote
49 Python interpreter.
50 </p>
51 <h3>Derived from</h3>
52 QsciScintillaCompat
53 <h3>Class Attributes</h3>
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Methods</h3>
58 <table>
59 <tr>
60 <td><a href="#Shell.__init__">Shell</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#Shell.__QScintillaAutoCompletionCommand">__QScintillaAutoCompletionCommand</a></td>
64 <td>Private method to handle a command for autocompletion only.</td>
65 </tr><tr>
66 <td><a href="#Shell.__QScintillaCharLeft">__QScintillaCharLeft</a></td>
67 <td>Private method to handle the Cursor Left command.</td>
68 </tr><tr>
69 <td><a href="#Shell.__QScintillaCharLeftExtend">__QScintillaCharLeftExtend</a></td>
70 <td>Private method to handle the Extend Selection Left command.</td>
71 </tr><tr>
72 <td><a href="#Shell.__QScintillaCharRight">__QScintillaCharRight</a></td>
73 <td>Private method to handle the Cursor Right command.</td>
74 </tr><tr>
75 <td><a href="#Shell.__QScintillaDelete">__QScintillaDelete</a></td>
76 <td>Private method to handle the delete command.</td>
77 </tr><tr>
78 <td><a href="#Shell.__QScintillaDeleteBack">__QScintillaDeleteBack</a></td>
79 <td>Private method to handle the Backspace key.</td>
80 </tr><tr>
81 <td><a href="#Shell.__QScintillaDeleteLineLeft">__QScintillaDeleteLineLeft</a></td>
82 <td>Private method to handle the Delete Line Left command.</td>
83 </tr><tr>
84 <td><a href="#Shell.__QScintillaDeleteLineRight">__QScintillaDeleteLineRight</a></td>
85 <td>Private method to handle the Delete Line Right command.</td>
86 </tr><tr>
87 <td><a href="#Shell.__QScintillaDeleteWordLeft">__QScintillaDeleteWordLeft</a></td>
88 <td>Private method to handle the Delete Word Left command.</td>
89 </tr><tr>
90 <td><a href="#Shell.__QScintillaDeleteWordRight">__QScintillaDeleteWordRight</a></td>
91 <td>Private method to handle the Delete Word Right command.</td>
92 </tr><tr>
93 <td><a href="#Shell.__QScintillaLeftCommand">__QScintillaLeftCommand</a></td>
94 <td>Private method to handle a QScintilla command working to the left.</td>
95 </tr><tr>
96 <td><a href="#Shell.__QScintillaLeftDeleteCommand">__QScintillaLeftDeleteCommand</a></td>
97 <td>Private method to handle a QScintilla delete command working to the left.</td>
98 </tr><tr>
99 <td><a href="#Shell.__QScintillaLineDown">__QScintillaLineDown</a></td>
100 <td>Private method to handle the Down key.</td>
101 </tr><tr>
102 <td><a href="#Shell.__QScintillaLineEnd">__QScintillaLineEnd</a></td>
103 <td>Private method to handle the End key.</td>
104 </tr><tr>
105 <td><a href="#Shell.__QScintillaLineUp">__QScintillaLineUp</a></td>
106 <td>Private method to handle the Up key.</td>
107 </tr><tr>
108 <td><a href="#Shell.__QScintillaNewline">__QScintillaNewline</a></td>
109 <td>Private method to handle the Return key.</td>
110 </tr><tr>
111 <td><a href="#Shell.__QScintillaRightCommand">__QScintillaRightCommand</a></td>
112 <td>Private method to handle a QScintilla command working to the right.</td>
113 </tr><tr>
114 <td><a href="#Shell.__QScintillaTab">__QScintillaTab</a></td>
115 <td>Private method to handle the Tab key.</td>
116 </tr><tr>
117 <td><a href="#Shell.__QScintillaVCHome">__QScintillaVCHome</a></td>
118 <td>Private method to handle the Home key.</td>
119 </tr><tr>
120 <td><a href="#Shell.__QScintillaVCHomeExtend">__QScintillaVCHomeExtend</a></td>
121 <td>Private method to handle the Extend Selection to start of line command.</td>
122 </tr><tr>
123 <td><a href="#Shell.__QScintillaWordLeft">__QScintillaWordLeft</a></td>
124 <td>Private method to handle the Cursor Word Left command.</td>
125 </tr><tr>
126 <td><a href="#Shell.__QScintillaWordLeftExtend">__QScintillaWordLeftExtend</a></td>
127 <td>Private method to handle the Extend Selection Left one word command.</td>
128 </tr><tr>
129 <td><a href="#Shell.__QScintillaWordRight">__QScintillaWordRight</a></td>
130 <td>Private method to handle the Cursor Word Right command.</td>
131 </tr><tr>
132 <td><a href="#Shell.__bindLexer">__bindLexer</a></td>
133 <td>Private slot to set the lexer.</td>
134 </tr><tr>
135 <td><a href="#Shell.__clearCurrentLine">__clearCurrentLine</a></td>
136 <td>Private method to clear the line containing the cursor.</td>
137 </tr><tr>
138 <td><a href="#Shell.__clearHistory">__clearHistory</a></td>
139 <td>Private slot to clear the current history.</td>
140 </tr><tr>
141 <td><a href="#Shell.__clientCapabilities">__clientCapabilities</a></td>
142 <td>Private slot to handle the reporting of the clients capabilities.</td>
143 </tr><tr>
144 <td><a href="#Shell.__clientError">__clientError</a></td>
145 <td>Private method to handle an error in the client.</td>
146 </tr><tr>
147 <td><a href="#Shell.__clientStatement">__clientStatement</a></td>
148 <td>Private method to handle the response from the debugger client.</td>
149 </tr><tr>
150 <td><a href="#Shell.__completionListSelected">__completionListSelected</a></td>
151 <td>Private slot to handle the selection from the completion list.</td>
152 </tr><tr>
153 <td><a href="#Shell.__configure">__configure</a></td>
154 <td>Private method to open the configuration dialog.</td>
155 </tr><tr>
156 <td><a href="#Shell.__executeCommand">__executeCommand</a></td>
157 <td>Private slot to execute a command.</td>
158 </tr><tr>
159 <td><a href="#Shell.__getBanner">__getBanner</a></td>
160 <td>Private method to get the banner for the remote interpreter.</td>
161 </tr><tr>
162 <td><a href="#Shell.__getEndPos">__getEndPos</a></td>
163 <td>Private method to return the line and column of the last character.</td>
164 </tr><tr>
165 <td><a href="#Shell.__initialise">__initialise</a></td>
166 <td>Private method to get ready for a new remote interpreter.</td>
167 </tr><tr>
168 <td><a href="#Shell.__insertHistory">__insertHistory</a></td>
169 <td>Private method to insert a command selected from the history.</td>
170 </tr><tr>
171 <td><a href="#Shell.__insertText">__insertText</a></td>
172 <td>Private method to insert some text at the current cursor position.</td>
173 </tr><tr>
174 <td><a href="#Shell.__insertTextAtEnd">__insertTextAtEnd</a></td>
175 <td>Private method to insert some text at the end of the command line.</td>
176 </tr><tr>
177 <td><a href="#Shell.__insertTextNoEcho">__insertTextNoEcho</a></td>
178 <td>Private method to insert some text at the end of the buffer without echoing it.</td>
179 </tr><tr>
180 <td><a href="#Shell.__isCursorOnLastLine">__isCursorOnLastLine</a></td>
181 <td>Private method to check, if the cursor is on the last line.</td>
182 </tr><tr>
183 <td><a href="#Shell.__middleMouseButton">__middleMouseButton</a></td>
184 <td>Private method to handle the middle mouse button press.</td>
185 </tr><tr>
186 <td><a href="#Shell.__raw_input">__raw_input</a></td>
187 <td>Private method to handle raw input.</td>
188 </tr><tr>
189 <td><a href="#Shell.__reset">__reset</a></td>
190 <td>Private slot to handle the 'reset' context menu entry.</td>
191 </tr><tr>
192 <td><a href="#Shell.__resetAndClear">__resetAndClear</a></td>
193 <td>Private slot to handle the 'reset and clear' context menu entry.</td>
194 </tr><tr>
195 <td><a href="#Shell.__rsearchHistory">__rsearchHistory</a></td>
196 <td>Private method used to reverse search the history.</td>
197 </tr><tr>
198 <td><a href="#Shell.__searchHistory">__searchHistory</a></td>
199 <td>Private method used to search the history.</td>
200 </tr><tr>
201 <td><a href="#Shell.__selectHistory">__selectHistory</a></td>
202 <td>Private slot to select a history entry to execute.</td>
203 </tr><tr>
204 <td><a href="#Shell.__setAutoCompletion">__setAutoCompletion</a></td>
205 <td>Private method to configure the autocompletion function.</td>
206 </tr><tr>
207 <td><a href="#Shell.__setCallTips">__setCallTips</a></td>
208 <td>Private method to configure the calltips function.</td>
209 </tr><tr>
210 <td><a href="#Shell.__setMargin0">__setMargin0</a></td>
211 <td>Private method to configure margin 0.</td>
212 </tr><tr>
213 <td><a href="#Shell.__setMonospaced">__setMonospaced</a></td>
214 <td>Private method to set/reset a monospaced font.</td>
215 </tr><tr>
216 <td><a href="#Shell.__setTextDisplay">__setTextDisplay</a></td>
217 <td>Private method to configure the text display.</td>
218 </tr><tr>
219 <td><a href="#Shell.__showCompletions">__showCompletions</a></td>
220 <td>Private method to display the possible completions.</td>
221 </tr><tr>
222 <td><a href="#Shell.__showHistory">__showHistory</a></td>
223 <td>Private slot to show the shell history dialog.</td>
224 </tr><tr>
225 <td><a href="#Shell.__startDebugClient">__startDebugClient</a></td>
226 <td>Private slot to start a debug client accoding to the action triggered.</td>
227 </tr><tr>
228 <td><a href="#Shell.__useHistory">__useHistory</a></td>
229 <td>Private method to display a command from the history.</td>
230 </tr><tr>
231 <td><a href="#Shell.__write">__write</a></td>
232 <td>Private method to display some text.</td>
233 </tr><tr>
234 <td><a href="#Shell.__writeBanner">__writeBanner</a></td>
235 <td>Private method to write a banner with info from the debug client.</td>
236 </tr><tr>
237 <td><a href="#Shell.__writePrompt">__writePrompt</a></td>
238 <td>Private method to write the prompt.</td>
239 </tr><tr>
240 <td><a href="#Shell.__writeStdErr">__writeStdErr</a></td>
241 <td>Private method to display some text with StdErr label.</td>
242 </tr><tr>
243 <td><a href="#Shell.__writeStdOut">__writeStdOut</a></td>
244 <td>Private method to display some text with StdOut label.</td>
245 </tr><tr>
246 <td><a href="#Shell.clear">clear</a></td>
247 <td>Public slot to clear the display.</td>
248 </tr><tr>
249 <td><a href="#Shell.closeShell">closeShell</a></td>
250 <td>Public method to shutdown the shell.</td>
251 </tr><tr>
252 <td><a href="#Shell.contextMenuEvent">contextMenuEvent</a></td>
253 <td>Reimplemented to show our own context menu.</td>
254 </tr><tr>
255 <td><a href="#Shell.dragEnterEvent">dragEnterEvent</a></td>
256 <td>Protected method to handle the drag enter event.</td>
257 </tr><tr>
258 <td><a href="#Shell.dragLeaveEvent">dragLeaveEvent</a></td>
259 <td>Protected method to handle the drag leave event.</td>
260 </tr><tr>
261 <td><a href="#Shell.dragMoveEvent">dragMoveEvent</a></td>
262 <td>Protected method to handle the drag move event.</td>
263 </tr><tr>
264 <td><a href="#Shell.dropEvent">dropEvent</a></td>
265 <td>Protected method to handle the drop event.</td>
266 </tr><tr>
267 <td><a href="#Shell.editorCommand">editorCommand</a></td>
268 <td>Public method to perform an editor command.</td>
269 </tr><tr>
270 <td><a href="#Shell.executeLines">executeLines</a></td>
271 <td>Public method to execute a set of lines as multiple commands.</td>
272 </tr><tr>
273 <td><a href="#Shell.focusInEvent">focusInEvent</a></td>
274 <td>Public method called when the shell receives focus.</td>
275 </tr><tr>
276 <td><a href="#Shell.focusNextPrevChild">focusNextPrevChild</a></td>
277 <td>Reimplemented to stop Tab moving to the next window.</td>
278 </tr><tr>
279 <td><a href="#Shell.focusOutEvent">focusOutEvent</a></td>
280 <td>Public method called when the shell loses focus.</td>
281 </tr><tr>
282 <td><a href="#Shell.getClientType">getClientType</a></td>
283 <td>Public slot to get the clients type.</td>
284 </tr><tr>
285 <td><a href="#Shell.getHistory">getHistory</a></td>
286 <td>Public method to get the history for the given client type.</td>
287 </tr><tr>
288 <td><a href="#Shell.handlePreferencesChanged">handlePreferencesChanged</a></td>
289 <td>Public slot to handle the preferencesChanged signal.</td>
290 </tr><tr>
291 <td><a href="#Shell.insert">insert</a></td>
292 <td>Public slot to insert text at the current cursor position.</td>
293 </tr><tr>
294 <td><a href="#Shell.keyPressEvent">keyPressEvent</a></td>
295 <td>Re-implemented to handle the user input a key at a time.</td>
296 </tr><tr>
297 <td><a href="#Shell.loadHistory">loadHistory</a></td>
298 <td>Public method to load the history for the given client type.</td>
299 </tr><tr>
300 <td><a href="#Shell.mousePressEvent">mousePressEvent</a></td>
301 <td>Protected method to handle the mouse press event.</td>
302 </tr><tr>
303 <td><a href="#Shell.paste">paste</a></td>
304 <td>Reimplemented slot to handle the paste action.</td>
305 </tr><tr>
306 <td><a href="#Shell.reloadHistory">reloadHistory</a></td>
307 <td>Public method to reload the history of the currently selected client type.</td>
308 </tr><tr>
309 <td><a href="#Shell.saveHistory">saveHistory</a></td>
310 <td>Public method to save the history for the given client type.</td>
311 </tr><tr>
312 <td><a href="#Shell.setDebuggerUI">setDebuggerUI</a></td>
313 <td>Public method to set the debugger UI.</td>
314 </tr>
315 </table>
316 <a NAME="Shell.__init__" ID="Shell.__init__"></a>
317 <h4>Shell (Constructor)</h4>
318 <b>Shell</b>(<i>dbs, vm, parent = None</i>)
319 <p>
320 Constructor
321 </p><dl>
322 <dt><i>dbs</i></dt>
323 <dd>
324 reference to the debug server object
325 </dd><dt><i>vm</i></dt>
326 <dd>
327 reference to the viewmanager object
328 </dd><dt><i>parent</i></dt>
329 <dd>
330 parent widget (QWidget)
331 </dd>
332 </dl><a NAME="Shell.__QScintillaAutoCompletionCommand" ID="Shell.__QScintillaAutoCompletionCommand"></a>
333 <h4>Shell.__QScintillaAutoCompletionCommand</h4>
334 <b>__QScintillaAutoCompletionCommand</b>(<i>cmd</i>)
335 <p>
336 Private method to handle a command for autocompletion only.
337 </p><dl>
338 <dt><i>cmd</i></dt>
339 <dd>
340 QScintilla command
341 </dd>
342 </dl><a NAME="Shell.__QScintillaCharLeft" ID="Shell.__QScintillaCharLeft"></a>
343 <h4>Shell.__QScintillaCharLeft</h4>
344 <b>__QScintillaCharLeft</b>(<i></i>)
345 <p>
346 Private method to handle the Cursor Left command.
347 </p><a NAME="Shell.__QScintillaCharLeftExtend" ID="Shell.__QScintillaCharLeftExtend"></a>
348 <h4>Shell.__QScintillaCharLeftExtend</h4>
349 <b>__QScintillaCharLeftExtend</b>(<i></i>)
350 <p>
351 Private method to handle the Extend Selection Left command.
352 </p><a NAME="Shell.__QScintillaCharRight" ID="Shell.__QScintillaCharRight"></a>
353 <h4>Shell.__QScintillaCharRight</h4>
354 <b>__QScintillaCharRight</b>(<i></i>)
355 <p>
356 Private method to handle the Cursor Right command.
357 </p><a NAME="Shell.__QScintillaDelete" ID="Shell.__QScintillaDelete"></a>
358 <h4>Shell.__QScintillaDelete</h4>
359 <b>__QScintillaDelete</b>(<i></i>)
360 <p>
361 Private method to handle the delete command.
362 </p><a NAME="Shell.__QScintillaDeleteBack" ID="Shell.__QScintillaDeleteBack"></a>
363 <h4>Shell.__QScintillaDeleteBack</h4>
364 <b>__QScintillaDeleteBack</b>(<i></i>)
365 <p>
366 Private method to handle the Backspace key.
367 </p><a NAME="Shell.__QScintillaDeleteLineLeft" ID="Shell.__QScintillaDeleteLineLeft"></a>
368 <h4>Shell.__QScintillaDeleteLineLeft</h4>
369 <b>__QScintillaDeleteLineLeft</b>(<i></i>)
370 <p>
371 Private method to handle the Delete Line Left command.
372 </p><a NAME="Shell.__QScintillaDeleteLineRight" ID="Shell.__QScintillaDeleteLineRight"></a>
373 <h4>Shell.__QScintillaDeleteLineRight</h4>
374 <b>__QScintillaDeleteLineRight</b>(<i></i>)
375 <p>
376 Private method to handle the Delete Line Right command.
377 </p><a NAME="Shell.__QScintillaDeleteWordLeft" ID="Shell.__QScintillaDeleteWordLeft"></a>
378 <h4>Shell.__QScintillaDeleteWordLeft</h4>
379 <b>__QScintillaDeleteWordLeft</b>(<i></i>)
380 <p>
381 Private method to handle the Delete Word Left command.
382 </p><a NAME="Shell.__QScintillaDeleteWordRight" ID="Shell.__QScintillaDeleteWordRight"></a>
383 <h4>Shell.__QScintillaDeleteWordRight</h4>
384 <b>__QScintillaDeleteWordRight</b>(<i></i>)
385 <p>
386 Private method to handle the Delete Word Right command.
387 </p><a NAME="Shell.__QScintillaLeftCommand" ID="Shell.__QScintillaLeftCommand"></a>
388 <h4>Shell.__QScintillaLeftCommand</h4>
389 <b>__QScintillaLeftCommand</b>(<i>method, allLinesAllowed = False</i>)
390 <p>
391 Private method to handle a QScintilla command working to the left.
392 </p><dl>
393 <dt><i>method</i></dt>
394 <dd>
395 shell method to execute
396 </dd><dt><i>allLinesAllowed</i></dt>
397 <dd>
398 flag indicating that the command may be executed
399 on any line (boolean)
400 </dd>
401 </dl><a NAME="Shell.__QScintillaLeftDeleteCommand" ID="Shell.__QScintillaLeftDeleteCommand"></a>
402 <h4>Shell.__QScintillaLeftDeleteCommand</h4>
403 <b>__QScintillaLeftDeleteCommand</b>(<i>method</i>)
404 <p>
405 Private method to handle a QScintilla delete command working to the left.
406 </p><dl>
407 <dt><i>method</i></dt>
408 <dd>
409 shell method to execute
410 </dd>
411 </dl><a NAME="Shell.__QScintillaLineDown" ID="Shell.__QScintillaLineDown"></a>
412 <h4>Shell.__QScintillaLineDown</h4>
413 <b>__QScintillaLineDown</b>(<i>cmd</i>)
414 <p>
415 Private method to handle the Down key.
416 </p><dl>
417 <dt><i>cmd</i></dt>
418 <dd>
419 QScintilla command
420 </dd>
421 </dl><a NAME="Shell.__QScintillaLineEnd" ID="Shell.__QScintillaLineEnd"></a>
422 <h4>Shell.__QScintillaLineEnd</h4>
423 <b>__QScintillaLineEnd</b>(<i>cmd</i>)
424 <p>
425 Private method to handle the End key.
426 </p><dl>
427 <dt><i>cmd</i></dt>
428 <dd>
429 QScintilla command
430 </dd>
431 </dl><a NAME="Shell.__QScintillaLineUp" ID="Shell.__QScintillaLineUp"></a>
432 <h4>Shell.__QScintillaLineUp</h4>
433 <b>__QScintillaLineUp</b>(<i>cmd</i>)
434 <p>
435 Private method to handle the Up key.
436 </p><dl>
437 <dt><i>cmd</i></dt>
438 <dd>
439 QScintilla command
440 </dd>
441 </dl><a NAME="Shell.__QScintillaNewline" ID="Shell.__QScintillaNewline"></a>
442 <h4>Shell.__QScintillaNewline</h4>
443 <b>__QScintillaNewline</b>(<i>cmd</i>)
444 <p>
445 Private method to handle the Return key.
446 </p><dl>
447 <dt><i>cmd</i></dt>
448 <dd>
449 QScintilla command
450 </dd>
451 </dl><a NAME="Shell.__QScintillaRightCommand" ID="Shell.__QScintillaRightCommand"></a>
452 <h4>Shell.__QScintillaRightCommand</h4>
453 <b>__QScintillaRightCommand</b>(<i>method</i>)
454 <p>
455 Private method to handle a QScintilla command working to the right.
456 </p><dl>
457 <dt><i>method</i></dt>
458 <dd>
459 shell method to execute
460 </dd>
461 </dl><a NAME="Shell.__QScintillaTab" ID="Shell.__QScintillaTab"></a>
462 <h4>Shell.__QScintillaTab</h4>
463 <b>__QScintillaTab</b>(<i>cmd</i>)
464 <p>
465 Private method to handle the Tab key.
466 </p><dl>
467 <dt><i>cmd</i></dt>
468 <dd>
469 QScintilla command
470 </dd>
471 </dl><a NAME="Shell.__QScintillaVCHome" ID="Shell.__QScintillaVCHome"></a>
472 <h4>Shell.__QScintillaVCHome</h4>
473 <b>__QScintillaVCHome</b>(<i>cmd</i>)
474 <p>
475 Private method to handle the Home key.
476 </p><dl>
477 <dt><i>cmd</i></dt>
478 <dd>
479 QScintilla command
480 </dd>
481 </dl><a NAME="Shell.__QScintillaVCHomeExtend" ID="Shell.__QScintillaVCHomeExtend"></a>
482 <h4>Shell.__QScintillaVCHomeExtend</h4>
483 <b>__QScintillaVCHomeExtend</b>(<i></i>)
484 <p>
485 Private method to handle the Extend Selection to start of line command.
486 </p><a NAME="Shell.__QScintillaWordLeft" ID="Shell.__QScintillaWordLeft"></a>
487 <h4>Shell.__QScintillaWordLeft</h4>
488 <b>__QScintillaWordLeft</b>(<i></i>)
489 <p>
490 Private method to handle the Cursor Word Left command.
491 </p><a NAME="Shell.__QScintillaWordLeftExtend" ID="Shell.__QScintillaWordLeftExtend"></a>
492 <h4>Shell.__QScintillaWordLeftExtend</h4>
493 <b>__QScintillaWordLeftExtend</b>(<i></i>)
494 <p>
495 Private method to handle the Extend Selection Left one word command.
496 </p><a NAME="Shell.__QScintillaWordRight" ID="Shell.__QScintillaWordRight"></a>
497 <h4>Shell.__QScintillaWordRight</h4>
498 <b>__QScintillaWordRight</b>(<i></i>)
499 <p>
500 Private method to handle the Cursor Word Right command.
501 </p><a NAME="Shell.__bindLexer" ID="Shell.__bindLexer"></a>
502 <h4>Shell.__bindLexer</h4>
503 <b>__bindLexer</b>(<i>language = 'Python'</i>)
504 <p>
505 Private slot to set the lexer.
506 </p><dl>
507 <dt><i>language</i></dt>
508 <dd>
509 lexer language to set (string)
510 </dd>
511 </dl><a NAME="Shell.__clearCurrentLine" ID="Shell.__clearCurrentLine"></a>
512 <h4>Shell.__clearCurrentLine</h4>
513 <b>__clearCurrentLine</b>(<i></i>)
514 <p>
515 Private method to clear the line containing the cursor.
516 </p><a NAME="Shell.__clearHistory" ID="Shell.__clearHistory"></a>
517 <h4>Shell.__clearHistory</h4>
518 <b>__clearHistory</b>(<i></i>)
519 <p>
520 Private slot to clear the current history.
521 </p><a NAME="Shell.__clientCapabilities" ID="Shell.__clientCapabilities"></a>
522 <h4>Shell.__clientCapabilities</h4>
523 <b>__clientCapabilities</b>(<i>cap, clType</i>)
524 <p>
525 Private slot to handle the reporting of the clients capabilities.
526 </p><dl>
527 <dt><i>cap</i></dt>
528 <dd>
529 client capabilities (integer)
530 </dd><dt><i>clType</i></dt>
531 <dd>
532 type of the debug client (string)
533 </dd>
534 </dl><a NAME="Shell.__clientError" ID="Shell.__clientError"></a>
535 <h4>Shell.__clientError</h4>
536 <b>__clientError</b>(<i></i>)
537 <p>
538 Private method to handle an error in the client.
539 </p><a NAME="Shell.__clientStatement" ID="Shell.__clientStatement"></a>
540 <h4>Shell.__clientStatement</h4>
541 <b>__clientStatement</b>(<i>more</i>)
542 <p>
543 Private method to handle the response from the debugger client.
544 </p><dl>
545 <dt><i>more</i></dt>
546 <dd>
547 flag indicating that more user input is required (boolean)
548 </dd>
549 </dl><a NAME="Shell.__completionListSelected" ID="Shell.__completionListSelected"></a>
550 <h4>Shell.__completionListSelected</h4>
551 <b>__completionListSelected</b>(<i>id, txt</i>)
552 <p>
553 Private slot to handle the selection from the completion list.
554 </p><dl>
555 <dt><i>id</i></dt>
556 <dd>
557 the ID of the user list (should be 1) (integer)
558 </dd><dt><i>txt</i></dt>
559 <dd>
560 the selected text (string)
561 </dd>
562 </dl><a NAME="Shell.__configure" ID="Shell.__configure"></a>
563 <h4>Shell.__configure</h4>
564 <b>__configure</b>(<i></i>)
565 <p>
566 Private method to open the configuration dialog.
567 </p><a NAME="Shell.__executeCommand" ID="Shell.__executeCommand"></a>
568 <h4>Shell.__executeCommand</h4>
569 <b>__executeCommand</b>(<i>cmd</i>)
570 <p>
571 Private slot to execute a command.
572 </p><dl>
573 <dt><i>cmd</i></dt>
574 <dd>
575 command to be executed by debug client (string)
576 </dd>
577 </dl><a NAME="Shell.__getBanner" ID="Shell.__getBanner"></a>
578 <h4>Shell.__getBanner</h4>
579 <b>__getBanner</b>(<i></i>)
580 <p>
581 Private method to get the banner for the remote interpreter.
582 </p><p>
583 It requests the interpreter version and platform running on the
584 debug client side.
585 </p><a NAME="Shell.__getEndPos" ID="Shell.__getEndPos"></a>
586 <h4>Shell.__getEndPos</h4>
587 <b>__getEndPos</b>(<i></i>)
588 <p>
589 Private method to return the line and column of the last character.
590 </p><dl>
591 <dt>Returns:</dt>
592 <dd>
593 tuple of two values (int, int) giving the line and column
594 </dd>
595 </dl><a NAME="Shell.__initialise" ID="Shell.__initialise"></a>
596 <h4>Shell.__initialise</h4>
597 <b>__initialise</b>(<i></i>)
598 <p>
599 Private method to get ready for a new remote interpreter.
600 </p><a NAME="Shell.__insertHistory" ID="Shell.__insertHistory"></a>
601 <h4>Shell.__insertHistory</h4>
602 <b>__insertHistory</b>(<i>cmd</i>)
603 <p>
604 Private method to insert a command selected from the history.
605 </p><dl>
606 <dt><i>cmd</i></dt>
607 <dd>
608 history entry to be inserted (string)
609 </dd>
610 </dl><a NAME="Shell.__insertText" ID="Shell.__insertText"></a>
611 <h4>Shell.__insertText</h4>
612 <b>__insertText</b>(<i>s</i>)
613 <p>
614 Private method to insert some text at the current cursor position.
615 </p><dl>
616 <dt><i>s</i></dt>
617 <dd>
618 text to be inserted (string)
619 </dd>
620 </dl><a NAME="Shell.__insertTextAtEnd" ID="Shell.__insertTextAtEnd"></a>
621 <h4>Shell.__insertTextAtEnd</h4>
622 <b>__insertTextAtEnd</b>(<i>s</i>)
623 <p>
624 Private method to insert some text at the end of the command line.
625 </p><dl>
626 <dt><i>s</i></dt>
627 <dd>
628 text to be inserted (string)
629 </dd>
630 </dl><a NAME="Shell.__insertTextNoEcho" ID="Shell.__insertTextNoEcho"></a>
631 <h4>Shell.__insertTextNoEcho</h4>
632 <b>__insertTextNoEcho</b>(<i>s</i>)
633 <p>
634 Private method to insert some text at the end of the buffer without echoing it.
635 </p><dl>
636 <dt><i>s</i></dt>
637 <dd>
638 text to be inserted (string)
639 </dd>
640 </dl><a NAME="Shell.__isCursorOnLastLine" ID="Shell.__isCursorOnLastLine"></a>
641 <h4>Shell.__isCursorOnLastLine</h4>
642 <b>__isCursorOnLastLine</b>(<i></i>)
643 <p>
644 Private method to check, if the cursor is on the last line.
645 </p><a NAME="Shell.__middleMouseButton" ID="Shell.__middleMouseButton"></a>
646 <h4>Shell.__middleMouseButton</h4>
647 <b>__middleMouseButton</b>(<i></i>)
648 <p>
649 Private method to handle the middle mouse button press.
650 </p><a NAME="Shell.__raw_input" ID="Shell.__raw_input"></a>
651 <h4>Shell.__raw_input</h4>
652 <b>__raw_input</b>(<i>s, echo</i>)
653 <p>
654 Private method to handle raw input.
655 </p><dl>
656 <dt><i>s</i></dt>
657 <dd>
658 prompt to be displayed (string)
659 </dd><dt><i>echo</i></dt>
660 <dd>
661 Flag indicating echoing of the input (boolean)
662 </dd>
663 </dl><a NAME="Shell.__reset" ID="Shell.__reset"></a>
664 <h4>Shell.__reset</h4>
665 <b>__reset</b>(<i></i>)
666 <p>
667 Private slot to handle the 'reset' context menu entry.
668 </p><a NAME="Shell.__resetAndClear" ID="Shell.__resetAndClear"></a>
669 <h4>Shell.__resetAndClear</h4>
670 <b>__resetAndClear</b>(<i></i>)
671 <p>
672 Private slot to handle the 'reset and clear' context menu entry.
673 </p><a NAME="Shell.__rsearchHistory" ID="Shell.__rsearchHistory"></a>
674 <h4>Shell.__rsearchHistory</h4>
675 <b>__rsearchHistory</b>(<i>txt, startIdx = -1</i>)
676 <p>
677 Private method used to reverse search the history.
678 </p><dl>
679 <dt><i>txt</i></dt>
680 <dd>
681 text to match at the beginning (string)
682 </dd><dt><i>startIdx</i></dt>
683 <dd>
684 index to start search from (integer)
685 </dd>
686 </dl><dl>
687 <dt>Returns:</dt>
688 <dd>
689 index of found entry (integer)
690 </dd>
691 </dl><a NAME="Shell.__searchHistory" ID="Shell.__searchHistory"></a>
692 <h4>Shell.__searchHistory</h4>
693 <b>__searchHistory</b>(<i>txt, startIdx = -1</i>)
694 <p>
695 Private method used to search the history.
696 </p><dl>
697 <dt><i>txt</i></dt>
698 <dd>
699 text to match at the beginning (string)
700 </dd><dt><i>startIdx</i></dt>
701 <dd>
702 index to start search from (integer)
703 </dd>
704 </dl><dl>
705 <dt>Returns:</dt>
706 <dd>
707 index of found entry (integer)
708 </dd>
709 </dl><a NAME="Shell.__selectHistory" ID="Shell.__selectHistory"></a>
710 <h4>Shell.__selectHistory</h4>
711 <b>__selectHistory</b>(<i></i>)
712 <p>
713 Private slot to select a history entry to execute.
714 </p><a NAME="Shell.__setAutoCompletion" ID="Shell.__setAutoCompletion"></a>
715 <h4>Shell.__setAutoCompletion</h4>
716 <b>__setAutoCompletion</b>(<i>language = 'Python'</i>)
717 <p>
718 Private method to configure the autocompletion function.
719 </p><dl>
720 <dt><i>language</i></dt>
721 <dd>
722 of the autocompletion set to set (string)
723 </dd>
724 </dl><a NAME="Shell.__setCallTips" ID="Shell.__setCallTips"></a>
725 <h4>Shell.__setCallTips</h4>
726 <b>__setCallTips</b>(<i>language = 'Python'</i>)
727 <p>
728 Private method to configure the calltips function.
729 </p><dl>
730 <dt><i>language</i></dt>
731 <dd>
732 of the calltips set to set (string)
733 </dd>
734 </dl><a NAME="Shell.__setMargin0" ID="Shell.__setMargin0"></a>
735 <h4>Shell.__setMargin0</h4>
736 <b>__setMargin0</b>(<i></i>)
737 <p>
738 Private method to configure margin 0.
739 </p><a NAME="Shell.__setMonospaced" ID="Shell.__setMonospaced"></a>
740 <h4>Shell.__setMonospaced</h4>
741 <b>__setMonospaced</b>(<i>on</i>)
742 <p>
743 Private method to set/reset a monospaced font.
744 </p><dl>
745 <dt><i>on</i></dt>
746 <dd>
747 flag to indicate usage of a monospace font (boolean)
748 </dd>
749 </dl><a NAME="Shell.__setTextDisplay" ID="Shell.__setTextDisplay"></a>
750 <h4>Shell.__setTextDisplay</h4>
751 <b>__setTextDisplay</b>(<i></i>)
752 <p>
753 Private method to configure the text display.
754 </p><a NAME="Shell.__showCompletions" ID="Shell.__showCompletions"></a>
755 <h4>Shell.__showCompletions</h4>
756 <b>__showCompletions</b>(<i>completions, text</i>)
757 <p>
758 Private method to display the possible completions.
759 </p><dl>
760 <dt><i>completions</i></dt>
761 <dd>
762 list of possible completions (list of strings)
763 </dd><dt><i>text</i></dt>
764 <dd>
765 text that is about to be completed (string)
766 </dd>
767 </dl><a NAME="Shell.__showHistory" ID="Shell.__showHistory"></a>
768 <h4>Shell.__showHistory</h4>
769 <b>__showHistory</b>(<i></i>)
770 <p>
771 Private slot to show the shell history dialog.
772 </p><a NAME="Shell.__startDebugClient" ID="Shell.__startDebugClient"></a>
773 <h4>Shell.__startDebugClient</h4>
774 <b>__startDebugClient</b>(<i>action</i>)
775 <p>
776 Private slot to start a debug client accoding to the action triggered.
777 </p><dl>
778 <dt><i>action</i></dt>
779 <dd>
780 context menu action that was triggered (QAction)
781 </dd>
782 </dl><a NAME="Shell.__useHistory" ID="Shell.__useHistory"></a>
783 <h4>Shell.__useHistory</h4>
784 <b>__useHistory</b>(<i></i>)
785 <p>
786 Private method to display a command from the history.
787 </p><a NAME="Shell.__write" ID="Shell.__write"></a>
788 <h4>Shell.__write</h4>
789 <b>__write</b>(<i>s</i>)
790 <p>
791 Private method to display some text.
792 </p><dl>
793 <dt><i>s</i></dt>
794 <dd>
795 text to be displayed (string)
796 </dd>
797 </dl><a NAME="Shell.__writeBanner" ID="Shell.__writeBanner"></a>
798 <h4>Shell.__writeBanner</h4>
799 <b>__writeBanner</b>(<i>version, platform, dbgclient</i>)
800 <p>
801 Private method to write a banner with info from the debug client.
802 </p><dl>
803 <dt><i>version</i></dt>
804 <dd>
805 interpreter version string (string)
806 </dd><dt><i>platform</i></dt>
807 <dd>
808 platform of the remote interpreter (string)
809 </dd><dt><i>dbgclient</i></dt>
810 <dd>
811 debug client variant used (string)
812 </dd>
813 </dl><a NAME="Shell.__writePrompt" ID="Shell.__writePrompt"></a>
814 <h4>Shell.__writePrompt</h4>
815 <b>__writePrompt</b>(<i></i>)
816 <p>
817 Private method to write the prompt.
818 </p><a NAME="Shell.__writeStdErr" ID="Shell.__writeStdErr"></a>
819 <h4>Shell.__writeStdErr</h4>
820 <b>__writeStdErr</b>(<i>s</i>)
821 <p>
822 Private method to display some text with StdErr label.
823 </p><dl>
824 <dt><i>s</i></dt>
825 <dd>
826 text to be displayed (string)
827 </dd>
828 </dl><a NAME="Shell.__writeStdOut" ID="Shell.__writeStdOut"></a>
829 <h4>Shell.__writeStdOut</h4>
830 <b>__writeStdOut</b>(<i>s</i>)
831 <p>
832 Private method to display some text with StdOut label.
833 </p><dl>
834 <dt><i>s</i></dt>
835 <dd>
836 text to be displayed (string)
837 </dd>
838 </dl><a NAME="Shell.clear" ID="Shell.clear"></a>
839 <h4>Shell.clear</h4>
840 <b>clear</b>(<i></i>)
841 <p>
842 Public slot to clear the display.
843 </p><a NAME="Shell.closeShell" ID="Shell.closeShell"></a>
844 <h4>Shell.closeShell</h4>
845 <b>closeShell</b>(<i></i>)
846 <p>
847 Public method to shutdown the shell.
848 </p><a NAME="Shell.contextMenuEvent" ID="Shell.contextMenuEvent"></a>
849 <h4>Shell.contextMenuEvent</h4>
850 <b>contextMenuEvent</b>(<i>ev</i>)
851 <p>
852 Reimplemented to show our own context menu.
853 </p><dl>
854 <dt><i>ev</i></dt>
855 <dd>
856 context menu event (QContextMenuEvent)
857 </dd>
858 </dl><a NAME="Shell.dragEnterEvent" ID="Shell.dragEnterEvent"></a>
859 <h4>Shell.dragEnterEvent</h4>
860 <b>dragEnterEvent</b>(<i>event</i>)
861 <p>
862 Protected method to handle the drag enter event.
863 </p><dl>
864 <dt><i>event</i></dt>
865 <dd>
866 the drag enter event (QDragEnterEvent)
867 </dd>
868 </dl><a NAME="Shell.dragLeaveEvent" ID="Shell.dragLeaveEvent"></a>
869 <h4>Shell.dragLeaveEvent</h4>
870 <b>dragLeaveEvent</b>(<i>event</i>)
871 <p>
872 Protected method to handle the drag leave event.
873 </p><dl>
874 <dt><i>event</i></dt>
875 <dd>
876 the drag leave event (QDragLeaveEvent)
877 </dd>
878 </dl><a NAME="Shell.dragMoveEvent" ID="Shell.dragMoveEvent"></a>
879 <h4>Shell.dragMoveEvent</h4>
880 <b>dragMoveEvent</b>(<i>event</i>)
881 <p>
882 Protected method to handle the drag move event.
883 </p><dl>
884 <dt><i>event</i></dt>
885 <dd>
886 the drag move event (QDragMoveEvent)
887 </dd>
888 </dl><a NAME="Shell.dropEvent" ID="Shell.dropEvent"></a>
889 <h4>Shell.dropEvent</h4>
890 <b>dropEvent</b>(<i>event</i>)
891 <p>
892 Protected method to handle the drop event.
893 </p><dl>
894 <dt><i>event</i></dt>
895 <dd>
896 the drop event (QDropEvent)
897 </dd>
898 </dl><a NAME="Shell.editorCommand" ID="Shell.editorCommand"></a>
899 <h4>Shell.editorCommand</h4>
900 <b>editorCommand</b>(<i>cmd</i>)
901 <p>
902 Public method to perform an editor command.
903 </p><dl>
904 <dt><i>cmd</i></dt>
905 <dd>
906 the scintilla command to be performed
907 </dd>
908 </dl><a NAME="Shell.executeLines" ID="Shell.executeLines"></a>
909 <h4>Shell.executeLines</h4>
910 <b>executeLines</b>(<i>lines</i>)
911 <p>
912 Public method to execute a set of lines as multiple commands.
913 </p><dl>
914 <dt><i>lines</i></dt>
915 <dd>
916 multiple lines of text to be executed as single
917 commands (string)
918 </dd>
919 </dl><a NAME="Shell.focusInEvent" ID="Shell.focusInEvent"></a>
920 <h4>Shell.focusInEvent</h4>
921 <b>focusInEvent</b>(<i>event</i>)
922 <p>
923 Public method called when the shell receives focus.
924 </p><dl>
925 <dt><i>event</i></dt>
926 <dd>
927 the event object (QFocusEvent)
928 </dd>
929 </dl><a NAME="Shell.focusNextPrevChild" ID="Shell.focusNextPrevChild"></a>
930 <h4>Shell.focusNextPrevChild</h4>
931 <b>focusNextPrevChild</b>(<i>next</i>)
932 <p>
933 Reimplemented to stop Tab moving to the next window.
934 </p><p>
935 While the user is entering a multi-line command, the movement to
936 the next window by the Tab key being pressed is suppressed.
937 </p><dl>
938 <dt><i>next</i></dt>
939 <dd>
940 next window
941 </dd>
942 </dl><dl>
943 <dt>Returns:</dt>
944 <dd>
945 flag indicating the movement
946 </dd>
947 </dl><a NAME="Shell.focusOutEvent" ID="Shell.focusOutEvent"></a>
948 <h4>Shell.focusOutEvent</h4>
949 <b>focusOutEvent</b>(<i>event</i>)
950 <p>
951 Public method called when the shell loses focus.
952 </p><dl>
953 <dt><i>event</i></dt>
954 <dd>
955 the event object (QFocusEvent)
956 </dd>
957 </dl><a NAME="Shell.getClientType" ID="Shell.getClientType"></a>
958 <h4>Shell.getClientType</h4>
959 <b>getClientType</b>(<i></i>)
960 <p>
961 Public slot to get the clients type.
962 </p><dl>
963 <dt>Returns:</dt>
964 <dd>
965 client type (string)
966 </dd>
967 </dl><a NAME="Shell.getHistory" ID="Shell.getHistory"></a>
968 <h4>Shell.getHistory</h4>
969 <b>getHistory</b>(<i>clientType</i>)
970 <p>
971 Public method to get the history for the given client type.
972 </p><dl>
973 <dt><i>clientType</i></dt>
974 <dd>
975 type of the debug client (string).
976 If it is None, the current history is returned.
977 </dd>
978 </dl><dl>
979 <dt>Returns:</dt>
980 <dd>
981 reference to the history list (list of strings)
982 </dd>
983 </dl><a NAME="Shell.handlePreferencesChanged" ID="Shell.handlePreferencesChanged"></a>
984 <h4>Shell.handlePreferencesChanged</h4>
985 <b>handlePreferencesChanged</b>(<i></i>)
986 <p>
987 Public slot to handle the preferencesChanged signal.
988 </p><a NAME="Shell.insert" ID="Shell.insert"></a>
989 <h4>Shell.insert</h4>
990 <b>insert</b>(<i>txt</i>)
991 <p>
992 Public slot to insert text at the current cursor position.
993 </p><p>
994 The cursor is advanced to the end of the inserted text.
995 </p><dl>
996 <dt><i>txt</i></dt>
997 <dd>
998 text to be inserted (string)
999 </dd>
1000 </dl><a NAME="Shell.keyPressEvent" ID="Shell.keyPressEvent"></a>
1001 <h4>Shell.keyPressEvent</h4>
1002 <b>keyPressEvent</b>(<i>ev</i>)
1003 <p>
1004 Re-implemented to handle the user input a key at a time.
1005 </p><dl>
1006 <dt><i>ev</i></dt>
1007 <dd>
1008 key event (QKeyEvent)
1009 </dd>
1010 </dl><a NAME="Shell.loadHistory" ID="Shell.loadHistory"></a>
1011 <h4>Shell.loadHistory</h4>
1012 <b>loadHistory</b>(<i>clientType</i>)
1013 <p>
1014 Public method to load the history for the given client type.
1015 </p><dl>
1016 <dt><i>clientType</i></dt>
1017 <dd>
1018 type of the debug client (string)
1019 </dd>
1020 </dl><a NAME="Shell.mousePressEvent" ID="Shell.mousePressEvent"></a>
1021 <h4>Shell.mousePressEvent</h4>
1022 <b>mousePressEvent</b>(<i>event</i>)
1023 <p>
1024 Protected method to handle the mouse press event.
1025 </p><dl>
1026 <dt><i>event</i></dt>
1027 <dd>
1028 the mouse press event (QMouseEvent)
1029 </dd>
1030 </dl><a NAME="Shell.paste" ID="Shell.paste"></a>
1031 <h4>Shell.paste</h4>
1032 <b>paste</b>(<i></i>)
1033 <p>
1034 Reimplemented slot to handle the paste action.
1035 </p><a NAME="Shell.reloadHistory" ID="Shell.reloadHistory"></a>
1036 <h4>Shell.reloadHistory</h4>
1037 <b>reloadHistory</b>(<i></i>)
1038 <p>
1039 Public method to reload the history of the currently selected client type.
1040 </p><a NAME="Shell.saveHistory" ID="Shell.saveHistory"></a>
1041 <h4>Shell.saveHistory</h4>
1042 <b>saveHistory</b>(<i>clientType</i>)
1043 <p>
1044 Public method to save the history for the given client type.
1045 </p><dl>
1046 <dt><i>clientType</i></dt>
1047 <dd>
1048 type of the debug client (string)
1049 </dd>
1050 </dl><a NAME="Shell.setDebuggerUI" ID="Shell.setDebuggerUI"></a>
1051 <h4>Shell.setDebuggerUI</h4>
1052 <b>setDebuggerUI</b>(<i>ui</i>)
1053 <p>
1054 Public method to set the debugger UI.
1055 </p><dl>
1056 <dt><i>ui</i></dt>
1057 <dd>
1058 reference to the debugger UI object (DebugUI)
1059 </dd>
1060 </dl>
1061 <div align="right"><a href="#top">Up</a></div>
1062 <hr />
1063 </body></html>

Mercurial Repository: eric

eric ide

mercurial