Documentation/Source/eric6.UI.SearchWidget.html

changeset 3673
e26d7d0c1088
child 5711
50b6867ffcd3
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric6.UI.SearchWidget.html	Sat Jul 05 12:29:15 2014 +0200
@@ -0,0 +1,197 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric6.UI.SearchWidget</title>
+<meta charset="UTF-8">
+<style>
+body {
+    background: #EDECE6;
+    margin: 0em 1em 10em 1em;
+    color: black;
+}
+
+h1 { color: white; background: #85774A; }
+h2 { color: white; background: #85774A; }
+h3 { color: white; background: #9D936E; }
+h4 { color: white; background: #9D936E; }
+    
+a { color: #BA6D36; }
+
+</style>
+</head>
+<body><a NAME="top" ID="top"></a>
+<h1>eric6.UI.SearchWidget</h1>
+<p>
+Module implementing the search box for the shell, terminal and log viewer.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#SearchWidget">SearchWidget</a></td>
+<td>Class implementing the search box for the shell, terminal and log viewer.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr /><hr />
+<a NAME="SearchWidget" ID="SearchWidget"></a>
+<h2>SearchWidget</h2>
+<p>
+    Class implementing the search box for the shell, terminal and log viewer.
+</p><h3>Signals</h3>
+<dl>
+<dt>searchNext(text, caseSensitive, wholeWord)</dt>
+<dd>
+emitted when the user
+        pressed the next button (string, boolean, boolean)
+</dd><dt>searchPrevious(text, caseSensitive, wholeWord)</dt>
+<dd>
+emitted when the
+        user pressed the previous button (string, boolean, boolean)
+</dd>
+</dl>
+<h3>Derived from</h3>
+QWidget, Ui_SearchWidget
+<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="#SearchWidget.__init__">SearchWidget</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#SearchWidget.__findByReturnPressed">__findByReturnPressed</a></td>
+<td>Private slot to handle the returnPressed signal of the findtext combobox.</td>
+</tr><tr>
+<td><a href="#SearchWidget.__setSearchButtons">__setSearchButtons</a></td>
+<td>Private slot to set the state of the search buttons.</td>
+</tr><tr>
+<td><a href="#SearchWidget.keyPressEvent">keyPressEvent</a></td>
+<td>Protected slot to handle key press events.</td>
+</tr><tr>
+<td><a href="#SearchWidget.on_closeButton_clicked">on_closeButton_clicked</a></td>
+<td>Private slot to close the widget.</td>
+</tr><tr>
+<td><a href="#SearchWidget.on_findNextButton_clicked">on_findNextButton_clicked</a></td>
+<td>Private slot to find the next occurrence.</td>
+</tr><tr>
+<td><a href="#SearchWidget.on_findPrevButton_clicked">on_findPrevButton_clicked</a></td>
+<td>Private slot to find the previous occurrence.</td>
+</tr><tr>
+<td><a href="#SearchWidget.on_findtextCombo_editTextChanged">on_findtextCombo_editTextChanged</a></td>
+<td>Private slot to enable/disable the find buttons.</td>
+</tr><tr>
+<td><a href="#SearchWidget.searchStringFound">searchStringFound</a></td>
+<td>Public slot to indicate that the search string was found.</td>
+</tr><tr>
+<td><a href="#SearchWidget.showFind">showFind</a></td>
+<td>Public method to display this widget.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<a NAME="SearchWidget.__init__" ID="SearchWidget.__init__"></a>
+<h4>SearchWidget (Constructor)</h4>
+<b>SearchWidget</b>(<i>mainWindow, parent=None, spacer=True</i>)
+<p>
+        Constructor
+</p><dl>
+<dt><i>mainWindow</i></dt>
+<dd>
+reference to the main window (QWidget)
+</dd><dt><i>parent</i></dt>
+<dd>
+reference to the parent widget (QWidget)
+</dd><dt><i>spacer</i></dt>
+<dd>
+flag indicating to add a vertical spacer to the
+            main layout (boolean)
+</dd>
+</dl><a NAME="SearchWidget.__findByReturnPressed" ID="SearchWidget.__findByReturnPressed"></a>
+<h4>SearchWidget.__findByReturnPressed</h4>
+<b>__findByReturnPressed</b>(<i></i>)
+<p>
+        Private slot to handle the returnPressed signal of the findtext
+        combobox.
+</p><a NAME="SearchWidget.__setSearchButtons" ID="SearchWidget.__setSearchButtons"></a>
+<h4>SearchWidget.__setSearchButtons</h4>
+<b>__setSearchButtons</b>(<i>enabled</i>)
+<p>
+        Private slot to set the state of the search buttons.
+</p><dl>
+<dt><i>enabled</i></dt>
+<dd>
+flag indicating the state (boolean)
+</dd>
+</dl><a NAME="SearchWidget.keyPressEvent" ID="SearchWidget.keyPressEvent"></a>
+<h4>SearchWidget.keyPressEvent</h4>
+<b>keyPressEvent</b>(<i>event</i>)
+<p>
+        Protected slot to handle key press events.
+</p><dl>
+<dt><i>event</i></dt>
+<dd>
+reference to the key press event (QKeyEvent)
+</dd>
+</dl><a NAME="SearchWidget.on_closeButton_clicked" ID="SearchWidget.on_closeButton_clicked"></a>
+<h4>SearchWidget.on_closeButton_clicked</h4>
+<b>on_closeButton_clicked</b>(<i></i>)
+<p>
+        Private slot to close the widget.
+</p><a NAME="SearchWidget.on_findNextButton_clicked" ID="SearchWidget.on_findNextButton_clicked"></a>
+<h4>SearchWidget.on_findNextButton_clicked</h4>
+<b>on_findNextButton_clicked</b>(<i></i>)
+<p>
+        Private slot to find the next occurrence.
+</p><a NAME="SearchWidget.on_findPrevButton_clicked" ID="SearchWidget.on_findPrevButton_clicked"></a>
+<h4>SearchWidget.on_findPrevButton_clicked</h4>
+<b>on_findPrevButton_clicked</b>(<i></i>)
+<p>
+        Private slot to find the previous occurrence.
+</p><a NAME="SearchWidget.on_findtextCombo_editTextChanged" ID="SearchWidget.on_findtextCombo_editTextChanged"></a>
+<h4>SearchWidget.on_findtextCombo_editTextChanged</h4>
+<b>on_findtextCombo_editTextChanged</b>(<i>txt</i>)
+<p>
+        Private slot to enable/disable the find buttons.
+</p><dl>
+<dt><i>txt</i></dt>
+<dd>
+text of the combobox (string)
+</dd>
+</dl><a NAME="SearchWidget.searchStringFound" ID="SearchWidget.searchStringFound"></a>
+<h4>SearchWidget.searchStringFound</h4>
+<b>searchStringFound</b>(<i>found</i>)
+<p>
+        Public slot to indicate that the search string was found.
+</p><dl>
+<dt><i>found</i></dt>
+<dd>
+flag indicating success (boolean)
+</dd>
+</dl><a NAME="SearchWidget.showFind" ID="SearchWidget.showFind"></a>
+<h4>SearchWidget.showFind</h4>
+<b>showFind</b>(<i>txt=""</i>)
+<p>
+        Public method to display this 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