--- a/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.InlineDialog.html Fri Sep 29 10:23:35 2017 +0200 +++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.InlineDialog.html Fri Sep 29 10:32:30 2017 +0200 @@ -60,11 +60,17 @@ <td><a href="#InlineDialog.__init__">InlineDialog</a></td> <td>Constructor</td> </tr><tr> +<td><a href="#InlineDialog.__processInlineType">__processInlineType</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="#InlineDialog._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="#InlineDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> <td>Private slot to act on the button pressed.</td> +</tr><tr> +<td><a href="#InlineDialog.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,52 +79,62 @@ </table> <a NAME="InlineDialog.__init__" ID="InlineDialog.__init__"></a> <h4>InlineDialog (Constructor)</h4> -<b>InlineDialog</b>(<i>refactoring, title, inliner, parent=None</i>) +<b>InlineDialog</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>inliner</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 inliner object - (rope.refactor.inline.InlineMethod, - rope.refactor.inline.InlineVariable - or rope.refactor.inline.InlineParameter) -</dd><dt><i>parent</i></dt> +reference to the parent widget +</dd> +</dl><a NAME="InlineDialog.__processInlineType" ID="InlineDialog.__processInlineType"></a> +<h4>InlineDialog.__processInlineType</h4> +<b>__processInlineType</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> -reference to the parent widget (QWidget) +dictionary containing the inline type data </dd> </dl><a NAME="InlineDialog._calculateChanges" ID="InlineDialog._calculateChanges"></a> <h4>InlineDialog._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="InlineDialog.on_buttonBox_clicked" ID="InlineDialog.on_buttonBox_clicked"></a> + Protected method to initiate the calculation of the changes. +</p><a NAME="InlineDialog.on_buttonBox_clicked" ID="InlineDialog.on_buttonBox_clicked"></a> <h4>InlineDialog.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="InlineDialog.processChangeData" ID="InlineDialog.processChangeData"></a> +<h4>InlineDialog.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>