|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric6.QScintilla.Shell</title> |
|
4 <meta charset="UTF-8"> |
|
5 <style> |
|
6 body { |
|
7 background: #EDECE6; |
|
8 margin: 0em 1em 10em 1em; |
|
9 color: black; |
|
10 } |
|
11 |
|
12 h1 { color: white; background: #85774A; } |
|
13 h2 { color: white; background: #85774A; } |
|
14 h3 { color: white; background: #9D936E; } |
|
15 h4 { color: white; background: #9D936E; } |
|
16 |
|
17 a { color: #BA6D36; } |
|
18 |
|
19 </style> |
|
20 </head> |
|
21 <body><a NAME="top" ID="top"></a> |
|
22 <h1>eric6.QScintilla.Shell</h1> |
|
23 <p> |
|
24 Module implementing a graphical Python shell. |
|
25 </p> |
|
26 <h3>Global Attributes</h3> |
|
27 <table> |
|
28 <tr><td>None</td></tr> |
|
29 </table> |
|
30 <h3>Classes</h3> |
|
31 <table> |
|
32 <tr> |
|
33 <td><a href="#Shell">Shell</a></td> |
|
34 <td>Class implementing a graphical Python shell.</td> |
|
35 </tr><tr> |
|
36 <td><a href="#ShellAssembly">ShellAssembly</a></td> |
|
37 <td>Class implementing the containing widget for the shell.</td> |
|
38 </tr><tr> |
|
39 <td><a href="#ShellHistoryStyle">ShellHistoryStyle</a></td> |
|
40 <td>Class defining the shell history styles.</td> |
|
41 </tr> |
|
42 </table> |
|
43 <h3>Functions</h3> |
|
44 <table> |
|
45 <tr><td>None</td></tr> |
|
46 </table> |
|
47 <hr /><hr /> |
|
48 <a NAME="Shell" ID="Shell"></a> |
|
49 <h2>Shell</h2> |
|
50 <p> |
|
51 Class implementing a graphical Python shell. |
|
52 </p><p> |
|
53 A user can enter commands that are executed in the remote |
|
54 Python interpreter. |
|
55 </p><h3>Signals</h3> |
|
56 <dl> |
|
57 <dt>historyStyleChanged(ShellHistoryStyle)</dt> |
|
58 <dd> |
|
59 emitted to indicate a |
|
60 change of the history style |
|
61 </dd><dt>queueText(str)</dt> |
|
62 <dd> |
|
63 emitted to queue some text for processing |
|
64 </dd><dt>searchStringFound(bool)</dt> |
|
65 <dd> |
|
66 emitted to indicate the search |
|
67 result |
|
68 </dd><dt>virtualEnvironmentChanged(str)</dt> |
|
69 <dd> |
|
70 emitted to signal the new virtual |
|
71 environment of the shell |
|
72 </dd> |
|
73 </dl> |
|
74 <h3>Derived from</h3> |
|
75 QsciScintillaCompat |
|
76 <h3>Class Attributes</h3> |
|
77 <table> |
|
78 <tr><td>None</td></tr> |
|
79 </table> |
|
80 <h3>Class Methods</h3> |
|
81 <table> |
|
82 <tr><td>None</td></tr> |
|
83 </table> |
|
84 <h3>Methods</h3> |
|
85 <table> |
|
86 <tr> |
|
87 <td><a href="#Shell.__init__">Shell</a></td> |
|
88 <td>Constructor</td> |
|
89 </tr><tr> |
|
90 <td><a href="#Shell.__QScintillaAutoCompletionCommand">__QScintillaAutoCompletionCommand</a></td> |
|
91 <td>Private method to handle a command for autocompletion only.</td> |
|
92 </tr><tr> |
|
93 <td><a href="#Shell.__QScintillaCancel">__QScintillaCancel</a></td> |
|
94 <td>Private method to handle the ESC command.</td> |
|
95 </tr><tr> |
|
96 <td><a href="#Shell.__QScintillaCharLeft">__QScintillaCharLeft</a></td> |
|
97 <td>Private method to handle the Cursor Left command.</td> |
|
98 </tr><tr> |
|
99 <td><a href="#Shell.__QScintillaCharLeftExtend">__QScintillaCharLeftExtend</a></td> |
|
100 <td>Private method to handle the Extend Selection Left command.</td> |
|
101 </tr><tr> |
|
102 <td><a href="#Shell.__QScintillaCharRight">__QScintillaCharRight</a></td> |
|
103 <td>Private method to handle the Cursor Right command.</td> |
|
104 </tr><tr> |
|
105 <td><a href="#Shell.__QScintillaCommand">__QScintillaCommand</a></td> |
|
106 <td>Private method to send the command to QScintilla.</td> |
|
107 </tr><tr> |
|
108 <td><a href="#Shell.__QScintillaCursorCommand">__QScintillaCursorCommand</a></td> |
|
109 <td>Private method to handle the cursor commands.</td> |
|
110 </tr><tr> |
|
111 <td><a href="#Shell.__QScintillaDelete">__QScintillaDelete</a></td> |
|
112 <td>Private method to handle the delete command.</td> |
|
113 </tr><tr> |
|
114 <td><a href="#Shell.__QScintillaDeleteBack">__QScintillaDeleteBack</a></td> |
|
115 <td>Private method to handle the Backspace key.</td> |
|
116 </tr><tr> |
|
117 <td><a href="#Shell.__QScintillaDeleteLineLeft">__QScintillaDeleteLineLeft</a></td> |
|
118 <td>Private method to handle the Delete Line Left command.</td> |
|
119 </tr><tr> |
|
120 <td><a href="#Shell.__QScintillaDeleteLineRight">__QScintillaDeleteLineRight</a></td> |
|
121 <td>Private method to handle the Delete Line Right command.</td> |
|
122 </tr><tr> |
|
123 <td><a href="#Shell.__QScintillaDeleteWordLeft">__QScintillaDeleteWordLeft</a></td> |
|
124 <td>Private method to handle the Delete Word Left command.</td> |
|
125 </tr><tr> |
|
126 <td><a href="#Shell.__QScintillaDeleteWordRight">__QScintillaDeleteWordRight</a></td> |
|
127 <td>Private method to handle the Delete Word Right command.</td> |
|
128 </tr><tr> |
|
129 <td><a href="#Shell.__QScintillaHistoryDown">__QScintillaHistoryDown</a></td> |
|
130 <td>Private method to handle the history down command.</td> |
|
131 </tr><tr> |
|
132 <td><a href="#Shell.__QScintillaHistoryUp">__QScintillaHistoryUp</a></td> |
|
133 <td>Private method to handle the history up command.</td> |
|
134 </tr><tr> |
|
135 <td><a href="#Shell.__QScintillaLeftCommand">__QScintillaLeftCommand</a></td> |
|
136 <td>Private method to handle a QScintilla command working to the left.</td> |
|
137 </tr><tr> |
|
138 <td><a href="#Shell.__QScintillaLeftDeleteCommand">__QScintillaLeftDeleteCommand</a></td> |
|
139 <td>Private method to handle a QScintilla delete command working to the left.</td> |
|
140 </tr><tr> |
|
141 <td><a href="#Shell.__QScintillaLineDown">__QScintillaLineDown</a></td> |
|
142 <td>Private method to handle the cursor down command.</td> |
|
143 </tr><tr> |
|
144 <td><a href="#Shell.__QScintillaLineEnd">__QScintillaLineEnd</a></td> |
|
145 <td>Private method to handle the End key.</td> |
|
146 </tr><tr> |
|
147 <td><a href="#Shell.__QScintillaLineUp">__QScintillaLineUp</a></td> |
|
148 <td>Private method to handle the cursor up command.</td> |
|
149 </tr><tr> |
|
150 <td><a href="#Shell.__QScintillaNewline">__QScintillaNewline</a></td> |
|
151 <td>Private method to handle the Return key.</td> |
|
152 </tr><tr> |
|
153 <td><a href="#Shell.__QScintillaRightCommand">__QScintillaRightCommand</a></td> |
|
154 <td>Private method to handle a QScintilla command working to the right.</td> |
|
155 </tr><tr> |
|
156 <td><a href="#Shell.__QScintillaTab">__QScintillaTab</a></td> |
|
157 <td>Private method to handle the Tab key.</td> |
|
158 </tr><tr> |
|
159 <td><a href="#Shell.__QScintillaVCHome">__QScintillaVCHome</a></td> |
|
160 <td>Private method to handle the Home key.</td> |
|
161 </tr><tr> |
|
162 <td><a href="#Shell.__QScintillaVCHomeExtend">__QScintillaVCHomeExtend</a></td> |
|
163 <td>Private method to handle the Extend Selection to start of line command.</td> |
|
164 </tr><tr> |
|
165 <td><a href="#Shell.__QScintillaWordLeft">__QScintillaWordLeft</a></td> |
|
166 <td>Private method to handle the Cursor Word Left command.</td> |
|
167 </tr><tr> |
|
168 <td><a href="#Shell.__QScintillaWordLeftExtend">__QScintillaWordLeftExtend</a></td> |
|
169 <td>Private method to handle the Extend Selection Left one word command.</td> |
|
170 </tr><tr> |
|
171 <td><a href="#Shell.__QScintillaWordRight">__QScintillaWordRight</a></td> |
|
172 <td>Private method to handle the Cursor Word Right command.</td> |
|
173 </tr><tr> |
|
174 <td><a href="#Shell.__bindLexer">__bindLexer</a></td> |
|
175 <td>Private slot to set the lexer.</td> |
|
176 </tr><tr> |
|
177 <td><a href="#Shell.__clearCurrentLine">__clearCurrentLine</a></td> |
|
178 <td>Private method to clear the line containing the cursor.</td> |
|
179 </tr><tr> |
|
180 <td><a href="#Shell.__clientCapabilities">__clientCapabilities</a></td> |
|
181 <td>Private slot to handle the reporting of the clients capabilities.</td> |
|
182 </tr><tr> |
|
183 <td><a href="#Shell.__clientError">__clientError</a></td> |
|
184 <td>Private method to handle an error in the client.</td> |
|
185 </tr><tr> |
|
186 <td><a href="#Shell.__clientException">__clientException</a></td> |
|
187 <td>Private method to handle an exception of the client.</td> |
|
188 </tr><tr> |
|
189 <td><a href="#Shell.__clientSignal">__clientSignal</a></td> |
|
190 <td>Private method to handle a signal generated on the client side.</td> |
|
191 </tr><tr> |
|
192 <td><a href="#Shell.__clientStatement">__clientStatement</a></td> |
|
193 <td>Private method to handle the response from the debugger client.</td> |
|
194 </tr><tr> |
|
195 <td><a href="#Shell.__clientSyntaxError">__clientSyntaxError</a></td> |
|
196 <td>Private method to handle a syntax error in the debugged program.</td> |
|
197 </tr><tr> |
|
198 <td><a href="#Shell.__completionListSelected">__completionListSelected</a></td> |
|
199 <td>Private slot to handle the selection from the completion list.</td> |
|
200 </tr><tr> |
|
201 <td><a href="#Shell.__concatenateText">__concatenateText</a></td> |
|
202 <td>Private slot to queue text and process it in one step.</td> |
|
203 </tr><tr> |
|
204 <td><a href="#Shell.__configure">__configure</a></td> |
|
205 <td>Private method to open the configuration dialog.</td> |
|
206 </tr><tr> |
|
207 <td><a href="#Shell.__executeCommand">__executeCommand</a></td> |
|
208 <td>Private slot to execute a command.</td> |
|
209 </tr><tr> |
|
210 <td><a href="#Shell.__find">__find</a></td> |
|
211 <td>Private slot to show the find widget.</td> |
|
212 </tr><tr> |
|
213 <td><a href="#Shell.__getBanner">__getBanner</a></td> |
|
214 <td>Private method to get the banner for the remote interpreter.</td> |
|
215 </tr><tr> |
|
216 <td><a href="#Shell.__getEndPos">__getEndPos</a></td> |
|
217 <td>Private method to return the line and column of the last character.</td> |
|
218 </tr><tr> |
|
219 <td><a href="#Shell.__indentLength">__indentLength</a></td> |
|
220 <td>Private method to determine the indentation length of the given line.</td> |
|
221 </tr><tr> |
|
222 <td><a href="#Shell.__initialise">__initialise</a></td> |
|
223 <td>Private method to get ready for a new remote interpreter.</td> |
|
224 </tr><tr> |
|
225 <td><a href="#Shell.__insertHistory">__insertHistory</a></td> |
|
226 <td>Private method to insert a command selected from the history.</td> |
|
227 </tr><tr> |
|
228 <td><a href="#Shell.__insertText">__insertText</a></td> |
|
229 <td>Private method to insert some text at the current cursor position.</td> |
|
230 </tr><tr> |
|
231 <td><a href="#Shell.__insertTextAtEnd">__insertTextAtEnd</a></td> |
|
232 <td>Private method to insert some text at the end of the command line.</td> |
|
233 </tr><tr> |
|
234 <td><a href="#Shell.__insertTextNoEcho">__insertTextNoEcho</a></td> |
|
235 <td>Private method to insert some text at the end of the buffer without echoing it.</td> |
|
236 </tr><tr> |
|
237 <td><a href="#Shell.__isCursorOnLastLine">__isCursorOnLastLine</a></td> |
|
238 <td>Private method to check, if the cursor is on the last line.</td> |
|
239 </tr><tr> |
|
240 <td><a href="#Shell.__isHistoryIndexValid">__isHistoryIndexValid</a></td> |
|
241 <td>Private method to test, if the history index is valid.</td> |
|
242 </tr><tr> |
|
243 <td><a href="#Shell.__middleMouseButton">__middleMouseButton</a></td> |
|
244 <td>Private method to handle the middle mouse button press.</td> |
|
245 </tr><tr> |
|
246 <td><a href="#Shell.__projectClosed">__projectClosed</a></td> |
|
247 <td>Private slot to restart the default shell when the project is closed.</td> |
|
248 </tr><tr> |
|
249 <td><a href="#Shell.__projectOpened">__projectOpened</a></td> |
|
250 <td>Private slot to start the shell for the opened project.</td> |
|
251 </tr><tr> |
|
252 <td><a href="#Shell.__raw_input">__raw_input</a></td> |
|
253 <td>Private method to handle raw input.</td> |
|
254 </tr><tr> |
|
255 <td><a href="#Shell.__resetIncrementalHistorySearch">__resetIncrementalHistorySearch</a></td> |
|
256 <td>Private method to reset the incremental history search.</td> |
|
257 </tr><tr> |
|
258 <td><a href="#Shell.__resizeLinenoMargin">__resizeLinenoMargin</a></td> |
|
259 <td>Private slot to resize the line numbers margin.</td> |
|
260 </tr><tr> |
|
261 <td><a href="#Shell.__rsearchHistory">__rsearchHistory</a></td> |
|
262 <td>Private method used to reverse search the history.</td> |
|
263 </tr><tr> |
|
264 <td><a href="#Shell.__searchHistory">__searchHistory</a></td> |
|
265 <td>Private method used to search the history.</td> |
|
266 </tr><tr> |
|
267 <td><a href="#Shell.__searchNext">__searchNext</a></td> |
|
268 <td>Private method to search for the next occurrence.</td> |
|
269 </tr><tr> |
|
270 <td><a href="#Shell.__searchPrev">__searchPrev</a></td> |
|
271 <td>Private method to search for the next occurrence.</td> |
|
272 </tr><tr> |
|
273 <td><a href="#Shell.__setAutoCompletion">__setAutoCompletion</a></td> |
|
274 <td>Private method to configure the autocompletion function.</td> |
|
275 </tr><tr> |
|
276 <td><a href="#Shell.__setCallTips">__setCallTips</a></td> |
|
277 <td>Private method to configure the calltips function.</td> |
|
278 </tr><tr> |
|
279 <td><a href="#Shell.__setHistoryIndex">__setHistoryIndex</a></td> |
|
280 <td>Private method to set the initial history index.</td> |
|
281 </tr><tr> |
|
282 <td><a href="#Shell.__setMargin0">__setMargin0</a></td> |
|
283 <td>Private method to configure margin 0.</td> |
|
284 </tr><tr> |
|
285 <td><a href="#Shell.__setMonospaced">__setMonospaced</a></td> |
|
286 <td>Private method to set/reset a monospaced font.</td> |
|
287 </tr><tr> |
|
288 <td><a href="#Shell.__setTextDisplay">__setTextDisplay</a></td> |
|
289 <td>Private method to configure the text display.</td> |
|
290 </tr><tr> |
|
291 <td><a href="#Shell.__showCompletions">__showCompletions</a></td> |
|
292 <td>Private method to display the possible completions.</td> |
|
293 </tr><tr> |
|
294 <td><a href="#Shell.__showStartMenu">__showStartMenu</a></td> |
|
295 <td>Private slot to prepare the start submenu.</td> |
|
296 </tr><tr> |
|
297 <td><a href="#Shell.__showVenvName">__showVenvName</a></td> |
|
298 <td>Private method to show the name of the active virtual environment.</td> |
|
299 </tr><tr> |
|
300 <td><a href="#Shell.__startDebugClient">__startDebugClient</a></td> |
|
301 <td>Private slot to start a debug client according to the action triggered.</td> |
|
302 </tr><tr> |
|
303 <td><a href="#Shell.__useHistory">__useHistory</a></td> |
|
304 <td>Private method to display a command from the history.</td> |
|
305 </tr><tr> |
|
306 <td><a href="#Shell.__write">__write</a></td> |
|
307 <td>Private method to display some text without queuing.</td> |
|
308 </tr><tr> |
|
309 <td><a href="#Shell.__writeBanner">__writeBanner</a></td> |
|
310 <td>Private method to write a banner with info from the debug client.</td> |
|
311 </tr><tr> |
|
312 <td><a href="#Shell.__writePrompt">__writePrompt</a></td> |
|
313 <td>Private method to write the prompt using a write queue.</td> |
|
314 </tr><tr> |
|
315 <td><a href="#Shell.__writeQueued">__writeQueued</a></td> |
|
316 <td>Private method to display some text using a write queue.</td> |
|
317 </tr><tr> |
|
318 <td><a href="#Shell.__writeStdErr">__writeStdErr</a></td> |
|
319 <td>Private method to display some text with StdErr label.</td> |
|
320 </tr><tr> |
|
321 <td><a href="#Shell.__writeStdOut">__writeStdOut</a></td> |
|
322 <td>Private method to display some text with StdOut label.</td> |
|
323 </tr><tr> |
|
324 <td><a href="#Shell.clear">clear</a></td> |
|
325 <td>Public slot to clear the display.</td> |
|
326 </tr><tr> |
|
327 <td><a href="#Shell.clearAllHistories">clearAllHistories</a></td> |
|
328 <td>Public method to clear all available histories and sync them.</td> |
|
329 </tr><tr> |
|
330 <td><a href="#Shell.clearHistory">clearHistory</a></td> |
|
331 <td>Public slot to clear the current history.</td> |
|
332 </tr><tr> |
|
333 <td><a href="#Shell.closeShell">closeShell</a></td> |
|
334 <td>Public method to shutdown the shell.</td> |
|
335 </tr><tr> |
|
336 <td><a href="#Shell.contextMenuEvent">contextMenuEvent</a></td> |
|
337 <td>Protected method to show our own context menu.</td> |
|
338 </tr><tr> |
|
339 <td><a href="#Shell.doClearRestart">doClearRestart</a></td> |
|
340 <td>Public slot to handle the 'restart and clear' context menu entry.</td> |
|
341 </tr><tr> |
|
342 <td><a href="#Shell.doRestart">doRestart</a></td> |
|
343 <td>Public slot to handle the 'restart' context menu entry.</td> |
|
344 </tr><tr> |
|
345 <td><a href="#Shell.dragEnterEvent">dragEnterEvent</a></td> |
|
346 <td>Protected method to handle the drag enter event.</td> |
|
347 </tr><tr> |
|
348 <td><a href="#Shell.dragLeaveEvent">dragLeaveEvent</a></td> |
|
349 <td>Protected method to handle the drag leave event.</td> |
|
350 </tr><tr> |
|
351 <td><a href="#Shell.dragMoveEvent">dragMoveEvent</a></td> |
|
352 <td>Protected method to handle the drag move event.</td> |
|
353 </tr><tr> |
|
354 <td><a href="#Shell.dropEvent">dropEvent</a></td> |
|
355 <td>Protected method to handle the drop event.</td> |
|
356 </tr><tr> |
|
357 <td><a href="#Shell.editorCommand">editorCommand</a></td> |
|
358 <td>Public method to perform an editor command.</td> |
|
359 </tr><tr> |
|
360 <td><a href="#Shell.event">event</a></td> |
|
361 <td>Public method handling events.</td> |
|
362 </tr><tr> |
|
363 <td><a href="#Shell.executeLines">executeLines</a></td> |
|
364 <td>Public method to execute a set of lines as multiple commands.</td> |
|
365 </tr><tr> |
|
366 <td><a href="#Shell.focusInEvent">focusInEvent</a></td> |
|
367 <td>Protected method called when the shell receives focus.</td> |
|
368 </tr><tr> |
|
369 <td><a href="#Shell.focusNextPrevChild">focusNextPrevChild</a></td> |
|
370 <td>Public method to stop Tab moving to the next window.</td> |
|
371 </tr><tr> |
|
372 <td><a href="#Shell.focusOutEvent">focusOutEvent</a></td> |
|
373 <td>Protected method called when the shell loses focus.</td> |
|
374 </tr><tr> |
|
375 <td><a href="#Shell.gestureEvent">gestureEvent</a></td> |
|
376 <td>Protected method handling gesture events.</td> |
|
377 </tr><tr> |
|
378 <td><a href="#Shell.getClientType">getClientType</a></td> |
|
379 <td>Public slot to get the clients type.</td> |
|
380 </tr><tr> |
|
381 <td><a href="#Shell.getHistory">getHistory</a></td> |
|
382 <td>Public method to get the history for the given client type.</td> |
|
383 </tr><tr> |
|
384 <td><a href="#Shell.getHistoryIndex">getHistoryIndex</a></td> |
|
385 <td>Public method to get the current value of the history index.</td> |
|
386 </tr><tr> |
|
387 <td><a href="#Shell.handlePreferencesChanged">handlePreferencesChanged</a></td> |
|
388 <td>Public slot to handle the preferencesChanged signal.</td> |
|
389 </tr><tr> |
|
390 <td><a href="#Shell.historyStyle">historyStyle</a></td> |
|
391 <td>Public method to get the shell history style.</td> |
|
392 </tr><tr> |
|
393 <td><a href="#Shell.insert">insert</a></td> |
|
394 <td>Public slot to insert text at the current cursor position.</td> |
|
395 </tr><tr> |
|
396 <td><a href="#Shell.isHistoryEnabled">isHistoryEnabled</a></td> |
|
397 <td>Public method to check, if the history is enabled.</td> |
|
398 </tr><tr> |
|
399 <td><a href="#Shell.keyPressEvent">keyPressEvent</a></td> |
|
400 <td>Protected method to handle the user input a key at a time.</td> |
|
401 </tr><tr> |
|
402 <td><a href="#Shell.loadHistory">loadHistory</a></td> |
|
403 <td>Public method to load the history for the given client type.</td> |
|
404 </tr><tr> |
|
405 <td><a href="#Shell.mousePressEvent">mousePressEvent</a></td> |
|
406 <td>Protected method to handle the mouse press event.</td> |
|
407 </tr><tr> |
|
408 <td><a href="#Shell.paste">paste</a></td> |
|
409 <td>Public slot to handle the paste action.</td> |
|
410 </tr><tr> |
|
411 <td><a href="#Shell.reloadHistory">reloadHistory</a></td> |
|
412 <td>Public method to reload the history of the currently selected client type.</td> |
|
413 </tr><tr> |
|
414 <td><a href="#Shell.saveHistory">saveHistory</a></td> |
|
415 <td>Public method to save the history for the given client type.</td> |
|
416 </tr><tr> |
|
417 <td><a href="#Shell.searchNext">searchNext</a></td> |
|
418 <td>Public method to search the next occurrence of the given text.</td> |
|
419 </tr><tr> |
|
420 <td><a href="#Shell.searchPrev">searchPrev</a></td> |
|
421 <td>Public method to search the previous occurrence of the given text.</td> |
|
422 </tr><tr> |
|
423 <td><a href="#Shell.selectHistory">selectHistory</a></td> |
|
424 <td>Public slot to select a history entry to execute.</td> |
|
425 </tr><tr> |
|
426 <td><a href="#Shell.setDebuggerUI">setDebuggerUI</a></td> |
|
427 <td>Public method to set the debugger UI.</td> |
|
428 </tr><tr> |
|
429 <td><a href="#Shell.showHistory">showHistory</a></td> |
|
430 <td>Public slot to show the shell history dialog.</td> |
|
431 </tr><tr> |
|
432 <td><a href="#Shell.wheelEvent">wheelEvent</a></td> |
|
433 <td>Protected method to handle wheel events.</td> |
|
434 </tr> |
|
435 </table> |
|
436 <h3>Static Methods</h3> |
|
437 <table> |
|
438 <tr><td>None</td></tr> |
|
439 </table> |
|
440 <a NAME="Shell.__init__" ID="Shell.__init__"></a> |
|
441 <h4>Shell (Constructor)</h4> |
|
442 <b>Shell</b>(<i>dbs, vm, project, windowedVariant, parent=None</i>) |
|
443 <p> |
|
444 Constructor |
|
445 </p><dl> |
|
446 <dt><i>dbs</i> (DebugServer)</dt> |
|
447 <dd> |
|
448 reference to the debug server object |
|
449 </dd><dt><i>vm</i> (ViewManager)</dt> |
|
450 <dd> |
|
451 reference to the viewmanager object |
|
452 </dd><dt><i>project</i> (Project)</dt> |
|
453 <dd> |
|
454 reference to the project object |
|
455 </dd><dt><i>windowedVariant</i> (bool)</dt> |
|
456 <dd> |
|
457 flag indicating the shell window variant |
|
458 </dd><dt><i>parent</i> (QWidget)</dt> |
|
459 <dd> |
|
460 parent widget |
|
461 </dd> |
|
462 </dl><a NAME="Shell.__QScintillaAutoCompletionCommand" ID="Shell.__QScintillaAutoCompletionCommand"></a> |
|
463 <h4>Shell.__QScintillaAutoCompletionCommand</h4> |
|
464 <b>__QScintillaAutoCompletionCommand</b>(<i>cmd</i>) |
|
465 <p> |
|
466 Private method to handle a command for autocompletion only. |
|
467 </p><dl> |
|
468 <dt><i>cmd</i></dt> |
|
469 <dd> |
|
470 QScintilla command |
|
471 </dd> |
|
472 </dl><a NAME="Shell.__QScintillaCancel" ID="Shell.__QScintillaCancel"></a> |
|
473 <h4>Shell.__QScintillaCancel</h4> |
|
474 <b>__QScintillaCancel</b>(<i></i>) |
|
475 <p> |
|
476 Private method to handle the ESC command. |
|
477 </p><a NAME="Shell.__QScintillaCharLeft" ID="Shell.__QScintillaCharLeft"></a> |
|
478 <h4>Shell.__QScintillaCharLeft</h4> |
|
479 <b>__QScintillaCharLeft</b>(<i></i>) |
|
480 <p> |
|
481 Private method to handle the Cursor Left command. |
|
482 </p><a NAME="Shell.__QScintillaCharLeftExtend" ID="Shell.__QScintillaCharLeftExtend"></a> |
|
483 <h4>Shell.__QScintillaCharLeftExtend</h4> |
|
484 <b>__QScintillaCharLeftExtend</b>(<i></i>) |
|
485 <p> |
|
486 Private method to handle the Extend Selection Left command. |
|
487 </p><a NAME="Shell.__QScintillaCharRight" ID="Shell.__QScintillaCharRight"></a> |
|
488 <h4>Shell.__QScintillaCharRight</h4> |
|
489 <b>__QScintillaCharRight</b>(<i></i>) |
|
490 <p> |
|
491 Private method to handle the Cursor Right command. |
|
492 </p><a NAME="Shell.__QScintillaCommand" ID="Shell.__QScintillaCommand"></a> |
|
493 <h4>Shell.__QScintillaCommand</h4> |
|
494 <b>__QScintillaCommand</b>(<i>cmd</i>) |
|
495 <p> |
|
496 Private method to send the command to QScintilla. |
|
497 </p><dl> |
|
498 <dt><i>cmd</i></dt> |
|
499 <dd> |
|
500 QScintilla command |
|
501 </dd> |
|
502 </dl><a NAME="Shell.__QScintillaCursorCommand" ID="Shell.__QScintillaCursorCommand"></a> |
|
503 <h4>Shell.__QScintillaCursorCommand</h4> |
|
504 <b>__QScintillaCursorCommand</b>(<i>cmd</i>) |
|
505 <p> |
|
506 Private method to handle the cursor commands. |
|
507 </p><dl> |
|
508 <dt><i>cmd</i></dt> |
|
509 <dd> |
|
510 QScintilla command |
|
511 </dd> |
|
512 </dl><a NAME="Shell.__QScintillaDelete" ID="Shell.__QScintillaDelete"></a> |
|
513 <h4>Shell.__QScintillaDelete</h4> |
|
514 <b>__QScintillaDelete</b>(<i></i>) |
|
515 <p> |
|
516 Private method to handle the delete command. |
|
517 </p><a NAME="Shell.__QScintillaDeleteBack" ID="Shell.__QScintillaDeleteBack"></a> |
|
518 <h4>Shell.__QScintillaDeleteBack</h4> |
|
519 <b>__QScintillaDeleteBack</b>(<i></i>) |
|
520 <p> |
|
521 Private method to handle the Backspace key. |
|
522 </p><a NAME="Shell.__QScintillaDeleteLineLeft" ID="Shell.__QScintillaDeleteLineLeft"></a> |
|
523 <h4>Shell.__QScintillaDeleteLineLeft</h4> |
|
524 <b>__QScintillaDeleteLineLeft</b>(<i></i>) |
|
525 <p> |
|
526 Private method to handle the Delete Line Left command. |
|
527 </p><a NAME="Shell.__QScintillaDeleteLineRight" ID="Shell.__QScintillaDeleteLineRight"></a> |
|
528 <h4>Shell.__QScintillaDeleteLineRight</h4> |
|
529 <b>__QScintillaDeleteLineRight</b>(<i></i>) |
|
530 <p> |
|
531 Private method to handle the Delete Line Right command. |
|
532 </p><a NAME="Shell.__QScintillaDeleteWordLeft" ID="Shell.__QScintillaDeleteWordLeft"></a> |
|
533 <h4>Shell.__QScintillaDeleteWordLeft</h4> |
|
534 <b>__QScintillaDeleteWordLeft</b>(<i></i>) |
|
535 <p> |
|
536 Private method to handle the Delete Word Left command. |
|
537 </p><a NAME="Shell.__QScintillaDeleteWordRight" ID="Shell.__QScintillaDeleteWordRight"></a> |
|
538 <h4>Shell.__QScintillaDeleteWordRight</h4> |
|
539 <b>__QScintillaDeleteWordRight</b>(<i></i>) |
|
540 <p> |
|
541 Private method to handle the Delete Word Right command. |
|
542 </p><a NAME="Shell.__QScintillaHistoryDown" ID="Shell.__QScintillaHistoryDown"></a> |
|
543 <h4>Shell.__QScintillaHistoryDown</h4> |
|
544 <b>__QScintillaHistoryDown</b>(<i>cmd</i>) |
|
545 <p> |
|
546 Private method to handle the history down command. |
|
547 </p><dl> |
|
548 <dt><i>cmd</i></dt> |
|
549 <dd> |
|
550 QScintilla command |
|
551 </dd> |
|
552 </dl><a NAME="Shell.__QScintillaHistoryUp" ID="Shell.__QScintillaHistoryUp"></a> |
|
553 <h4>Shell.__QScintillaHistoryUp</h4> |
|
554 <b>__QScintillaHistoryUp</b>(<i>cmd</i>) |
|
555 <p> |
|
556 Private method to handle the history up command. |
|
557 </p><dl> |
|
558 <dt><i>cmd</i></dt> |
|
559 <dd> |
|
560 QScintilla command |
|
561 </dd> |
|
562 </dl><a NAME="Shell.__QScintillaLeftCommand" ID="Shell.__QScintillaLeftCommand"></a> |
|
563 <h4>Shell.__QScintillaLeftCommand</h4> |
|
564 <b>__QScintillaLeftCommand</b>(<i>method, allLinesAllowed=False</i>) |
|
565 <p> |
|
566 Private method to handle a QScintilla command working to the left. |
|
567 </p><dl> |
|
568 <dt><i>method</i></dt> |
|
569 <dd> |
|
570 shell method to execute |
|
571 </dd><dt><i>allLinesAllowed</i></dt> |
|
572 <dd> |
|
573 flag indicating that the command may be executed |
|
574 on any line (boolean) |
|
575 </dd> |
|
576 </dl><a NAME="Shell.__QScintillaLeftDeleteCommand" ID="Shell.__QScintillaLeftDeleteCommand"></a> |
|
577 <h4>Shell.__QScintillaLeftDeleteCommand</h4> |
|
578 <b>__QScintillaLeftDeleteCommand</b>(<i>method</i>) |
|
579 <p> |
|
580 Private method to handle a QScintilla delete command working to |
|
581 the left. |
|
582 </p><dl> |
|
583 <dt><i>method</i></dt> |
|
584 <dd> |
|
585 shell method to execute |
|
586 </dd> |
|
587 </dl><a NAME="Shell.__QScintillaLineDown" ID="Shell.__QScintillaLineDown"></a> |
|
588 <h4>Shell.__QScintillaLineDown</h4> |
|
589 <b>__QScintillaLineDown</b>(<i>cmd</i>) |
|
590 <p> |
|
591 Private method to handle the cursor down command. |
|
592 </p><dl> |
|
593 <dt><i>cmd</i></dt> |
|
594 <dd> |
|
595 QScintilla command |
|
596 </dd> |
|
597 </dl><a NAME="Shell.__QScintillaLineEnd" ID="Shell.__QScintillaLineEnd"></a> |
|
598 <h4>Shell.__QScintillaLineEnd</h4> |
|
599 <b>__QScintillaLineEnd</b>(<i>cmd</i>) |
|
600 <p> |
|
601 Private method to handle the End key. |
|
602 </p><dl> |
|
603 <dt><i>cmd</i></dt> |
|
604 <dd> |
|
605 QScintilla command |
|
606 </dd> |
|
607 </dl><a NAME="Shell.__QScintillaLineUp" ID="Shell.__QScintillaLineUp"></a> |
|
608 <h4>Shell.__QScintillaLineUp</h4> |
|
609 <b>__QScintillaLineUp</b>(<i>cmd</i>) |
|
610 <p> |
|
611 Private method to handle the cursor up command. |
|
612 </p><dl> |
|
613 <dt><i>cmd</i></dt> |
|
614 <dd> |
|
615 QScintilla command |
|
616 </dd> |
|
617 </dl><a NAME="Shell.__QScintillaNewline" ID="Shell.__QScintillaNewline"></a> |
|
618 <h4>Shell.__QScintillaNewline</h4> |
|
619 <b>__QScintillaNewline</b>(<i>cmd</i>) |
|
620 <p> |
|
621 Private method to handle the Return key. |
|
622 </p><dl> |
|
623 <dt><i>cmd</i></dt> |
|
624 <dd> |
|
625 QScintilla command |
|
626 </dd> |
|
627 </dl><a NAME="Shell.__QScintillaRightCommand" ID="Shell.__QScintillaRightCommand"></a> |
|
628 <h4>Shell.__QScintillaRightCommand</h4> |
|
629 <b>__QScintillaRightCommand</b>(<i>method</i>) |
|
630 <p> |
|
631 Private method to handle a QScintilla command working to the right. |
|
632 </p><dl> |
|
633 <dt><i>method</i></dt> |
|
634 <dd> |
|
635 shell method to execute |
|
636 </dd> |
|
637 </dl><a NAME="Shell.__QScintillaTab" ID="Shell.__QScintillaTab"></a> |
|
638 <h4>Shell.__QScintillaTab</h4> |
|
639 <b>__QScintillaTab</b>(<i>cmd</i>) |
|
640 <p> |
|
641 Private method to handle the Tab key. |
|
642 </p><dl> |
|
643 <dt><i>cmd</i></dt> |
|
644 <dd> |
|
645 QScintilla command |
|
646 </dd> |
|
647 </dl><a NAME="Shell.__QScintillaVCHome" ID="Shell.__QScintillaVCHome"></a> |
|
648 <h4>Shell.__QScintillaVCHome</h4> |
|
649 <b>__QScintillaVCHome</b>(<i>cmd</i>) |
|
650 <p> |
|
651 Private method to handle the Home key. |
|
652 </p><dl> |
|
653 <dt><i>cmd</i></dt> |
|
654 <dd> |
|
655 QScintilla command |
|
656 </dd> |
|
657 </dl><a NAME="Shell.__QScintillaVCHomeExtend" ID="Shell.__QScintillaVCHomeExtend"></a> |
|
658 <h4>Shell.__QScintillaVCHomeExtend</h4> |
|
659 <b>__QScintillaVCHomeExtend</b>(<i></i>) |
|
660 <p> |
|
661 Private method to handle the Extend Selection to start of line command. |
|
662 </p><a NAME="Shell.__QScintillaWordLeft" ID="Shell.__QScintillaWordLeft"></a> |
|
663 <h4>Shell.__QScintillaWordLeft</h4> |
|
664 <b>__QScintillaWordLeft</b>(<i></i>) |
|
665 <p> |
|
666 Private method to handle the Cursor Word Left command. |
|
667 </p><a NAME="Shell.__QScintillaWordLeftExtend" ID="Shell.__QScintillaWordLeftExtend"></a> |
|
668 <h4>Shell.__QScintillaWordLeftExtend</h4> |
|
669 <b>__QScintillaWordLeftExtend</b>(<i></i>) |
|
670 <p> |
|
671 Private method to handle the Extend Selection Left one word command. |
|
672 </p><a NAME="Shell.__QScintillaWordRight" ID="Shell.__QScintillaWordRight"></a> |
|
673 <h4>Shell.__QScintillaWordRight</h4> |
|
674 <b>__QScintillaWordRight</b>(<i></i>) |
|
675 <p> |
|
676 Private method to handle the Cursor Word Right command. |
|
677 </p><a NAME="Shell.__bindLexer" ID="Shell.__bindLexer"></a> |
|
678 <h4>Shell.__bindLexer</h4> |
|
679 <b>__bindLexer</b>(<i>language='Python3'</i>) |
|
680 <p> |
|
681 Private slot to set the lexer. |
|
682 </p><dl> |
|
683 <dt><i>language</i></dt> |
|
684 <dd> |
|
685 lexer language to set (string) |
|
686 </dd> |
|
687 </dl><a NAME="Shell.__clearCurrentLine" ID="Shell.__clearCurrentLine"></a> |
|
688 <h4>Shell.__clearCurrentLine</h4> |
|
689 <b>__clearCurrentLine</b>(<i></i>) |
|
690 <p> |
|
691 Private method to clear the line containing the cursor. |
|
692 </p><a NAME="Shell.__clientCapabilities" ID="Shell.__clientCapabilities"></a> |
|
693 <h4>Shell.__clientCapabilities</h4> |
|
694 <b>__clientCapabilities</b>(<i>cap, clType, venvName</i>) |
|
695 <p> |
|
696 Private slot to handle the reporting of the clients capabilities. |
|
697 </p><dl> |
|
698 <dt><i>cap</i> (int)</dt> |
|
699 <dd> |
|
700 client capabilities |
|
701 </dd><dt><i>clType</i> (str)</dt> |
|
702 <dd> |
|
703 type of the debug client |
|
704 </dd><dt><i>venvName</i> (str)</dt> |
|
705 <dd> |
|
706 name of the virtual environment |
|
707 </dd> |
|
708 </dl><a NAME="Shell.__clientError" ID="Shell.__clientError"></a> |
|
709 <h4>Shell.__clientError</h4> |
|
710 <b>__clientError</b>(<i></i>) |
|
711 <p> |
|
712 Private method to handle an error in the client. |
|
713 </p><a NAME="Shell.__clientException" ID="Shell.__clientException"></a> |
|
714 <h4>Shell.__clientException</h4> |
|
715 <b>__clientException</b>(<i>exceptionType, exceptionMessage, stackTrace</i>) |
|
716 <p> |
|
717 Private method to handle an exception of the client. |
|
718 </p><dl> |
|
719 <dt><i>exceptionType</i></dt> |
|
720 <dd> |
|
721 type of exception raised (string) |
|
722 </dd><dt><i>exceptionMessage</i></dt> |
|
723 <dd> |
|
724 message given by the exception (string) |
|
725 </dd><dt><i>stackTrace</i></dt> |
|
726 <dd> |
|
727 list of stack entries (list of string) |
|
728 </dd> |
|
729 </dl><a NAME="Shell.__clientSignal" ID="Shell.__clientSignal"></a> |
|
730 <h4>Shell.__clientSignal</h4> |
|
731 <b>__clientSignal</b>(<i>message, filename, lineNo, funcName, funcArgs</i>) |
|
732 <p> |
|
733 Private method to handle a signal generated on the client side. |
|
734 </p><dl> |
|
735 <dt><i>message</i> (str)</dt> |
|
736 <dd> |
|
737 message of the syntax error |
|
738 </dd><dt><i>filename</i> (str)</dt> |
|
739 <dd> |
|
740 translated filename of the syntax error position |
|
741 </dd><dt><i>lineNo</i> (int)</dt> |
|
742 <dd> |
|
743 line number of the syntax error position |
|
744 </dd><dt><i>funcName</i> (str)</dt> |
|
745 <dd> |
|
746 name of the function causing the signal |
|
747 </dd><dt><i>funcArgs</i> (str)</dt> |
|
748 <dd> |
|
749 function arguments |
|
750 </dd> |
|
751 </dl><a NAME="Shell.__clientStatement" ID="Shell.__clientStatement"></a> |
|
752 <h4>Shell.__clientStatement</h4> |
|
753 <b>__clientStatement</b>(<i>more</i>) |
|
754 <p> |
|
755 Private method to handle the response from the debugger client. |
|
756 </p><dl> |
|
757 <dt><i>more</i></dt> |
|
758 <dd> |
|
759 flag indicating that more user input is required (boolean) |
|
760 </dd> |
|
761 </dl><a NAME="Shell.__clientSyntaxError" ID="Shell.__clientSyntaxError"></a> |
|
762 <h4>Shell.__clientSyntaxError</h4> |
|
763 <b>__clientSyntaxError</b>(<i>message, filename, lineNo, characterNo</i>) |
|
764 <p> |
|
765 Private method to handle a syntax error in the debugged program. |
|
766 </p><dl> |
|
767 <dt><i>message</i></dt> |
|
768 <dd> |
|
769 message of the syntax error (string) |
|
770 </dd><dt><i>filename</i></dt> |
|
771 <dd> |
|
772 translated filename of the syntax error position |
|
773 (string) |
|
774 </dd><dt><i>lineNo</i></dt> |
|
775 <dd> |
|
776 line number of the syntax error position (integer) |
|
777 </dd><dt><i>characterNo</i></dt> |
|
778 <dd> |
|
779 character number of the syntax error position |
|
780 (integer) |
|
781 </dd> |
|
782 </dl><a NAME="Shell.__completionListSelected" ID="Shell.__completionListSelected"></a> |
|
783 <h4>Shell.__completionListSelected</h4> |
|
784 <b>__completionListSelected</b>(<i>listId, txt</i>) |
|
785 <p> |
|
786 Private slot to handle the selection from the completion list. |
|
787 </p><dl> |
|
788 <dt><i>listId</i></dt> |
|
789 <dd> |
|
790 the ID of the user list (should be 1) (integer) |
|
791 </dd><dt><i>txt</i></dt> |
|
792 <dd> |
|
793 the selected text (string) |
|
794 </dd> |
|
795 </dl><a NAME="Shell.__concatenateText" ID="Shell.__concatenateText"></a> |
|
796 <h4>Shell.__concatenateText</h4> |
|
797 <b>__concatenateText</b>(<i>text</i>) |
|
798 <p> |
|
799 Private slot to queue text and process it in one step. |
|
800 </p><dl> |
|
801 <dt><i>text</i> (str)</dt> |
|
802 <dd> |
|
803 text to be appended |
|
804 </dd> |
|
805 </dl><a NAME="Shell.__configure" ID="Shell.__configure"></a> |
|
806 <h4>Shell.__configure</h4> |
|
807 <b>__configure</b>(<i></i>) |
|
808 <p> |
|
809 Private method to open the configuration dialog. |
|
810 </p><a NAME="Shell.__executeCommand" ID="Shell.__executeCommand"></a> |
|
811 <h4>Shell.__executeCommand</h4> |
|
812 <b>__executeCommand</b>(<i>cmd, historyIndex=None</i>) |
|
813 <p> |
|
814 Private slot to execute a command. |
|
815 </p><dl> |
|
816 <dt><i>cmd</i> (str)</dt> |
|
817 <dd> |
|
818 command to be executed by debug client |
|
819 </dd><dt><i>historyIndex</i> (int)</dt> |
|
820 <dd> |
|
821 history index to be set |
|
822 </dd> |
|
823 </dl><a NAME="Shell.__find" ID="Shell.__find"></a> |
|
824 <h4>Shell.__find</h4> |
|
825 <b>__find</b>(<i></i>) |
|
826 <p> |
|
827 Private slot to show the find widget. |
|
828 </p><a NAME="Shell.__getBanner" ID="Shell.__getBanner"></a> |
|
829 <h4>Shell.__getBanner</h4> |
|
830 <b>__getBanner</b>(<i></i>) |
|
831 <p> |
|
832 Private method to get the banner for the remote interpreter. |
|
833 </p><p> |
|
834 It requests the interpreter version and platform running on the |
|
835 debug client side. |
|
836 </p><a NAME="Shell.__getEndPos" ID="Shell.__getEndPos"></a> |
|
837 <h4>Shell.__getEndPos</h4> |
|
838 <b>__getEndPos</b>(<i></i>) |
|
839 <p> |
|
840 Private method to return the line and column of the last character. |
|
841 </p><dl> |
|
842 <dt>Returns:</dt> |
|
843 <dd> |
|
844 tuple of two values (int, int) giving the line and column |
|
845 </dd> |
|
846 </dl><a NAME="Shell.__indentLength" ID="Shell.__indentLength"></a> |
|
847 <h4>Shell.__indentLength</h4> |
|
848 <b>__indentLength</b>(<i>line</i>) |
|
849 <p> |
|
850 Private method to determine the indentation length of the given line. |
|
851 </p><dl> |
|
852 <dt><i>line</i> (str)</dt> |
|
853 <dd> |
|
854 line to determine the indentation length for |
|
855 </dd> |
|
856 </dl><dl> |
|
857 <dt>Returns:</dt> |
|
858 <dd> |
|
859 indentation length |
|
860 </dd> |
|
861 </dl><dl> |
|
862 <dt>Return Type:</dt> |
|
863 <dd> |
|
864 int |
|
865 </dd> |
|
866 </dl><a NAME="Shell.__initialise" ID="Shell.__initialise"></a> |
|
867 <h4>Shell.__initialise</h4> |
|
868 <b>__initialise</b>(<i></i>) |
|
869 <p> |
|
870 Private method to get ready for a new remote interpreter. |
|
871 </p><a NAME="Shell.__insertHistory" ID="Shell.__insertHistory"></a> |
|
872 <h4>Shell.__insertHistory</h4> |
|
873 <b>__insertHistory</b>(<i>cmd</i>) |
|
874 <p> |
|
875 Private method to insert a command selected from the history. |
|
876 </p><dl> |
|
877 <dt><i>cmd</i></dt> |
|
878 <dd> |
|
879 history entry to be inserted (string) |
|
880 </dd> |
|
881 </dl><a NAME="Shell.__insertText" ID="Shell.__insertText"></a> |
|
882 <h4>Shell.__insertText</h4> |
|
883 <b>__insertText</b>(<i>s</i>) |
|
884 <p> |
|
885 Private method to insert some text at the current cursor position. |
|
886 </p><dl> |
|
887 <dt><i>s</i></dt> |
|
888 <dd> |
|
889 text to be inserted (string) |
|
890 </dd> |
|
891 </dl><a NAME="Shell.__insertTextAtEnd" ID="Shell.__insertTextAtEnd"></a> |
|
892 <h4>Shell.__insertTextAtEnd</h4> |
|
893 <b>__insertTextAtEnd</b>(<i>s</i>) |
|
894 <p> |
|
895 Private method to insert some text at the end of the command line. |
|
896 </p><dl> |
|
897 <dt><i>s</i></dt> |
|
898 <dd> |
|
899 text to be inserted (string) |
|
900 </dd> |
|
901 </dl><a NAME="Shell.__insertTextNoEcho" ID="Shell.__insertTextNoEcho"></a> |
|
902 <h4>Shell.__insertTextNoEcho</h4> |
|
903 <b>__insertTextNoEcho</b>(<i>s</i>) |
|
904 <p> |
|
905 Private method to insert some text at the end of the buffer without |
|
906 echoing it. |
|
907 </p><dl> |
|
908 <dt><i>s</i></dt> |
|
909 <dd> |
|
910 text to be inserted (string) |
|
911 </dd> |
|
912 </dl><a NAME="Shell.__isCursorOnLastLine" ID="Shell.__isCursorOnLastLine"></a> |
|
913 <h4>Shell.__isCursorOnLastLine</h4> |
|
914 <b>__isCursorOnLastLine</b>(<i></i>) |
|
915 <p> |
|
916 Private method to check, if the cursor is on the last line. |
|
917 </p><dl> |
|
918 <dt>Returns:</dt> |
|
919 <dd> |
|
920 flag indicating that the cursor is on the last line (boolean) |
|
921 </dd> |
|
922 </dl><a NAME="Shell.__isHistoryIndexValid" ID="Shell.__isHistoryIndexValid"></a> |
|
923 <h4>Shell.__isHistoryIndexValid</h4> |
|
924 <b>__isHistoryIndexValid</b>(<i></i>) |
|
925 <p> |
|
926 Private method to test, if the history index is valid. |
|
927 </p><dl> |
|
928 <dt>Returns:</dt> |
|
929 <dd> |
|
930 flag indicating validity |
|
931 </dd> |
|
932 </dl><dl> |
|
933 <dt>Return Type:</dt> |
|
934 <dd> |
|
935 bool |
|
936 </dd> |
|
937 </dl><a NAME="Shell.__middleMouseButton" ID="Shell.__middleMouseButton"></a> |
|
938 <h4>Shell.__middleMouseButton</h4> |
|
939 <b>__middleMouseButton</b>(<i></i>) |
|
940 <p> |
|
941 Private method to handle the middle mouse button press. |
|
942 </p><a NAME="Shell.__projectClosed" ID="Shell.__projectClosed"></a> |
|
943 <h4>Shell.__projectClosed</h4> |
|
944 <b>__projectClosed</b>(<i></i>) |
|
945 <p> |
|
946 Private slot to restart the default shell when the project is closed. |
|
947 </p><a NAME="Shell.__projectOpened" ID="Shell.__projectOpened"></a> |
|
948 <h4>Shell.__projectOpened</h4> |
|
949 <b>__projectOpened</b>(<i></i>) |
|
950 <p> |
|
951 Private slot to start the shell for the opened project. |
|
952 </p><a NAME="Shell.__raw_input" ID="Shell.__raw_input"></a> |
|
953 <h4>Shell.__raw_input</h4> |
|
954 <b>__raw_input</b>(<i>s, echo</i>) |
|
955 <p> |
|
956 Private method to handle raw input. |
|
957 </p><dl> |
|
958 <dt><i>s</i></dt> |
|
959 <dd> |
|
960 prompt to be displayed (string) |
|
961 </dd><dt><i>echo</i></dt> |
|
962 <dd> |
|
963 Flag indicating echoing of the input (boolean) |
|
964 </dd> |
|
965 </dl><a NAME="Shell.__resetIncrementalHistorySearch" ID="Shell.__resetIncrementalHistorySearch"></a> |
|
966 <h4>Shell.__resetIncrementalHistorySearch</h4> |
|
967 <b>__resetIncrementalHistorySearch</b>(<i></i>) |
|
968 <p> |
|
969 Private method to reset the incremental history search. |
|
970 </p><a NAME="Shell.__resizeLinenoMargin" ID="Shell.__resizeLinenoMargin"></a> |
|
971 <h4>Shell.__resizeLinenoMargin</h4> |
|
972 <b>__resizeLinenoMargin</b>(<i></i>) |
|
973 <p> |
|
974 Private slot to resize the line numbers margin. |
|
975 </p><a NAME="Shell.__rsearchHistory" ID="Shell.__rsearchHistory"></a> |
|
976 <h4>Shell.__rsearchHistory</h4> |
|
977 <b>__rsearchHistory</b>(<i>txt, startIdx=-1</i>) |
|
978 <p> |
|
979 Private method used to reverse search the history. |
|
980 </p><dl> |
|
981 <dt><i>txt</i> (str)</dt> |
|
982 <dd> |
|
983 text to match at the beginning |
|
984 </dd><dt><i>startIdx</i> (int)</dt> |
|
985 <dd> |
|
986 index to start search from |
|
987 </dd> |
|
988 </dl><dl> |
|
989 <dt>Returns:</dt> |
|
990 <dd> |
|
991 tuple containing the index of found entry and a flag indicating |
|
992 that something was found |
|
993 </dd> |
|
994 </dl><dl> |
|
995 <dt>Return Type:</dt> |
|
996 <dd> |
|
997 tuple of (int, bool) |
|
998 </dd> |
|
999 </dl><a NAME="Shell.__searchHistory" ID="Shell.__searchHistory"></a> |
|
1000 <h4>Shell.__searchHistory</h4> |
|
1001 <b>__searchHistory</b>(<i>txt, startIdx=-1</i>) |
|
1002 <p> |
|
1003 Private method used to search the history. |
|
1004 </p><dl> |
|
1005 <dt><i>txt</i> (str)</dt> |
|
1006 <dd> |
|
1007 text to match at the beginning |
|
1008 </dd><dt><i>startIdx</i> (int)</dt> |
|
1009 <dd> |
|
1010 index to start search from |
|
1011 </dd> |
|
1012 </dl><dl> |
|
1013 <dt>Returns:</dt> |
|
1014 <dd> |
|
1015 tuple containing the index of found entry and a flag indicating |
|
1016 that something was found |
|
1017 </dd> |
|
1018 </dl><dl> |
|
1019 <dt>Return Type:</dt> |
|
1020 <dd> |
|
1021 tuple of (int, bool) |
|
1022 </dd> |
|
1023 </dl><a NAME="Shell.__searchNext" ID="Shell.__searchNext"></a> |
|
1024 <h4>Shell.__searchNext</h4> |
|
1025 <b>__searchNext</b>(<i></i>) |
|
1026 <p> |
|
1027 Private method to search for the next occurrence. |
|
1028 </p><a NAME="Shell.__searchPrev" ID="Shell.__searchPrev"></a> |
|
1029 <h4>Shell.__searchPrev</h4> |
|
1030 <b>__searchPrev</b>(<i></i>) |
|
1031 <p> |
|
1032 Private method to search for the next occurrence. |
|
1033 </p><a NAME="Shell.__setAutoCompletion" ID="Shell.__setAutoCompletion"></a> |
|
1034 <h4>Shell.__setAutoCompletion</h4> |
|
1035 <b>__setAutoCompletion</b>(<i>language='Python'</i>) |
|
1036 <p> |
|
1037 Private method to configure the autocompletion function. |
|
1038 </p><dl> |
|
1039 <dt><i>language</i></dt> |
|
1040 <dd> |
|
1041 of the autocompletion set to set (string) |
|
1042 </dd> |
|
1043 </dl><a NAME="Shell.__setCallTips" ID="Shell.__setCallTips"></a> |
|
1044 <h4>Shell.__setCallTips</h4> |
|
1045 <b>__setCallTips</b>(<i>language='Python'</i>) |
|
1046 <p> |
|
1047 Private method to configure the calltips function. |
|
1048 </p><dl> |
|
1049 <dt><i>language</i></dt> |
|
1050 <dd> |
|
1051 of the calltips set to set (string) |
|
1052 </dd> |
|
1053 </dl><a NAME="Shell.__setHistoryIndex" ID="Shell.__setHistoryIndex"></a> |
|
1054 <h4>Shell.__setHistoryIndex</h4> |
|
1055 <b>__setHistoryIndex</b>(<i>index=None</i>) |
|
1056 <p> |
|
1057 Private method to set the initial history index. |
|
1058 </p><dl> |
|
1059 <dt><i>index</i> (int or None)</dt> |
|
1060 <dd> |
|
1061 index value to be set |
|
1062 </dd> |
|
1063 </dl><a NAME="Shell.__setMargin0" ID="Shell.__setMargin0"></a> |
|
1064 <h4>Shell.__setMargin0</h4> |
|
1065 <b>__setMargin0</b>(<i></i>) |
|
1066 <p> |
|
1067 Private method to configure margin 0. |
|
1068 </p><a NAME="Shell.__setMonospaced" ID="Shell.__setMonospaced"></a> |
|
1069 <h4>Shell.__setMonospaced</h4> |
|
1070 <b>__setMonospaced</b>(<i>on</i>) |
|
1071 <p> |
|
1072 Private method to set/reset a monospaced font. |
|
1073 </p><dl> |
|
1074 <dt><i>on</i></dt> |
|
1075 <dd> |
|
1076 flag to indicate usage of a monospace font (boolean) |
|
1077 </dd> |
|
1078 </dl><a NAME="Shell.__setTextDisplay" ID="Shell.__setTextDisplay"></a> |
|
1079 <h4>Shell.__setTextDisplay</h4> |
|
1080 <b>__setTextDisplay</b>(<i></i>) |
|
1081 <p> |
|
1082 Private method to configure the text display. |
|
1083 </p><a NAME="Shell.__showCompletions" ID="Shell.__showCompletions"></a> |
|
1084 <h4>Shell.__showCompletions</h4> |
|
1085 <b>__showCompletions</b>(<i>completions, text</i>) |
|
1086 <p> |
|
1087 Private method to display the possible completions. |
|
1088 </p><dl> |
|
1089 <dt><i>completions</i></dt> |
|
1090 <dd> |
|
1091 list of possible completions (list of strings) |
|
1092 </dd><dt><i>text</i></dt> |
|
1093 <dd> |
|
1094 text that is about to be completed (string) |
|
1095 </dd> |
|
1096 </dl><a NAME="Shell.__showStartMenu" ID="Shell.__showStartMenu"></a> |
|
1097 <h4>Shell.__showStartMenu</h4> |
|
1098 <b>__showStartMenu</b>(<i></i>) |
|
1099 <p> |
|
1100 Private slot to prepare the start submenu. |
|
1101 </p><a NAME="Shell.__showVenvName" ID="Shell.__showVenvName"></a> |
|
1102 <h4>Shell.__showVenvName</h4> |
|
1103 <b>__showVenvName</b>(<i></i>) |
|
1104 <p> |
|
1105 Private method to show the name of the active virtual environment. |
|
1106 </p><a NAME="Shell.__startDebugClient" ID="Shell.__startDebugClient"></a> |
|
1107 <h4>Shell.__startDebugClient</h4> |
|
1108 <b>__startDebugClient</b>(<i>action</i>) |
|
1109 <p> |
|
1110 Private slot to start a debug client according to the action |
|
1111 triggered. |
|
1112 </p><dl> |
|
1113 <dt><i>action</i></dt> |
|
1114 <dd> |
|
1115 context menu action that was triggered (QAction) |
|
1116 </dd> |
|
1117 </dl><a NAME="Shell.__useHistory" ID="Shell.__useHistory"></a> |
|
1118 <h4>Shell.__useHistory</h4> |
|
1119 <b>__useHistory</b>(<i></i>) |
|
1120 <p> |
|
1121 Private method to display a command from the history. |
|
1122 </p><a NAME="Shell.__write" ID="Shell.__write"></a> |
|
1123 <h4>Shell.__write</h4> |
|
1124 <b>__write</b>(<i>s</i>) |
|
1125 <p> |
|
1126 Private method to display some text without queuing. |
|
1127 </p><dl> |
|
1128 <dt><i>s</i> (str)</dt> |
|
1129 <dd> |
|
1130 text to be displayed |
|
1131 </dd> |
|
1132 </dl><a NAME="Shell.__writeBanner" ID="Shell.__writeBanner"></a> |
|
1133 <h4>Shell.__writeBanner</h4> |
|
1134 <b>__writeBanner</b>(<i>version, platform, dbgclient, venvName</i>) |
|
1135 <p> |
|
1136 Private method to write a banner with info from the debug client. |
|
1137 </p><dl> |
|
1138 <dt><i>version</i> (str)</dt> |
|
1139 <dd> |
|
1140 interpreter version string |
|
1141 </dd><dt><i>platform</i> (str)</dt> |
|
1142 <dd> |
|
1143 platform of the remote interpreter |
|
1144 </dd><dt><i>dbgclient</i> (str)</dt> |
|
1145 <dd> |
|
1146 debug client variant used |
|
1147 </dd><dt><i>venvName</i> (str)</dt> |
|
1148 <dd> |
|
1149 name of the virtual environment |
|
1150 </dd> |
|
1151 </dl><a NAME="Shell.__writePrompt" ID="Shell.__writePrompt"></a> |
|
1152 <h4>Shell.__writePrompt</h4> |
|
1153 <b>__writePrompt</b>(<i></i>) |
|
1154 <p> |
|
1155 Private method to write the prompt using a write queue. |
|
1156 </p><a NAME="Shell.__writeQueued" ID="Shell.__writeQueued"></a> |
|
1157 <h4>Shell.__writeQueued</h4> |
|
1158 <b>__writeQueued</b>(<i>s</i>) |
|
1159 <p> |
|
1160 Private method to display some text using a write queue. |
|
1161 </p><dl> |
|
1162 <dt><i>s</i></dt> |
|
1163 <dd> |
|
1164 text to be displayed (string) |
|
1165 </dd> |
|
1166 </dl><a NAME="Shell.__writeStdErr" ID="Shell.__writeStdErr"></a> |
|
1167 <h4>Shell.__writeStdErr</h4> |
|
1168 <b>__writeStdErr</b>(<i>s</i>) |
|
1169 <p> |
|
1170 Private method to display some text with StdErr label. |
|
1171 </p><dl> |
|
1172 <dt><i>s</i></dt> |
|
1173 <dd> |
|
1174 text to be displayed (string) |
|
1175 </dd> |
|
1176 </dl><a NAME="Shell.__writeStdOut" ID="Shell.__writeStdOut"></a> |
|
1177 <h4>Shell.__writeStdOut</h4> |
|
1178 <b>__writeStdOut</b>(<i>s</i>) |
|
1179 <p> |
|
1180 Private method to display some text with StdOut label. |
|
1181 </p><dl> |
|
1182 <dt><i>s</i></dt> |
|
1183 <dd> |
|
1184 text to be displayed (string) |
|
1185 </dd> |
|
1186 </dl><a NAME="Shell.clear" ID="Shell.clear"></a> |
|
1187 <h4>Shell.clear</h4> |
|
1188 <b>clear</b>(<i></i>) |
|
1189 <p> |
|
1190 Public slot to clear the display. |
|
1191 </p><a NAME="Shell.clearAllHistories" ID="Shell.clearAllHistories"></a> |
|
1192 <h4>Shell.clearAllHistories</h4> |
|
1193 <b>clearAllHistories</b>(<i></i>) |
|
1194 <p> |
|
1195 Public method to clear all available histories and sync them. |
|
1196 </p><a NAME="Shell.clearHistory" ID="Shell.clearHistory"></a> |
|
1197 <h4>Shell.clearHistory</h4> |
|
1198 <b>clearHistory</b>(<i></i>) |
|
1199 <p> |
|
1200 Public slot to clear the current history. |
|
1201 </p><a NAME="Shell.closeShell" ID="Shell.closeShell"></a> |
|
1202 <h4>Shell.closeShell</h4> |
|
1203 <b>closeShell</b>(<i></i>) |
|
1204 <p> |
|
1205 Public method to shutdown the shell. |
|
1206 </p><a NAME="Shell.contextMenuEvent" ID="Shell.contextMenuEvent"></a> |
|
1207 <h4>Shell.contextMenuEvent</h4> |
|
1208 <b>contextMenuEvent</b>(<i>ev</i>) |
|
1209 <p> |
|
1210 Protected method to show our own context menu. |
|
1211 </p><dl> |
|
1212 <dt><i>ev</i></dt> |
|
1213 <dd> |
|
1214 context menu event (QContextMenuEvent) |
|
1215 </dd> |
|
1216 </dl><a NAME="Shell.doClearRestart" ID="Shell.doClearRestart"></a> |
|
1217 <h4>Shell.doClearRestart</h4> |
|
1218 <b>doClearRestart</b>(<i></i>) |
|
1219 <p> |
|
1220 Public slot to handle the 'restart and clear' context menu entry. |
|
1221 </p><a NAME="Shell.doRestart" ID="Shell.doRestart"></a> |
|
1222 <h4>Shell.doRestart</h4> |
|
1223 <b>doRestart</b>(<i></i>) |
|
1224 <p> |
|
1225 Public slot to handle the 'restart' context menu entry. |
|
1226 </p><a NAME="Shell.dragEnterEvent" ID="Shell.dragEnterEvent"></a> |
|
1227 <h4>Shell.dragEnterEvent</h4> |
|
1228 <b>dragEnterEvent</b>(<i>event</i>) |
|
1229 <p> |
|
1230 Protected method to handle the drag enter event. |
|
1231 </p><dl> |
|
1232 <dt><i>event</i></dt> |
|
1233 <dd> |
|
1234 the drag enter event (QDragEnterEvent) |
|
1235 </dd> |
|
1236 </dl><a NAME="Shell.dragLeaveEvent" ID="Shell.dragLeaveEvent"></a> |
|
1237 <h4>Shell.dragLeaveEvent</h4> |
|
1238 <b>dragLeaveEvent</b>(<i>event</i>) |
|
1239 <p> |
|
1240 Protected method to handle the drag leave event. |
|
1241 </p><dl> |
|
1242 <dt><i>event</i></dt> |
|
1243 <dd> |
|
1244 the drag leave event (QDragLeaveEvent) |
|
1245 </dd> |
|
1246 </dl><a NAME="Shell.dragMoveEvent" ID="Shell.dragMoveEvent"></a> |
|
1247 <h4>Shell.dragMoveEvent</h4> |
|
1248 <b>dragMoveEvent</b>(<i>event</i>) |
|
1249 <p> |
|
1250 Protected method to handle the drag move event. |
|
1251 </p><dl> |
|
1252 <dt><i>event</i></dt> |
|
1253 <dd> |
|
1254 the drag move event (QDragMoveEvent) |
|
1255 </dd> |
|
1256 </dl><a NAME="Shell.dropEvent" ID="Shell.dropEvent"></a> |
|
1257 <h4>Shell.dropEvent</h4> |
|
1258 <b>dropEvent</b>(<i>event</i>) |
|
1259 <p> |
|
1260 Protected method to handle the drop event. |
|
1261 </p><dl> |
|
1262 <dt><i>event</i></dt> |
|
1263 <dd> |
|
1264 the drop event (QDropEvent) |
|
1265 </dd> |
|
1266 </dl><a NAME="Shell.editorCommand" ID="Shell.editorCommand"></a> |
|
1267 <h4>Shell.editorCommand</h4> |
|
1268 <b>editorCommand</b>(<i>cmd</i>) |
|
1269 <p> |
|
1270 Public method to perform an editor command. |
|
1271 </p><dl> |
|
1272 <dt><i>cmd</i></dt> |
|
1273 <dd> |
|
1274 the scintilla command to be performed |
|
1275 </dd> |
|
1276 </dl><a NAME="Shell.event" ID="Shell.event"></a> |
|
1277 <h4>Shell.event</h4> |
|
1278 <b>event</b>(<i>evt</i>) |
|
1279 <p> |
|
1280 Public method handling events. |
|
1281 </p><dl> |
|
1282 <dt><i>evt</i></dt> |
|
1283 <dd> |
|
1284 reference to the event (QEvent) |
|
1285 </dd> |
|
1286 </dl><dl> |
|
1287 <dt>Returns:</dt> |
|
1288 <dd> |
|
1289 flag indicating, if the event was handled (boolean) |
|
1290 </dd> |
|
1291 </dl><a NAME="Shell.executeLines" ID="Shell.executeLines"></a> |
|
1292 <h4>Shell.executeLines</h4> |
|
1293 <b>executeLines</b>(<i>lines, historyIndex=None</i>) |
|
1294 <p> |
|
1295 Public method to execute a set of lines as multiple commands. |
|
1296 </p><dl> |
|
1297 <dt><i>lines</i> (str)</dt> |
|
1298 <dd> |
|
1299 multiple lines of text to be executed as |
|
1300 single commands |
|
1301 </dd><dt><i>historyIndex</i> (int)</dt> |
|
1302 <dd> |
|
1303 history index to be set |
|
1304 </dd> |
|
1305 </dl><a NAME="Shell.focusInEvent" ID="Shell.focusInEvent"></a> |
|
1306 <h4>Shell.focusInEvent</h4> |
|
1307 <b>focusInEvent</b>(<i>event</i>) |
|
1308 <p> |
|
1309 Protected method called when the shell receives focus. |
|
1310 </p><dl> |
|
1311 <dt><i>event</i></dt> |
|
1312 <dd> |
|
1313 the event object (QFocusEvent) |
|
1314 </dd> |
|
1315 </dl><a NAME="Shell.focusNextPrevChild" ID="Shell.focusNextPrevChild"></a> |
|
1316 <h4>Shell.focusNextPrevChild</h4> |
|
1317 <b>focusNextPrevChild</b>(<i>nextChild</i>) |
|
1318 <p> |
|
1319 Public method to stop Tab moving to the next window. |
|
1320 </p><p> |
|
1321 While the user is entering a multi-line command, the movement to |
|
1322 the next window by the Tab key being pressed is suppressed. |
|
1323 </p><dl> |
|
1324 <dt><i>nextChild</i></dt> |
|
1325 <dd> |
|
1326 next window |
|
1327 </dd> |
|
1328 </dl><dl> |
|
1329 <dt>Returns:</dt> |
|
1330 <dd> |
|
1331 flag indicating the movement |
|
1332 </dd> |
|
1333 </dl><a NAME="Shell.focusOutEvent" ID="Shell.focusOutEvent"></a> |
|
1334 <h4>Shell.focusOutEvent</h4> |
|
1335 <b>focusOutEvent</b>(<i>event</i>) |
|
1336 <p> |
|
1337 Protected method called when the shell loses focus. |
|
1338 </p><dl> |
|
1339 <dt><i>event</i></dt> |
|
1340 <dd> |
|
1341 the event object (QFocusEvent) |
|
1342 </dd> |
|
1343 </dl><a NAME="Shell.gestureEvent" ID="Shell.gestureEvent"></a> |
|
1344 <h4>Shell.gestureEvent</h4> |
|
1345 <b>gestureEvent</b>(<i>evt</i>) |
|
1346 <p> |
|
1347 Protected method handling gesture events. |
|
1348 </p><dl> |
|
1349 <dt><i>evt</i></dt> |
|
1350 <dd> |
|
1351 reference to the gesture event (QGestureEvent |
|
1352 </dd> |
|
1353 </dl><a NAME="Shell.getClientType" ID="Shell.getClientType"></a> |
|
1354 <h4>Shell.getClientType</h4> |
|
1355 <b>getClientType</b>(<i></i>) |
|
1356 <p> |
|
1357 Public slot to get the clients type. |
|
1358 </p><dl> |
|
1359 <dt>Returns:</dt> |
|
1360 <dd> |
|
1361 client type (string) |
|
1362 </dd> |
|
1363 </dl><a NAME="Shell.getHistory" ID="Shell.getHistory"></a> |
|
1364 <h4>Shell.getHistory</h4> |
|
1365 <b>getHistory</b>(<i>clientType</i>) |
|
1366 <p> |
|
1367 Public method to get the history for the given client type. |
|
1368 </p><dl> |
|
1369 <dt><i>clientType</i></dt> |
|
1370 <dd> |
|
1371 type of the debug client (string). |
|
1372 If it is None, the current history is returned. |
|
1373 </dd> |
|
1374 </dl><dl> |
|
1375 <dt>Returns:</dt> |
|
1376 <dd> |
|
1377 reference to the history list (list of strings) |
|
1378 </dd> |
|
1379 </dl><a NAME="Shell.getHistoryIndex" ID="Shell.getHistoryIndex"></a> |
|
1380 <h4>Shell.getHistoryIndex</h4> |
|
1381 <b>getHistoryIndex</b>(<i></i>) |
|
1382 <p> |
|
1383 Public method to get the current value of the history index. |
|
1384 </p><dl> |
|
1385 <dt>Returns:</dt> |
|
1386 <dd> |
|
1387 history index |
|
1388 </dd> |
|
1389 </dl><dl> |
|
1390 <dt>Return Type:</dt> |
|
1391 <dd> |
|
1392 int |
|
1393 </dd> |
|
1394 </dl><a NAME="Shell.handlePreferencesChanged" ID="Shell.handlePreferencesChanged"></a> |
|
1395 <h4>Shell.handlePreferencesChanged</h4> |
|
1396 <b>handlePreferencesChanged</b>(<i></i>) |
|
1397 <p> |
|
1398 Public slot to handle the preferencesChanged signal. |
|
1399 </p><a NAME="Shell.historyStyle" ID="Shell.historyStyle"></a> |
|
1400 <h4>Shell.historyStyle</h4> |
|
1401 <b>historyStyle</b>(<i></i>) |
|
1402 <p> |
|
1403 Public method to get the shell history style. |
|
1404 </p><dl> |
|
1405 <dt>Returns:</dt> |
|
1406 <dd> |
|
1407 shell history style |
|
1408 </dd> |
|
1409 </dl><dl> |
|
1410 <dt>Return Type:</dt> |
|
1411 <dd> |
|
1412 ShellHistoryStyle |
|
1413 </dd> |
|
1414 </dl><a NAME="Shell.insert" ID="Shell.insert"></a> |
|
1415 <h4>Shell.insert</h4> |
|
1416 <b>insert</b>(<i>txt</i>) |
|
1417 <p> |
|
1418 Public slot to insert text at the current cursor position. |
|
1419 </p><p> |
|
1420 The cursor is advanced to the end of the inserted text. |
|
1421 </p><dl> |
|
1422 <dt><i>txt</i></dt> |
|
1423 <dd> |
|
1424 text to be inserted (string) |
|
1425 </dd> |
|
1426 </dl><a NAME="Shell.isHistoryEnabled" ID="Shell.isHistoryEnabled"></a> |
|
1427 <h4>Shell.isHistoryEnabled</h4> |
|
1428 <b>isHistoryEnabled</b>(<i></i>) |
|
1429 <p> |
|
1430 Public method to check, if the history is enabled. |
|
1431 </p><dl> |
|
1432 <dt>Returns:</dt> |
|
1433 <dd> |
|
1434 flag indicating if history is enabled |
|
1435 </dd> |
|
1436 </dl><dl> |
|
1437 <dt>Return Type:</dt> |
|
1438 <dd> |
|
1439 bool |
|
1440 </dd> |
|
1441 </dl><a NAME="Shell.keyPressEvent" ID="Shell.keyPressEvent"></a> |
|
1442 <h4>Shell.keyPressEvent</h4> |
|
1443 <b>keyPressEvent</b>(<i>ev</i>) |
|
1444 <p> |
|
1445 Protected method to handle the user input a key at a time. |
|
1446 </p><dl> |
|
1447 <dt><i>ev</i></dt> |
|
1448 <dd> |
|
1449 key event (QKeyEvent) |
|
1450 </dd> |
|
1451 </dl><a NAME="Shell.loadHistory" ID="Shell.loadHistory"></a> |
|
1452 <h4>Shell.loadHistory</h4> |
|
1453 <b>loadHistory</b>(<i>clientType</i>) |
|
1454 <p> |
|
1455 Public method to load the history for the given client type. |
|
1456 </p><dl> |
|
1457 <dt><i>clientType</i></dt> |
|
1458 <dd> |
|
1459 type of the debug client (string) |
|
1460 </dd> |
|
1461 </dl><a NAME="Shell.mousePressEvent" ID="Shell.mousePressEvent"></a> |
|
1462 <h4>Shell.mousePressEvent</h4> |
|
1463 <b>mousePressEvent</b>(<i>event</i>) |
|
1464 <p> |
|
1465 Protected method to handle the mouse press event. |
|
1466 </p><dl> |
|
1467 <dt><i>event</i></dt> |
|
1468 <dd> |
|
1469 the mouse press event (QMouseEvent) |
|
1470 </dd> |
|
1471 </dl><a NAME="Shell.paste" ID="Shell.paste"></a> |
|
1472 <h4>Shell.paste</h4> |
|
1473 <b>paste</b>(<i></i>) |
|
1474 <p> |
|
1475 Public slot to handle the paste action. |
|
1476 </p><a NAME="Shell.reloadHistory" ID="Shell.reloadHistory"></a> |
|
1477 <h4>Shell.reloadHistory</h4> |
|
1478 <b>reloadHistory</b>(<i></i>) |
|
1479 <p> |
|
1480 Public method to reload the history of the currently selected client |
|
1481 type. |
|
1482 </p><a NAME="Shell.saveHistory" ID="Shell.saveHistory"></a> |
|
1483 <h4>Shell.saveHistory</h4> |
|
1484 <b>saveHistory</b>(<i>clientType</i>) |
|
1485 <p> |
|
1486 Public method to save the history for the given client type. |
|
1487 </p><dl> |
|
1488 <dt><i>clientType</i></dt> |
|
1489 <dd> |
|
1490 type of the debug client (string) |
|
1491 </dd> |
|
1492 </dl><a NAME="Shell.searchNext" ID="Shell.searchNext"></a> |
|
1493 <h4>Shell.searchNext</h4> |
|
1494 <b>searchNext</b>(<i>txt, caseSensitive, wholeWord, regexp</i>) |
|
1495 <p> |
|
1496 Public method to search the next occurrence of the given text. |
|
1497 </p><dl> |
|
1498 <dt><i>txt</i> (str)</dt> |
|
1499 <dd> |
|
1500 text to search for |
|
1501 </dd><dt><i>caseSensitive</i> (bool)</dt> |
|
1502 <dd> |
|
1503 flag indicating to perform a case sensitive |
|
1504 search |
|
1505 </dd><dt><i>wholeWord</i> (bool)</dt> |
|
1506 <dd> |
|
1507 flag indicating to search for whole words |
|
1508 only |
|
1509 </dd><dt><i>regexp</i> (bool)</dt> |
|
1510 <dd> |
|
1511 flag indicating a regular expression search |
|
1512 </dd> |
|
1513 </dl><a NAME="Shell.searchPrev" ID="Shell.searchPrev"></a> |
|
1514 <h4>Shell.searchPrev</h4> |
|
1515 <b>searchPrev</b>(<i>txt, caseSensitive, wholeWord, regexp</i>) |
|
1516 <p> |
|
1517 Public method to search the previous occurrence of the given text. |
|
1518 </p><dl> |
|
1519 <dt><i>txt</i> (str)</dt> |
|
1520 <dd> |
|
1521 text to search for |
|
1522 </dd><dt><i>caseSensitive</i> (bool)</dt> |
|
1523 <dd> |
|
1524 flag indicating to perform a case sensitive |
|
1525 search |
|
1526 </dd><dt><i>wholeWord</i> (bool)</dt> |
|
1527 <dd> |
|
1528 flag indicating to search for whole words |
|
1529 only |
|
1530 </dd><dt><i>regexp</i> (bool)</dt> |
|
1531 <dd> |
|
1532 flag indicating a regular expression search |
|
1533 </dd> |
|
1534 </dl><a NAME="Shell.selectHistory" ID="Shell.selectHistory"></a> |
|
1535 <h4>Shell.selectHistory</h4> |
|
1536 <b>selectHistory</b>(<i></i>) |
|
1537 <p> |
|
1538 Public slot to select a history entry to execute. |
|
1539 </p><a NAME="Shell.setDebuggerUI" ID="Shell.setDebuggerUI"></a> |
|
1540 <h4>Shell.setDebuggerUI</h4> |
|
1541 <b>setDebuggerUI</b>(<i>ui</i>) |
|
1542 <p> |
|
1543 Public method to set the debugger UI. |
|
1544 </p><dl> |
|
1545 <dt><i>ui</i></dt> |
|
1546 <dd> |
|
1547 reference to the debugger UI object (DebugUI) |
|
1548 </dd> |
|
1549 </dl><a NAME="Shell.showHistory" ID="Shell.showHistory"></a> |
|
1550 <h4>Shell.showHistory</h4> |
|
1551 <b>showHistory</b>(<i></i>) |
|
1552 <p> |
|
1553 Public slot to show the shell history dialog. |
|
1554 </p><a NAME="Shell.wheelEvent" ID="Shell.wheelEvent"></a> |
|
1555 <h4>Shell.wheelEvent</h4> |
|
1556 <b>wheelEvent</b>(<i>evt</i>) |
|
1557 <p> |
|
1558 Protected method to handle wheel events. |
|
1559 </p><dl> |
|
1560 <dt><i>evt</i></dt> |
|
1561 <dd> |
|
1562 reference to the wheel event (QWheelEvent) |
|
1563 </dd> |
|
1564 </dl> |
|
1565 <div align="right"><a href="#top">Up</a></div> |
|
1566 <hr /><hr /> |
|
1567 <a NAME="ShellAssembly" ID="ShellAssembly"></a> |
|
1568 <h2>ShellAssembly</h2> |
|
1569 <p> |
|
1570 Class implementing the containing widget for the shell. |
|
1571 </p> |
|
1572 <h3>Derived from</h3> |
|
1573 QWidget |
|
1574 <h3>Class Attributes</h3> |
|
1575 <table> |
|
1576 <tr><td>None</td></tr> |
|
1577 </table> |
|
1578 <h3>Class Methods</h3> |
|
1579 <table> |
|
1580 <tr><td>None</td></tr> |
|
1581 </table> |
|
1582 <h3>Methods</h3> |
|
1583 <table> |
|
1584 <tr> |
|
1585 <td><a href="#ShellAssembly.__init__">ShellAssembly</a></td> |
|
1586 <td>Constructor</td> |
|
1587 </tr><tr> |
|
1588 <td><a href="#ShellAssembly.shell">shell</a></td> |
|
1589 <td>Public method to get a reference to the shell widget.</td> |
|
1590 </tr><tr> |
|
1591 <td><a href="#ShellAssembly.showFind">showFind</a></td> |
|
1592 <td>Public method to display the search widget.</td> |
|
1593 </tr> |
|
1594 </table> |
|
1595 <h3>Static Methods</h3> |
|
1596 <table> |
|
1597 <tr><td>None</td></tr> |
|
1598 </table> |
|
1599 <a NAME="ShellAssembly.__init__" ID="ShellAssembly.__init__"></a> |
|
1600 <h4>ShellAssembly (Constructor)</h4> |
|
1601 <b>ShellAssembly</b>(<i>dbs, vm, project, horizontal=True, parent=None</i>) |
|
1602 <p> |
|
1603 Constructor |
|
1604 </p><dl> |
|
1605 <dt><i>dbs</i> (DebugServer)</dt> |
|
1606 <dd> |
|
1607 reference to the debug server object |
|
1608 </dd><dt><i>vm</i> (ViewManager)</dt> |
|
1609 <dd> |
|
1610 reference to the viewmanager object |
|
1611 </dd><dt><i>project</i> (Project)</dt> |
|
1612 <dd> |
|
1613 reference to the project object |
|
1614 </dd><dt><i>horizontal</i> (bool)</dt> |
|
1615 <dd> |
|
1616 flag indicating a horizontal layout |
|
1617 </dd><dt><i>parent</i> (QWidget)</dt> |
|
1618 <dd> |
|
1619 parent widget |
|
1620 </dd> |
|
1621 </dl><a NAME="ShellAssembly.shell" ID="ShellAssembly.shell"></a> |
|
1622 <h4>ShellAssembly.shell</h4> |
|
1623 <b>shell</b>(<i></i>) |
|
1624 <p> |
|
1625 Public method to get a reference to the shell widget. |
|
1626 </p><dl> |
|
1627 <dt>Returns:</dt> |
|
1628 <dd> |
|
1629 reference to the shell widget (Shell) |
|
1630 </dd> |
|
1631 </dl><a NAME="ShellAssembly.showFind" ID="ShellAssembly.showFind"></a> |
|
1632 <h4>ShellAssembly.showFind</h4> |
|
1633 <b>showFind</b>(<i>txt=""</i>) |
|
1634 <p> |
|
1635 Public method to display the search widget. |
|
1636 </p><dl> |
|
1637 <dt><i>txt</i></dt> |
|
1638 <dd> |
|
1639 text to be shown in the combo (string) |
|
1640 </dd> |
|
1641 </dl> |
|
1642 <div align="right"><a href="#top">Up</a></div> |
|
1643 <hr /><hr /> |
|
1644 <a NAME="ShellHistoryStyle" ID="ShellHistoryStyle"></a> |
|
1645 <h2>ShellHistoryStyle</h2> |
|
1646 <p> |
|
1647 Class defining the shell history styles. |
|
1648 </p> |
|
1649 <h3>Derived from</h3> |
|
1650 Enum |
|
1651 <h3>Class Attributes</h3> |
|
1652 <table> |
|
1653 <tr><td>Disabled</td></tr><tr><td>LinuxStyle</td></tr><tr><td>WindowsStyle</td></tr> |
|
1654 </table> |
|
1655 <h3>Class Methods</h3> |
|
1656 <table> |
|
1657 <tr><td>None</td></tr> |
|
1658 </table> |
|
1659 <h3>Methods</h3> |
|
1660 <table> |
|
1661 <tr><td>None</td></tr> |
|
1662 </table> |
|
1663 <h3>Static Methods</h3> |
|
1664 <table> |
|
1665 <tr><td>None</td></tr> |
|
1666 </table> |
|
1667 |
|
1668 <div align="right"><a href="#top">Up</a></div> |
|
1669 <hr /> |
|
1670 </body></html> |