diff -r c38750e1bafd -r b4bf79b956bc RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.UseFunctionDialog.html
--- a/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.UseFunctionDialog.html Fri Sep 29 10:23:35 2017 +0200
+++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.UseFunctionDialog.html Fri Sep 29 10:32:30 2017 +0200
@@ -21,7 +21,7 @@
<body><a NAME="top" ID="top"></a>
<h1>Plugin_Refactoring_Rope.RefactoringRope.UseFunctionDialog</h1>
<p>
-Module implementing the Inline dialog.
+Module implementing the Use Function dialog.
</p>
<h3>Global Attributes</h3>
<table>
@@ -31,7 +31,7 @@
<table>
<tr>
<td><a href="#UseFunctionDialog">UseFunctionDialog</a></td>
-<td>Class implementing the Inline dialog.</td>
+<td>Class implementing the Use Function dialog.</td>
</tr>
</table>
<h3>Functions</h3>
@@ -42,7 +42,7 @@
<a NAME="UseFunctionDialog" ID="UseFunctionDialog"></a>
<h2>UseFunctionDialog</h2>
<p>
- Class implementing the Inline dialog.
+ Class implementing the Use Function dialog.
</p>
<h3>Derived from</h3>
RefactoringDialogBase, Ui_UseFunctionDialog
@@ -60,11 +60,17 @@
<td><a href="#UseFunctionDialog.__init__">UseFunctionDialog</a></td>
<td>Constructor</td>
</tr><tr>
+<td><a href="#UseFunctionDialog.__processUseFunctionName">__processUseFunctionName</a></td>
+<td>Private method to process the function name data sent by the refactoring client in order to polish the dialog.</td>
+</tr><tr>
<td><a href="#UseFunctionDialog._calculateChanges">_calculateChanges</a></td>
-<td>Protected method to calculate the changes.</td>
+<td>Protected method to initiate the calculation of the changes.</td>
</tr><tr>
<td><a href="#UseFunctionDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
<td>Private slot to act on the button pressed.</td>
+</tr><tr>
+<td><a href="#UseFunctionDialog.processChangeData">processChangeData</a></td>
+<td>Public method to process the change data sent by the refactoring client.</td>
</tr>
</table>
<h3>Static Methods</h3>
@@ -73,50 +79,62 @@
</table>
<a NAME="UseFunctionDialog.__init__" ID="UseFunctionDialog.__init__"></a>
<h4>UseFunctionDialog (Constructor)</h4>
-<b>UseFunctionDialog</b>(<i>refactoring, title, user, parent=None</i>)
+<b>UseFunctionDialog</b>(<i>refactoring, title, filename, offset, parent=None</i>)
<p>
Constructor
</p><dl>
-<dt><i>refactoring</i></dt>
+<dt><i>refactoring</i> (RefactoringServer)</dt>
<dd>
reference to the main refactoring object
- (Refactoring)
-</dd><dt><i>title</i></dt>
+</dd><dt><i>title</i> (str)</dt>
+<dd>
+title of the dialog
+</dd><dt><i>filename</i> (str)</dt>
<dd>
-title of the dialog (string)
-</dd><dt><i>user</i></dt>
+file name to be worked on
+</dd><dt><i>offset</i> (int or None)</dt>
+<dd>
+offset within file
+</dd><dt><i>parent</i> (QWidget)</dt>
<dd>
-reference to the usefunction object
- (rope.refactor.usefunction.UseFunction)
-</dd><dt><i>parent</i></dt>
+reference to the parent widget
+</dd>
+</dl><a NAME="UseFunctionDialog.__processUseFunctionName" ID="UseFunctionDialog.__processUseFunctionName"></a>
+<h4>UseFunctionDialog.__processUseFunctionName</h4>
+<b>__processUseFunctionName</b>(<i>data</i>)
+<p>
+ Private method to process the function name data sent by the
+ refactoring client in order to polish the dialog.
+</p><dl>
+<dt><i>data</i> (dict)</dt>
<dd>
-reference to the parent widget (QWidget)
+dictionary containing the inline type data
</dd>
</dl><a NAME="UseFunctionDialog._calculateChanges" ID="UseFunctionDialog._calculateChanges"></a>
<h4>UseFunctionDialog._calculateChanges</h4>
-<b>_calculateChanges</b>(<i>handle</i>)
+<b>_calculateChanges</b>(<i></i>)
<p>
- Protected method to calculate the changes.
-</p><dl>
-<dt><i>handle</i></dt>
-<dd>
-reference to the task handle
- (rope.base.taskhandle.TaskHandle)
-</dd>
-</dl><dl>
-<dt>Returns:</dt>
-<dd>
-reference to the Changes object (rope.base.change.ChangeSet)
-</dd>
-</dl><a NAME="UseFunctionDialog.on_buttonBox_clicked" ID="UseFunctionDialog.on_buttonBox_clicked"></a>
+ Protected method to initiate the calculation of the changes.
+</p><a NAME="UseFunctionDialog.on_buttonBox_clicked" ID="UseFunctionDialog.on_buttonBox_clicked"></a>
<h4>UseFunctionDialog.on_buttonBox_clicked</h4>
<b>on_buttonBox_clicked</b>(<i>button</i>)
<p>
Private slot to act on the button pressed.
</p><dl>
-<dt><i>button</i></dt>
+<dt><i>button</i> (QAbstractButton)</dt>
<dd>
-reference to the button pressed (QAbstractButton)
+reference to the button pressed
+</dd>
+</dl><a NAME="UseFunctionDialog.processChangeData" ID="UseFunctionDialog.processChangeData"></a>
+<h4>UseFunctionDialog.processChangeData</h4>
+<b>processChangeData</b>(<i>data</i>)
+<p>
+ Public method to process the change data sent by the refactoring
+ client.
+</p><dl>
+<dt><i>data</i> (dict)</dt>
+<dd>
+dictionary containing the change data
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
