RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.HelpDialog.html

changeset 321
d51e810107ec
parent 204
b4bf79b956bc
child 347
b5048b5ff454
--- a/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.HelpDialog.html	Fri Oct 11 19:05:23 2019 +0200
+++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.HelpDialog.html	Fri Oct 11 19:05:59 2019 +0200
@@ -18,128 +18,167 @@
 
 </style>
 </head>
-<body><a NAME="top" ID="top"></a>
+<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 />
+<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>Class Methods</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>
+</tr>
+<tr>
 <td><a href="#HelpDialog.findNextPrev">findNextPrev</a></td>
 <td>Public slot to find the next occurrence of a text.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#HelpDialog.helpWidget">helpWidget</a></td>
 <td>Public method to get a reference to the help widget.</td>
-</tr><tr>
+</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>
 <h3>Static Methods</h3>
+
 <table>
 <tr><td>None</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>
+</p>
+<dl>
+
 <dt><i>title</i> (str)</dt>
 <dd>
 window title
-</dd><dt><i>helpfile</i> (str)</dt>
+</dd>
+<dt><i>helpfile</i> (str)</dt>
 <dd>
 filename of the helpfile
-</dd><dt><i>parent</i> (QWidget)</dt>
+</dd>
+<dt><i>parent</i> (QWidget)</dt>
 <dd>
 reference to the parent widget
 </dd>
-</dl><a NAME="HelpDialog.findNextPrev" ID="HelpDialog.findNextPrev"></a>
+</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>
+</p>
+<dl>
+
 <dt><i>txt</i> (str)</dt>
 <dd>
 text to search for
-</dd><dt><i>case</i> (bool)</dt>
+</dd>
+<dt><i>case</i> (bool)</dt>
 <dd>
 flag indicating a case sensitive search
-</dd><dt><i>word</i> (bool)</dt>
+</dd>
+<dt><i>word</i> (bool)</dt>
 <dd>
 flag indicating a word based search
-</dd><dt><i>backwards</i> (bool)</dt>
+</dd>
+<dt><i>backwards</i> (bool)</dt>
 <dd>
 flag indicating a backwards search
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Returns:</dt>
 <dd>
 flag indicating the search found another occurrence
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Return Type:</dt>
 <dd>
 bool
 </dd>
-</dl><a NAME="HelpDialog.helpWidget" ID="HelpDialog.helpWidget"></a>
+</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>
+</p>
+<dl>
 <dt>Returns:</dt>
 <dd>
 reference to the help widget
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Return Type:</dt>
 <dd>
 QTextEdit
 </dd>
-</dl><a NAME="HelpDialog.on_buttonBox_clicked" ID="HelpDialog.on_buttonBox_clicked"></a>
+</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>
+</p>
+<dl>
+
 <dt><i>button</i> (QAbstractButton)</dt>
 <dd>
 button that was clicked

eric ide

mercurial