RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.ConfirmationDialog.html

<!DOCTYPE html>
<html><head>
<title>Plugin_Refactoring_Rope.RefactoringRope.ConfirmationDialog</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>Plugin_Refactoring_Rope.RefactoringRope.ConfirmationDialog</h1>

<p>
Module implementing the Confirmation dialog.
</p>
<h3>Global Attributes</h3>

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

<table>

<tr>
<td><a href="#ConfirmationDialog">ConfirmationDialog</a></td>
<td>Class implementing the Confirmation dialog.</td>
</tr>
</table>
<h3>Functions</h3>

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

<p>
    Class implementing the Confirmation dialog.
</p>
<h3>Derived from</h3>
RefactoringDialogBase, Ui_ConfirmationDialog
<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="#ConfirmationDialog.__init__">ConfirmationDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#ConfirmationDialog.__processChangeDescription">__processChangeDescription</a></td>
<td>Private method to process the change description data sent by the refactoring client in order to polish the dialog.</td>
</tr>
<tr>
<td><a href="#ConfirmationDialog._calculateChanges">_calculateChanges</a></td>
<td>Protected method to initiate the calculation of the changes.</td>
</tr>
<tr>
<td><a href="#ConfirmationDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
<td>Private slot to act on the button pressed.</td>
</tr>
<tr>
<td><a href="#ConfirmationDialog.processChangeData">processChangeData</a></td>
<td>Public method to process the change data sent by the refactoring client.</td>
</tr>
</table>
<h3>Static Methods</h3>

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

<a NAME="ConfirmationDialog.__init__" ID="ConfirmationDialog.__init__"></a>
<h4>ConfirmationDialog (Constructor)</h4>
<b>ConfirmationDialog</b>(<i>refactoring, title, changeGroupName, method, parameters, 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>changeGroupName</i> (str)</dt>
<dd>
name of the change group
</dd>
<dt><i>method</i> (str)</dt>
<dd>
method to produce the refactoring changes
</dd>
<dt><i>parameters</i> (dict)</dt>
<dd>
dictionary containing the method parameters
</dd>
<dt><i>parent</i> (QWidget)</dt>
<dd>
reference to the parent widget
</dd>
</dl>
<a NAME="ConfirmationDialog.__processChangeDescription" ID="ConfirmationDialog.__processChangeDescription"></a>
<h4>ConfirmationDialog.__processChangeDescription</h4>
<b>__processChangeDescription</b>(<i>data</i>)

<p>
        Private method to process the change description data sent by the
        refactoring client in order to polish the dialog.
</p>
<dl>

<dt><i>data</i> (dict)</dt>
<dd>
dictionary containing the data
</dd>
</dl>
<a NAME="ConfirmationDialog._calculateChanges" ID="ConfirmationDialog._calculateChanges"></a>
<h4>ConfirmationDialog._calculateChanges</h4>
<b>_calculateChanges</b>(<i></i>)

<p>
        Protected method to initiate the calculation of the changes.
</p>
<a NAME="ConfirmationDialog.on_buttonBox_clicked" ID="ConfirmationDialog.on_buttonBox_clicked"></a>
<h4>ConfirmationDialog.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> (QAbstractButton)</dt>
<dd>
reference to the button pressed
</dd>
</dl>
<a NAME="ConfirmationDialog.processChangeData" ID="ConfirmationDialog.processChangeData"></a>
<h4>ConfirmationDialog.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>