Mercurial Repositories > eric / file revision
Documentation/Source/eric5.QScintilla.Shell.html@b88a0e6268bd
Documentation/Source/eric5.QScintilla.Shell.html
Wed, 06 Jan 2010 18:14:15 +0000
- author
- Detlev Offenbach <detlev@die-offenbachs.de>
- date
- Wed, 06 Jan 2010 18:14:15 +0000
- changeset 21
- b88a0e6268bd
- parent 17
- edde1fe80b3e
- child 58
- 37f0444c3479
- permissions
- -rw-r--r--
Fixed a bug in eric5-doc.py and regenerated docu.
<?xml version="1.0" encoding="utf-8"?> <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> <html><head> <title>eric5.QScintilla.Shell</title> <style> body { background:white; margin: 0em 1em 10em 1em; color: black; } h1 { color: white; background: #4FA4FF; } h2 { color: white; background: #4FA4FF; } h3 { color: white; background: #00557F; } h4 { color: white; background: #00557F; } a { color: #AA5500; } </style> </head> <body><a NAME="top" ID="top"></a> <h1>eric5.QScintilla.Shell</h1> <p> Module implementing a graphical Python shell. </p> <h3>Global Attributes</h3> <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> <table> <tr> <td><a href="#Shell">Shell</a></td> <td>Class implementing a graphical Python shell.</td> </tr> </table> <h3>Functions</h3> <table> <tr><td>None</td></tr> </table> <hr /><hr /> <a NAME="Shell" ID="Shell"></a> <h2>Shell</h2> <p> Class implementing a graphical Python shell. </p><p> A user can enter commands that are executed in the remote Python interpreter. </p> <h3>Derived from</h3> QsciScintillaCompat <h3>Class Attributes</h3> <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> <table> <tr> <td><a href="#Shell.__init__">Shell</a></td> <td>Constructor</td> </tr><tr> <td><a href="#Shell.__QScintillaAutoCompletionCommand">__QScintillaAutoCompletionCommand</a></td> <td>Private method to handle a command for autocompletion only.</td> </tr><tr> <td><a href="#Shell.__QScintillaCharLeft">__QScintillaCharLeft</a></td> <td>Private method to handle the Cursor Left command.</td> </tr><tr> <td><a href="#Shell.__QScintillaCharLeftExtend">__QScintillaCharLeftExtend</a></td> <td>Private method to handle the Extend Selection Left command.</td> </tr><tr> <td><a href="#Shell.__QScintillaCharRight">__QScintillaCharRight</a></td> <td>Private method to handle the Cursor Right command.</td> </tr><tr> <td><a href="#Shell.__QScintillaDelete">__QScintillaDelete</a></td> <td>Private method to handle the delete command.</td> </tr><tr> <td><a href="#Shell.__QScintillaDeleteBack">__QScintillaDeleteBack</a></td> <td>Private method to handle the Backspace key.</td> </tr><tr> <td><a href="#Shell.__QScintillaDeleteLineLeft">__QScintillaDeleteLineLeft</a></td> <td>Private method to handle the Delete Line Left command.</td> </tr><tr> <td><a href="#Shell.__QScintillaDeleteLineRight">__QScintillaDeleteLineRight</a></td> <td>Private method to handle the Delete Line Right command.</td> </tr><tr> <td><a href="#Shell.__QScintillaDeleteWordLeft">__QScintillaDeleteWordLeft</a></td> <td>Private method to handle the Delete Word Left command.</td> </tr><tr> <td><a href="#Shell.__QScintillaDeleteWordRight">__QScintillaDeleteWordRight</a></td> <td>Private method to handle the Delete Word Right command.</td> </tr><tr> <td><a href="#Shell.__QScintillaLeftCommand">__QScintillaLeftCommand</a></td> <td>Private method to handle a QScintilla command working to the left.</td> </tr><tr> <td><a href="#Shell.__QScintillaLeftDeleteCommand">__QScintillaLeftDeleteCommand</a></td> <td>Private method to handle a QScintilla delete command working to the left.</td> </tr><tr> <td><a href="#Shell.__QScintillaLineDown">__QScintillaLineDown</a></td> <td>Private method to handle the Down key.</td> </tr><tr> <td><a href="#Shell.__QScintillaLineEnd">__QScintillaLineEnd</a></td> <td>Private method to handle the End key.</td> </tr><tr> <td><a href="#Shell.__QScintillaLineUp">__QScintillaLineUp</a></td> <td>Private method to handle the Up key.</td> </tr><tr> <td><a href="#Shell.__QScintillaNewline">__QScintillaNewline</a></td> <td>Private method to handle the Return key.</td> </tr><tr> <td><a href="#Shell.__QScintillaRightCommand">__QScintillaRightCommand</a></td> <td>Private method to handle a QScintilla command working to the right.</td> </tr><tr> <td><a href="#Shell.__QScintillaTab">__QScintillaTab</a></td> <td>Private method to handle the Tab key.</td> </tr><tr> <td><a href="#Shell.__QScintillaVCHome">__QScintillaVCHome</a></td> <td>Private method to handle the Home key.</td> </tr><tr> <td><a href="#Shell.__QScintillaVCHomeExtend">__QScintillaVCHomeExtend</a></td> <td>Private method to handle the Extend Selection to start of line command.</td> </tr><tr> <td><a href="#Shell.__QScintillaWordLeft">__QScintillaWordLeft</a></td> <td>Private method to handle the Cursor Word Left command.</td> </tr><tr> <td><a href="#Shell.__QScintillaWordLeftExtend">__QScintillaWordLeftExtend</a></td> <td>Private method to handle the Extend Selection Left one word command.</td> </tr><tr> <td><a href="#Shell.__QScintillaWordRight">__QScintillaWordRight</a></td> <td>Private method to handle the Cursor Word Right command.</td> </tr><tr> <td><a href="#Shell.__bindLexer">__bindLexer</a></td> <td>Private slot to set the lexer.</td> </tr><tr> <td><a href="#Shell.__clearCurrentLine">__clearCurrentLine</a></td> <td>Private method to clear the line containing the cursor.</td> </tr><tr> <td><a href="#Shell.__clearHistory">__clearHistory</a></td> <td>Private slot to clear the current history.</td> </tr><tr> <td><a href="#Shell.__clientCapabilities">__clientCapabilities</a></td> <td>Private slot to handle the reporting of the clients capabilities.</td> </tr><tr> <td><a href="#Shell.__clientError">__clientError</a></td> <td>Private method to handle an error in the client.</td> </tr><tr> <td><a href="#Shell.__clientStatement">__clientStatement</a></td> <td>Private method to handle the response from the debugger client.</td> </tr><tr> <td><a href="#Shell.__completionListSelected">__completionListSelected</a></td> <td>Private slot to handle the selection from the completion list.</td> </tr><tr> <td><a href="#Shell.__configure">__configure</a></td> <td>Private method to open the configuration dialog.</td> </tr><tr> <td><a href="#Shell.__executeCommand">__executeCommand</a></td> <td>Private slot to execute a command.</td> </tr><tr> <td><a href="#Shell.__getBanner">__getBanner</a></td> <td>Private method to get the banner for the remote interpreter.</td> </tr><tr> <td><a href="#Shell.__getEndPos">__getEndPos</a></td> <td>Private method to return the line and column of the last character.</td> </tr><tr> <td><a href="#Shell.__initialise">__initialise</a></td> <td>Private method to get ready for a new remote interpreter.</td> </tr><tr> <td><a href="#Shell.__insertHistory">__insertHistory</a></td> <td>Private method to insert a command selected from the history.</td> </tr><tr> <td><a href="#Shell.__insertText">__insertText</a></td> <td>Private method to insert some text at the current cursor position.</td> </tr><tr> <td><a href="#Shell.__insertTextAtEnd">__insertTextAtEnd</a></td> <td>Private method to insert some text at the end of the command line.</td> </tr><tr> <td><a href="#Shell.__insertTextNoEcho">__insertTextNoEcho</a></td> <td>Private method to insert some text at the end of the buffer without echoing it.</td> </tr><tr> <td><a href="#Shell.__isCursorOnLastLine">__isCursorOnLastLine</a></td> <td>Private method to check, if the cursor is on the last line.</td> </tr><tr> <td><a href="#Shell.__middleMouseButton">__middleMouseButton</a></td> <td>Private method to handle the middle mouse button press.</td> </tr><tr> <td><a href="#Shell.__raw_input">__raw_input</a></td> <td>Private method to handle raw input.</td> </tr><tr> <td><a href="#Shell.__reset">__reset</a></td> <td>Private slot to handle the 'reset' context menu entry.</td> </tr><tr> <td><a href="#Shell.__resetAndClear">__resetAndClear</a></td> <td>Private slot to handle the 'reset and clear' context menu entry.</td> </tr><tr> <td><a href="#Shell.__rsearchHistory">__rsearchHistory</a></td> <td>Private method used to reverse search the history.</td> </tr><tr> <td><a href="#Shell.__searchHistory">__searchHistory</a></td> <td>Private method used to search the history.</td> </tr><tr> <td><a href="#Shell.__selectHistory">__selectHistory</a></td> <td>Private slot to select a history entry to execute.</td> </tr><tr> <td><a href="#Shell.__setAutoCompletion">__setAutoCompletion</a></td> <td>Private method to configure the autocompletion function.</td> </tr><tr> <td><a href="#Shell.__setCallTips">__setCallTips</a></td> <td>Private method to configure the calltips function.</td> </tr><tr> <td><a href="#Shell.__setMargin0">__setMargin0</a></td> <td>Private method to configure margin 0.</td> </tr><tr> <td><a href="#Shell.__setMonospaced">__setMonospaced</a></td> <td>Private method to set/reset a monospaced font.</td> </tr><tr> <td><a href="#Shell.__setTextDisplay">__setTextDisplay</a></td> <td>Private method to configure the text display.</td> </tr><tr> <td><a href="#Shell.__showCompletions">__showCompletions</a></td> <td>Private method to display the possible completions.</td> </tr><tr> <td><a href="#Shell.__showHistory">__showHistory</a></td> <td>Private slot to show the shell history dialog.</td> </tr><tr> <td><a href="#Shell.__startDebugClient">__startDebugClient</a></td> <td>Private slot to start a debug client accoding to the action triggered.</td> </tr><tr> <td><a href="#Shell.__useHistory">__useHistory</a></td> <td>Private method to display a command from the history.</td> </tr><tr> <td><a href="#Shell.__write">__write</a></td> <td>Private method to display some text.</td> </tr><tr> <td><a href="#Shell.__writeBanner">__writeBanner</a></td> <td>Private method to write a banner with info from the debug client.</td> </tr><tr> <td><a href="#Shell.__writePrompt">__writePrompt</a></td> <td>Private method to write the prompt.</td> </tr><tr> <td><a href="#Shell.__writeStdErr">__writeStdErr</a></td> <td>Private method to display some text with StdErr label.</td> </tr><tr> <td><a href="#Shell.__writeStdOut">__writeStdOut</a></td> <td>Private method to display some text with StdOut label.</td> </tr><tr> <td><a href="#Shell.clear">clear</a></td> <td>Public slot to clear the display.</td> </tr><tr> <td><a href="#Shell.closeShell">closeShell</a></td> <td>Public method to shutdown the shell.</td> </tr><tr> <td><a href="#Shell.contextMenuEvent">contextMenuEvent</a></td> <td>Reimplemented to show our own context menu.</td> </tr><tr> <td><a href="#Shell.dragEnterEvent">dragEnterEvent</a></td> <td>Protected method to handle the drag enter event.</td> </tr><tr> <td><a href="#Shell.dragLeaveEvent">dragLeaveEvent</a></td> <td>Protected method to handle the drag leave event.</td> </tr><tr> <td><a href="#Shell.dragMoveEvent">dragMoveEvent</a></td> <td>Protected method to handle the drag move event.</td> </tr><tr> <td><a href="#Shell.dropEvent">dropEvent</a></td> <td>Protected method to handle the drop event.</td> </tr><tr> <td><a href="#Shell.editorCommand">editorCommand</a></td> <td>Public method to perform an editor command.</td> </tr><tr> <td><a href="#Shell.executeLines">executeLines</a></td> <td>Public method to execute a set of lines as multiple commands.</td> </tr><tr> <td><a href="#Shell.focusInEvent">focusInEvent</a></td> <td>Public method called when the shell receives focus.</td> </tr><tr> <td><a href="#Shell.focusNextPrevChild">focusNextPrevChild</a></td> <td>Reimplemented to stop Tab moving to the next window.</td> </tr><tr> <td><a href="#Shell.focusOutEvent">focusOutEvent</a></td> <td>Public method called when the shell loses focus.</td> </tr><tr> <td><a href="#Shell.getClientType">getClientType</a></td> <td>Public slot to get the clients type.</td> </tr><tr> <td><a href="#Shell.getHistory">getHistory</a></td> <td>Public method to get the history for the given client type.</td> </tr><tr> <td><a href="#Shell.handlePreferencesChanged">handlePreferencesChanged</a></td> <td>Public slot to handle the preferencesChanged signal.</td> </tr><tr> <td><a href="#Shell.insert">insert</a></td> <td>Public slot to insert text at the current cursor position.</td> </tr><tr> <td><a href="#Shell.keyPressEvent">keyPressEvent</a></td> <td>Re-implemented to handle the user input a key at a time.</td> </tr><tr> <td><a href="#Shell.loadHistory">loadHistory</a></td> <td>Public method to load the history for the given client type.</td> </tr><tr> <td><a href="#Shell.mousePressEvent">mousePressEvent</a></td> <td>Protected method to handle the mouse press event.</td> </tr><tr> <td><a href="#Shell.paste">paste</a></td> <td>Reimplemented slot to handle the paste action.</td> </tr><tr> <td><a href="#Shell.reloadHistory">reloadHistory</a></td> <td>Public method to reload the history of the currently selected client type.</td> </tr><tr> <td><a href="#Shell.saveHistory">saveHistory</a></td> <td>Public method to save the history for the given client type.</td> </tr><tr> <td><a href="#Shell.setDebuggerUI">setDebuggerUI</a></td> <td>Public method to set the debugger UI.</td> </tr> </table> <a NAME="Shell.__init__" ID="Shell.__init__"></a> <h4>Shell (Constructor)</h4> <b>Shell</b>(<i>dbs, vm, parent = None</i>) <p> Constructor </p><dl> <dt><i>dbs</i></dt> <dd> reference to the debug server object </dd><dt><i>vm</i></dt> <dd> reference to the viewmanager object </dd><dt><i>parent</i></dt> <dd> parent widget (QWidget) </dd> </dl><a NAME="Shell.__QScintillaAutoCompletionCommand" ID="Shell.__QScintillaAutoCompletionCommand"></a> <h4>Shell.__QScintillaAutoCompletionCommand</h4> <b>__QScintillaAutoCompletionCommand</b>(<i>cmd</i>) <p> Private method to handle a command for autocompletion only. </p><dl> <dt><i>cmd</i></dt> <dd> QScintilla command </dd> </dl><a NAME="Shell.__QScintillaCharLeft" ID="Shell.__QScintillaCharLeft"></a> <h4>Shell.__QScintillaCharLeft</h4> <b>__QScintillaCharLeft</b>(<i></i>) <p> Private method to handle the Cursor Left command. </p><a NAME="Shell.__QScintillaCharLeftExtend" ID="Shell.__QScintillaCharLeftExtend"></a> <h4>Shell.__QScintillaCharLeftExtend</h4> <b>__QScintillaCharLeftExtend</b>(<i></i>) <p> Private method to handle the Extend Selection Left command. </p><a NAME="Shell.__QScintillaCharRight" ID="Shell.__QScintillaCharRight"></a> <h4>Shell.__QScintillaCharRight</h4> <b>__QScintillaCharRight</b>(<i></i>) <p> Private method to handle the Cursor Right command. </p><a NAME="Shell.__QScintillaDelete" ID="Shell.__QScintillaDelete"></a> <h4>Shell.__QScintillaDelete</h4> <b>__QScintillaDelete</b>(<i></i>) <p> Private method to handle the delete command. </p><a NAME="Shell.__QScintillaDeleteBack" ID="Shell.__QScintillaDeleteBack"></a> <h4>Shell.__QScintillaDeleteBack</h4> <b>__QScintillaDeleteBack</b>(<i></i>) <p> Private method to handle the Backspace key. </p><a NAME="Shell.__QScintillaDeleteLineLeft" ID="Shell.__QScintillaDeleteLineLeft"></a> <h4>Shell.__QScintillaDeleteLineLeft</h4> <b>__QScintillaDeleteLineLeft</b>(<i></i>) <p> Private method to handle the Delete Line Left command. </p><a NAME="Shell.__QScintillaDeleteLineRight" ID="Shell.__QScintillaDeleteLineRight"></a> <h4>Shell.__QScintillaDeleteLineRight</h4> <b>__QScintillaDeleteLineRight</b>(<i></i>) <p> Private method to handle the Delete Line Right command. </p><a NAME="Shell.__QScintillaDeleteWordLeft" ID="Shell.__QScintillaDeleteWordLeft"></a> <h4>Shell.__QScintillaDeleteWordLeft</h4> <b>__QScintillaDeleteWordLeft</b>(<i></i>) <p> Private method to handle the Delete Word Left command. </p><a NAME="Shell.__QScintillaDeleteWordRight" ID="Shell.__QScintillaDeleteWordRight"></a> <h4>Shell.__QScintillaDeleteWordRight</h4> <b>__QScintillaDeleteWordRight</b>(<i></i>) <p> Private method to handle the Delete Word Right command. </p><a NAME="Shell.__QScintillaLeftCommand" ID="Shell.__QScintillaLeftCommand"></a> <h4>Shell.__QScintillaLeftCommand</h4> <b>__QScintillaLeftCommand</b>(<i>method, allLinesAllowed = False</i>) <p> Private method to handle a QScintilla command working to the left. </p><dl> <dt><i>method</i></dt> <dd> shell method to execute </dd><dt><i>allLinesAllowed</i></dt> <dd> flag indicating that the command may be executed on any line (boolean) </dd> </dl><a NAME="Shell.__QScintillaLeftDeleteCommand" ID="Shell.__QScintillaLeftDeleteCommand"></a> <h4>Shell.__QScintillaLeftDeleteCommand</h4> <b>__QScintillaLeftDeleteCommand</b>(<i>method</i>) <p> Private method to handle a QScintilla delete command working to the left. </p><dl> <dt><i>method</i></dt> <dd> shell method to execute </dd> </dl><a NAME="Shell.__QScintillaLineDown" ID="Shell.__QScintillaLineDown"></a> <h4>Shell.__QScintillaLineDown</h4> <b>__QScintillaLineDown</b>(<i>cmd</i>) <p> Private method to handle the Down key. </p><dl> <dt><i>cmd</i></dt> <dd> QScintilla command </dd> </dl><a NAME="Shell.__QScintillaLineEnd" ID="Shell.__QScintillaLineEnd"></a> <h4>Shell.__QScintillaLineEnd</h4> <b>__QScintillaLineEnd</b>(<i>cmd</i>) <p> Private method to handle the End key. </p><dl> <dt><i>cmd</i></dt> <dd> QScintilla command </dd> </dl><a NAME="Shell.__QScintillaLineUp" ID="Shell.__QScintillaLineUp"></a> <h4>Shell.__QScintillaLineUp</h4> <b>__QScintillaLineUp</b>(<i>cmd</i>) <p> Private method to handle the Up key. </p><dl> <dt><i>cmd</i></dt> <dd> QScintilla command </dd> </dl><a NAME="Shell.__QScintillaNewline" ID="Shell.__QScintillaNewline"></a> <h4>Shell.__QScintillaNewline</h4> <b>__QScintillaNewline</b>(<i>cmd</i>) <p> Private method to handle the Return key. </p><dl> <dt><i>cmd</i></dt> <dd> QScintilla command </dd> </dl><a NAME="Shell.__QScintillaRightCommand" ID="Shell.__QScintillaRightCommand"></a> <h4>Shell.__QScintillaRightCommand</h4> <b>__QScintillaRightCommand</b>(<i>method</i>) <p> Private method to handle a QScintilla command working to the right. </p><dl> <dt><i>method</i></dt> <dd> shell method to execute </dd> </dl><a NAME="Shell.__QScintillaTab" ID="Shell.__QScintillaTab"></a> <h4>Shell.__QScintillaTab</h4> <b>__QScintillaTab</b>(<i>cmd</i>) <p> Private method to handle the Tab key. </p><dl> <dt><i>cmd</i></dt> <dd> QScintilla command </dd> </dl><a NAME="Shell.__QScintillaVCHome" ID="Shell.__QScintillaVCHome"></a> <h4>Shell.__QScintillaVCHome</h4> <b>__QScintillaVCHome</b>(<i>cmd</i>) <p> Private method to handle the Home key. </p><dl> <dt><i>cmd</i></dt> <dd> QScintilla command </dd> </dl><a NAME="Shell.__QScintillaVCHomeExtend" ID="Shell.__QScintillaVCHomeExtend"></a> <h4>Shell.__QScintillaVCHomeExtend</h4> <b>__QScintillaVCHomeExtend</b>(<i></i>) <p> Private method to handle the Extend Selection to start of line command. </p><a NAME="Shell.__QScintillaWordLeft" ID="Shell.__QScintillaWordLeft"></a> <h4>Shell.__QScintillaWordLeft</h4> <b>__QScintillaWordLeft</b>(<i></i>) <p> Private method to handle the Cursor Word Left command. </p><a NAME="Shell.__QScintillaWordLeftExtend" ID="Shell.__QScintillaWordLeftExtend"></a> <h4>Shell.__QScintillaWordLeftExtend</h4> <b>__QScintillaWordLeftExtend</b>(<i></i>) <p> Private method to handle the Extend Selection Left one word command. </p><a NAME="Shell.__QScintillaWordRight" ID="Shell.__QScintillaWordRight"></a> <h4>Shell.__QScintillaWordRight</h4> <b>__QScintillaWordRight</b>(<i></i>) <p> Private method to handle the Cursor Word Right command. </p><a NAME="Shell.__bindLexer" ID="Shell.__bindLexer"></a> <h4>Shell.__bindLexer</h4> <b>__bindLexer</b>(<i>language = 'Python'</i>) <p> Private slot to set the lexer. </p><dl> <dt><i>language</i></dt> <dd> lexer language to set (string) </dd> </dl><a NAME="Shell.__clearCurrentLine" ID="Shell.__clearCurrentLine"></a> <h4>Shell.__clearCurrentLine</h4> <b>__clearCurrentLine</b>(<i></i>) <p> Private method to clear the line containing the cursor. </p><a NAME="Shell.__clearHistory" ID="Shell.__clearHistory"></a> <h4>Shell.__clearHistory</h4> <b>__clearHistory</b>(<i></i>) <p> Private slot to clear the current history. </p><a NAME="Shell.__clientCapabilities" ID="Shell.__clientCapabilities"></a> <h4>Shell.__clientCapabilities</h4> <b>__clientCapabilities</b>(<i>cap, clType</i>) <p> Private slot to handle the reporting of the clients capabilities. </p><dl> <dt><i>cap</i></dt> <dd> client capabilities (integer) </dd><dt><i>clType</i></dt> <dd> type of the debug client (string) </dd> </dl><a NAME="Shell.__clientError" ID="Shell.__clientError"></a> <h4>Shell.__clientError</h4> <b>__clientError</b>(<i></i>) <p> Private method to handle an error in the client. </p><a NAME="Shell.__clientStatement" ID="Shell.__clientStatement"></a> <h4>Shell.__clientStatement</h4> <b>__clientStatement</b>(<i>more</i>) <p> Private method to handle the response from the debugger client. </p><dl> <dt><i>more</i></dt> <dd> flag indicating that more user input is required (boolean) </dd> </dl><a NAME="Shell.__completionListSelected" ID="Shell.__completionListSelected"></a> <h4>Shell.__completionListSelected</h4> <b>__completionListSelected</b>(<i>id, txt</i>) <p> Private slot to handle the selection from the completion list. </p><dl> <dt><i>id</i></dt> <dd> the ID of the user list (should be 1) (integer) </dd><dt><i>txt</i></dt> <dd> the selected text (string) </dd> </dl><a NAME="Shell.__configure" ID="Shell.__configure"></a> <h4>Shell.__configure</h4> <b>__configure</b>(<i></i>) <p> Private method to open the configuration dialog. </p><a NAME="Shell.__executeCommand" ID="Shell.__executeCommand"></a> <h4>Shell.__executeCommand</h4> <b>__executeCommand</b>(<i>cmd</i>) <p> Private slot to execute a command. </p><dl> <dt><i>cmd</i></dt> <dd> command to be executed by debug client (string) </dd> </dl><a NAME="Shell.__getBanner" ID="Shell.__getBanner"></a> <h4>Shell.__getBanner</h4> <b>__getBanner</b>(<i></i>) <p> Private method to get the banner for the remote interpreter. </p><p> It requests the interpreter version and platform running on the debug client side. </p><a NAME="Shell.__getEndPos" ID="Shell.__getEndPos"></a> <h4>Shell.__getEndPos</h4> <b>__getEndPos</b>(<i></i>) <p> Private method to return the line and column of the last character. </p><dl> <dt>Returns:</dt> <dd> tuple of two values (int, int) giving the line and column </dd> </dl><a NAME="Shell.__initialise" ID="Shell.__initialise"></a> <h4>Shell.__initialise</h4> <b>__initialise</b>(<i></i>) <p> Private method to get ready for a new remote interpreter. </p><a NAME="Shell.__insertHistory" ID="Shell.__insertHistory"></a> <h4>Shell.__insertHistory</h4> <b>__insertHistory</b>(<i>cmd</i>) <p> Private method to insert a command selected from the history. </p><dl> <dt><i>cmd</i></dt> <dd> history entry to be inserted (string) </dd> </dl><a NAME="Shell.__insertText" ID="Shell.__insertText"></a> <h4>Shell.__insertText</h4> <b>__insertText</b>(<i>s</i>) <p> Private method to insert some text at the current cursor position. </p><dl> <dt><i>s</i></dt> <dd> text to be inserted (string) </dd> </dl><a NAME="Shell.__insertTextAtEnd" ID="Shell.__insertTextAtEnd"></a> <h4>Shell.__insertTextAtEnd</h4> <b>__insertTextAtEnd</b>(<i>s</i>) <p> Private method to insert some text at the end of the command line. </p><dl> <dt><i>s</i></dt> <dd> text to be inserted (string) </dd> </dl><a NAME="Shell.__insertTextNoEcho" ID="Shell.__insertTextNoEcho"></a> <h4>Shell.__insertTextNoEcho</h4> <b>__insertTextNoEcho</b>(<i>s</i>) <p> Private method to insert some text at the end of the buffer without echoing it. </p><dl> <dt><i>s</i></dt> <dd> text to be inserted (string) </dd> </dl><a NAME="Shell.__isCursorOnLastLine" ID="Shell.__isCursorOnLastLine"></a> <h4>Shell.__isCursorOnLastLine</h4> <b>__isCursorOnLastLine</b>(<i></i>) <p> Private method to check, if the cursor is on the last line. </p><a NAME="Shell.__middleMouseButton" ID="Shell.__middleMouseButton"></a> <h4>Shell.__middleMouseButton</h4> <b>__middleMouseButton</b>(<i></i>) <p> Private method to handle the middle mouse button press. </p><a NAME="Shell.__raw_input" ID="Shell.__raw_input"></a> <h4>Shell.__raw_input</h4> <b>__raw_input</b>(<i>s, echo</i>) <p> Private method to handle raw input. </p><dl> <dt><i>s</i></dt> <dd> prompt to be displayed (string) </dd><dt><i>echo</i></dt> <dd> Flag indicating echoing of the input (boolean) </dd> </dl><a NAME="Shell.__reset" ID="Shell.__reset"></a> <h4>Shell.__reset</h4> <b>__reset</b>(<i></i>) <p> Private slot to handle the 'reset' context menu entry. </p><a NAME="Shell.__resetAndClear" ID="Shell.__resetAndClear"></a> <h4>Shell.__resetAndClear</h4> <b>__resetAndClear</b>(<i></i>) <p> Private slot to handle the 'reset and clear' context menu entry. </p><a NAME="Shell.__rsearchHistory" ID="Shell.__rsearchHistory"></a> <h4>Shell.__rsearchHistory</h4> <b>__rsearchHistory</b>(<i>txt, startIdx = -1</i>) <p> Private method used to reverse search the history. </p><dl> <dt><i>txt</i></dt> <dd> text to match at the beginning (string) </dd><dt><i>startIdx</i></dt> <dd> index to start search from (integer) </dd> </dl><dl> <dt>Returns:</dt> <dd> index of found entry (integer) </dd> </dl><a NAME="Shell.__searchHistory" ID="Shell.__searchHistory"></a> <h4>Shell.__searchHistory</h4> <b>__searchHistory</b>(<i>txt, startIdx = -1</i>) <p> Private method used to search the history. </p><dl> <dt><i>txt</i></dt> <dd> text to match at the beginning (string) </dd><dt><i>startIdx</i></dt> <dd> index to start search from (integer) </dd> </dl><dl> <dt>Returns:</dt> <dd> index of found entry (integer) </dd> </dl><a NAME="Shell.__selectHistory" ID="Shell.__selectHistory"></a> <h4>Shell.__selectHistory</h4> <b>__selectHistory</b>(<i></i>) <p> Private slot to select a history entry to execute. </p><a NAME="Shell.__setAutoCompletion" ID="Shell.__setAutoCompletion"></a> <h4>Shell.__setAutoCompletion</h4> <b>__setAutoCompletion</b>(<i>language = 'Python'</i>) <p> Private method to configure the autocompletion function. </p><dl> <dt><i>language</i></dt> <dd> of the autocompletion set to set (string) </dd> </dl><a NAME="Shell.__setCallTips" ID="Shell.__setCallTips"></a> <h4>Shell.__setCallTips</h4> <b>__setCallTips</b>(<i>language = 'Python'</i>) <p> Private method to configure the calltips function. </p><dl> <dt><i>language</i></dt> <dd> of the calltips set to set (string) </dd> </dl><a NAME="Shell.__setMargin0" ID="Shell.__setMargin0"></a> <h4>Shell.__setMargin0</h4> <b>__setMargin0</b>(<i></i>) <p> Private method to configure margin 0. </p><a NAME="Shell.__setMonospaced" ID="Shell.__setMonospaced"></a> <h4>Shell.__setMonospaced</h4> <b>__setMonospaced</b>(<i>on</i>) <p> Private method to set/reset a monospaced font. </p><dl> <dt><i>on</i></dt> <dd> flag to indicate usage of a monospace font (boolean) </dd> </dl><a NAME="Shell.__setTextDisplay" ID="Shell.__setTextDisplay"></a> <h4>Shell.__setTextDisplay</h4> <b>__setTextDisplay</b>(<i></i>) <p> Private method to configure the text display. </p><a NAME="Shell.__showCompletions" ID="Shell.__showCompletions"></a> <h4>Shell.__showCompletions</h4> <b>__showCompletions</b>(<i>completions, text</i>) <p> Private method to display the possible completions. </p><dl> <dt><i>completions</i></dt> <dd> list of possible completions (list of strings) </dd><dt><i>text</i></dt> <dd> text that is about to be completed (string) </dd> </dl><a NAME="Shell.__showHistory" ID="Shell.__showHistory"></a> <h4>Shell.__showHistory</h4> <b>__showHistory</b>(<i></i>) <p> Private slot to show the shell history dialog. </p><a NAME="Shell.__startDebugClient" ID="Shell.__startDebugClient"></a> <h4>Shell.__startDebugClient</h4> <b>__startDebugClient</b>(<i>action</i>) <p> Private slot to start a debug client accoding to the action triggered. </p><dl> <dt><i>action</i></dt> <dd> context menu action that was triggered (QAction) </dd> </dl><a NAME="Shell.__useHistory" ID="Shell.__useHistory"></a> <h4>Shell.__useHistory</h4> <b>__useHistory</b>(<i></i>) <p> Private method to display a command from the history. </p><a NAME="Shell.__write" ID="Shell.__write"></a> <h4>Shell.__write</h4> <b>__write</b>(<i>s</i>) <p> Private method to display some text. </p><dl> <dt><i>s</i></dt> <dd> text to be displayed (string) </dd> </dl><a NAME="Shell.__writeBanner" ID="Shell.__writeBanner"></a> <h4>Shell.__writeBanner</h4> <b>__writeBanner</b>(<i>version, platform, dbgclient</i>) <p> Private method to write a banner with info from the debug client. </p><dl> <dt><i>version</i></dt> <dd> interpreter version string (string) </dd><dt><i>platform</i></dt> <dd> platform of the remote interpreter (string) </dd><dt><i>dbgclient</i></dt> <dd> debug client variant used (string) </dd> </dl><a NAME="Shell.__writePrompt" ID="Shell.__writePrompt"></a> <h4>Shell.__writePrompt</h4> <b>__writePrompt</b>(<i></i>) <p> Private method to write the prompt. </p><a NAME="Shell.__writeStdErr" ID="Shell.__writeStdErr"></a> <h4>Shell.__writeStdErr</h4> <b>__writeStdErr</b>(<i>s</i>) <p> Private method to display some text with StdErr label. </p><dl> <dt><i>s</i></dt> <dd> text to be displayed (string) </dd> </dl><a NAME="Shell.__writeStdOut" ID="Shell.__writeStdOut"></a> <h4>Shell.__writeStdOut</h4> <b>__writeStdOut</b>(<i>s</i>) <p> Private method to display some text with StdOut label. </p><dl> <dt><i>s</i></dt> <dd> text to be displayed (string) </dd> </dl><a NAME="Shell.clear" ID="Shell.clear"></a> <h4>Shell.clear</h4> <b>clear</b>(<i></i>) <p> Public slot to clear the display. </p><a NAME="Shell.closeShell" ID="Shell.closeShell"></a> <h4>Shell.closeShell</h4> <b>closeShell</b>(<i></i>) <p> Public method to shutdown the shell. </p><a NAME="Shell.contextMenuEvent" ID="Shell.contextMenuEvent"></a> <h4>Shell.contextMenuEvent</h4> <b>contextMenuEvent</b>(<i>ev</i>) <p> Reimplemented to show our own context menu. </p><dl> <dt><i>ev</i></dt> <dd> context menu event (QContextMenuEvent) </dd> </dl><a NAME="Shell.dragEnterEvent" ID="Shell.dragEnterEvent"></a> <h4>Shell.dragEnterEvent</h4> <b>dragEnterEvent</b>(<i>event</i>) <p> Protected method to handle the drag enter event. </p><dl> <dt><i>event</i></dt> <dd> the drag enter event (QDragEnterEvent) </dd> </dl><a NAME="Shell.dragLeaveEvent" ID="Shell.dragLeaveEvent"></a> <h4>Shell.dragLeaveEvent</h4> <b>dragLeaveEvent</b>(<i>event</i>) <p> Protected method to handle the drag leave event. </p><dl> <dt><i>event</i></dt> <dd> the drag leave event (QDragLeaveEvent) </dd> </dl><a NAME="Shell.dragMoveEvent" ID="Shell.dragMoveEvent"></a> <h4>Shell.dragMoveEvent</h4> <b>dragMoveEvent</b>(<i>event</i>) <p> Protected method to handle the drag move event. </p><dl> <dt><i>event</i></dt> <dd> the drag move event (QDragMoveEvent) </dd> </dl><a NAME="Shell.dropEvent" ID="Shell.dropEvent"></a> <h4>Shell.dropEvent</h4> <b>dropEvent</b>(<i>event</i>) <p> Protected method to handle the drop event. </p><dl> <dt><i>event</i></dt> <dd> the drop event (QDropEvent) </dd> </dl><a NAME="Shell.editorCommand" ID="Shell.editorCommand"></a> <h4>Shell.editorCommand</h4> <b>editorCommand</b>(<i>cmd</i>) <p> Public method to perform an editor command. </p><dl> <dt><i>cmd</i></dt> <dd> the scintilla command to be performed </dd> </dl><a NAME="Shell.executeLines" ID="Shell.executeLines"></a> <h4>Shell.executeLines</h4> <b>executeLines</b>(<i>lines</i>) <p> Public method to execute a set of lines as multiple commands. </p><dl> <dt><i>lines</i></dt> <dd> multiple lines of text to be executed as single commands (string) </dd> </dl><a NAME="Shell.focusInEvent" ID="Shell.focusInEvent"></a> <h4>Shell.focusInEvent</h4> <b>focusInEvent</b>(<i>event</i>) <p> Public method called when the shell receives focus. </p><dl> <dt><i>event</i></dt> <dd> the event object (QFocusEvent) </dd> </dl><a NAME="Shell.focusNextPrevChild" ID="Shell.focusNextPrevChild"></a> <h4>Shell.focusNextPrevChild</h4> <b>focusNextPrevChild</b>(<i>next</i>) <p> Reimplemented to stop Tab moving to the next window. </p><p> While the user is entering a multi-line command, the movement to the next window by the Tab key being pressed is suppressed. </p><dl> <dt><i>next</i></dt> <dd> next window </dd> </dl><dl> <dt>Returns:</dt> <dd> flag indicating the movement </dd> </dl><a NAME="Shell.focusOutEvent" ID="Shell.focusOutEvent"></a> <h4>Shell.focusOutEvent</h4> <b>focusOutEvent</b>(<i>event</i>) <p> Public method called when the shell loses focus. </p><dl> <dt><i>event</i></dt> <dd> the event object (QFocusEvent) </dd> </dl><a NAME="Shell.getClientType" ID="Shell.getClientType"></a> <h4>Shell.getClientType</h4> <b>getClientType</b>(<i></i>) <p> Public slot to get the clients type. </p><dl> <dt>Returns:</dt> <dd> client type (string) </dd> </dl><a NAME="Shell.getHistory" ID="Shell.getHistory"></a> <h4>Shell.getHistory</h4> <b>getHistory</b>(<i>clientType</i>) <p> Public method to get the history for the given client type. </p><dl> <dt><i>clientType</i></dt> <dd> type of the debug client (string). If it is None, the current history is returned. </dd> </dl><dl> <dt>Returns:</dt> <dd> reference to the history list (list of strings) </dd> </dl><a NAME="Shell.handlePreferencesChanged" ID="Shell.handlePreferencesChanged"></a> <h4>Shell.handlePreferencesChanged</h4> <b>handlePreferencesChanged</b>(<i></i>) <p> Public slot to handle the preferencesChanged signal. </p><a NAME="Shell.insert" ID="Shell.insert"></a> <h4>Shell.insert</h4> <b>insert</b>(<i>txt</i>) <p> Public slot to insert text at the current cursor position. </p><p> The cursor is advanced to the end of the inserted text. </p><dl> <dt><i>txt</i></dt> <dd> text to be inserted (string) </dd> </dl><a NAME="Shell.keyPressEvent" ID="Shell.keyPressEvent"></a> <h4>Shell.keyPressEvent</h4> <b>keyPressEvent</b>(<i>ev</i>) <p> Re-implemented to handle the user input a key at a time. </p><dl> <dt><i>ev</i></dt> <dd> key event (QKeyEvent) </dd> </dl><a NAME="Shell.loadHistory" ID="Shell.loadHistory"></a> <h4>Shell.loadHistory</h4> <b>loadHistory</b>(<i>clientType</i>) <p> Public method to load the history for the given client type. </p><dl> <dt><i>clientType</i></dt> <dd> type of the debug client (string) </dd> </dl><a NAME="Shell.mousePressEvent" ID="Shell.mousePressEvent"></a> <h4>Shell.mousePressEvent</h4> <b>mousePressEvent</b>(<i>event</i>) <p> Protected method to handle the mouse press event. </p><dl> <dt><i>event</i></dt> <dd> the mouse press event (QMouseEvent) </dd> </dl><a NAME="Shell.paste" ID="Shell.paste"></a> <h4>Shell.paste</h4> <b>paste</b>(<i></i>) <p> Reimplemented slot to handle the paste action. </p><a NAME="Shell.reloadHistory" ID="Shell.reloadHistory"></a> <h4>Shell.reloadHistory</h4> <b>reloadHistory</b>(<i></i>) <p> Public method to reload the history of the currently selected client type. </p><a NAME="Shell.saveHistory" ID="Shell.saveHistory"></a> <h4>Shell.saveHistory</h4> <b>saveHistory</b>(<i>clientType</i>) <p> Public method to save the history for the given client type. </p><dl> <dt><i>clientType</i></dt> <dd> type of the debug client (string) </dd> </dl><a NAME="Shell.setDebuggerUI" ID="Shell.setDebuggerUI"></a> <h4>Shell.setDebuggerUI</h4> <b>setDebuggerUI</b>(<i>ui</i>) <p> Public method to set the debugger UI. </p><dl> <dt><i>ui</i></dt> <dd> reference to the debugger UI object (DebugUI) </dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html>
