--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.SearchDialog.html Sun Jan 30 18:26:37 2011 +0100 @@ -0,0 +1,146 @@ +<?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>Plugin_Refactoring_Rope.RefactoringRope.SearchDialog</title> +<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>Plugin_Refactoring_Rope.RefactoringRope.SearchDialog</h1> +<p> +Module implementing the search dialog for the rope help dialog. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#SearchDialog">SearchDialog</a></td> +<td>Module implementing the search dialog for the rope help dialog.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="SearchDialog" ID="SearchDialog"></a> +<h2>SearchDialog</h2> +<p> + Module implementing the search dialog for the rope help dialog. +</p> +<h3>Derived from</h3> +QDialog, Ui_SearchDialog +<h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#SearchDialog.__init__">SearchDialog</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#SearchDialog.__findNextPrev">__findNextPrev</a></td> +<td>Private slot to find the next occurrence of text.</td> +</tr><tr> +<td><a href="#SearchDialog.findNext">findNext</a></td> +<td>Public slot to find the next occurrence.</td> +</tr><tr> +<td><a href="#SearchDialog.findPrevious">findPrevious</a></td> +<td>Public slot to find the previous occurrence.</td> +</tr><tr> +<td><a href="#SearchDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> +<td>Private slot called by a button of the button box clicked.</td> +</tr><tr> +<td><a href="#SearchDialog.on_findButton_clicked">on_findButton_clicked</a></td> +<td>Private slot to find the entered text in the displayed page.</td> +</tr><tr> +<td><a href="#SearchDialog.on_findtextCombo_editTextChanged">on_findtextCombo_editTextChanged</a></td> +<td>Private slot to enable/disable the find buttons.</td> +</tr><tr> +<td><a href="#SearchDialog.showFind">showFind</a></td> +<td>Public method to display this dialog.</td> +</tr> +</table> +<a NAME="SearchDialog.__init__" ID="SearchDialog.__init__"></a> +<h4>SearchDialog (Constructor)</h4> +<b>SearchDialog</b>(<i>parent = None, name = "", fl = Qt.WindowFlags(Qt.Widget)</i>) +<p> + Constructor +</p><dl> +<dt><i>parent</i></dt> +<dd> +parent widget of this dialog (QWidget) +</dd><dt><i>name</i></dt> +<dd> +object name of the dialog (string) +</dd><dt><i>fl</i></dt> +<dd> +window flags +</dd> +</dl><a NAME="SearchDialog.__findNextPrev" ID="SearchDialog.__findNextPrev"></a> +<h4>SearchDialog.__findNextPrev</h4> +<b>__findNextPrev</b>(<i>backwards</i>) +<p> + Private slot to find the next occurrence of text. +</p><dl> +<dt><i>backwards</i></dt> +<dd> +flag indicating a backwards search (boolean) +</dd> +</dl><a NAME="SearchDialog.findNext" ID="SearchDialog.findNext"></a> +<h4>SearchDialog.findNext</h4> +<b>findNext</b>(<i></i>) +<p> + Public slot to find the next occurrence. +</p><a NAME="SearchDialog.findPrevious" ID="SearchDialog.findPrevious"></a> +<h4>SearchDialog.findPrevious</h4> +<b>findPrevious</b>(<i></i>) +<p> + Public slot to find the previous occurrence. +</p><a NAME="SearchDialog.on_buttonBox_clicked" ID="SearchDialog.on_buttonBox_clicked"></a> +<h4>SearchDialog.on_buttonBox_clicked</h4> +<b>on_buttonBox_clicked</b>(<i>button</i>) +<p> + Private slot called by a button of the button box clicked. +</p><dl> +<dt><i>button</i></dt> +<dd> +button that was clicked (QAbstractButton) +</dd> +</dl><a NAME="SearchDialog.on_findButton_clicked" ID="SearchDialog.on_findButton_clicked"></a> +<h4>SearchDialog.on_findButton_clicked</h4> +<b>on_findButton_clicked</b>(<i></i>) +<p> + Private slot to find the entered text in the displayed page. +</p><a NAME="SearchDialog.on_findtextCombo_editTextChanged" ID="SearchDialog.on_findtextCombo_editTextChanged"></a> +<h4>SearchDialog.on_findtextCombo_editTextChanged</h4> +<b>on_findtextCombo_editTextChanged</b>(<i>txt</i>) +<p> + Private slot to enable/disable the find buttons. +</p><a NAME="SearchDialog.showFind" ID="SearchDialog.showFind"></a> +<h4>SearchDialog.showFind</h4> +<b>showFind</b>(<i></i>) +<p> + Public method to display this dialog. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file