Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.QScintilla.Shell.html
src/eric7/Documentation/Source/eric7.QScintilla.Shell.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 9236
- db53a9efe7ef
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.QScintilla.Shell</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.QScintilla.Shell</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a graphical Python shell. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#Shell">Shell</a></td> | |
| 25 <td>Class implementing a graphical Python shell.</td> | |
| 26 </tr> | |
| 27 <tr> | |
| 28 <td><a href="#ShellAssembly">ShellAssembly</a></td> | |
| 29 <td>Class implementing the containing widget for the shell.</td> | |
| 30 </tr> | |
| 31 <tr> | |
| 32 <td><a href="#ShellHistoryStyle">ShellHistoryStyle</a></td> | |
| 33 <td>Class defining the shell history styles.</td> | |
| 34 </tr> | |
| 35 </table> | |
| 36 <h3>Functions</h3> | |
| 37 | |
| 38 <table> | |
| 39 <tr><td>None</td></tr> | |
| 40 </table> | |
| 41 <hr /> | |
| 42 <hr /> | |
| 43 <a NAME="Shell" ID="Shell"></a> | |
| 44 <h2>Shell</h2> | |
| 45 | |
| 46 <p> | |
| 47 Class implementing a graphical Python shell. | |
| 48 </p> | |
| 49 <p> | |
| 50 A user can enter commands that are executed in the remote | |
| 51 Python interpreter. | |
| 52 </p> | |
| 53 <h3>Signals</h3> | |
| 54 <dl> | |
| 55 | |
| 56 <dt>historyStyleChanged(ShellHistoryStyle)</dt> | |
| 57 <dd> | |
| 58 emitted to indicate a | |
| 59 change of the history style | |
| 60 </dd> | |
| 61 <dt>queueText(str)</dt> | |
| 62 <dd> | |
| 63 emitted to queue some text for processing | |
| 64 </dd> | |
| 65 <dt>searchStringFound(bool)</dt> | |
| 66 <dd> | |
| 67 emitted to indicate the search | |
| 68 result | |
| 69 </dd> | |
| 70 <dt>virtualEnvironmentChanged(str)</dt> | |
| 71 <dd> | |
| 72 emitted to signal the new virtual | |
| 73 environment of the shell | |
| 74 </dd> | |
| 75 </dl> | |
| 76 <h3>Derived from</h3> | |
| 77 QsciScintillaCompat | |
| 78 <h3>Class Attributes</h3> | |
| 79 | |
| 80 <table> | |
| 81 <tr><td>None</td></tr> | |
| 82 </table> | |
| 83 <h3>Class Methods</h3> | |
| 84 | |
| 85 <table> | |
| 86 <tr><td>None</td></tr> | |
| 87 </table> | |
| 88 <h3>Methods</h3> | |
| 89 | |
| 90 <table> | |
| 91 | |
| 92 <tr> | |
| 93 <td><a href="#Shell.__init__">Shell</a></td> | |
| 94 <td>Constructor</td> | |
| 95 </tr> | |
| 96 <tr> | |
| 97 <td><a href="#Shell.__QScintillaAutoCompletionCommand">__QScintillaAutoCompletionCommand</a></td> | |
| 98 <td>Private method to handle a command for autocompletion only.</td> | |
| 99 </tr> | |
| 100 <tr> | |
| 101 <td><a href="#Shell.__QScintillaCancel">__QScintillaCancel</a></td> | |
| 102 <td>Private method to handle the ESC command.</td> | |
| 103 </tr> | |
| 104 <tr> | |
| 105 <td><a href="#Shell.__QScintillaCharLeft">__QScintillaCharLeft</a></td> | |
| 106 <td>Private method to handle the Cursor Left command.</td> | |
| 107 </tr> | |
| 108 <tr> | |
| 109 <td><a href="#Shell.__QScintillaCharLeftExtend">__QScintillaCharLeftExtend</a></td> | |
| 110 <td>Private method to handle the Extend Selection Left command.</td> | |
| 111 </tr> | |
| 112 <tr> | |
| 113 <td><a href="#Shell.__QScintillaCharRight">__QScintillaCharRight</a></td> | |
| 114 <td>Private method to handle the Cursor Right command.</td> | |
| 115 </tr> | |
| 116 <tr> | |
| 117 <td><a href="#Shell.__QScintillaCommand">__QScintillaCommand</a></td> | |
| 118 <td>Private method to send the command to QScintilla.</td> | |
| 119 </tr> | |
| 120 <tr> | |
| 121 <td><a href="#Shell.__QScintillaCursorCommand">__QScintillaCursorCommand</a></td> | |
| 122 <td>Private method to handle the cursor commands.</td> | |
| 123 </tr> | |
| 124 <tr> | |
| 125 <td><a href="#Shell.__QScintillaDelete">__QScintillaDelete</a></td> | |
| 126 <td>Private method to handle the delete command.</td> | |
| 127 </tr> | |
| 128 <tr> | |
| 129 <td><a href="#Shell.__QScintillaDeleteBack">__QScintillaDeleteBack</a></td> | |
| 130 <td>Private method to handle the Backspace key.</td> | |
| 131 </tr> | |
| 132 <tr> | |
| 133 <td><a href="#Shell.__QScintillaDeleteLineLeft">__QScintillaDeleteLineLeft</a></td> | |
| 134 <td>Private method to handle the Delete Line Left command.</td> | |
| 135 </tr> | |
| 136 <tr> | |
| 137 <td><a href="#Shell.__QScintillaDeleteLineRight">__QScintillaDeleteLineRight</a></td> | |
| 138 <td>Private method to handle the Delete Line Right command.</td> | |
| 139 </tr> | |
| 140 <tr> | |
| 141 <td><a href="#Shell.__QScintillaDeleteWordLeft">__QScintillaDeleteWordLeft</a></td> | |
| 142 <td>Private method to handle the Delete Word Left command.</td> | |
| 143 </tr> | |
| 144 <tr> | |
| 145 <td><a href="#Shell.__QScintillaDeleteWordRight">__QScintillaDeleteWordRight</a></td> | |
| 146 <td>Private method to handle the Delete Word Right command.</td> | |
| 147 </tr> | |
| 148 <tr> | |
| 149 <td><a href="#Shell.__QScintillaHistoryDown">__QScintillaHistoryDown</a></td> | |
| 150 <td>Private method to handle the history down command.</td> | |
| 151 </tr> | |
| 152 <tr> | |
| 153 <td><a href="#Shell.__QScintillaHistoryUp">__QScintillaHistoryUp</a></td> | |
| 154 <td>Private method to handle the history up command.</td> | |
| 155 </tr> | |
| 156 <tr> | |
| 157 <td><a href="#Shell.__QScintillaLeftCommand">__QScintillaLeftCommand</a></td> | |
| 158 <td>Private method to handle a QScintilla command working to the left.</td> | |
| 159 </tr> | |
| 160 <tr> | |
| 161 <td><a href="#Shell.__QScintillaLeftDeleteCommand">__QScintillaLeftDeleteCommand</a></td> | |
| 162 <td>Private method to handle a QScintilla delete command working to the left.</td> | |
| 163 </tr> | |
| 164 <tr> | |
| 165 <td><a href="#Shell.__QScintillaLineDown">__QScintillaLineDown</a></td> | |
| 166 <td>Private method to handle the cursor down command.</td> | |
| 167 </tr> | |
| 168 <tr> | |
| 169 <td><a href="#Shell.__QScintillaLineEnd">__QScintillaLineEnd</a></td> | |
| 170 <td>Private method to handle the End key.</td> | |
| 171 </tr> | |
| 172 <tr> | |
| 173 <td><a href="#Shell.__QScintillaLineUp">__QScintillaLineUp</a></td> | |
| 174 <td>Private method to handle the cursor up command.</td> | |
| 175 </tr> | |
| 176 <tr> | |
| 177 <td><a href="#Shell.__QScintillaNewline">__QScintillaNewline</a></td> | |
| 178 <td>Private method to handle the Return key.</td> | |
| 179 </tr> | |
| 180 <tr> | |
| 181 <td><a href="#Shell.__QScintillaRightCommand">__QScintillaRightCommand</a></td> | |
| 182 <td>Private method to handle a QScintilla command working to the right.</td> | |
| 183 </tr> | |
| 184 <tr> | |
| 185 <td><a href="#Shell.__QScintillaTab">__QScintillaTab</a></td> | |
| 186 <td>Private method to handle the Tab key.</td> | |
| 187 </tr> | |
| 188 <tr> | |
| 189 <td><a href="#Shell.__QScintillaVCHome">__QScintillaVCHome</a></td> | |
| 190 <td>Private method to handle the Home key.</td> | |
| 191 </tr> | |
| 192 <tr> | |
| 193 <td><a href="#Shell.__QScintillaVCHomeExtend">__QScintillaVCHomeExtend</a></td> | |
| 194 <td>Private method to handle the Extend Selection to start of line command.</td> | |
| 195 </tr> | |
| 196 <tr> | |
| 197 <td><a href="#Shell.__QScintillaWordLeft">__QScintillaWordLeft</a></td> | |
| 198 <td>Private method to handle the Cursor Word Left command.</td> | |
| 199 </tr> | |
| 200 <tr> | |
| 201 <td><a href="#Shell.__QScintillaWordLeftExtend">__QScintillaWordLeftExtend</a></td> | |
| 202 <td>Private method to handle the Extend Selection Left one word command.</td> | |
| 203 </tr> | |
| 204 <tr> | |
| 205 <td><a href="#Shell.__QScintillaWordRight">__QScintillaWordRight</a></td> | |
| 206 <td>Private method to handle the Cursor Word Right command.</td> | |
| 207 </tr> | |
| 208 <tr> | |
| 209 <td><a href="#Shell.__bindLexer">__bindLexer</a></td> | |
| 210 <td>Private slot to set the lexer.</td> | |
| 211 </tr> | |
| 212 <tr> | |
| 213 <td><a href="#Shell.__clearCurrentLine">__clearCurrentLine</a></td> | |
| 214 <td>Private method to clear the line containing the cursor.</td> | |
| 215 </tr> | |
| 216 <tr> | |
| 217 <td><a href="#Shell.__clientCapabilities">__clientCapabilities</a></td> | |
| 218 <td>Private slot to handle the reporting of the clients capabilities.</td> | |
| 219 </tr> | |
| 220 <tr> | |
| 221 <td><a href="#Shell.__clientError">__clientError</a></td> | |
| 222 <td>Private method to handle an error in the client.</td> | |
| 223 </tr> | |
| 224 <tr> | |
| 225 <td><a href="#Shell.__clientException">__clientException</a></td> | |
| 226 <td>Private method to handle an exception of the client.</td> | |
| 227 </tr> | |
| 228 <tr> | |
| 229 <td><a href="#Shell.__clientSignal">__clientSignal</a></td> | |
| 230 <td>Private method to handle a signal generated on the client side.</td> | |
| 231 </tr> | |
| 232 <tr> | |
| 233 <td><a href="#Shell.__clientStatement">__clientStatement</a></td> | |
| 234 <td>Private method to handle the response from the debugger client.</td> | |
| 235 </tr> | |
| 236 <tr> | |
| 237 <td><a href="#Shell.__clientSyntaxError">__clientSyntaxError</a></td> | |
| 238 <td>Private method to handle a syntax error in the debugged program.</td> | |
| 239 </tr> | |
| 240 <tr> | |
| 241 <td><a href="#Shell.__completionListSelected">__completionListSelected</a></td> | |
| 242 <td>Private slot to handle the selection from the completion list.</td> | |
| 243 </tr> | |
| 244 <tr> | |
| 245 <td><a href="#Shell.__concatenateText">__concatenateText</a></td> | |
| 246 <td>Private slot to queue text and process it in one step.</td> | |
| 247 </tr> | |
| 248 <tr> | |
| 249 <td><a href="#Shell.__configure">__configure</a></td> | |
| 250 <td>Private method to open the configuration dialog.</td> | |
| 251 </tr> | |
| 252 <tr> | |
| 253 <td><a href="#Shell.__executeCommand">__executeCommand</a></td> | |
| 254 <td>Private slot to execute a command.</td> | |
| 255 </tr> | |
| 256 <tr> | |
| 257 <td><a href="#Shell.__find">__find</a></td> | |
| 258 <td>Private slot to show the find widget.</td> | |
| 259 </tr> | |
| 260 <tr> | |
| 261 <td><a href="#Shell.__flushQueuedText">__flushQueuedText</a></td> | |
| 262 <td>Private slot to flush the accumulated text output.</td> | |
| 263 </tr> | |
| 264 <tr> | |
| 265 <td><a href="#Shell.__getBanner">__getBanner</a></td> | |
| 266 <td>Private method to get the banner for the remote interpreter.</td> | |
| 267 </tr> | |
| 268 <tr> | |
| 269 <td><a href="#Shell.__getEndPos">__getEndPos</a></td> | |
| 270 <td>Private method to return the line and column of the last character.</td> | |
| 271 </tr> | |
| 272 <tr> | |
| 273 <td><a href="#Shell.__indentLength">__indentLength</a></td> | |
| 274 <td>Private method to determine the indentation length of the given line.</td> | |
| 275 </tr> | |
| 276 <tr> | |
| 277 <td><a href="#Shell.__initialise">__initialise</a></td> | |
| 278 <td>Private method to get ready for a new remote interpreter.</td> | |
| 279 </tr> | |
| 280 <tr> | |
| 281 <td><a href="#Shell.__insertHistory">__insertHistory</a></td> | |
| 282 <td>Private method to insert a command selected from the history.</td> | |
| 283 </tr> | |
| 284 <tr> | |
| 285 <td><a href="#Shell.__insertText">__insertText</a></td> | |
| 286 <td>Private method to insert some text at the current cursor position.</td> | |
| 287 </tr> | |
| 288 <tr> | |
| 289 <td><a href="#Shell.__insertTextAtEnd">__insertTextAtEnd</a></td> | |
| 290 <td>Private method to insert some text at the end of the command line.</td> | |
| 291 </tr> | |
| 292 <tr> | |
| 293 <td><a href="#Shell.__insertTextNoEcho">__insertTextNoEcho</a></td> | |
| 294 <td>Private method to insert some text at the end of the buffer without echoing it.</td> | |
| 295 </tr> | |
| 296 <tr> | |
| 297 <td><a href="#Shell.__isCursorOnLastLine">__isCursorOnLastLine</a></td> | |
| 298 <td>Private method to check, if the cursor is on the last line.</td> | |
| 299 </tr> | |
| 300 <tr> | |
| 301 <td><a href="#Shell.__isHistoryIndexValid">__isHistoryIndexValid</a></td> | |
| 302 <td>Private method to test, if the history index is valid.</td> | |
| 303 </tr> | |
| 304 <tr> | |
| 305 <td><a href="#Shell.__projectClosed">__projectClosed</a></td> | |
| 306 <td>Private slot to restart the default shell when the project is closed.</td> | |
| 307 </tr> | |
| 308 <tr> | |
| 309 <td><a href="#Shell.__projectOpened">__projectOpened</a></td> | |
| 310 <td>Private slot to start the shell for the opened project.</td> | |
| 311 </tr> | |
| 312 <tr> | |
| 313 <td><a href="#Shell.__raw_input">__raw_input</a></td> | |
| 314 <td>Private method to handle raw input.</td> | |
| 315 </tr> | |
| 316 <tr> | |
| 317 <td><a href="#Shell.__resetIncrementalHistorySearch">__resetIncrementalHistorySearch</a></td> | |
| 318 <td>Private method to reset the incremental history search.</td> | |
| 319 </tr> | |
| 320 <tr> | |
| 321 <td><a href="#Shell.__resizeLinenoMargin">__resizeLinenoMargin</a></td> | |
| 322 <td>Private slot to resize the line numbers margin.</td> | |
| 323 </tr> | |
| 324 <tr> | |
| 325 <td><a href="#Shell.__rsearchHistory">__rsearchHistory</a></td> | |
| 326 <td>Private method used to reverse search the history.</td> | |
| 327 </tr> | |
| 328 <tr> | |
| 329 <td><a href="#Shell.__searchHistory">__searchHistory</a></td> | |
| 330 <td>Private method used to search the history.</td> | |
| 331 </tr> | |
| 332 <tr> | |
| 333 <td><a href="#Shell.__searchNext">__searchNext</a></td> | |
| 334 <td>Private method to search for the next occurrence.</td> | |
| 335 </tr> | |
| 336 <tr> | |
| 337 <td><a href="#Shell.__searchPrev">__searchPrev</a></td> | |
| 338 <td>Private method to search for the next occurrence.</td> | |
| 339 </tr> | |
| 340 <tr> | |
| 341 <td><a href="#Shell.__setAutoCompletion">__setAutoCompletion</a></td> | |
| 342 <td>Private method to configure the autocompletion function.</td> | |
| 343 </tr> | |
| 344 <tr> | |
| 345 <td><a href="#Shell.__setCallTips">__setCallTips</a></td> | |
| 346 <td>Private method to configure the calltips function.</td> | |
| 347 </tr> | |
| 348 <tr> | |
| 349 <td><a href="#Shell.__setHistoryIndex">__setHistoryIndex</a></td> | |
| 350 <td>Private method to set the initial history index.</td> | |
| 351 </tr> | |
| 352 <tr> | |
| 353 <td><a href="#Shell.__setMargin0">__setMargin0</a></td> | |
| 354 <td>Private method to configure margin 0.</td> | |
| 355 </tr> | |
| 356 <tr> | |
| 357 <td><a href="#Shell.__setMonospaced">__setMonospaced</a></td> | |
| 358 <td>Private method to set/reset a monospaced font.</td> | |
| 359 </tr> | |
| 360 <tr> | |
| 361 <td><a href="#Shell.__setTextDisplay">__setTextDisplay</a></td> | |
| 362 <td>Private method to configure the text display.</td> | |
| 363 </tr> | |
| 364 <tr> | |
| 365 <td><a href="#Shell.__showCompletions">__showCompletions</a></td> | |
| 366 <td>Private method to display the possible completions.</td> | |
| 367 </tr> | |
| 368 <tr> | |
| 369 <td><a href="#Shell.__showStartMenu">__showStartMenu</a></td> | |
| 370 <td>Private slot to prepare the start submenu.</td> | |
| 371 </tr> | |
| 372 <tr> | |
| 373 <td><a href="#Shell.__showVenvName">__showVenvName</a></td> | |
| 374 <td>Private method to show the name of the active virtual environment.</td> | |
| 375 </tr> | |
| 376 <tr> | |
| 377 <td><a href="#Shell.__startDebugClient">__startDebugClient</a></td> | |
| 378 <td>Private slot to start a debug client according to the action triggered.</td> | |
| 379 </tr> | |
| 380 <tr> | |
| 381 <td><a href="#Shell.__useHistory">__useHistory</a></td> | |
| 382 <td>Private method to display a command from the history.</td> | |
| 383 </tr> | |
| 384 <tr> | |
| 385 <td><a href="#Shell.__write">__write</a></td> | |
| 386 <td>Private method to display some text without queuing.</td> | |
| 387 </tr> | |
| 388 <tr> | |
| 389 <td><a href="#Shell.__writeBanner">__writeBanner</a></td> | |
| 390 <td>Private method to write a banner with info from the debug client.</td> | |
| 391 </tr> | |
| 392 <tr> | |
| 393 <td><a href="#Shell.__writePrompt">__writePrompt</a></td> | |
| 394 <td>Private method to write the prompt using a write queue.</td> | |
| 395 </tr> | |
| 396 <tr> | |
| 397 <td><a href="#Shell.__writeQueued">__writeQueued</a></td> | |
| 398 <td>Private method to display some text using a write queue.</td> | |
| 399 </tr> | |
| 400 <tr> | |
| 401 <td><a href="#Shell.__writeStdErr">__writeStdErr</a></td> | |
| 402 <td>Private method to display some text with StdErr label.</td> | |
| 403 </tr> | |
| 404 <tr> | |
| 405 <td><a href="#Shell.__writeStdOut">__writeStdOut</a></td> | |
| 406 <td>Private method to display some text with StdOut label.</td> | |
| 407 </tr> | |
| 408 <tr> | |
| 409 <td><a href="#Shell.clear">clear</a></td> | |
| 410 <td>Public slot to clear the display.</td> | |
| 411 </tr> | |
| 412 <tr> | |
| 413 <td><a href="#Shell.clearAllHistories">clearAllHistories</a></td> | |
| 414 <td>Public method to clear all available histories and sync them.</td> | |
| 415 </tr> | |
| 416 <tr> | |
| 417 <td><a href="#Shell.clearHistory">clearHistory</a></td> | |
| 418 <td>Public slot to clear the current history.</td> | |
| 419 </tr> | |
| 420 <tr> | |
| 421 <td><a href="#Shell.closeShell">closeShell</a></td> | |
| 422 <td>Public method to shutdown the shell.</td> | |
| 423 </tr> | |
| 424 <tr> | |
| 425 <td><a href="#Shell.contextMenuEvent">contextMenuEvent</a></td> | |
| 426 <td>Protected method to show our own context menu.</td> | |
| 427 </tr> | |
| 428 <tr> | |
| 429 <td><a href="#Shell.doClearRestart">doClearRestart</a></td> | |
| 430 <td>Public slot to handle the 'restart and clear' context menu entry.</td> | |
| 431 </tr> | |
| 432 <tr> | |
| 433 <td><a href="#Shell.doRestart">doRestart</a></td> | |
| 434 <td>Public slot to handle the 'restart' context menu entry.</td> | |
| 435 </tr> | |
| 436 <tr> | |
| 437 <td><a href="#Shell.dragEnterEvent">dragEnterEvent</a></td> | |
| 438 <td>Protected method to handle the drag enter event.</td> | |
| 439 </tr> | |
| 440 <tr> | |
| 441 <td><a href="#Shell.dragLeaveEvent">dragLeaveEvent</a></td> | |
| 442 <td>Protected method to handle the drag leave event.</td> | |
| 443 </tr> | |
| 444 <tr> | |
| 445 <td><a href="#Shell.dragMoveEvent">dragMoveEvent</a></td> | |
| 446 <td>Protected method to handle the drag move event.</td> | |
| 447 </tr> | |
| 448 <tr> | |
| 449 <td><a href="#Shell.dropEvent">dropEvent</a></td> | |
| 450 <td>Protected method to handle the drop event.</td> | |
| 451 </tr> | |
| 452 <tr> | |
| 453 <td><a href="#Shell.editorCommand">editorCommand</a></td> | |
| 454 <td>Public method to perform an editor command.</td> | |
| 455 </tr> | |
| 456 <tr> | |
| 457 <td><a href="#Shell.event">event</a></td> | |
| 458 <td>Public method handling events.</td> | |
| 459 </tr> | |
| 460 <tr> | |
| 461 <td><a href="#Shell.executeLines">executeLines</a></td> | |
| 462 <td>Public method to execute a set of lines as multiple commands.</td> | |
| 463 </tr> | |
| 464 <tr> | |
| 465 <td><a href="#Shell.focusInEvent">focusInEvent</a></td> | |
| 466 <td>Protected method called when the shell receives focus.</td> | |
| 467 </tr> | |
| 468 <tr> | |
| 469 <td><a href="#Shell.focusNextPrevChild">focusNextPrevChild</a></td> | |
| 470 <td>Public method to stop Tab moving to the next window.</td> | |
| 471 </tr> | |
| 472 <tr> | |
| 473 <td><a href="#Shell.focusOutEvent">focusOutEvent</a></td> | |
| 474 <td>Protected method called when the shell loses focus.</td> | |
| 475 </tr> | |
| 476 <tr> | |
| 477 <td><a href="#Shell.gestureEvent">gestureEvent</a></td> | |
| 478 <td>Protected method handling gesture events.</td> | |
| 479 </tr> | |
| 480 <tr> | |
| 481 <td><a href="#Shell.getClientType">getClientType</a></td> | |
| 482 <td>Public slot to get the clients type.</td> | |
| 483 </tr> | |
| 484 <tr> | |
| 485 <td><a href="#Shell.getHistory">getHistory</a></td> | |
| 486 <td>Public method to get the history for the given client type.</td> | |
| 487 </tr> | |
| 488 <tr> | |
| 489 <td><a href="#Shell.getHistoryIndex">getHistoryIndex</a></td> | |
| 490 <td>Public method to get the current value of the history index.</td> | |
| 491 </tr> | |
| 492 <tr> | |
| 493 <td><a href="#Shell.handlePreferencesChanged">handlePreferencesChanged</a></td> | |
| 494 <td>Public slot to handle the preferencesChanged signal.</td> | |
| 495 </tr> | |
| 496 <tr> | |
| 497 <td><a href="#Shell.historyStyle">historyStyle</a></td> | |
| 498 <td>Public method to get the shell history style.</td> | |
| 499 </tr> | |
| 500 <tr> | |
| 501 <td><a href="#Shell.insert">insert</a></td> | |
| 502 <td>Public slot to insert text at the current cursor position.</td> | |
| 503 </tr> | |
| 504 <tr> | |
| 505 <td><a href="#Shell.isHistoryEnabled">isHistoryEnabled</a></td> | |
| 506 <td>Public method to check, if the history is enabled.</td> | |
| 507 </tr> | |
| 508 <tr> | |
| 509 <td><a href="#Shell.keyPressEvent">keyPressEvent</a></td> | |
| 510 <td>Protected method to handle the user input a key at a time.</td> | |
| 511 </tr> | |
| 512 <tr> | |
| 513 <td><a href="#Shell.loadHistory">loadHistory</a></td> | |
| 514 <td>Public method to load the history for the given client type.</td> | |
| 515 </tr> | |
| 516 <tr> | |
| 517 <td><a href="#Shell.mousePressEvent">mousePressEvent</a></td> | |
| 518 <td>Protected method to handle the mouse press event.</td> | |
| 519 </tr> | |
| 520 <tr> | |
| 521 <td><a href="#Shell.paste">paste</a></td> | |
| 522 <td>Public slot to handle the paste action.</td> | |
| 523 </tr> | |
| 524 <tr> | |
| 525 <td><a href="#Shell.registerDebuggerIdMethod">registerDebuggerIdMethod</a></td> | |
| 526 <td>Public method to register a method to get the debugger ID to send data to.</td> | |
| 527 </tr> | |
| 528 <tr> | |
| 529 <td><a href="#Shell.reloadHistory">reloadHistory</a></td> | |
| 530 <td>Public method to reload the history of the currently selected client type.</td> | |
| 531 </tr> | |
| 532 <tr> | |
| 533 <td><a href="#Shell.saveContents">saveContents</a></td> | |
| 534 <td>Public method to save the current contents to a file.</td> | |
| 535 </tr> | |
| 536 <tr> | |
| 537 <td><a href="#Shell.saveHistory">saveHistory</a></td> | |
| 538 <td>Public method to save the history for the given client type.</td> | |
| 539 </tr> | |
| 540 <tr> | |
| 541 <td><a href="#Shell.searchNext">searchNext</a></td> | |
| 542 <td>Public method to search the next occurrence of the given text.</td> | |
| 543 </tr> | |
| 544 <tr> | |
| 545 <td><a href="#Shell.searchPrev">searchPrev</a></td> | |
| 546 <td>Public method to search the previous occurrence of the given text.</td> | |
| 547 </tr> | |
| 548 <tr> | |
| 549 <td><a href="#Shell.selectHistory">selectHistory</a></td> | |
| 550 <td>Public slot to select a history entry to execute.</td> | |
| 551 </tr> | |
| 552 <tr> | |
| 553 <td><a href="#Shell.setDebuggerUI">setDebuggerUI</a></td> | |
| 554 <td>Public method to set the debugger UI.</td> | |
| 555 </tr> | |
| 556 <tr> | |
| 557 <td><a href="#Shell.showHistory">showHistory</a></td> | |
| 558 <td>Public slot to show the shell history dialog.</td> | |
| 559 </tr> | |
| 560 <tr> | |
| 561 <td><a href="#Shell.wheelEvent">wheelEvent</a></td> | |
| 562 <td>Protected method to handle wheel events.</td> | |
| 563 </tr> | |
| 564 </table> | |
| 565 <h3>Static Methods</h3> | |
| 566 | |
| 567 <table> | |
| 568 <tr><td>None</td></tr> | |
| 569 </table> | |
| 570 | |
| 571 <a NAME="Shell.__init__" ID="Shell.__init__"></a> | |
| 572 <h4>Shell (Constructor)</h4> | |
| 573 <b>Shell</b>(<i>dbs, vm, project, windowedVariant, parent=None</i>) | |
| 574 | |
| 575 <p> | |
| 576 Constructor | |
| 577 </p> | |
| 578 <dl> | |
| 579 | |
| 580 <dt><i>dbs</i> (DebugServer)</dt> | |
| 581 <dd> | |
| 582 reference to the debug server object | |
| 583 </dd> | |
| 584 <dt><i>vm</i> (ViewManager)</dt> | |
| 585 <dd> | |
| 586 reference to the viewmanager object | |
| 587 </dd> | |
| 588 <dt><i>project</i> (Project)</dt> | |
| 589 <dd> | |
| 590 reference to the project object | |
| 591 </dd> | |
| 592 <dt><i>windowedVariant</i> (bool)</dt> | |
| 593 <dd> | |
| 594 flag indicating the shell window variant | |
| 595 </dd> | |
| 596 <dt><i>parent</i> (QWidget)</dt> | |
| 597 <dd> | |
| 598 parent widget | |
| 599 </dd> | |
| 600 </dl> | |
| 601 <a NAME="Shell.__QScintillaAutoCompletionCommand" ID="Shell.__QScintillaAutoCompletionCommand"></a> | |
| 602 <h4>Shell.__QScintillaAutoCompletionCommand</h4> | |
| 603 <b>__QScintillaAutoCompletionCommand</b>(<i>cmd</i>) | |
| 604 | |
| 605 <p> | |
| 606 Private method to handle a command for autocompletion only. | |
| 607 </p> | |
| 608 <dl> | |
| 609 | |
| 610 <dt><i>cmd</i></dt> | |
| 611 <dd> | |
| 612 QScintilla command | |
| 613 </dd> | |
| 614 </dl> | |
| 615 <a NAME="Shell.__QScintillaCancel" ID="Shell.__QScintillaCancel"></a> | |
| 616 <h4>Shell.__QScintillaCancel</h4> | |
| 617 <b>__QScintillaCancel</b>(<i></i>) | |
| 618 | |
| 619 <p> | |
| 620 Private method to handle the ESC command. | |
| 621 </p> | |
| 622 <a NAME="Shell.__QScintillaCharLeft" ID="Shell.__QScintillaCharLeft"></a> | |
| 623 <h4>Shell.__QScintillaCharLeft</h4> | |
| 624 <b>__QScintillaCharLeft</b>(<i></i>) | |
| 625 | |
| 626 <p> | |
| 627 Private method to handle the Cursor Left command. | |
| 628 </p> | |
| 629 <a NAME="Shell.__QScintillaCharLeftExtend" ID="Shell.__QScintillaCharLeftExtend"></a> | |
| 630 <h4>Shell.__QScintillaCharLeftExtend</h4> | |
| 631 <b>__QScintillaCharLeftExtend</b>(<i></i>) | |
| 632 | |
| 633 <p> | |
| 634 Private method to handle the Extend Selection Left command. | |
| 635 </p> | |
| 636 <a NAME="Shell.__QScintillaCharRight" ID="Shell.__QScintillaCharRight"></a> | |
| 637 <h4>Shell.__QScintillaCharRight</h4> | |
| 638 <b>__QScintillaCharRight</b>(<i></i>) | |
| 639 | |
| 640 <p> | |
| 641 Private method to handle the Cursor Right command. | |
| 642 </p> | |
| 643 <a NAME="Shell.__QScintillaCommand" ID="Shell.__QScintillaCommand"></a> | |
| 644 <h4>Shell.__QScintillaCommand</h4> | |
| 645 <b>__QScintillaCommand</b>(<i>cmd</i>) | |
| 646 | |
| 647 <p> | |
| 648 Private method to send the command to QScintilla. | |
| 649 </p> | |
| 650 <dl> | |
| 651 | |
| 652 <dt><i>cmd</i></dt> | |
| 653 <dd> | |
| 654 QScintilla command | |
| 655 </dd> | |
| 656 </dl> | |
| 657 <a NAME="Shell.__QScintillaCursorCommand" ID="Shell.__QScintillaCursorCommand"></a> | |
| 658 <h4>Shell.__QScintillaCursorCommand</h4> | |
| 659 <b>__QScintillaCursorCommand</b>(<i>cmd</i>) | |
| 660 | |
| 661 <p> | |
| 662 Private method to handle the cursor commands. | |
| 663 </p> | |
| 664 <dl> | |
| 665 | |
| 666 <dt><i>cmd</i></dt> | |
| 667 <dd> | |
| 668 QScintilla command | |
| 669 </dd> | |
| 670 </dl> | |
| 671 <a NAME="Shell.__QScintillaDelete" ID="Shell.__QScintillaDelete"></a> | |
| 672 <h4>Shell.__QScintillaDelete</h4> | |
| 673 <b>__QScintillaDelete</b>(<i></i>) | |
| 674 | |
| 675 <p> | |
| 676 Private method to handle the delete command. | |
| 677 </p> | |
| 678 <a NAME="Shell.__QScintillaDeleteBack" ID="Shell.__QScintillaDeleteBack"></a> | |
| 679 <h4>Shell.__QScintillaDeleteBack</h4> | |
| 680 <b>__QScintillaDeleteBack</b>(<i></i>) | |
| 681 | |
| 682 <p> | |
| 683 Private method to handle the Backspace key. | |
| 684 </p> | |
| 685 <a NAME="Shell.__QScintillaDeleteLineLeft" ID="Shell.__QScintillaDeleteLineLeft"></a> | |
| 686 <h4>Shell.__QScintillaDeleteLineLeft</h4> | |
| 687 <b>__QScintillaDeleteLineLeft</b>(<i></i>) | |
| 688 | |
| 689 <p> | |
| 690 Private method to handle the Delete Line Left command. | |
| 691 </p> | |
| 692 <a NAME="Shell.__QScintillaDeleteLineRight" ID="Shell.__QScintillaDeleteLineRight"></a> | |
| 693 <h4>Shell.__QScintillaDeleteLineRight</h4> | |
| 694 <b>__QScintillaDeleteLineRight</b>(<i></i>) | |
| 695 | |
| 696 <p> | |
| 697 Private method to handle the Delete Line Right command. | |
| 698 </p> | |
| 699 <a NAME="Shell.__QScintillaDeleteWordLeft" ID="Shell.__QScintillaDeleteWordLeft"></a> | |
| 700 <h4>Shell.__QScintillaDeleteWordLeft</h4> | |
| 701 <b>__QScintillaDeleteWordLeft</b>(<i></i>) | |
| 702 | |
| 703 <p> | |
| 704 Private method to handle the Delete Word Left command. | |
| 705 </p> | |
| 706 <a NAME="Shell.__QScintillaDeleteWordRight" ID="Shell.__QScintillaDeleteWordRight"></a> | |
| 707 <h4>Shell.__QScintillaDeleteWordRight</h4> | |
| 708 <b>__QScintillaDeleteWordRight</b>(<i></i>) | |
| 709 | |
| 710 <p> | |
| 711 Private method to handle the Delete Word Right command. | |
| 712 </p> | |
| 713 <a NAME="Shell.__QScintillaHistoryDown" ID="Shell.__QScintillaHistoryDown"></a> | |
| 714 <h4>Shell.__QScintillaHistoryDown</h4> | |
| 715 <b>__QScintillaHistoryDown</b>(<i>cmd</i>) | |
| 716 | |
| 717 <p> | |
| 718 Private method to handle the history down command. | |
| 719 </p> | |
| 720 <dl> | |
| 721 | |
| 722 <dt><i>cmd</i></dt> | |
| 723 <dd> | |
| 724 QScintilla command | |
| 725 </dd> | |
| 726 </dl> | |
| 727 <a NAME="Shell.__QScintillaHistoryUp" ID="Shell.__QScintillaHistoryUp"></a> | |
| 728 <h4>Shell.__QScintillaHistoryUp</h4> | |
| 729 <b>__QScintillaHistoryUp</b>(<i>cmd</i>) | |
| 730 | |
| 731 <p> | |
| 732 Private method to handle the history up command. | |
| 733 </p> | |
| 734 <dl> | |
| 735 | |
| 736 <dt><i>cmd</i></dt> | |
| 737 <dd> | |
| 738 QScintilla command | |
| 739 </dd> | |
| 740 </dl> | |
| 741 <a NAME="Shell.__QScintillaLeftCommand" ID="Shell.__QScintillaLeftCommand"></a> | |
| 742 <h4>Shell.__QScintillaLeftCommand</h4> | |
| 743 <b>__QScintillaLeftCommand</b>(<i>method, allLinesAllowed=False</i>) | |
| 744 | |
| 745 <p> | |
| 746 Private method to handle a QScintilla command working to the left. | |
| 747 </p> | |
| 748 <dl> | |
| 749 | |
| 750 <dt><i>method</i></dt> | |
| 751 <dd> | |
| 752 shell method to execute | |
| 753 </dd> | |
| 754 <dt><i>allLinesAllowed</i></dt> | |
| 755 <dd> | |
| 756 flag indicating that the command may be executed | |
| 757 on any line (boolean) | |
| 758 </dd> | |
| 759 </dl> | |
| 760 <a NAME="Shell.__QScintillaLeftDeleteCommand" ID="Shell.__QScintillaLeftDeleteCommand"></a> | |
| 761 <h4>Shell.__QScintillaLeftDeleteCommand</h4> | |
| 762 <b>__QScintillaLeftDeleteCommand</b>(<i>method</i>) | |
| 763 | |
| 764 <p> | |
| 765 Private method to handle a QScintilla delete command working to | |
| 766 the left. | |
| 767 </p> | |
| 768 <dl> | |
| 769 | |
| 770 <dt><i>method</i></dt> | |
| 771 <dd> | |
| 772 shell method to execute | |
| 773 </dd> | |
| 774 </dl> | |
| 775 <a NAME="Shell.__QScintillaLineDown" ID="Shell.__QScintillaLineDown"></a> | |
| 776 <h4>Shell.__QScintillaLineDown</h4> | |
| 777 <b>__QScintillaLineDown</b>(<i>cmd</i>) | |
| 778 | |
| 779 <p> | |
| 780 Private method to handle the cursor down command. | |
| 781 </p> | |
| 782 <dl> | |
| 783 | |
| 784 <dt><i>cmd</i></dt> | |
| 785 <dd> | |
| 786 QScintilla command | |
| 787 </dd> | |
| 788 </dl> | |
| 789 <a NAME="Shell.__QScintillaLineEnd" ID="Shell.__QScintillaLineEnd"></a> | |
| 790 <h4>Shell.__QScintillaLineEnd</h4> | |
| 791 <b>__QScintillaLineEnd</b>(<i>cmd</i>) | |
| 792 | |
| 793 <p> | |
| 794 Private method to handle the End key. | |
| 795 </p> | |
| 796 <dl> | |
| 797 | |
| 798 <dt><i>cmd</i></dt> | |
| 799 <dd> | |
| 800 QScintilla command | |
| 801 </dd> | |
| 802 </dl> | |
| 803 <a NAME="Shell.__QScintillaLineUp" ID="Shell.__QScintillaLineUp"></a> | |
| 804 <h4>Shell.__QScintillaLineUp</h4> | |
| 805 <b>__QScintillaLineUp</b>(<i>cmd</i>) | |
| 806 | |
| 807 <p> | |
| 808 Private method to handle the cursor up command. | |
| 809 </p> | |
| 810 <dl> | |
| 811 | |
| 812 <dt><i>cmd</i></dt> | |
| 813 <dd> | |
| 814 QScintilla command | |
| 815 </dd> | |
| 816 </dl> | |
| 817 <a NAME="Shell.__QScintillaNewline" ID="Shell.__QScintillaNewline"></a> | |
| 818 <h4>Shell.__QScintillaNewline</h4> | |
| 819 <b>__QScintillaNewline</b>(<i>cmd</i>) | |
| 820 | |
| 821 <p> | |
| 822 Private method to handle the Return key. | |
| 823 </p> | |
| 824 <dl> | |
| 825 | |
| 826 <dt><i>cmd</i></dt> | |
| 827 <dd> | |
| 828 QScintilla command | |
| 829 </dd> | |
| 830 </dl> | |
| 831 <a NAME="Shell.__QScintillaRightCommand" ID="Shell.__QScintillaRightCommand"></a> | |
| 832 <h4>Shell.__QScintillaRightCommand</h4> | |
| 833 <b>__QScintillaRightCommand</b>(<i>method</i>) | |
| 834 | |
| 835 <p> | |
| 836 Private method to handle a QScintilla command working to the right. | |
| 837 </p> | |
| 838 <dl> | |
| 839 | |
| 840 <dt><i>method</i></dt> | |
| 841 <dd> | |
| 842 shell method to execute | |
| 843 </dd> | |
| 844 </dl> | |
| 845 <a NAME="Shell.__QScintillaTab" ID="Shell.__QScintillaTab"></a> | |
| 846 <h4>Shell.__QScintillaTab</h4> | |
| 847 <b>__QScintillaTab</b>(<i>cmd</i>) | |
| 848 | |
| 849 <p> | |
| 850 Private method to handle the Tab key. | |
| 851 </p> | |
| 852 <dl> | |
| 853 | |
| 854 <dt><i>cmd</i></dt> | |
| 855 <dd> | |
| 856 QScintilla command | |
| 857 </dd> | |
| 858 </dl> | |
| 859 <a NAME="Shell.__QScintillaVCHome" ID="Shell.__QScintillaVCHome"></a> | |
| 860 <h4>Shell.__QScintillaVCHome</h4> | |
| 861 <b>__QScintillaVCHome</b>(<i>cmd</i>) | |
| 862 | |
| 863 <p> | |
| 864 Private method to handle the Home key. | |
| 865 </p> | |
| 866 <dl> | |
| 867 | |
| 868 <dt><i>cmd</i></dt> | |
| 869 <dd> | |
| 870 QScintilla command | |
| 871 </dd> | |
| 872 </dl> | |
| 873 <a NAME="Shell.__QScintillaVCHomeExtend" ID="Shell.__QScintillaVCHomeExtend"></a> | |
| 874 <h4>Shell.__QScintillaVCHomeExtend</h4> | |
| 875 <b>__QScintillaVCHomeExtend</b>(<i></i>) | |
| 876 | |
| 877 <p> | |
| 878 Private method to handle the Extend Selection to start of line command. | |
| 879 </p> | |
| 880 <a NAME="Shell.__QScintillaWordLeft" ID="Shell.__QScintillaWordLeft"></a> | |
| 881 <h4>Shell.__QScintillaWordLeft</h4> | |
| 882 <b>__QScintillaWordLeft</b>(<i></i>) | |
| 883 | |
| 884 <p> | |
| 885 Private method to handle the Cursor Word Left command. | |
| 886 </p> | |
| 887 <a NAME="Shell.__QScintillaWordLeftExtend" ID="Shell.__QScintillaWordLeftExtend"></a> | |
| 888 <h4>Shell.__QScintillaWordLeftExtend</h4> | |
| 889 <b>__QScintillaWordLeftExtend</b>(<i></i>) | |
| 890 | |
| 891 <p> | |
| 892 Private method to handle the Extend Selection Left one word command. | |
| 893 </p> | |
| 894 <a NAME="Shell.__QScintillaWordRight" ID="Shell.__QScintillaWordRight"></a> | |
| 895 <h4>Shell.__QScintillaWordRight</h4> | |
| 896 <b>__QScintillaWordRight</b>(<i></i>) | |
| 897 | |
| 898 <p> | |
| 899 Private method to handle the Cursor Word Right command. | |
| 900 </p> | |
| 901 <a NAME="Shell.__bindLexer" ID="Shell.__bindLexer"></a> | |
| 902 <h4>Shell.__bindLexer</h4> | |
| 903 <b>__bindLexer</b>(<i>language='Python3'</i>) | |
| 904 | |
| 905 <p> | |
| 906 Private slot to set the lexer. | |
| 907 </p> | |
| 908 <dl> | |
| 909 | |
| 910 <dt><i>language</i></dt> | |
| 911 <dd> | |
| 912 lexer language to set (string) | |
| 913 </dd> | |
| 914 </dl> | |
| 915 <a NAME="Shell.__clearCurrentLine" ID="Shell.__clearCurrentLine"></a> | |
| 916 <h4>Shell.__clearCurrentLine</h4> | |
| 917 <b>__clearCurrentLine</b>(<i></i>) | |
| 918 | |
| 919 <p> | |
| 920 Private method to clear the line containing the cursor. | |
| 921 </p> | |
| 922 <a NAME="Shell.__clientCapabilities" ID="Shell.__clientCapabilities"></a> | |
| 923 <h4>Shell.__clientCapabilities</h4> | |
| 924 <b>__clientCapabilities</b>(<i>cap, clType, venvName</i>) | |
| 925 | |
| 926 <p> | |
| 927 Private slot to handle the reporting of the clients capabilities. | |
| 928 </p> | |
| 929 <dl> | |
| 930 | |
| 931 <dt><i>cap</i> (int)</dt> | |
| 932 <dd> | |
| 933 client capabilities | |
| 934 </dd> | |
| 935 <dt><i>clType</i> (str)</dt> | |
| 936 <dd> | |
| 937 type of the debug client | |
| 938 </dd> | |
| 939 <dt><i>venvName</i> (str)</dt> | |
| 940 <dd> | |
| 941 name of the virtual environment | |
| 942 </dd> | |
| 943 </dl> | |
| 944 <a NAME="Shell.__clientError" ID="Shell.__clientError"></a> | |
| 945 <h4>Shell.__clientError</h4> | |
| 946 <b>__clientError</b>(<i></i>) | |
| 947 | |
| 948 <p> | |
| 949 Private method to handle an error in the client. | |
| 950 </p> | |
| 951 <a NAME="Shell.__clientException" ID="Shell.__clientException"></a> | |
| 952 <h4>Shell.__clientException</h4> | |
| 953 <b>__clientException</b>(<i>exceptionType, exceptionMessage, stackTrace</i>) | |
| 954 | |
| 955 <p> | |
| 956 Private method to handle an exception of the client. | |
| 957 </p> | |
| 958 <dl> | |
| 959 | |
| 960 <dt><i>exceptionType</i></dt> | |
| 961 <dd> | |
| 962 type of exception raised (string) | |
| 963 </dd> | |
| 964 <dt><i>exceptionMessage</i></dt> | |
| 965 <dd> | |
| 966 message given by the exception (string) | |
| 967 </dd> | |
| 968 <dt><i>stackTrace</i></dt> | |
| 969 <dd> | |
| 970 list of stack entries (list of string) | |
| 971 </dd> | |
| 972 </dl> | |
| 973 <a NAME="Shell.__clientSignal" ID="Shell.__clientSignal"></a> | |
| 974 <h4>Shell.__clientSignal</h4> | |
| 975 <b>__clientSignal</b>(<i>message, filename, lineNo, funcName, funcArgs</i>) | |
| 976 | |
| 977 <p> | |
| 978 Private method to handle a signal generated on the client side. | |
| 979 </p> | |
| 980 <dl> | |
| 981 | |
| 982 <dt><i>message</i> (str)</dt> | |
| 983 <dd> | |
| 984 message of the syntax error | |
| 985 </dd> | |
| 986 <dt><i>filename</i> (str)</dt> | |
| 987 <dd> | |
| 988 translated filename of the syntax error position | |
| 989 </dd> | |
| 990 <dt><i>lineNo</i> (int)</dt> | |
| 991 <dd> | |
| 992 line number of the syntax error position | |
| 993 </dd> | |
| 994 <dt><i>funcName</i> (str)</dt> | |
| 995 <dd> | |
| 996 name of the function causing the signal | |
| 997 </dd> | |
| 998 <dt><i>funcArgs</i> (str)</dt> | |
| 999 <dd> | |
| 1000 function arguments | |
| 1001 </dd> | |
| 1002 </dl> | |
| 1003 <a NAME="Shell.__clientStatement" ID="Shell.__clientStatement"></a> | |
| 1004 <h4>Shell.__clientStatement</h4> | |
| 1005 <b>__clientStatement</b>(<i>more</i>) | |
| 1006 | |
| 1007 <p> | |
| 1008 Private method to handle the response from the debugger client. | |
| 1009 </p> | |
| 1010 <dl> | |
| 1011 | |
| 1012 <dt><i>more</i> (bool)</dt> | |
| 1013 <dd> | |
| 1014 flag indicating that more user input is required | |
| 1015 </dd> | |
| 1016 </dl> | |
| 1017 <a NAME="Shell.__clientSyntaxError" ID="Shell.__clientSyntaxError"></a> | |
| 1018 <h4>Shell.__clientSyntaxError</h4> | |
| 1019 <b>__clientSyntaxError</b>(<i>message, filename, lineNo, characterNo</i>) | |
| 1020 | |
| 1021 <p> | |
| 1022 Private method to handle a syntax error in the debugged program. | |
| 1023 </p> | |
| 1024 <dl> | |
| 1025 | |
| 1026 <dt><i>message</i></dt> | |
| 1027 <dd> | |
| 1028 message of the syntax error (string) | |
| 1029 </dd> | |
| 1030 <dt><i>filename</i></dt> | |
| 1031 <dd> | |
| 1032 translated filename of the syntax error position | |
| 1033 (string) | |
| 1034 </dd> | |
| 1035 <dt><i>lineNo</i></dt> | |
| 1036 <dd> | |
| 1037 line number of the syntax error position (integer) | |
| 1038 </dd> | |
| 1039 <dt><i>characterNo</i></dt> | |
| 1040 <dd> | |
| 1041 character number of the syntax error position | |
| 1042 (integer) | |
| 1043 </dd> | |
| 1044 </dl> | |
| 1045 <a NAME="Shell.__completionListSelected" ID="Shell.__completionListSelected"></a> | |
| 1046 <h4>Shell.__completionListSelected</h4> | |
| 1047 <b>__completionListSelected</b>(<i>listId, txt</i>) | |
| 1048 | |
| 1049 <p> | |
| 1050 Private slot to handle the selection from the completion list. | |
| 1051 </p> | |
| 1052 <dl> | |
| 1053 | |
| 1054 <dt><i>listId</i></dt> | |
| 1055 <dd> | |
| 1056 the ID of the user list (should be 1) (integer) | |
| 1057 </dd> | |
| 1058 <dt><i>txt</i></dt> | |
| 1059 <dd> | |
| 1060 the selected text (string) | |
| 1061 </dd> | |
| 1062 </dl> | |
| 1063 <a NAME="Shell.__concatenateText" ID="Shell.__concatenateText"></a> | |
| 1064 <h4>Shell.__concatenateText</h4> | |
| 1065 <b>__concatenateText</b>(<i>text</i>) | |
| 1066 | |
| 1067 <p> | |
| 1068 Private slot to queue text and process it in one step. | |
| 1069 </p> | |
| 1070 <dl> | |
| 1071 | |
| 1072 <dt><i>text</i> (str)</dt> | |
| 1073 <dd> | |
| 1074 text to be appended | |
| 1075 </dd> | |
| 1076 </dl> | |
| 1077 <a NAME="Shell.__configure" ID="Shell.__configure"></a> | |
| 1078 <h4>Shell.__configure</h4> | |
| 1079 <b>__configure</b>(<i></i>) | |
| 1080 | |
| 1081 <p> | |
| 1082 Private method to open the configuration dialog. | |
| 1083 </p> | |
| 1084 <a NAME="Shell.__executeCommand" ID="Shell.__executeCommand"></a> | |
| 1085 <h4>Shell.__executeCommand</h4> | |
| 1086 <b>__executeCommand</b>(<i>cmd, historyIndex=None</i>) | |
| 1087 | |
| 1088 <p> | |
| 1089 Private slot to execute a command. | |
| 1090 </p> | |
| 1091 <dl> | |
| 1092 | |
| 1093 <dt><i>cmd</i> (str)</dt> | |
| 1094 <dd> | |
| 1095 command to be executed by debug client | |
| 1096 </dd> | |
| 1097 <dt><i>historyIndex</i> (int)</dt> | |
| 1098 <dd> | |
| 1099 history index to be set | |
| 1100 </dd> | |
| 1101 </dl> | |
| 1102 <a NAME="Shell.__find" ID="Shell.__find"></a> | |
| 1103 <h4>Shell.__find</h4> | |
| 1104 <b>__find</b>(<i></i>) | |
| 1105 | |
| 1106 <p> | |
| 1107 Private slot to show the find widget. | |
| 1108 </p> | |
| 1109 <a NAME="Shell.__flushQueuedText" ID="Shell.__flushQueuedText"></a> | |
| 1110 <h4>Shell.__flushQueuedText</h4> | |
| 1111 <b>__flushQueuedText</b>(<i></i>) | |
| 1112 | |
| 1113 <p> | |
| 1114 Private slot to flush the accumulated text output. | |
| 1115 </p> | |
| 1116 <a NAME="Shell.__getBanner" ID="Shell.__getBanner"></a> | |
| 1117 <h4>Shell.__getBanner</h4> | |
| 1118 <b>__getBanner</b>(<i></i>) | |
| 1119 | |
| 1120 <p> | |
| 1121 Private method to get the banner for the remote interpreter. | |
| 1122 </p> | |
| 1123 <p> | |
| 1124 It requests the interpreter version and platform running on the | |
| 1125 debug client side. | |
| 1126 </p> | |
| 1127 <a NAME="Shell.__getEndPos" ID="Shell.__getEndPos"></a> | |
| 1128 <h4>Shell.__getEndPos</h4> | |
| 1129 <b>__getEndPos</b>(<i></i>) | |
| 1130 | |
| 1131 <p> | |
| 1132 Private method to return the line and column of the last character. | |
| 1133 </p> | |
| 1134 <dl> | |
| 1135 <dt>Return:</dt> | |
| 1136 <dd> | |
| 1137 tuple of two values (int, int) giving the line and column | |
| 1138 </dd> | |
| 1139 </dl> | |
| 1140 <a NAME="Shell.__indentLength" ID="Shell.__indentLength"></a> | |
| 1141 <h4>Shell.__indentLength</h4> | |
| 1142 <b>__indentLength</b>(<i>line</i>) | |
| 1143 | |
| 1144 <p> | |
| 1145 Private method to determine the indentation length of the given line. | |
| 1146 </p> | |
| 1147 <dl> | |
| 1148 | |
| 1149 <dt><i>line</i> (str)</dt> | |
| 1150 <dd> | |
| 1151 line to determine the indentation length for | |
| 1152 </dd> | |
| 1153 </dl> | |
| 1154 <dl> | |
| 1155 <dt>Return:</dt> | |
| 1156 <dd> | |
| 1157 indentation length | |
| 1158 </dd> | |
| 1159 </dl> | |
| 1160 <dl> | |
| 1161 <dt>Return Type:</dt> | |
| 1162 <dd> | |
| 1163 int | |
| 1164 </dd> | |
| 1165 </dl> | |
| 1166 <a NAME="Shell.__initialise" ID="Shell.__initialise"></a> | |
| 1167 <h4>Shell.__initialise</h4> | |
| 1168 <b>__initialise</b>(<i></i>) | |
| 1169 | |
| 1170 <p> | |
| 1171 Private method to get ready for a new remote interpreter. | |
| 1172 </p> | |
| 1173 <a NAME="Shell.__insertHistory" ID="Shell.__insertHistory"></a> | |
| 1174 <h4>Shell.__insertHistory</h4> | |
| 1175 <b>__insertHistory</b>(<i>cmd</i>) | |
| 1176 | |
| 1177 <p> | |
| 1178 Private method to insert a command selected from the history. | |
| 1179 </p> | |
| 1180 <dl> | |
| 1181 | |
| 1182 <dt><i>cmd</i></dt> | |
| 1183 <dd> | |
| 1184 history entry to be inserted (string) | |
| 1185 </dd> | |
| 1186 </dl> | |
| 1187 <a NAME="Shell.__insertText" ID="Shell.__insertText"></a> | |
| 1188 <h4>Shell.__insertText</h4> | |
| 1189 <b>__insertText</b>(<i>s</i>) | |
| 1190 | |
| 1191 <p> | |
| 1192 Private method to insert some text at the current cursor position. | |
| 1193 </p> | |
| 1194 <dl> | |
| 1195 | |
| 1196 <dt><i>s</i></dt> | |
| 1197 <dd> | |
| 1198 text to be inserted (string) | |
| 1199 </dd> | |
| 1200 </dl> | |
| 1201 <a NAME="Shell.__insertTextAtEnd" ID="Shell.__insertTextAtEnd"></a> | |
| 1202 <h4>Shell.__insertTextAtEnd</h4> | |
| 1203 <b>__insertTextAtEnd</b>(<i>s</i>) | |
| 1204 | |
| 1205 <p> | |
| 1206 Private method to insert some text at the end of the command line. | |
| 1207 </p> | |
| 1208 <dl> | |
| 1209 | |
| 1210 <dt><i>s</i></dt> | |
| 1211 <dd> | |
| 1212 text to be inserted (string) | |
| 1213 </dd> | |
| 1214 </dl> | |
| 1215 <a NAME="Shell.__insertTextNoEcho" ID="Shell.__insertTextNoEcho"></a> | |
| 1216 <h4>Shell.__insertTextNoEcho</h4> | |
| 1217 <b>__insertTextNoEcho</b>(<i>s</i>) | |
| 1218 | |
| 1219 <p> | |
| 1220 Private method to insert some text at the end of the buffer without | |
| 1221 echoing it. | |
| 1222 </p> | |
| 1223 <dl> | |
| 1224 | |
| 1225 <dt><i>s</i></dt> | |
| 1226 <dd> | |
| 1227 text to be inserted (string) | |
| 1228 </dd> | |
| 1229 </dl> | |
| 1230 <a NAME="Shell.__isCursorOnLastLine" ID="Shell.__isCursorOnLastLine"></a> | |
| 1231 <h4>Shell.__isCursorOnLastLine</h4> | |
| 1232 <b>__isCursorOnLastLine</b>(<i></i>) | |
| 1233 | |
| 1234 <p> | |
| 1235 Private method to check, if the cursor is on the last line. | |
| 1236 </p> | |
| 1237 <dl> | |
| 1238 <dt>Return:</dt> | |
| 1239 <dd> | |
| 1240 flag indicating that the cursor is on the last line (boolean) | |
| 1241 </dd> | |
| 1242 </dl> | |
| 1243 <a NAME="Shell.__isHistoryIndexValid" ID="Shell.__isHistoryIndexValid"></a> | |
| 1244 <h4>Shell.__isHistoryIndexValid</h4> | |
| 1245 <b>__isHistoryIndexValid</b>(<i></i>) | |
| 1246 | |
| 1247 <p> | |
| 1248 Private method to test, if the history index is valid. | |
| 1249 </p> | |
| 1250 <dl> | |
| 1251 <dt>Return:</dt> | |
| 1252 <dd> | |
| 1253 flag indicating validity | |
| 1254 </dd> | |
| 1255 </dl> | |
| 1256 <dl> | |
| 1257 <dt>Return Type:</dt> | |
| 1258 <dd> | |
| 1259 bool | |
| 1260 </dd> | |
| 1261 </dl> | |
| 1262 <a NAME="Shell.__projectClosed" ID="Shell.__projectClosed"></a> | |
| 1263 <h4>Shell.__projectClosed</h4> | |
| 1264 <b>__projectClosed</b>(<i></i>) | |
| 1265 | |
| 1266 <p> | |
| 1267 Private slot to restart the default shell when the project is closed. | |
| 1268 </p> | |
| 1269 <a NAME="Shell.__projectOpened" ID="Shell.__projectOpened"></a> | |
| 1270 <h4>Shell.__projectOpened</h4> | |
| 1271 <b>__projectOpened</b>(<i></i>) | |
| 1272 | |
| 1273 <p> | |
| 1274 Private slot to start the shell for the opened project. | |
| 1275 </p> | |
| 1276 <a NAME="Shell.__raw_input" ID="Shell.__raw_input"></a> | |
| 1277 <h4>Shell.__raw_input</h4> | |
| 1278 <b>__raw_input</b>(<i>prompt, echo, debuggerId</i>) | |
| 1279 | |
| 1280 <p> | |
| 1281 Private method to handle raw input. | |
| 1282 </p> | |
| 1283 <dl> | |
| 1284 | |
| 1285 <dt><i>prompt</i> (str)</dt> | |
| 1286 <dd> | |
| 1287 the input prompt | |
| 1288 </dd> | |
| 1289 <dt><i>echo</i> (bool)</dt> | |
| 1290 <dd> | |
| 1291 flag indicating an echoing of the input | |
| 1292 </dd> | |
| 1293 <dt><i>debuggerId</i> (str)</dt> | |
| 1294 <dd> | |
| 1295 ID of the debugger backend | |
| 1296 </dd> | |
| 1297 </dl> | |
| 1298 <a NAME="Shell.__resetIncrementalHistorySearch" ID="Shell.__resetIncrementalHistorySearch"></a> | |
| 1299 <h4>Shell.__resetIncrementalHistorySearch</h4> | |
| 1300 <b>__resetIncrementalHistorySearch</b>(<i></i>) | |
| 1301 | |
| 1302 <p> | |
| 1303 Private method to reset the incremental history search. | |
| 1304 </p> | |
| 1305 <a NAME="Shell.__resizeLinenoMargin" ID="Shell.__resizeLinenoMargin"></a> | |
| 1306 <h4>Shell.__resizeLinenoMargin</h4> | |
| 1307 <b>__resizeLinenoMargin</b>(<i></i>) | |
| 1308 | |
| 1309 <p> | |
| 1310 Private slot to resize the line numbers margin. | |
| 1311 </p> | |
| 1312 <a NAME="Shell.__rsearchHistory" ID="Shell.__rsearchHistory"></a> | |
| 1313 <h4>Shell.__rsearchHistory</h4> | |
| 1314 <b>__rsearchHistory</b>(<i>txt, startIdx=-1</i>) | |
| 1315 | |
| 1316 <p> | |
| 1317 Private method used to reverse search the history. | |
| 1318 </p> | |
| 1319 <dl> | |
| 1320 | |
| 1321 <dt><i>txt</i> (str)</dt> | |
| 1322 <dd> | |
| 1323 text to match at the beginning | |
| 1324 </dd> | |
| 1325 <dt><i>startIdx</i> (int)</dt> | |
| 1326 <dd> | |
| 1327 index to start search from | |
| 1328 </dd> | |
| 1329 </dl> | |
| 1330 <dl> | |
| 1331 <dt>Return:</dt> | |
| 1332 <dd> | |
| 1333 tuple containing the index of found entry and a flag indicating | |
| 1334 that something was found | |
| 1335 </dd> | |
| 1336 </dl> | |
| 1337 <dl> | |
| 1338 <dt>Return Type:</dt> | |
| 1339 <dd> | |
| 1340 tuple of (int, bool) | |
| 1341 </dd> | |
| 1342 </dl> | |
| 1343 <a NAME="Shell.__searchHistory" ID="Shell.__searchHistory"></a> | |
| 1344 <h4>Shell.__searchHistory</h4> | |
| 1345 <b>__searchHistory</b>(<i>txt, startIdx=-1</i>) | |
| 1346 | |
| 1347 <p> | |
| 1348 Private method used to search the history. | |
| 1349 </p> | |
| 1350 <dl> | |
| 1351 | |
| 1352 <dt><i>txt</i> (str)</dt> | |
| 1353 <dd> | |
| 1354 text to match at the beginning | |
| 1355 </dd> | |
| 1356 <dt><i>startIdx</i> (int)</dt> | |
| 1357 <dd> | |
| 1358 index to start search from | |
| 1359 </dd> | |
| 1360 </dl> | |
| 1361 <dl> | |
| 1362 <dt>Return:</dt> | |
| 1363 <dd> | |
| 1364 tuple containing the index of found entry and a flag indicating | |
| 1365 that something was found | |
| 1366 </dd> | |
| 1367 </dl> | |
| 1368 <dl> | |
| 1369 <dt>Return Type:</dt> | |
| 1370 <dd> | |
| 1371 tuple of (int, bool) | |
| 1372 </dd> | |
| 1373 </dl> | |
| 1374 <a NAME="Shell.__searchNext" ID="Shell.__searchNext"></a> | |
| 1375 <h4>Shell.__searchNext</h4> | |
| 1376 <b>__searchNext</b>(<i></i>) | |
| 1377 | |
| 1378 <p> | |
| 1379 Private method to search for the next occurrence. | |
| 1380 </p> | |
| 1381 <a NAME="Shell.__searchPrev" ID="Shell.__searchPrev"></a> | |
| 1382 <h4>Shell.__searchPrev</h4> | |
| 1383 <b>__searchPrev</b>(<i></i>) | |
| 1384 | |
| 1385 <p> | |
| 1386 Private method to search for the next occurrence. | |
| 1387 </p> | |
| 1388 <a NAME="Shell.__setAutoCompletion" ID="Shell.__setAutoCompletion"></a> | |
| 1389 <h4>Shell.__setAutoCompletion</h4> | |
| 1390 <b>__setAutoCompletion</b>(<i>language='Python'</i>) | |
| 1391 | |
| 1392 <p> | |
| 1393 Private method to configure the autocompletion function. | |
| 1394 </p> | |
| 1395 <dl> | |
| 1396 | |
| 1397 <dt><i>language</i></dt> | |
| 1398 <dd> | |
| 1399 of the autocompletion set to set (string) | |
| 1400 </dd> | |
| 1401 </dl> | |
| 1402 <a NAME="Shell.__setCallTips" ID="Shell.__setCallTips"></a> | |
| 1403 <h4>Shell.__setCallTips</h4> | |
| 1404 <b>__setCallTips</b>(<i>language='Python'</i>) | |
| 1405 | |
| 1406 <p> | |
| 1407 Private method to configure the calltips function. | |
| 1408 </p> | |
| 1409 <dl> | |
| 1410 | |
| 1411 <dt><i>language</i></dt> | |
| 1412 <dd> | |
| 1413 of the calltips set to set (string) | |
| 1414 </dd> | |
| 1415 </dl> | |
| 1416 <a NAME="Shell.__setHistoryIndex" ID="Shell.__setHistoryIndex"></a> | |
| 1417 <h4>Shell.__setHistoryIndex</h4> | |
| 1418 <b>__setHistoryIndex</b>(<i>index=None</i>) | |
| 1419 | |
| 1420 <p> | |
| 1421 Private method to set the initial history index. | |
| 1422 </p> | |
| 1423 <dl> | |
| 1424 | |
| 1425 <dt><i>index</i> (int or None)</dt> | |
| 1426 <dd> | |
| 1427 index value to be set | |
| 1428 </dd> | |
| 1429 </dl> | |
| 1430 <a NAME="Shell.__setMargin0" ID="Shell.__setMargin0"></a> | |
| 1431 <h4>Shell.__setMargin0</h4> | |
| 1432 <b>__setMargin0</b>(<i></i>) | |
| 1433 | |
| 1434 <p> | |
| 1435 Private method to configure margin 0. | |
| 1436 </p> | |
| 1437 <a NAME="Shell.__setMonospaced" ID="Shell.__setMonospaced"></a> | |
| 1438 <h4>Shell.__setMonospaced</h4> | |
| 1439 <b>__setMonospaced</b>(<i>on</i>) | |
| 1440 | |
| 1441 <p> | |
| 1442 Private method to set/reset a monospaced font. | |
| 1443 </p> | |
| 1444 <dl> | |
| 1445 | |
| 1446 <dt><i>on</i></dt> | |
| 1447 <dd> | |
| 1448 flag to indicate usage of a monospace font (boolean) | |
| 1449 </dd> | |
| 1450 </dl> | |
| 1451 <a NAME="Shell.__setTextDisplay" ID="Shell.__setTextDisplay"></a> | |
| 1452 <h4>Shell.__setTextDisplay</h4> | |
| 1453 <b>__setTextDisplay</b>(<i></i>) | |
| 1454 | |
| 1455 <p> | |
| 1456 Private method to configure the text display. | |
| 1457 </p> | |
| 1458 <a NAME="Shell.__showCompletions" ID="Shell.__showCompletions"></a> | |
| 1459 <h4>Shell.__showCompletions</h4> | |
| 1460 <b>__showCompletions</b>(<i>completions, text</i>) | |
| 1461 | |
| 1462 <p> | |
| 1463 Private method to display the possible completions. | |
| 1464 </p> | |
| 1465 <dl> | |
| 1466 | |
| 1467 <dt><i>completions</i></dt> | |
| 1468 <dd> | |
| 1469 list of possible completions (list of strings) | |
| 1470 </dd> | |
| 1471 <dt><i>text</i></dt> | |
| 1472 <dd> | |
| 1473 text that is about to be completed (string) | |
| 1474 </dd> | |
| 1475 </dl> | |
| 1476 <a NAME="Shell.__showStartMenu" ID="Shell.__showStartMenu"></a> | |
| 1477 <h4>Shell.__showStartMenu</h4> | |
| 1478 <b>__showStartMenu</b>(<i></i>) | |
| 1479 | |
| 1480 <p> | |
| 1481 Private slot to prepare the start submenu. | |
| 1482 </p> | |
| 1483 <a NAME="Shell.__showVenvName" ID="Shell.__showVenvName"></a> | |
| 1484 <h4>Shell.__showVenvName</h4> | |
| 1485 <b>__showVenvName</b>(<i></i>) | |
| 1486 | |
| 1487 <p> | |
| 1488 Private method to show the name of the active virtual environment. | |
| 1489 </p> | |
| 1490 <a NAME="Shell.__startDebugClient" ID="Shell.__startDebugClient"></a> | |
| 1491 <h4>Shell.__startDebugClient</h4> | |
| 1492 <b>__startDebugClient</b>(<i>action</i>) | |
| 1493 | |
| 1494 <p> | |
| 1495 Private slot to start a debug client according to the action | |
| 1496 triggered. | |
| 1497 </p> | |
| 1498 <dl> | |
| 1499 | |
| 1500 <dt><i>action</i></dt> | |
| 1501 <dd> | |
| 1502 context menu action that was triggered (QAction) | |
| 1503 </dd> | |
| 1504 </dl> | |
| 1505 <a NAME="Shell.__useHistory" ID="Shell.__useHistory"></a> | |
| 1506 <h4>Shell.__useHistory</h4> | |
| 1507 <b>__useHistory</b>(<i></i>) | |
| 1508 | |
| 1509 <p> | |
| 1510 Private method to display a command from the history. | |
| 1511 </p> | |
| 1512 <a NAME="Shell.__write" ID="Shell.__write"></a> | |
| 1513 <h4>Shell.__write</h4> | |
| 1514 <b>__write</b>(<i>s</i>) | |
| 1515 | |
| 1516 <p> | |
| 1517 Private method to display some text without queuing. | |
| 1518 </p> | |
| 1519 <dl> | |
| 1520 | |
| 1521 <dt><i>s</i> (str)</dt> | |
| 1522 <dd> | |
| 1523 text to be displayed | |
| 1524 </dd> | |
| 1525 </dl> | |
| 1526 <a NAME="Shell.__writeBanner" ID="Shell.__writeBanner"></a> | |
| 1527 <h4>Shell.__writeBanner</h4> | |
| 1528 <b>__writeBanner</b>(<i>version, platform, venvName</i>) | |
| 1529 | |
| 1530 <p> | |
| 1531 Private method to write a banner with info from the debug client. | |
| 1532 </p> | |
| 1533 <dl> | |
| 1534 | |
| 1535 <dt><i>version</i> (str)</dt> | |
| 1536 <dd> | |
| 1537 interpreter version string | |
| 1538 </dd> | |
| 1539 <dt><i>platform</i> (str)</dt> | |
| 1540 <dd> | |
| 1541 platform of the remote interpreter | |
| 1542 </dd> | |
| 1543 <dt><i>venvName</i> (str)</dt> | |
| 1544 <dd> | |
| 1545 name of the virtual environment | |
| 1546 </dd> | |
| 1547 </dl> | |
| 1548 <a NAME="Shell.__writePrompt" ID="Shell.__writePrompt"></a> | |
| 1549 <h4>Shell.__writePrompt</h4> | |
| 1550 <b>__writePrompt</b>(<i></i>) | |
| 1551 | |
| 1552 <p> | |
| 1553 Private method to write the prompt using a write queue. | |
| 1554 </p> | |
| 1555 <a NAME="Shell.__writeQueued" ID="Shell.__writeQueued"></a> | |
| 1556 <h4>Shell.__writeQueued</h4> | |
| 1557 <b>__writeQueued</b>(<i>s</i>) | |
| 1558 | |
| 1559 <p> | |
| 1560 Private method to display some text using a write queue. | |
| 1561 </p> | |
| 1562 <dl> | |
| 1563 | |
| 1564 <dt><i>s</i></dt> | |
| 1565 <dd> | |
| 1566 text to be displayed (string) | |
| 1567 </dd> | |
| 1568 </dl> | |
| 1569 <a NAME="Shell.__writeStdErr" ID="Shell.__writeStdErr"></a> | |
| 1570 <h4>Shell.__writeStdErr</h4> | |
| 1571 <b>__writeStdErr</b>(<i>s</i>) | |
| 1572 | |
| 1573 <p> | |
| 1574 Private method to display some text with StdErr label. | |
| 1575 </p> | |
| 1576 <dl> | |
| 1577 | |
| 1578 <dt><i>s</i></dt> | |
| 1579 <dd> | |
| 1580 text to be displayed (string) | |
| 1581 </dd> | |
| 1582 </dl> | |
| 1583 <a NAME="Shell.__writeStdOut" ID="Shell.__writeStdOut"></a> | |
| 1584 <h4>Shell.__writeStdOut</h4> | |
| 1585 <b>__writeStdOut</b>(<i>s</i>) | |
| 1586 | |
| 1587 <p> | |
| 1588 Private method to display some text with StdOut label. | |
| 1589 </p> | |
| 1590 <dl> | |
| 1591 | |
| 1592 <dt><i>s</i></dt> | |
| 1593 <dd> | |
| 1594 text to be displayed (string) | |
| 1595 </dd> | |
| 1596 </dl> | |
| 1597 <a NAME="Shell.clear" ID="Shell.clear"></a> | |
| 1598 <h4>Shell.clear</h4> | |
| 1599 <b>clear</b>(<i></i>) | |
| 1600 | |
| 1601 <p> | |
| 1602 Public slot to clear the display. | |
| 1603 </p> | |
| 1604 <a NAME="Shell.clearAllHistories" ID="Shell.clearAllHistories"></a> | |
| 1605 <h4>Shell.clearAllHistories</h4> | |
| 1606 <b>clearAllHistories</b>(<i></i>) | |
| 1607 | |
| 1608 <p> | |
| 1609 Public method to clear all available histories and sync them. | |
| 1610 </p> | |
| 1611 <a NAME="Shell.clearHistory" ID="Shell.clearHistory"></a> | |
| 1612 <h4>Shell.clearHistory</h4> | |
| 1613 <b>clearHistory</b>(<i></i>) | |
| 1614 | |
| 1615 <p> | |
| 1616 Public slot to clear the current history. | |
| 1617 </p> | |
| 1618 <a NAME="Shell.closeShell" ID="Shell.closeShell"></a> | |
| 1619 <h4>Shell.closeShell</h4> | |
| 1620 <b>closeShell</b>(<i></i>) | |
| 1621 | |
| 1622 <p> | |
| 1623 Public method to shutdown the shell. | |
| 1624 </p> | |
| 1625 <a NAME="Shell.contextMenuEvent" ID="Shell.contextMenuEvent"></a> | |
| 1626 <h4>Shell.contextMenuEvent</h4> | |
| 1627 <b>contextMenuEvent</b>(<i>ev</i>) | |
| 1628 | |
| 1629 <p> | |
| 1630 Protected method to show our own context menu. | |
| 1631 </p> | |
| 1632 <dl> | |
| 1633 | |
| 1634 <dt><i>ev</i></dt> | |
| 1635 <dd> | |
| 1636 context menu event (QContextMenuEvent) | |
| 1637 </dd> | |
| 1638 </dl> | |
| 1639 <a NAME="Shell.doClearRestart" ID="Shell.doClearRestart"></a> | |
| 1640 <h4>Shell.doClearRestart</h4> | |
| 1641 <b>doClearRestart</b>(<i></i>) | |
| 1642 | |
| 1643 <p> | |
| 1644 Public slot to handle the 'restart and clear' context menu entry. | |
| 1645 </p> | |
| 1646 <a NAME="Shell.doRestart" ID="Shell.doRestart"></a> | |
| 1647 <h4>Shell.doRestart</h4> | |
| 1648 <b>doRestart</b>(<i></i>) | |
| 1649 | |
| 1650 <p> | |
| 1651 Public slot to handle the 'restart' context menu entry. | |
| 1652 </p> | |
| 1653 <a NAME="Shell.dragEnterEvent" ID="Shell.dragEnterEvent"></a> | |
| 1654 <h4>Shell.dragEnterEvent</h4> | |
| 1655 <b>dragEnterEvent</b>(<i>event</i>) | |
| 1656 | |
| 1657 <p> | |
| 1658 Protected method to handle the drag enter event. | |
| 1659 </p> | |
| 1660 <dl> | |
| 1661 | |
| 1662 <dt><i>event</i></dt> | |
| 1663 <dd> | |
| 1664 the drag enter event (QDragEnterEvent) | |
| 1665 </dd> | |
| 1666 </dl> | |
| 1667 <a NAME="Shell.dragLeaveEvent" ID="Shell.dragLeaveEvent"></a> | |
| 1668 <h4>Shell.dragLeaveEvent</h4> | |
| 1669 <b>dragLeaveEvent</b>(<i>event</i>) | |
| 1670 | |
| 1671 <p> | |
| 1672 Protected method to handle the drag leave event. | |
| 1673 </p> | |
| 1674 <dl> | |
| 1675 | |
| 1676 <dt><i>event</i></dt> | |
| 1677 <dd> | |
| 1678 the drag leave event (QDragLeaveEvent) | |
| 1679 </dd> | |
| 1680 </dl> | |
| 1681 <a NAME="Shell.dragMoveEvent" ID="Shell.dragMoveEvent"></a> | |
| 1682 <h4>Shell.dragMoveEvent</h4> | |
| 1683 <b>dragMoveEvent</b>(<i>event</i>) | |
| 1684 | |
| 1685 <p> | |
| 1686 Protected method to handle the drag move event. | |
| 1687 </p> | |
| 1688 <dl> | |
| 1689 | |
| 1690 <dt><i>event</i></dt> | |
| 1691 <dd> | |
| 1692 the drag move event (QDragMoveEvent) | |
| 1693 </dd> | |
| 1694 </dl> | |
| 1695 <a NAME="Shell.dropEvent" ID="Shell.dropEvent"></a> | |
| 1696 <h4>Shell.dropEvent</h4> | |
| 1697 <b>dropEvent</b>(<i>event</i>) | |
| 1698 | |
| 1699 <p> | |
| 1700 Protected method to handle the drop event. | |
| 1701 </p> | |
| 1702 <dl> | |
| 1703 | |
| 1704 <dt><i>event</i></dt> | |
| 1705 <dd> | |
| 1706 the drop event (QDropEvent) | |
| 1707 </dd> | |
| 1708 </dl> | |
| 1709 <a NAME="Shell.editorCommand" ID="Shell.editorCommand"></a> | |
| 1710 <h4>Shell.editorCommand</h4> | |
| 1711 <b>editorCommand</b>(<i>cmd</i>) | |
| 1712 | |
| 1713 <p> | |
| 1714 Public method to perform an editor command. | |
| 1715 </p> | |
| 1716 <dl> | |
| 1717 | |
| 1718 <dt><i>cmd</i></dt> | |
| 1719 <dd> | |
| 1720 the scintilla command to be performed | |
| 1721 </dd> | |
| 1722 </dl> | |
| 1723 <a NAME="Shell.event" ID="Shell.event"></a> | |
| 1724 <h4>Shell.event</h4> | |
| 1725 <b>event</b>(<i>evt</i>) | |
| 1726 | |
| 1727 <p> | |
| 1728 Public method handling events. | |
| 1729 </p> | |
| 1730 <dl> | |
| 1731 | |
| 1732 <dt><i>evt</i></dt> | |
| 1733 <dd> | |
| 1734 reference to the event (QEvent) | |
| 1735 </dd> | |
| 1736 </dl> | |
| 1737 <dl> | |
| 1738 <dt>Return:</dt> | |
| 1739 <dd> | |
| 1740 flag indicating, if the event was handled (boolean) | |
| 1741 </dd> | |
| 1742 </dl> | |
| 1743 <a NAME="Shell.executeLines" ID="Shell.executeLines"></a> | |
| 1744 <h4>Shell.executeLines</h4> | |
| 1745 <b>executeLines</b>(<i>lines, historyIndex=None</i>) | |
| 1746 | |
| 1747 <p> | |
| 1748 Public method to execute a set of lines as multiple commands. | |
| 1749 </p> | |
| 1750 <dl> | |
| 1751 | |
| 1752 <dt><i>lines</i> (str)</dt> | |
| 1753 <dd> | |
| 1754 multiple lines of text to be executed as | |
| 1755 single commands | |
| 1756 </dd> | |
| 1757 <dt><i>historyIndex</i> (int)</dt> | |
| 1758 <dd> | |
| 1759 history index to be set | |
| 1760 </dd> | |
| 1761 </dl> | |
| 1762 <a NAME="Shell.focusInEvent" ID="Shell.focusInEvent"></a> | |
| 1763 <h4>Shell.focusInEvent</h4> | |
| 1764 <b>focusInEvent</b>(<i>event</i>) | |
| 1765 | |
| 1766 <p> | |
| 1767 Protected method called when the shell receives focus. | |
| 1768 </p> | |
| 1769 <dl> | |
| 1770 | |
| 1771 <dt><i>event</i></dt> | |
| 1772 <dd> | |
| 1773 the event object (QFocusEvent) | |
| 1774 </dd> | |
| 1775 </dl> | |
| 1776 <a NAME="Shell.focusNextPrevChild" ID="Shell.focusNextPrevChild"></a> | |
| 1777 <h4>Shell.focusNextPrevChild</h4> | |
| 1778 <b>focusNextPrevChild</b>(<i>nextChild</i>) | |
| 1779 | |
| 1780 <p> | |
| 1781 Public method to stop Tab moving to the next window. | |
| 1782 </p> | |
| 1783 <p> | |
| 1784 While the user is entering a multi-line command, the movement to | |
| 1785 the next window by the Tab key being pressed is suppressed. | |
| 1786 </p> | |
| 1787 <dl> | |
| 1788 | |
| 1789 <dt><i>nextChild</i></dt> | |
| 1790 <dd> | |
| 1791 next window | |
| 1792 </dd> | |
| 1793 </dl> | |
| 1794 <dl> | |
| 1795 <dt>Return:</dt> | |
| 1796 <dd> | |
| 1797 flag indicating the movement | |
| 1798 </dd> | |
| 1799 </dl> | |
| 1800 <a NAME="Shell.focusOutEvent" ID="Shell.focusOutEvent"></a> | |
| 1801 <h4>Shell.focusOutEvent</h4> | |
| 1802 <b>focusOutEvent</b>(<i>event</i>) | |
| 1803 | |
| 1804 <p> | |
| 1805 Protected method called when the shell loses focus. | |
| 1806 </p> | |
| 1807 <dl> | |
| 1808 | |
| 1809 <dt><i>event</i></dt> | |
| 1810 <dd> | |
| 1811 the event object (QFocusEvent) | |
| 1812 </dd> | |
| 1813 </dl> | |
| 1814 <a NAME="Shell.gestureEvent" ID="Shell.gestureEvent"></a> | |
| 1815 <h4>Shell.gestureEvent</h4> | |
| 1816 <b>gestureEvent</b>(<i>evt</i>) | |
| 1817 | |
| 1818 <p> | |
| 1819 Protected method handling gesture events. | |
| 1820 </p> | |
| 1821 <dl> | |
| 1822 | |
| 1823 <dt><i>evt</i></dt> | |
| 1824 <dd> | |
| 1825 reference to the gesture event (QGestureEvent | |
| 1826 </dd> | |
| 1827 </dl> | |
| 1828 <a NAME="Shell.getClientType" ID="Shell.getClientType"></a> | |
| 1829 <h4>Shell.getClientType</h4> | |
| 1830 <b>getClientType</b>(<i></i>) | |
| 1831 | |
| 1832 <p> | |
| 1833 Public slot to get the clients type. | |
| 1834 </p> | |
| 1835 <dl> | |
| 1836 <dt>Return:</dt> | |
| 1837 <dd> | |
| 1838 client type (string) | |
| 1839 </dd> | |
| 1840 </dl> | |
| 1841 <a NAME="Shell.getHistory" ID="Shell.getHistory"></a> | |
| 1842 <h4>Shell.getHistory</h4> | |
| 1843 <b>getHistory</b>(<i>clientType</i>) | |
| 1844 | |
| 1845 <p> | |
| 1846 Public method to get the history for the given client type. | |
| 1847 </p> | |
| 1848 <dl> | |
| 1849 | |
| 1850 <dt><i>clientType</i></dt> | |
| 1851 <dd> | |
| 1852 type of the debug client (string). | |
| 1853 If it is None, the current history is returned. | |
| 1854 </dd> | |
| 1855 </dl> | |
| 1856 <dl> | |
| 1857 <dt>Return:</dt> | |
| 1858 <dd> | |
| 1859 reference to the history list (list of strings) | |
| 1860 </dd> | |
| 1861 </dl> | |
| 1862 <a NAME="Shell.getHistoryIndex" ID="Shell.getHistoryIndex"></a> | |
| 1863 <h4>Shell.getHistoryIndex</h4> | |
| 1864 <b>getHistoryIndex</b>(<i></i>) | |
| 1865 | |
| 1866 <p> | |
| 1867 Public method to get the current value of the history index. | |
| 1868 </p> | |
| 1869 <dl> | |
| 1870 <dt>Return:</dt> | |
| 1871 <dd> | |
| 1872 history index | |
| 1873 </dd> | |
| 1874 </dl> | |
| 1875 <dl> | |
| 1876 <dt>Return Type:</dt> | |
| 1877 <dd> | |
| 1878 int | |
| 1879 </dd> | |
| 1880 </dl> | |
| 1881 <a NAME="Shell.handlePreferencesChanged" ID="Shell.handlePreferencesChanged"></a> | |
| 1882 <h4>Shell.handlePreferencesChanged</h4> | |
| 1883 <b>handlePreferencesChanged</b>(<i></i>) | |
| 1884 | |
| 1885 <p> | |
| 1886 Public slot to handle the preferencesChanged signal. | |
| 1887 </p> | |
| 1888 <a NAME="Shell.historyStyle" ID="Shell.historyStyle"></a> | |
| 1889 <h4>Shell.historyStyle</h4> | |
| 1890 <b>historyStyle</b>(<i></i>) | |
| 1891 | |
| 1892 <p> | |
| 1893 Public method to get the shell history style. | |
| 1894 </p> | |
| 1895 <dl> | |
| 1896 <dt>Return:</dt> | |
| 1897 <dd> | |
| 1898 shell history style | |
| 1899 </dd> | |
| 1900 </dl> | |
| 1901 <dl> | |
| 1902 <dt>Return Type:</dt> | |
| 1903 <dd> | |
| 1904 ShellHistoryStyle | |
| 1905 </dd> | |
| 1906 </dl> | |
| 1907 <a NAME="Shell.insert" ID="Shell.insert"></a> | |
| 1908 <h4>Shell.insert</h4> | |
| 1909 <b>insert</b>(<i>txt</i>) | |
| 1910 | |
| 1911 <p> | |
| 1912 Public slot to insert text at the current cursor position. | |
| 1913 </p> | |
| 1914 <p> | |
| 1915 The cursor is advanced to the end of the inserted text. | |
| 1916 </p> | |
| 1917 <dl> | |
| 1918 | |
| 1919 <dt><i>txt</i></dt> | |
| 1920 <dd> | |
| 1921 text to be inserted (string) | |
| 1922 </dd> | |
| 1923 </dl> | |
| 1924 <a NAME="Shell.isHistoryEnabled" ID="Shell.isHistoryEnabled"></a> | |
| 1925 <h4>Shell.isHistoryEnabled</h4> | |
| 1926 <b>isHistoryEnabled</b>(<i></i>) | |
| 1927 | |
| 1928 <p> | |
| 1929 Public method to check, if the history is enabled. | |
| 1930 </p> | |
| 1931 <dl> | |
| 1932 <dt>Return:</dt> | |
| 1933 <dd> | |
| 1934 flag indicating if history is enabled | |
| 1935 </dd> | |
| 1936 </dl> | |
| 1937 <dl> | |
| 1938 <dt>Return Type:</dt> | |
| 1939 <dd> | |
| 1940 bool | |
| 1941 </dd> | |
| 1942 </dl> | |
| 1943 <a NAME="Shell.keyPressEvent" ID="Shell.keyPressEvent"></a> | |
| 1944 <h4>Shell.keyPressEvent</h4> | |
| 1945 <b>keyPressEvent</b>(<i>ev</i>) | |
| 1946 | |
| 1947 <p> | |
| 1948 Protected method to handle the user input a key at a time. | |
| 1949 </p> | |
| 1950 <dl> | |
| 1951 | |
| 1952 <dt><i>ev</i></dt> | |
| 1953 <dd> | |
| 1954 key event (QKeyEvent) | |
| 1955 </dd> | |
| 1956 </dl> | |
| 1957 <a NAME="Shell.loadHistory" ID="Shell.loadHistory"></a> | |
| 1958 <h4>Shell.loadHistory</h4> | |
| 1959 <b>loadHistory</b>(<i>clientType</i>) | |
| 1960 | |
| 1961 <p> | |
| 1962 Public method to load the history for the given client type. | |
| 1963 </p> | |
| 1964 <dl> | |
| 1965 | |
| 1966 <dt><i>clientType</i></dt> | |
| 1967 <dd> | |
| 1968 type of the debug client (string) | |
| 1969 </dd> | |
| 1970 </dl> | |
| 1971 <a NAME="Shell.mousePressEvent" ID="Shell.mousePressEvent"></a> | |
| 1972 <h4>Shell.mousePressEvent</h4> | |
| 1973 <b>mousePressEvent</b>(<i>event</i>) | |
| 1974 | |
| 1975 <p> | |
| 1976 Protected method to handle the mouse press event. | |
| 1977 </p> | |
| 1978 <dl> | |
| 1979 | |
| 1980 <dt><i>event</i></dt> | |
| 1981 <dd> | |
| 1982 the mouse press event (QMouseEvent) | |
| 1983 </dd> | |
| 1984 </dl> | |
| 1985 <a NAME="Shell.paste" ID="Shell.paste"></a> | |
| 1986 <h4>Shell.paste</h4> | |
| 1987 <b>paste</b>(<i>lines=None</i>) | |
| 1988 | |
| 1989 <p> | |
| 1990 Public slot to handle the paste action. | |
| 1991 </p> | |
| 1992 <dl> | |
| 1993 | |
| 1994 <dt><i>lines</i> (list of str)</dt> | |
| 1995 <dd> | |
| 1996 list of lines to be inserted | |
| 1997 </dd> | |
| 1998 </dl> | |
| 1999 <a NAME="Shell.registerDebuggerIdMethod" ID="Shell.registerDebuggerIdMethod"></a> | |
| 2000 <h4>Shell.registerDebuggerIdMethod</h4> | |
| 2001 <b>registerDebuggerIdMethod</b>(<i>method</i>) | |
| 2002 | |
| 2003 <p> | |
| 2004 Public method to register a method to get the debugger ID to send data | |
| 2005 to. | |
| 2006 </p> | |
| 2007 <dl> | |
| 2008 | |
| 2009 <dt><i>method</i> (function)</dt> | |
| 2010 <dd> | |
| 2011 reference to the method | |
| 2012 </dd> | |
| 2013 </dl> | |
| 2014 <a NAME="Shell.reloadHistory" ID="Shell.reloadHistory"></a> | |
| 2015 <h4>Shell.reloadHistory</h4> | |
| 2016 <b>reloadHistory</b>(<i></i>) | |
| 2017 | |
| 2018 <p> | |
| 2019 Public method to reload the history of the currently selected client | |
| 2020 type. | |
| 2021 </p> | |
| 2022 <a NAME="Shell.saveContents" ID="Shell.saveContents"></a> | |
| 2023 <h4>Shell.saveContents</h4> | |
| 2024 <b>saveContents</b>(<i></i>) | |
| 2025 | |
| 2026 <p> | |
| 2027 Public method to save the current contents to a file. | |
| 2028 </p> | |
| 2029 <a NAME="Shell.saveHistory" ID="Shell.saveHistory"></a> | |
| 2030 <h4>Shell.saveHistory</h4> | |
| 2031 <b>saveHistory</b>(<i>clientType</i>) | |
| 2032 | |
| 2033 <p> | |
| 2034 Public method to save the history for the given client type. | |
| 2035 </p> | |
| 2036 <dl> | |
| 2037 | |
| 2038 <dt><i>clientType</i></dt> | |
| 2039 <dd> | |
| 2040 type of the debug client (string) | |
| 2041 </dd> | |
| 2042 </dl> | |
| 2043 <a NAME="Shell.searchNext" ID="Shell.searchNext"></a> | |
| 2044 <h4>Shell.searchNext</h4> | |
| 2045 <b>searchNext</b>(<i>txt, caseSensitive, wholeWord, regexp</i>) | |
| 2046 | |
| 2047 <p> | |
| 2048 Public method to search the next occurrence of the given text. | |
| 2049 </p> | |
| 2050 <dl> | |
| 2051 | |
| 2052 <dt><i>txt</i> (str)</dt> | |
| 2053 <dd> | |
| 2054 text to search for | |
| 2055 </dd> | |
| 2056 <dt><i>caseSensitive</i> (bool)</dt> | |
| 2057 <dd> | |
| 2058 flag indicating to perform a case sensitive | |
| 2059 search | |
| 2060 </dd> | |
| 2061 <dt><i>wholeWord</i> (bool)</dt> | |
| 2062 <dd> | |
| 2063 flag indicating to search for whole words | |
| 2064 only | |
| 2065 </dd> | |
| 2066 <dt><i>regexp</i> (bool)</dt> | |
| 2067 <dd> | |
| 2068 flag indicating a regular expression search | |
| 2069 </dd> | |
| 2070 </dl> | |
| 2071 <a NAME="Shell.searchPrev" ID="Shell.searchPrev"></a> | |
| 2072 <h4>Shell.searchPrev</h4> | |
| 2073 <b>searchPrev</b>(<i>txt, caseSensitive, wholeWord, regexp</i>) | |
| 2074 | |
| 2075 <p> | |
| 2076 Public method to search the previous occurrence of the given text. | |
| 2077 </p> | |
| 2078 <dl> | |
| 2079 | |
| 2080 <dt><i>txt</i> (str)</dt> | |
| 2081 <dd> | |
| 2082 text to search for | |
| 2083 </dd> | |
| 2084 <dt><i>caseSensitive</i> (bool)</dt> | |
| 2085 <dd> | |
| 2086 flag indicating to perform a case sensitive | |
| 2087 search | |
| 2088 </dd> | |
| 2089 <dt><i>wholeWord</i> (bool)</dt> | |
| 2090 <dd> | |
| 2091 flag indicating to search for whole words | |
| 2092 only | |
| 2093 </dd> | |
| 2094 <dt><i>regexp</i> (bool)</dt> | |
| 2095 <dd> | |
| 2096 flag indicating a regular expression search | |
| 2097 </dd> | |
| 2098 </dl> | |
| 2099 <a NAME="Shell.selectHistory" ID="Shell.selectHistory"></a> | |
| 2100 <h4>Shell.selectHistory</h4> | |
| 2101 <b>selectHistory</b>(<i></i>) | |
| 2102 | |
| 2103 <p> | |
| 2104 Public slot to select a history entry to execute. | |
| 2105 </p> | |
| 2106 <a NAME="Shell.setDebuggerUI" ID="Shell.setDebuggerUI"></a> | |
| 2107 <h4>Shell.setDebuggerUI</h4> | |
| 2108 <b>setDebuggerUI</b>(<i>ui</i>) | |
| 2109 | |
| 2110 <p> | |
| 2111 Public method to set the debugger UI. | |
| 2112 </p> | |
| 2113 <dl> | |
| 2114 | |
| 2115 <dt><i>ui</i></dt> | |
| 2116 <dd> | |
| 2117 reference to the debugger UI object (DebugUI) | |
| 2118 </dd> | |
| 2119 </dl> | |
| 2120 <a NAME="Shell.showHistory" ID="Shell.showHistory"></a> | |
| 2121 <h4>Shell.showHistory</h4> | |
| 2122 <b>showHistory</b>(<i></i>) | |
| 2123 | |
| 2124 <p> | |
| 2125 Public slot to show the shell history dialog. | |
| 2126 </p> | |
| 2127 <a NAME="Shell.wheelEvent" ID="Shell.wheelEvent"></a> | |
| 2128 <h4>Shell.wheelEvent</h4> | |
| 2129 <b>wheelEvent</b>(<i>evt</i>) | |
| 2130 | |
| 2131 <p> | |
| 2132 Protected method to handle wheel events. | |
| 2133 </p> | |
| 2134 <dl> | |
| 2135 | |
| 2136 <dt><i>evt</i></dt> | |
| 2137 <dd> | |
| 2138 reference to the wheel event (QWheelEvent) | |
| 2139 </dd> | |
| 2140 </dl> | |
| 2141 <div align="right"><a href="#top">Up</a></div> | |
| 2142 <hr /> | |
| 2143 <hr /> | |
| 2144 <a NAME="ShellAssembly" ID="ShellAssembly"></a> | |
| 2145 <h2>ShellAssembly</h2> | |
| 2146 | |
| 2147 <p> | |
| 2148 Class implementing the containing widget for the shell. | |
| 2149 </p> | |
| 2150 <h3>Derived from</h3> | |
| 2151 QWidget | |
| 2152 <h3>Class Attributes</h3> | |
| 2153 | |
| 2154 <table> | |
| 2155 <tr><td>None</td></tr> | |
| 2156 </table> | |
| 2157 <h3>Class Methods</h3> | |
| 2158 | |
| 2159 <table> | |
| 2160 <tr><td>None</td></tr> | |
| 2161 </table> | |
| 2162 <h3>Methods</h3> | |
| 2163 | |
| 2164 <table> | |
| 2165 | |
| 2166 <tr> | |
| 2167 <td><a href="#ShellAssembly.__init__">ShellAssembly</a></td> | |
| 2168 <td>Constructor</td> | |
| 2169 </tr> | |
| 2170 <tr> | |
| 2171 <td><a href="#ShellAssembly.shell">shell</a></td> | |
| 2172 <td>Public method to get a reference to the shell widget.</td> | |
| 2173 </tr> | |
| 2174 <tr> | |
| 2175 <td><a href="#ShellAssembly.showFind">showFind</a></td> | |
| 2176 <td>Public method to display the search widget.</td> | |
| 2177 </tr> | |
| 2178 </table> | |
| 2179 <h3>Static Methods</h3> | |
| 2180 | |
| 2181 <table> | |
| 2182 <tr><td>None</td></tr> | |
| 2183 </table> | |
| 2184 | |
| 2185 <a NAME="ShellAssembly.__init__" ID="ShellAssembly.__init__"></a> | |
| 2186 <h4>ShellAssembly (Constructor)</h4> | |
| 2187 <b>ShellAssembly</b>(<i>dbs, vm, project, horizontal=True, parent=None</i>) | |
| 2188 | |
| 2189 <p> | |
| 2190 Constructor | |
| 2191 </p> | |
| 2192 <dl> | |
| 2193 | |
| 2194 <dt><i>dbs</i> (DebugServer)</dt> | |
| 2195 <dd> | |
| 2196 reference to the debug server object | |
| 2197 </dd> | |
| 2198 <dt><i>vm</i> (ViewManager)</dt> | |
| 2199 <dd> | |
| 2200 reference to the viewmanager object | |
| 2201 </dd> | |
| 2202 <dt><i>project</i> (Project)</dt> | |
| 2203 <dd> | |
| 2204 reference to the project object | |
| 2205 </dd> | |
| 2206 <dt><i>horizontal</i> (bool)</dt> | |
| 2207 <dd> | |
| 2208 flag indicating a horizontal layout | |
| 2209 </dd> | |
| 2210 <dt><i>parent</i> (QWidget)</dt> | |
| 2211 <dd> | |
| 2212 parent widget | |
| 2213 </dd> | |
| 2214 </dl> | |
| 2215 <a NAME="ShellAssembly.shell" ID="ShellAssembly.shell"></a> | |
| 2216 <h4>ShellAssembly.shell</h4> | |
| 2217 <b>shell</b>(<i></i>) | |
| 2218 | |
| 2219 <p> | |
| 2220 Public method to get a reference to the shell widget. | |
| 2221 </p> | |
| 2222 <dl> | |
| 2223 <dt>Return:</dt> | |
| 2224 <dd> | |
| 2225 reference to the shell widget (Shell) | |
| 2226 </dd> | |
| 2227 </dl> | |
| 2228 <a NAME="ShellAssembly.showFind" ID="ShellAssembly.showFind"></a> | |
| 2229 <h4>ShellAssembly.showFind</h4> | |
| 2230 <b>showFind</b>(<i>txt=""</i>) | |
| 2231 | |
| 2232 <p> | |
| 2233 Public method to display the search widget. | |
| 2234 </p> | |
| 2235 <dl> | |
| 2236 | |
| 2237 <dt><i>txt</i></dt> | |
| 2238 <dd> | |
| 2239 text to be shown in the combo (string) | |
| 2240 </dd> | |
| 2241 </dl> | |
| 2242 <div align="right"><a href="#top">Up</a></div> | |
| 2243 <hr /> | |
| 2244 <hr /> | |
| 2245 <a NAME="ShellHistoryStyle" ID="ShellHistoryStyle"></a> | |
| 2246 <h2>ShellHistoryStyle</h2> | |
| 2247 | |
| 2248 <p> | |
| 2249 Class defining the shell history styles. | |
| 2250 </p> | |
| 2251 <h3>Derived from</h3> | |
| 2252 enum.Enum | |
| 2253 <h3>Class Attributes</h3> | |
| 2254 | |
| 2255 <table> | |
| 2256 <tr><td>DISABLED</td></tr><tr><td>LINUXSTYLE</td></tr><tr><td>WINDOWSSTYLE</td></tr> | |
| 2257 </table> | |
| 2258 <h3>Class Methods</h3> | |
| 2259 | |
| 2260 <table> | |
| 2261 <tr><td>None</td></tr> | |
| 2262 </table> | |
| 2263 <h3>Methods</h3> | |
| 2264 | |
| 2265 <table> | |
| 2266 <tr><td>None</td></tr> | |
| 2267 </table> | |
| 2268 <h3>Static Methods</h3> | |
| 2269 | |
| 2270 <table> | |
| 2271 <tr><td>None</td></tr> | |
| 2272 </table> | |
| 2273 | |
| 2274 <div align="right"><a href="#top">Up</a></div> | |
| 2275 <hr /> | |
| 2276 </body></html> |
