--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Documentation/Source/eric5.QScintilla.SearchReplaceWidget.html Sat Jan 02 18:19:35 2010 +0000 @@ -0,0 +1,253 @@ +<?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.SearchReplaceWidget</title> +<style> +b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' +</style> +</head> +<body><a NAME="top" ID="top"></a> +<h1>eric5.QScintilla.SearchReplaceWidget</h1> +<p> +Module implementing the search and replace widget. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#SearchReplaceWidget">SearchReplaceWidget</a></td> +<td>Class implementing the search and replace widget.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="SearchReplaceWidget" ID="SearchReplaceWidget"></a> +<h2>SearchReplaceWidget</h2> +<p> + Class implementing the search and replace widget. +</p><h4>Signals</h4> +<dl> +<dt>searchListChanged</dt> +<dd> +emitted to indicate a change of the search list +</dd> +</dl> +<h3>Derived from</h3> +QWidget +<h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#SearchReplaceWidget.__init__">SearchReplaceWidget</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#SearchReplaceWidget.__findByReturnPressed">__findByReturnPressed</a></td> +<td>Private slot to handle the returnPressed signal of the findtext combobox.</td> +</tr><tr> +<td><a href="#SearchReplaceWidget.__findNextPrev">__findNextPrev</a></td> +<td>Private method to find the next occurrence of the search text.</td> +</tr><tr> +<td><a href="#SearchReplaceWidget.__markOccurrences">__markOccurrences</a></td> +<td>Private method to mark all occurrences of the search text.</td> +</tr><tr> +<td><a href="#SearchReplaceWidget.__showFind">__showFind</a></td> +<td>Private method to display this widget in find mode.</td> +</tr><tr> +<td><a href="#SearchReplaceWidget.__showReplace">__showReplace</a></td> +<td>Private slot to display this widget in replace mode.</td> +</tr><tr> +<td><a href="#SearchReplaceWidget.findNext">findNext</a></td> +<td>Public slot to find the next occurrence of text.</td> +</tr><tr> +<td><a href="#SearchReplaceWidget.findPrev">findPrev</a></td> +<td>Public slot to find the next previous of text.</td> +</tr><tr> +<td><a href="#SearchReplaceWidget.keyPressEvent">keyPressEvent</a></td> +<td>Protected slot to handle key press events.</td> +</tr><tr> +<td><a href="#SearchReplaceWidget.on_closeButton_clicked">on_closeButton_clicked</a></td> +<td>Private slot to close the widget.</td> +</tr><tr> +<td><a href="#SearchReplaceWidget.on_findNextButton_clicked">on_findNextButton_clicked</a></td> +<td>Private slot to find the next occurrence of text.</td> +</tr><tr> +<td><a href="#SearchReplaceWidget.on_findPrevButton_clicked">on_findPrevButton_clicked</a></td> +<td>Private slot to find the previous occurrence of text.</td> +</tr><tr> +<td><a href="#SearchReplaceWidget.on_findtextCombo_editTextChanged">on_findtextCombo_editTextChanged</a></td> +<td>Private slot to enable/disable the find buttons.</td> +</tr><tr> +<td><a href="#SearchReplaceWidget.on_replaceAllButton_clicked">on_replaceAllButton_clicked</a></td> +<td>Private slot to replace all occurrences of text.</td> +</tr><tr> +<td><a href="#SearchReplaceWidget.on_replaceButton_clicked">on_replaceButton_clicked</a></td> +<td>Private slot to replace one occurrence of text.</td> +</tr><tr> +<td><a href="#SearchReplaceWidget.selectionChanged">selectionChanged</a></td> +<td>Public slot tracking changes of selected text.</td> +</tr><tr> +<td><a href="#SearchReplaceWidget.show">show</a></td> +<td>Overridden slot from QWidget.</td> +</tr><tr> +<td><a href="#SearchReplaceWidget.updateSelectionCheckBox">updateSelectionCheckBox</a></td> +<td>Public slot to update the selection check box.</td> +</tr> +</table> +<a NAME="SearchReplaceWidget.__init__" ID="SearchReplaceWidget.__init__"></a> +<h4>SearchReplaceWidget (Constructor)</h4> +<b>SearchReplaceWidget</b>(<i>replace, vm, parent = None</i>) +<p> + Constructor +</p><dl> +<dt><i>replace</i></dt> +<dd> +flag indicating a replace widget is called +</dd><dt><i>vm</i></dt> +<dd> +reference to the viewmanager object +</dd><dt><i>parent</i></dt> +<dd> +parent widget of this widget (QWidget) +</dd> +</dl><a NAME="SearchReplaceWidget.__findByReturnPressed" ID="SearchReplaceWidget.__findByReturnPressed"></a> +<h4>SearchReplaceWidget.__findByReturnPressed</h4> +<b>__findByReturnPressed</b>(<i></i>) +<p> + Private slot to handle the returnPressed signal of the findtext combobox. +</p><a NAME="SearchReplaceWidget.__findNextPrev" ID="SearchReplaceWidget.__findNextPrev"></a> +<h4>SearchReplaceWidget.__findNextPrev</h4> +<b>__findNextPrev</b>(<i>txt, backwards</i>) +<p> + Private method to find the next occurrence of the search text. +</p><dl> +<dt><i>txt</i></dt> +<dd> +text to search for (string) +</dd><dt><i>backwards</i></dt> +<dd> +flag indicating a backwards search (boolean) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +flag indicating success (boolean) +</dd> +</dl><a NAME="SearchReplaceWidget.__markOccurrences" ID="SearchReplaceWidget.__markOccurrences"></a> +<h4>SearchReplaceWidget.__markOccurrences</h4> +<b>__markOccurrences</b>(<i>txt</i>) +<p> + Private method to mark all occurrences of the search text. +</p><dl> +<dt><i>txt</i></dt> +<dd> +text to search for (string) +</dd> +</dl><a NAME="SearchReplaceWidget.__showFind" ID="SearchReplaceWidget.__showFind"></a> +<h4>SearchReplaceWidget.__showFind</h4> +<b>__showFind</b>(<i>text = ''</i>) +<p> + Private method to display this widget in find mode. +</p><dl> +<dt><i>text</i></dt> +<dd> +text to be shown in the findtext edit (string) +</dd> +</dl><a NAME="SearchReplaceWidget.__showReplace" ID="SearchReplaceWidget.__showReplace"></a> +<h4>SearchReplaceWidget.__showReplace</h4> +<b>__showReplace</b>(<i>text=''</i>) +<p> + Private slot to display this widget in replace mode. +</p><dl> +<dt><i>text</i></dt> +<dd> +text to be shown in the findtext edit +</dd> +</dl><a NAME="SearchReplaceWidget.findNext" ID="SearchReplaceWidget.findNext"></a> +<h4>SearchReplaceWidget.findNext</h4> +<b>findNext</b>(<i></i>) +<p> + Public slot to find the next occurrence of text. +</p><a NAME="SearchReplaceWidget.findPrev" ID="SearchReplaceWidget.findPrev"></a> +<h4>SearchReplaceWidget.findPrev</h4> +<b>findPrev</b>(<i></i>) +<p> + Public slot to find the next previous of text. +</p><a NAME="SearchReplaceWidget.keyPressEvent" ID="SearchReplaceWidget.keyPressEvent"></a> +<h4>SearchReplaceWidget.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="SearchReplaceWidget.on_closeButton_clicked" ID="SearchReplaceWidget.on_closeButton_clicked"></a> +<h4>SearchReplaceWidget.on_closeButton_clicked</h4> +<b>on_closeButton_clicked</b>(<i></i>) +<p> + Private slot to close the widget. +</p><a NAME="SearchReplaceWidget.on_findNextButton_clicked" ID="SearchReplaceWidget.on_findNextButton_clicked"></a> +<h4>SearchReplaceWidget.on_findNextButton_clicked</h4> +<b>on_findNextButton_clicked</b>(<i></i>) +<p> + Private slot to find the next occurrence of text. +</p><a NAME="SearchReplaceWidget.on_findPrevButton_clicked" ID="SearchReplaceWidget.on_findPrevButton_clicked"></a> +<h4>SearchReplaceWidget.on_findPrevButton_clicked</h4> +<b>on_findPrevButton_clicked</b>(<i></i>) +<p> + Private slot to find the previous occurrence of text. +</p><a NAME="SearchReplaceWidget.on_findtextCombo_editTextChanged" ID="SearchReplaceWidget.on_findtextCombo_editTextChanged"></a> +<h4>SearchReplaceWidget.on_findtextCombo_editTextChanged</h4> +<b>on_findtextCombo_editTextChanged</b>(<i>txt</i>) +<p> + Private slot to enable/disable the find buttons. +</p><a NAME="SearchReplaceWidget.on_replaceAllButton_clicked" ID="SearchReplaceWidget.on_replaceAllButton_clicked"></a> +<h4>SearchReplaceWidget.on_replaceAllButton_clicked</h4> +<b>on_replaceAllButton_clicked</b>(<i></i>) +<p> + Private slot to replace all occurrences of text. +</p><a NAME="SearchReplaceWidget.on_replaceButton_clicked" ID="SearchReplaceWidget.on_replaceButton_clicked"></a> +<h4>SearchReplaceWidget.on_replaceButton_clicked</h4> +<b>on_replaceButton_clicked</b>(<i></i>) +<p> + Private slot to replace one occurrence of text. +</p><a NAME="SearchReplaceWidget.selectionChanged" ID="SearchReplaceWidget.selectionChanged"></a> +<h4>SearchReplaceWidget.selectionChanged</h4> +<b>selectionChanged</b>(<i></i>) +<p> + Public slot tracking changes of selected text. +</p><a NAME="SearchReplaceWidget.show" ID="SearchReplaceWidget.show"></a> +<h4>SearchReplaceWidget.show</h4> +<b>show</b>(<i>text = ''</i>) +<p> + Overridden slot from QWidget. +</p><dl> +<dt><i>text</i></dt> +<dd> +text to be shown in the findtext edit (string) +</dd> +</dl><a NAME="SearchReplaceWidget.updateSelectionCheckBox" ID="SearchReplaceWidget.updateSelectionCheckBox"></a> +<h4>SearchReplaceWidget.updateSelectionCheckBox</h4> +<b>updateSelectionCheckBox</b>(<i>editor</i>) +<p> + Public slot to update the selection check box. +</p><dl> +<dt><i>editor</i></dt> +<dd> +reference to the editor (Editor) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file