--- a/Documentation/Source/eric6.QScintilla.Shell.html Mon Jul 10 18:24:35 2017 +0200
+++ b/Documentation/Source/eric6.QScintilla.Shell.html Mon Jul 10 18:48:33 2017 +0200
@@ -35,6 +35,9 @@
</tr><tr>
<td><a href="#ShellAssembly">ShellAssembly</a></td>
<td>Class implementing the containing widget for the shell.</td>
+</tr><tr>
+<td><a href="#ShellHistoryStyle">ShellHistoryStyle</a></td>
+<td>Class defining the shell history styles.</td>
</tr>
</table>
<h3>Functions</h3>
@@ -51,10 +54,14 @@
Python interpreter.
</p><h3>Signals</h3>
<dl>
-<dt>searchStringFound(found)</dt>
+<dt>historyStyleChanged(ShellHistoryStyle)</dt>
+<dd>
+emitted to indicate a
+ change of the history style
+</dd><dt>searchStringFound(bool)</dt>
<dd>
emitted to indicate the search
- result (boolean)
+ result
</dd>
</dl>
<h3>Derived from</h3>
@@ -76,6 +83,9 @@
<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.__QScintillaCancel">__QScintillaCancel</a></td>
+<td>Private method to handle the ESC command.</td>
+</tr><tr>
<td><a href="#Shell.__QScintillaCharLeft">__QScintillaCharLeft</a></td>
<td>Private method to handle the Cursor Left command.</td>
</tr><tr>
@@ -107,10 +117,10 @@
<td>Private method to handle the Delete Word Right command.</td>
</tr><tr>
<td><a href="#Shell.__QScintillaHistoryDown">__QScintillaHistoryDown</a></td>
-<td>Private method to handle the Ctrl+Down key.</td>
+<td>Private method to handle the history down command.</td>
</tr><tr>
<td><a href="#Shell.__QScintillaHistoryUp">__QScintillaHistoryUp</a></td>
-<td>Private method to handle the Ctrl+Up key.</td>
+<td>Private method to handle the history up 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>
@@ -118,9 +128,15 @@
<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 cursor down command.</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 cursor up command.</td>
+</tr><tr>
<td><a href="#Shell.__QScintillaNewline">__QScintillaNewline</a></td>
<td>Private method to handle the Return key.</td>
</tr><tr>
@@ -205,6 +221,9 @@
<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.__isHistoryIndexValid">__isHistoryIndexValid</a></td>
+<td>Private method to test, if the history index is valid.</td>
+</tr><tr>
<td><a href="#Shell.__middleMouseButton">__middleMouseButton</a></td>
<td>Private method to handle the middle mouse button press.</td>
</tr><tr>
@@ -217,6 +236,9 @@
<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.__resetIncrementalHistorySearch">__resetIncrementalHistorySearch</a></td>
+<td>Private method to reset the incremental history search.</td>
+</tr><tr>
<td><a href="#Shell.__resizeLinenoMargin">__resizeLinenoMargin</a></td>
<td>Private slot to resize the line numbers margin.</td>
</tr><tr>
@@ -238,6 +260,9 @@
<td><a href="#Shell.__setCallTips">__setCallTips</a></td>
<td>Private method to configure the calltips function.</td>
</tr><tr>
+<td><a href="#Shell.__setHistoryIndex">__setHistoryIndex</a></td>
+<td>Private method to set the initial history index.</td>
+</tr><tr>
<td><a href="#Shell.__setMargin0">__setMargin0</a></td>
<td>Private method to configure margin 0.</td>
</tr><tr>
@@ -247,6 +272,9 @@
<td><a href="#Shell.__setTextDisplay">__setTextDisplay</a></td>
<td>Private method to configure the text display.</td>
</tr><tr>
+<td><a href="#Shell.__setupCursorKeys">__setupCursorKeys</a></td>
+<td>Private method to setup the cursor up and down mode.</td>
+</tr><tr>
<td><a href="#Shell.__showCompletions">__showCompletions</a></td>
<td>Private method to display the possible completions.</td>
</tr><tr>
@@ -328,12 +356,21 @@
<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.getHistoryIndex">getHistoryIndex</a></td>
+<td>Public method to get the current value of the history index.</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.historyStyle">historyStyle</a></td>
+<td>Public method to get the shell history style.</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.isHistoryEnabled">isHistoryEnabled</a></td>
+<td>Public method to check, if the history is enabled.</td>
+</tr><tr>
<td><a href="#Shell.keyPressEvent">keyPressEvent</a></td>
<td>Protected method to handle the user input a key at a time.</td>
</tr><tr>
@@ -405,7 +442,12 @@
<dd>
QScintilla command
</dd>
-</dl><a NAME="Shell.__QScintillaCharLeft" ID="Shell.__QScintillaCharLeft"></a>
+</dl><a NAME="Shell.__QScintillaCancel" ID="Shell.__QScintillaCancel"></a>
+<h4>Shell.__QScintillaCancel</h4>
+<b>__QScintillaCancel</b>(<i></i>)
+<p>
+ Private method to handle the ESC command.
+</p><a NAME="Shell.__QScintillaCharLeft" ID="Shell.__QScintillaCharLeft"></a>
<h4>Shell.__QScintillaCharLeft</h4>
<b>__QScintillaCharLeft</b>(<i></i>)
<p>
@@ -464,7 +506,7 @@
<h4>Shell.__QScintillaHistoryDown</h4>
<b>__QScintillaHistoryDown</b>(<i>cmd</i>)
<p>
- Private method to handle the Ctrl+Down key.
+ Private method to handle the history down command.
</p><dl>
<dt><i>cmd</i></dt>
<dd>
@@ -474,7 +516,7 @@
<h4>Shell.__QScintillaHistoryUp</h4>
<b>__QScintillaHistoryUp</b>(<i>cmd</i>)
<p>
- Private method to handle the Ctrl+Up key.
+ Private method to handle the history up command.
</p><dl>
<dt><i>cmd</i></dt>
<dd>
@@ -505,6 +547,16 @@
<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 cursor down command.
+</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>)
@@ -515,6 +567,16 @@
<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 cursor up command.
+</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>)
@@ -697,13 +759,16 @@
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>)
+<b>__executeCommand</b>(<i>cmd, historyIndex=None</i>)
<p>
Private slot to execute a command.
</p><dl>
-<dt><i>cmd</i></dt>
+<dt><i>cmd</i> (str)</dt>
<dd>
-command to be executed by debug client (string)
+command to be executed by debug client
+</dd><dt><i>historyIndex</i> (int)</dt>
+<dd>
+history index to be set
</dd>
</dl><a NAME="Shell.__find" ID="Shell.__find"></a>
<h4>Shell.__find</h4>
@@ -784,6 +849,21 @@
<dd>
flag indicating that the cursor is on the last line (boolean)
</dd>
+</dl><a NAME="Shell.__isHistoryIndexValid" ID="Shell.__isHistoryIndexValid"></a>
+<h4>Shell.__isHistoryIndexValid</h4>
+<b>__isHistoryIndexValid</b>(<i></i>)
+<p>
+ Private method to test, if the history index is valid.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating validity
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
</dl><a NAME="Shell.__middleMouseButton" ID="Shell.__middleMouseButton"></a>
<h4>Shell.__middleMouseButton</h4>
<b>__middleMouseButton</b>(<i></i>)
@@ -812,6 +892,11 @@
<b>__resetAndClear</b>(<i></i>)
<p>
Private slot to handle the 'reset and clear' context menu entry.
+</p><a NAME="Shell.__resetIncrementalHistorySearch" ID="Shell.__resetIncrementalHistorySearch"></a>
+<h4>Shell.__resetIncrementalHistorySearch</h4>
+<b>__resetIncrementalHistorySearch</b>(<i></i>)
+<p>
+ Private method to reset the incremental history search.
</p><a NAME="Shell.__resizeLinenoMargin" ID="Shell.__resizeLinenoMargin"></a>
<h4>Shell.__resizeLinenoMargin</h4>
<b>__resizeLinenoMargin</b>(<i></i>)
@@ -823,17 +908,23 @@
<p>
Private method used to reverse search the history.
</p><dl>
-<dt><i>txt</i></dt>
+<dt><i>txt</i> (str)</dt>
<dd>
-text to match at the beginning (string)
-</dd><dt><i>startIdx</i></dt>
+text to match at the beginning
+</dd><dt><i>startIdx</i> (int)</dt>
<dd>
-index to start search from (integer)
+index to start search from
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-index of found entry (integer)
+tuple containing the index of found entry and a flag indicating
+ that something was found
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (int, bool)
</dd>
</dl><a NAME="Shell.__searchHistory" ID="Shell.__searchHistory"></a>
<h4>Shell.__searchHistory</h4>
@@ -841,17 +932,23 @@
<p>
Private method used to search the history.
</p><dl>
-<dt><i>txt</i></dt>
+<dt><i>txt</i> (str)</dt>
<dd>
-text to match at the beginning (string)
-</dd><dt><i>startIdx</i></dt>
+text to match at the beginning
+</dd><dt><i>startIdx</i> (int)</dt>
<dd>
-index to start search from (integer)
+index to start search from
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-index of found entry (integer)
+tuple containing the index of found entry and a flag indicating
+ that something was found
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (int, bool)
</dd>
</dl><a NAME="Shell.__searchNext" ID="Shell.__searchNext"></a>
<h4>Shell.__searchNext</h4>
@@ -883,6 +980,16 @@
<dd>
of the calltips set to set (string)
</dd>
+</dl><a NAME="Shell.__setHistoryIndex" ID="Shell.__setHistoryIndex"></a>
+<h4>Shell.__setHistoryIndex</h4>
+<b>__setHistoryIndex</b>(<i>index=None</i>)
+<p>
+ Private method to set the initial history index.
+</p><dl>
+<dt><i>index</i> (int or None)</dt>
+<dd>
+index value to be set
+</dd>
</dl><a NAME="Shell.__setMargin0" ID="Shell.__setMargin0"></a>
<h4>Shell.__setMargin0</h4>
<b>__setMargin0</b>(<i></i>)
@@ -903,6 +1010,11 @@
<b>__setTextDisplay</b>(<i></i>)
<p>
Private method to configure the text display.
+</p><a NAME="Shell.__setupCursorKeys" ID="Shell.__setupCursorKeys"></a>
+<h4>Shell.__setupCursorKeys</h4>
+<b>__setupCursorKeys</b>(<i></i>)
+<p>
+ Private method to setup the cursor up and down mode.
</p><a NAME="Shell.__showCompletions" ID="Shell.__showCompletions"></a>
<h4>Shell.__showCompletions</h4>
<b>__showCompletions</b>(<i>completions, text</i>)
@@ -1085,14 +1197,17 @@
</dd>
</dl><a NAME="Shell.executeLines" ID="Shell.executeLines"></a>
<h4>Shell.executeLines</h4>
-<b>executeLines</b>(<i>lines</i>)
+<b>executeLines</b>(<i>lines, historyIndex=None</i>)
<p>
Public method to execute a set of lines as multiple commands.
</p><dl>
-<dt><i>lines</i></dt>
+<dt><i>lines</i> (str)</dt>
<dd>
-multiple lines of text to be executed as single
- commands (string)
+multiple lines of text to be executed as
+ single commands
+</dd><dt><i>historyIndex</i> (int)</dt>
+<dd>
+history index to be set
</dd>
</dl><a NAME="Shell.focusInEvent" ID="Shell.focusInEvent"></a>
<h4>Shell.focusInEvent</h4>
@@ -1168,12 +1283,42 @@
<dd>
reference to the history list (list of strings)
</dd>
+</dl><a NAME="Shell.getHistoryIndex" ID="Shell.getHistoryIndex"></a>
+<h4>Shell.getHistoryIndex</h4>
+<b>getHistoryIndex</b>(<i></i>)
+<p>
+ Public method to get the current value of the history index.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+history index
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+int
+</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>
+</p><a NAME="Shell.historyStyle" ID="Shell.historyStyle"></a>
+<h4>Shell.historyStyle</h4>
+<b>historyStyle</b>(<i></i>)
+<p>
+ Public method to get the shell history style.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+shell history style
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+ShellHistoryStyle
+</dd>
+</dl><a NAME="Shell.insert" ID="Shell.insert"></a>
<h4>Shell.insert</h4>
<b>insert</b>(<i>txt</i>)
<p>
@@ -1185,6 +1330,21 @@
<dd>
text to be inserted (string)
</dd>
+</dl><a NAME="Shell.isHistoryEnabled" ID="Shell.isHistoryEnabled"></a>
+<h4>Shell.isHistoryEnabled</h4>
+<b>isHistoryEnabled</b>(<i></i>)
+<p>
+ Public method to check, if the history is enabled.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating if history is enabled
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
</dl><a NAME="Shell.keyPressEvent" ID="Shell.keyPressEvent"></a>
<h4>Shell.keyPressEvent</h4>
<b>keyPressEvent</b>(<i>ev</i>)
@@ -1378,5 +1538,31 @@
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="ShellHistoryStyle" ID="ShellHistoryStyle"></a>
+<h2>ShellHistoryStyle</h2>
+<p>
+ Class defining the shell history styles.
+</p>
+<h3>Derived from</h3>
+Enum
+<h3>Class Attributes</h3>
+<table>
+<tr><td>Disabled</td></tr><tr><td>LinuxStyle</td></tr><tr><td>WindowsStyle</td></tr>
+</table>
+<h3>Class Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>
\ No newline at end of file
