Documentation/Source/eric5.QScintilla.Shell.html

changeset 1833
f7cd855680f1
parent 1518
e6e21910210d
child 2367
78f6c8193d37
diff -r 2dd263d670ca -r f7cd855680f1 Documentation/Source/eric5.QScintilla.Shell.html
--- a/Documentation/Source/eric5.QScintilla.Shell.html	Wed May 02 19:10:17 2012 +0200
+++ b/Documentation/Source/eric5.QScintilla.Shell.html	Fri May 04 20:06:17 2012 +0200
@@ -33,6 +33,9 @@
 <tr>
 <td><a href="#Shell">Shell</a></td>
 <td>Class implementing a graphical Python shell.</td>
+</tr><tr>
+<td><a href="#ShellAssembly">ShellAssembly</a></td>
+<td>Class implementing the containing widget for the shell.</td>
 </tr>
 </table>
 <h3>Functions</h3>
@@ -47,7 +50,13 @@
 </p><p>
     A user can enter commands that are executed in the remote
     Python interpreter.
-</p>
+</p><h3>Signals</h3>
+<dl>
+<dt>searchStringFound(found)</dt>
+<dd>
+emitted to indicate the search result (boolean)
+</dd>
+</dl>
 <h3>Derived from</h3>
 QsciScintillaCompat
 <h3>Class Attributes</h3>
@@ -160,6 +169,9 @@
 <td><a href="#Shell.__executeCommand">__executeCommand</a></td>
 <td>Private slot to execute a command.</td>
 </tr><tr>
+<td><a href="#Shell.__find">__find</a></td>
+<td>Private slot to show the find widget.</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>
@@ -202,6 +214,12 @@
 <td><a href="#Shell.__searchHistory">__searchHistory</a></td>
 <td>Private method used to search the history.</td>
 </tr><tr>
+<td><a href="#Shell.__searchNext">__searchNext</a></td>
+<td>Private method to search for the next occurrence.</td>
+</tr><tr>
+<td><a href="#Shell.__searchPrev">__searchPrev</a></td>
+<td>Private method to search for the next occurrence.</td>
+</tr><tr>
 <td><a href="#Shell.__selectHistory">__selectHistory</a></td>
 <td>Private slot to select a history entry to execute.</td>
 </tr><tr>
@@ -319,6 +337,12 @@
 <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.searchNext">searchNext</a></td>
+<td>Public method to search the next occurrence of the given text.</td>
+</tr><tr>
+<td><a href="#Shell.searchPrev">searchPrev</a></td>
+<td>Public method to search the previous occurrence of the given text.</td>
+</tr><tr>
 <td><a href="#Shell.setDebuggerUI">setDebuggerUI</a></td>
 <td>Public method to set the debugger UI.</td>
 </tr><tr>
@@ -591,7 +615,12 @@
 <dd>
 command to be executed by debug client (string)
 </dd>
-</dl><a NAME="Shell.__getBanner" ID="Shell.__getBanner"></a>
+</dl><a NAME="Shell.__find" ID="Shell.__find"></a>
+<h4>Shell.__find</h4>
+<b>__find</b>(<i></i>)
+<p>
+        Private slot to show the find widget.
+</p><a NAME="Shell.__getBanner" ID="Shell.__getBanner"></a>
 <h4>Shell.__getBanner</h4>
 <b>__getBanner</b>(<i></i>)
 <p>
@@ -723,7 +752,17 @@
 <dd>
 index of found entry (integer)
 </dd>
-</dl><a NAME="Shell.__selectHistory" ID="Shell.__selectHistory"></a>
+</dl><a NAME="Shell.__searchNext" ID="Shell.__searchNext"></a>
+<h4>Shell.__searchNext</h4>
+<b>__searchNext</b>(<i></i>)
+<p>
+        Private method to search for the next occurrence.
+</p><a NAME="Shell.__searchPrev" ID="Shell.__searchPrev"></a>
+<h4>Shell.__searchPrev</h4>
+<b>__searchPrev</b>(<i></i>)
+<p>
+        Private method to search for the next occurrence.
+</p><a NAME="Shell.__selectHistory" ID="Shell.__selectHistory"></a>
 <h4>Shell.__selectHistory</h4>
 <b>__selectHistory</b>(<i></i>)
 <p>
@@ -1089,6 +1128,42 @@
 <dd>
 type of the debug client (string)
 </dd>
+</dl><a NAME="Shell.searchNext" ID="Shell.searchNext"></a>
+<h4>Shell.searchNext</h4>
+<b>searchNext</b>(<i>txt, caseSensitive, wholeWord</i>)
+<p>
+        Public method to search the next occurrence of the given text.
+</p><dl>
+<dt><i>txt</i></dt>
+<dd>
+text to search for (string)
+</dd><dt><i>caseSensitive</i></dt>
+<dd>
+flag indicating to perform a case sensitive
+            search (boolean)
+</dd><dt><i>wholeWord</i></dt>
+<dd>
+flag indicating to search for whole words
+            only (boolean)
+</dd>
+</dl><a NAME="Shell.searchPrev" ID="Shell.searchPrev"></a>
+<h4>Shell.searchPrev</h4>
+<b>searchPrev</b>(<i>txt, caseSensitive, wholeWord</i>)
+<p>
+        Public method to search the previous occurrence of the given text.
+</p><dl>
+<dt><i>txt</i></dt>
+<dd>
+text to search for (string)
+</dd><dt><i>caseSensitive</i></dt>
+<dd>
+flag indicating to perform a case sensitive
+            search (boolean)
+</dd><dt><i>wholeWord</i></dt>
+<dd>
+flag indicating to search for whole words
+            only (boolean)
+</dd>
 </dl><a NAME="Shell.setDebuggerUI" ID="Shell.setDebuggerUI"></a>
 <h4>Shell.setDebuggerUI</h4>
 <b>setDebuggerUI</b>(<i>ui</i>)
@@ -1111,5 +1186,79 @@
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="ShellAssembly" ID="ShellAssembly"></a>
+<h2>ShellAssembly</h2>
+<p>
+    Class implementing the containing widget for the shell.
+</p>
+<h3>Derived from</h3>
+QWidget
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Class Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#ShellAssembly.__init__">ShellAssembly</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#ShellAssembly.shell">shell</a></td>
+<td>Public method to get a reference to the terminal widget.</td>
+</tr><tr>
+<td><a href="#ShellAssembly.showFind">showFind</a></td>
+<td>Public method to display the search widget.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<a NAME="ShellAssembly.__init__" ID="ShellAssembly.__init__"></a>
+<h4>ShellAssembly (Constructor)</h4>
+<b>ShellAssembly</b>(<i>dbs, vm, horizontal=True, 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>horizontal</i></dt>
+<dd>
+flag indicating a horizontal layout (boolean)
+</dd><dt><i>parent</i></dt>
+<dd>
+parent widget (QWidget)
+</dd>
+</dl><a NAME="ShellAssembly.shell" ID="ShellAssembly.shell"></a>
+<h4>ShellAssembly.shell</h4>
+<b>shell</b>(<i></i>)
+<p>
+        Public method to get a reference to the terminal widget.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+reference to the terminal widget (Terminal)
+</dd>
+</dl><a NAME="ShellAssembly.showFind" ID="ShellAssembly.showFind"></a>
+<h4>ShellAssembly.showFind</h4>
+<b>showFind</b>(<i>txt=""</i>)
+<p>
+        Public method to display the search widget.
+</p><dl>
+<dt><i>txt</i></dt>
+<dd>
+text to be shown in the combo (string)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
 <hr />
 </body></html>
\ No newline at end of file

eric ide

mercurial