diff -r c38750e1bafd -r b4bf79b956bc RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.ChangeSignatureDialog.html
--- a/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.ChangeSignatureDialog.html Fri Sep 29 10:23:35 2017 +0200
+++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.ChangeSignatureDialog.html Fri Sep 29 10:32:30 2017 +0200
@@ -63,8 +63,11 @@
<td><a href="#ChangeSignatureDialog.__getParameterIndex">__getParameterIndex</a></td>
<td>Private method to calculate the index of the given paramter.</td>
</tr><tr>
+<td><a href="#ChangeSignatureDialog.__processSignature">__processSignature</a></td>
+<td>Private method to process the inline type data sent by the refactoring client in order to polish the dialog.</td>
+</tr><tr>
<td><a href="#ChangeSignatureDialog._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="#ChangeSignatureDialog.on_addButton_clicked">on_addButton_clicked</a></td>
<td>Private slot to add a new parameter.</td>
@@ -83,6 +86,9 @@
</tr><tr>
<td><a href="#ChangeSignatureDialog.on_upButton_clicked">on_upButton_clicked</a></td>
<td>Private slot called to move the selected item up in the list.</td>
+</tr><tr>
+<td><a href="#ChangeSignatureDialog.processChangeData">processChangeData</a></td>
+<td>Public method to process the change data sent by the refactoring client.</td>
</tr>
</table>
<h3>Static Methods</h3>
@@ -91,24 +97,25 @@
</table>
<a NAME="ChangeSignatureDialog.__init__" ID="ChangeSignatureDialog.__init__"></a>
<h4>ChangeSignatureDialog (Constructor)</h4>
-<b>ChangeSignatureDialog</b>(<i>refactoring, title, changer, parent=None</i>)
+<b>ChangeSignatureDialog</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 (string)
-</dd><dt><i>changer</i></dt>
+title of the dialog
+</dd><dt><i>filename</i> (str)</dt>
<dd>
-reference to the signature changer object
- (rope.refactor.change_signature.ChangeSignature)
-</dd><dt><i>parent</i></dt>
+file name to be worked on
+</dd><dt><i>offset</i> (int or None)</dt>
<dd>
-reference to the parent widget (QWidget)
+offset within file
+</dd><dt><i>parent</i> (QWidget)</dt>
+<dd>
+reference to the parent widget
</dd>
</dl><a NAME="ChangeSignatureDialog.__getParameterIndex" ID="ChangeSignatureDialog.__getParameterIndex"></a>
<h4>ChangeSignatureDialog.__getParameterIndex</h4>
@@ -116,35 +123,41 @@
<p>
Private method to calculate the index of the given paramter.
</p><dl>
-<dt><i>definition_info</i></dt>
+<dt><i>definition_info</i> (list of lists of two str)</dt>
<dd>
-object containing the method definition
-</dd><dt><i>name</i></dt>
+list of lists containing the method signature
+ definition
+</dd><dt><i>name</i> (str)</dt>
<dd>
-parameter name (string)
+parameter name
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-index of the parameter (integer)
+index of the parameter
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+int
+</dd>
+</dl><a NAME="ChangeSignatureDialog.__processSignature" ID="ChangeSignatureDialog.__processSignature"></a>
+<h4>ChangeSignatureDialog.__processSignature</h4>
+<b>__processSignature</b>(<i>data</i>)
+<p>
+ Private method to process the inline type data sent by the refactoring
+ client in order to polish the dialog.
+</p><dl>
+<dt><i>data</i> (dict)</dt>
+<dd>
+dictionary containing the inline type data
</dd>
</dl><a NAME="ChangeSignatureDialog._calculateChanges" ID="ChangeSignatureDialog._calculateChanges"></a>
<h4>ChangeSignatureDialog._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="ChangeSignatureDialog.on_addButton_clicked" ID="ChangeSignatureDialog.on_addButton_clicked"></a>
+ Protected method to initiate the calculation of the changes.
+</p><a NAME="ChangeSignatureDialog.on_addButton_clicked" ID="ChangeSignatureDialog.on_addButton_clicked"></a>
<h4>ChangeSignatureDialog.on_addButton_clicked</h4>
<b>on_addButton_clicked</b>(<i></i>)
<p>
@@ -155,9 +168,9 @@
<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="ChangeSignatureDialog.on_downButton_clicked" ID="ChangeSignatureDialog.on_downButton_clicked"></a>
<h4>ChangeSignatureDialog.on_downButton_clicked</h4>
@@ -170,9 +183,9 @@
<p>
Private slot called, when the current row is changed.
</p><dl>
-<dt><i>currentRow</i></dt>
+<dt><i>currentRow</i> (int)</dt>
<dd>
-index of the current row (integer)
+index of the current row
</dd>
</dl><a NAME="ChangeSignatureDialog.on_removeButton_clicked" ID="ChangeSignatureDialog.on_removeButton_clicked"></a>
<h4>ChangeSignatureDialog.on_removeButton_clicked</h4>
@@ -184,7 +197,18 @@
<b>on_upButton_clicked</b>(<i></i>)
<p>
Private slot called to move the selected item up in the list.
-</p>
+</p><a NAME="ChangeSignatureDialog.processChangeData" ID="ChangeSignatureDialog.processChangeData"></a>
+<h4>ChangeSignatureDialog.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>
<hr />
</body></html>
\ No newline at end of file
