--- a/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.RefactoringDialogBase.html Fri Sep 29 10:23:35 2017 +0200 +++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.RefactoringDialogBase.html Fri Sep 29 10:32:30 2017 +0200 @@ -60,20 +60,26 @@ <td><a href="#RefactoringDialogBase.__init__">RefactoringDialogBase</a></td> <td>Constructor</td> </tr><tr> -<td><a href="#RefactoringDialogBase.__createProgressHandle">__createProgressHandle</a></td> -<td>Private method to create a TaskHandle to update a progress dialog.</td> -</tr><tr> -<td><a href="#RefactoringDialogBase.__getChanges">__getChanges</a></td> -<td>Private method to build the Changes object.</td> -</tr><tr> <td><a href="#RefactoringDialogBase._calculateChanges">_calculateChanges</a></td> -<td>Protected method to calculate the changes.</td> +<td>Protected method to initiate the calculation of changes.</td> </tr><tr> <td><a href="#RefactoringDialogBase.applyChanges">applyChanges</a></td> <td>Public method to apply the changes.</td> </tr><tr> +<td><a href="#RefactoringDialogBase.closeEvent">closeEvent</a></td> +<td>Protected method handling close events.</td> +</tr><tr> +<td><a href="#RefactoringDialogBase.getChangeGroupName">getChangeGroupName</a></td> +<td>Public method to get the name of the change group.</td> +</tr><tr> <td><a href="#RefactoringDialogBase.previewChanges">previewChanges</a></td> <td>Public method to preview the changes.</td> +</tr><tr> +<td><a href="#RefactoringDialogBase.processChangeData">processChangeData</a></td> +<td>Public method to process the change data sent by the refactoring client.</td> +</tr><tr> +<td><a href="#RefactoringDialogBase.requestPreview">requestPreview</a></td> +<td>Public method to request a preview of the calculated changes.</td> </tr> </table> <h3>Static Methods</h3> @@ -86,55 +92,22 @@ <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> -title of the dialog (string) -</dd><dt><i>parent</i></dt> +</dd><dt><i>title</i> (str)</dt> <dd> -reference to the parent widget (QWidget) -</dd> -</dl><a NAME="RefactoringDialogBase.__createProgressHandle" ID="RefactoringDialogBase.__createProgressHandle"></a> -<h4>RefactoringDialogBase.__createProgressHandle</h4> -<b>__createProgressHandle</b>(<i>interruptable=True</i>) -<p> - Private method to create a TaskHandle to update a progress dialog. -</p><dl> -<dt><i>interruptable</i></dt> +title of the dialog +</dd><dt><i>parent</i> (QWidget)</dt> <dd> -flag indicating, that the task may be - interrupted (boolean) -</dd> -</dl><a NAME="RefactoringDialogBase.__getChanges" ID="RefactoringDialogBase.__getChanges"></a> -<h4>RefactoringDialogBase.__getChanges</h4> -<b>__getChanges</b>(<i></i>) -<p> - Private method to build the Changes object. -</p><dl> -<dt>Returns:</dt> -<dd> -reference to the Changes object (rope.base.change.ChangeSet) +reference to the parent widget </dd> </dl><a NAME="RefactoringDialogBase._calculateChanges" ID="RefactoringDialogBase._calculateChanges"></a> <h4>RefactoringDialogBase._calculateChanges</h4> -<b>_calculateChanges</b>(<i>handle</i>) +<b>_calculateChanges</b>(<i></i>) <p> - Protected method to calculate the changes. + Protected method to initiate the calculation of 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 ChangeSet object (rope.base.change.ChangeSet) -</dd> -</dl><dl> <dt>Raises <b>NotImplementedError</b>:</dt> <dd> raised to indicate that this method must @@ -142,20 +115,60 @@ </dd> </dl><a NAME="RefactoringDialogBase.applyChanges" ID="RefactoringDialogBase.applyChanges"></a> <h4>RefactoringDialogBase.applyChanges</h4> -<b>applyChanges</b>(<i>changes=None</i>) +<b>applyChanges</b>(<i></i>) <p> Public method to apply the changes. +</p><a NAME="RefactoringDialogBase.closeEvent" ID="RefactoringDialogBase.closeEvent"></a> +<h4>RefactoringDialogBase.closeEvent</h4> +<b>closeEvent</b>(<i>evt</i>) +<p> + Protected method handling close events. </p><dl> -<dt><i>changes</i></dt> +<dt><i>evt</i> (QCloseEvent)</dt> <dd> -reference to the ChangeSet object - (rope.base.change.ChangeSet) +reference to the close event object +</dd> +</dl><a NAME="RefactoringDialogBase.getChangeGroupName" ID="RefactoringDialogBase.getChangeGroupName"></a> +<h4>RefactoringDialogBase.getChangeGroupName</h4> +<b>getChangeGroupName</b>(<i></i>) +<p> + Public method to get the name of the change group. +</p><dl> +<dt>Returns:</dt> +<dd> +name of the associated change group +</dd> +</dl><dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl><a NAME="RefactoringDialogBase.previewChanges" ID="RefactoringDialogBase.previewChanges"></a> <h4>RefactoringDialogBase.previewChanges</h4> -<b>previewChanges</b>(<i></i>) +<b>previewChanges</b>(<i>data</i>) <p> Public method to preview the changes. +</p><dl> +<dt><i>data</i> (dict)</dt> +<dd> +dictionary containing the change data +</dd> +</dl><a NAME="RefactoringDialogBase.processChangeData" ID="RefactoringDialogBase.processChangeData"></a> +<h4>RefactoringDialogBase.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><a NAME="RefactoringDialogBase.requestPreview" ID="RefactoringDialogBase.requestPreview"></a> +<h4>RefactoringDialogBase.requestPreview</h4> +<b>requestPreview</b>(<i></i>) +<p> + Public method to request a preview of the calculated changes. </p> <div align="right"><a href="#top">Up</a></div> <hr />