--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.HelpDialog.html Sun Jan 30 18:26:37 2011 +0100 @@ -0,0 +1,128 @@ +<?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.HelpDialog</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.HelpDialog</h1> +<p> +Module implementing a dialog to show help about rope. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#HelpDialog">HelpDialog</a></td> +<td>Class implementing a dialog to show help about rope.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="HelpDialog" ID="HelpDialog"></a> +<h2>HelpDialog</h2> +<p> + Class implementing a dialog to show help about rope. +</p> +<h3>Derived from</h3> +QDialog, Ui_HelpDialog +<h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#HelpDialog.__init__">HelpDialog</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#HelpDialog.findNextPrev">findNextPrev</a></td> +<td>Public slot to find the next occurrence of a text.</td> +</tr><tr> +<td><a href="#HelpDialog.helpWidget">helpWidget</a></td> +<td>Public method to get a reference to the help widget.</td> +</tr><tr> +<td><a href="#HelpDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> +<td>Private slot called by a button of the button box clicked.</td> +</tr> +</table> +<a NAME="HelpDialog.__init__" ID="HelpDialog.__init__"></a> +<h4>HelpDialog (Constructor)</h4> +<b>HelpDialog</b>(<i>title, helpfile, parent = None</i>) +<p> + Constructor +</p><dl> +<dt><i>title</i></dt> +<dd> +window title (string) +</dd><dt><i>helpfile</i></dt> +<dd> +filename of the helpfile (string) +</dd><dt><i>parent</i></dt> +<dd> +reference to the parent widget (QWidget) +</dd> +</dl><a NAME="HelpDialog.findNextPrev" ID="HelpDialog.findNextPrev"></a> +<h4>HelpDialog.findNextPrev</h4> +<b>findNextPrev</b>(<i>txt, case, word, backwards</i>) +<p> + Public slot to find the next occurrence of a text. +</p><dl> +<dt><i>txt</i></dt> +<dd> +text to search for (string) +</dd><dt><i>case</i></dt> +<dd> +flag indicating a case sensitive search (boolean) +</dd><dt><i>word</i></dt> +<dd> +flag indicating a word based search (boolean) +</dd><dt><i>backwards</i></dt> +<dd> +flag indicating a backwards search (boolean) +</dd> +</dl><a NAME="HelpDialog.helpWidget" ID="HelpDialog.helpWidget"></a> +<h4>HelpDialog.helpWidget</h4> +<b>helpWidget</b>(<i></i>) +<p> + Public method to get a reference to the help widget. +</p><dl> +<dt>Returns:</dt> +<dd> +reference to the help widget (QTextEdit) +</dd> +</dl><a NAME="HelpDialog.on_buttonBox_clicked" ID="HelpDialog.on_buttonBox_clicked"></a> +<h4>HelpDialog.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> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file