Documentation/Source/eric6.E5Gui.E5TextEditSearchWidget.html

changeset 4039
661167a99aef
child 5926
69482290dbdd
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric6.E5Gui.E5TextEditSearchWidget.html	Thu Jan 15 19:29:38 2015 +0100
@@ -0,0 +1,171 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric6.E5Gui.E5TextEditSearchWidget</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.E5Gui.E5TextEditSearchWidget</h1>
+<p>
+Module implementing a horizontal search widget for QTextEdit.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#E5TextEditSearchWidget">E5TextEditSearchWidget</a></td>
+<td>Class implementing a horizontal search widget for QTextEdit.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr /><hr />
+<a NAME="E5TextEditSearchWidget" ID="E5TextEditSearchWidget"></a>
+<h2>E5TextEditSearchWidget</h2>
+<p>
+    Class implementing a horizontal search widget for QTextEdit.
+</p>
+<h3>Derived from</h3>
+QWidget, Ui_E5TextEditSearchWidget
+<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="#E5TextEditSearchWidget.__init__">E5TextEditSearchWidget</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#E5TextEditSearchWidget.__find">__find</a></td>
+<td>Private method to search the associated text edit.</td>
+</tr><tr>
+<td><a href="#E5TextEditSearchWidget.__findByReturnPressed">__findByReturnPressed</a></td>
+<td>Private slot to handle the returnPressed signal of the findtext combobox.</td>
+</tr><tr>
+<td><a href="#E5TextEditSearchWidget.__setSearchButtons">__setSearchButtons</a></td>
+<td>Private slot to set the state of the search buttons.</td>
+</tr><tr>
+<td><a href="#E5TextEditSearchWidget.attachTextEdit">attachTextEdit</a></td>
+<td>Public method to attach a QTextEdit widget.</td>
+</tr><tr>
+<td><a href="#E5TextEditSearchWidget.keyPressEvent">keyPressEvent</a></td>
+<td>Protected slot to handle key press events.</td>
+</tr><tr>
+<td><a href="#E5TextEditSearchWidget.on_findNextButton_clicked">on_findNextButton_clicked</a></td>
+<td>Private slot to find the next occurrence.</td>
+</tr><tr>
+<td><a href="#E5TextEditSearchWidget.on_findPrevButton_clicked">on_findPrevButton_clicked</a></td>
+<td>Private slot to find the previous occurrence.</td>
+</tr><tr>
+<td><a href="#E5TextEditSearchWidget.on_findtextCombo_editTextChanged">on_findtextCombo_editTextChanged</a></td>
+<td>Private slot to enable/disable the find buttons.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<a NAME="E5TextEditSearchWidget.__init__" ID="E5TextEditSearchWidget.__init__"></a>
+<h4>E5TextEditSearchWidget (Constructor)</h4>
+<b>E5TextEditSearchWidget</b>(<i>parent=None</i>)
+<p>
+        Constructor
+</p><dl>
+<dt><i>parent</i></dt>
+<dd>
+reference to the parent widget (QWidget)
+</dd>
+</dl><a NAME="E5TextEditSearchWidget.__find" ID="E5TextEditSearchWidget.__find"></a>
+<h4>E5TextEditSearchWidget.__find</h4>
+<b>__find</b>(<i>backwards</i>)
+<p>
+        Private method to search the associated text edit.
+</p><dl>
+<dt><i>backwards</i></dt>
+<dd>
+flag indicating a backwards search (boolean)
+</dd>
+</dl><a NAME="E5TextEditSearchWidget.__findByReturnPressed" ID="E5TextEditSearchWidget.__findByReturnPressed"></a>
+<h4>E5TextEditSearchWidget.__findByReturnPressed</h4>
+<b>__findByReturnPressed</b>(<i></i>)
+<p>
+        Private slot to handle the returnPressed signal of the findtext
+        combobox.
+</p><a NAME="E5TextEditSearchWidget.__setSearchButtons" ID="E5TextEditSearchWidget.__setSearchButtons"></a>
+<h4>E5TextEditSearchWidget.__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="E5TextEditSearchWidget.attachTextEdit" ID="E5TextEditSearchWidget.attachTextEdit"></a>
+<h4>E5TextEditSearchWidget.attachTextEdit</h4>
+<b>attachTextEdit</b>(<i>textedit</i>)
+<p>
+        Public method to attach a QTextEdit widget.
+</p><dl>
+<dt><i>textedit</i></dt>
+<dd>
+reference to the QTextEdit to be attached (QTextEdit)
+</dd>
+</dl><a NAME="E5TextEditSearchWidget.keyPressEvent" ID="E5TextEditSearchWidget.keyPressEvent"></a>
+<h4>E5TextEditSearchWidget.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="E5TextEditSearchWidget.on_findNextButton_clicked" ID="E5TextEditSearchWidget.on_findNextButton_clicked"></a>
+<h4>E5TextEditSearchWidget.on_findNextButton_clicked</h4>
+<b>on_findNextButton_clicked</b>(<i></i>)
+<p>
+        Private slot to find the next occurrence.
+</p><a NAME="E5TextEditSearchWidget.on_findPrevButton_clicked" ID="E5TextEditSearchWidget.on_findPrevButton_clicked"></a>
+<h4>E5TextEditSearchWidget.on_findPrevButton_clicked</h4>
+<b>on_findPrevButton_clicked</b>(<i></i>)
+<p>
+        Private slot to find the previous occurrence.
+</p><a NAME="E5TextEditSearchWidget.on_findtextCombo_editTextChanged" ID="E5TextEditSearchWidget.on_findtextCombo_editTextChanged"></a>
+<h4>E5TextEditSearchWidget.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>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial