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