RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.RefactoringDialogBase.html

<!DOCTYPE html>
<html><head>
<title>Plugin_Refactoring_Rope.RefactoringRope.RefactoringDialogBase</title>
<meta charset="UTF-8">
<style>
body {
    background: #EDECE6;
    margin: 0em 1em 10em 1em;
    color: black;
}

h1 { color: white; background: #85774A; }
h2 { color: white; background: #85774A; }
h3 { color: white; background: #9D936E; }
h4 { color: white; background: #9D936E; }
    
a { color: #BA6D36; }

</style>
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>Plugin_Refactoring_Rope.RefactoringRope.RefactoringDialogBase</h1>

<p>
Module implementing the Refactoring dialog base class.
</p>
<h3>Global Attributes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>

<table>

<tr>
<td><a href="#RefactoringDialogBase">RefactoringDialogBase</a></td>
<td>Class implementing the Refactoring dialog base class.</td>
</tr>
</table>
<h3>Functions</h3>

<table>
<tr><td>None</td></tr>
</table>
<hr />
<hr />
<a NAME="RefactoringDialogBase" ID="RefactoringDialogBase"></a>
<h2>RefactoringDialogBase</h2>

<p>
    Class implementing the Refactoring dialog base class.
</p>
<h3>Derived from</h3>
QDialog
<h3>Class Attributes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Class Methods</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>

<table>

<tr>
<td><a href="#RefactoringDialogBase.__init__">RefactoringDialogBase</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#RefactoringDialogBase._calculateChanges">_calculateChanges</a></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>

<table>
<tr><td>None</td></tr>
</table>

<a NAME="RefactoringDialogBase.__init__" ID="RefactoringDialogBase.__init__"></a>
<h4>RefactoringDialogBase (Constructor)</h4>
<b>RefactoringDialogBase</b>(<i>refactoring, title, parent=None</i>)

<p>
        Constructor
</p>
<dl>

<dt><i>refactoring</i> (RefactoringServer)</dt>
<dd>
reference to the main refactoring object
</dd>
<dt><i>title</i> (str)</dt>
<dd>
title of the dialog
</dd>
<dt><i>parent</i> (QWidget)</dt>
<dd>
reference to the parent widget
</dd>
</dl>
<a NAME="RefactoringDialogBase._calculateChanges" ID="RefactoringDialogBase._calculateChanges"></a>
<h4>RefactoringDialogBase._calculateChanges</h4>
<b>_calculateChanges</b>(<i></i>)

<p>
        Protected method to initiate the calculation of changes.
</p>
<dl>

<dt>Raises <b>NotImplementedError</b>:</dt>
<dd>
raised to indicate that this method must
            be overridden by subclasses
</dd>
</dl>
<a NAME="RefactoringDialogBase.applyChanges" ID="RefactoringDialogBase.applyChanges"></a>
<h4>RefactoringDialogBase.applyChanges</h4>
<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>evt</i> (QCloseEvent)</dt>
<dd>
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>Return:</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>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 />
</body></html>