diff -r c38750e1bafd -r b4bf79b956bc RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.RenameDialog.html
--- a/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.RenameDialog.html Fri Sep 29 10:23:35 2017 +0200
+++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.RenameDialog.html Fri Sep 29 10:32:30 2017 +0200
@@ -64,13 +64,16 @@
<td>Private method to confirm unsure occurrences.</td>
</tr><tr>
<td><a href="#RenameDialog._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="#RenameDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
<td>Private slot to act on the button pressed.</td>
</tr><tr>
<td><a href="#RenameDialog.on_newNameEdit_textChanged">on_newNameEdit_textChanged</a></td>
<td>Private slot to react to changes of the new name.</td>
+</tr><tr>
+<td><a href="#RenameDialog.processChangeData">processChangeData</a></td>
+<td>Public method to process the change data sent by the refactoring client.</td>
</tr>
</table>
<h3>Static Methods</h3>
@@ -79,73 +82,57 @@
</table>
<a NAME="RenameDialog.__init__" ID="RenameDialog.__init__"></a>
<h4>RenameDialog (Constructor)</h4>
-<b>RenameDialog</b>(<i>refactoring, title, renamer, resource=None, selectedText='', parent=None</i>)
+<b>RenameDialog</b>(<i>refactoring, title, filename, offset, isLocal, selectedText='', 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 (string)
-</dd><dt><i>renamer</i></dt>
+title of the dialog
+</dd><dt><i>filename</i> (str)</dt>
+<dd>
+file name to be worked on
+</dd><dt><i>offset</i> (int or None)</dt>
<dd>
-reference to the renamer object
- (rope.refactor.rename.Rename)
-</dd><dt><i>resource</i></dt>
+offset within file
+</dd><dt><i>isLocal</i> (bool)</dt>
<dd>
-reference to a resource object, if the action is to
- be applied to the local file only (rope.base.resources.File)
-</dd><dt><i>selectedText</i></dt>
+flag indicating to restrict refactoring to
+ the local file
+</dd><dt><i>selectedText</i> (str)</dt>
<dd>
-selected text to rename (str)
-</dd><dt><i>parent</i></dt>
+selected text to rename
+</dd><dt><i>parent</i> (QWidget)</dt>
<dd>
-reference to the parent widget (QWidget)
+reference to the parent widget
</dd>
</dl><a NAME="RenameDialog.__confirmUnsure" ID="RenameDialog.__confirmUnsure"></a>
<h4>RenameDialog.__confirmUnsure</h4>
-<b>__confirmUnsure</b>(<i>occurrence</i>)
+<b>__confirmUnsure</b>(<i>data</i>)
<p>
Private method to confirm unsure occurrences.
</p><dl>
-<dt><i>occurrence</i></dt>
+<dt><i>data</i> (dict)</dt>
<dd>
-reference to the occurrence object
- (rope.refactor.occurrences.Occurrence)
-</dd>
-</dl><dl>
-<dt>Returns:</dt>
-<dd>
-flag indicating an occurrence (boolean)
+dictionary containing the change data
</dd>
</dl><a NAME="RenameDialog._calculateChanges" ID="RenameDialog._calculateChanges"></a>
<h4>RenameDialog._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="RenameDialog.on_buttonBox_clicked" ID="RenameDialog.on_buttonBox_clicked"></a>
+ Protected method to initiate the calculation of the changes.
+</p><a NAME="RenameDialog.on_buttonBox_clicked" ID="RenameDialog.on_buttonBox_clicked"></a>
<h4>RenameDialog.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="RenameDialog.on_newNameEdit_textChanged" ID="RenameDialog.on_newNameEdit_textChanged"></a>
<h4>RenameDialog.on_newNameEdit_textChanged</h4>
@@ -153,9 +140,20 @@
<p>
Private slot to react to changes of the new name.
</p><dl>
-<dt><i>text</i></dt>
+<dt><i>text</i> (str)</dt>
<dd>
-text entered into the edit (string)
+text entered into the edit
+</dd>
+</dl><a NAME="RenameDialog.processChangeData" ID="RenameDialog.processChangeData"></a>
+<h4>RenameDialog.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>
