RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.RenameDialog.html

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

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

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

<table>

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

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

<p>
    Class implementing the Rename dialog.
</p>
<h3>Derived from</h3>
RefactoringDialogBase, Ui_RenameDialog
<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="#RenameDialog.__init__">RenameDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#RenameDialog.__confirmUnsure">__confirmUnsure</a></td>
<td>Private method to confirm unsure occurrences.</td>
</tr>
<tr>
<td><a href="#RenameDialog._calculateChanges">_calculateChanges</a></td>
<td>Protected method to initiate the calculation of the changes.</td>
</tr>
<tr>
<td><a href="#RenameDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
<td>Private slot to act on the button pressed.</td>
</tr>
<tr>
<td><a href="#RenameDialog.on_newNameEdit_textChanged">on_newNameEdit_textChanged</a></td>
<td>Private slot to react to changes of the new name.</td>
</tr>
<tr>
<td><a href="#RenameDialog.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="RenameDialog.__init__" ID="RenameDialog.__init__"></a>
<h4>RenameDialog (Constructor)</h4>
<b>RenameDialog</b>(<i>refactoring, title, filename, offset, isLocal, selectedText='', 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>filename</i> (str)</dt>
<dd>
file name to be worked on
</dd>
<dt><i>offset</i> (int or None)</dt>
<dd>
offset within file
</dd>
<dt><i>isLocal</i> (bool)</dt>
<dd>
flag indicating to restrict refactoring to
            the local file
</dd>
<dt><i>selectedText</i> (str)</dt>
<dd>
selected text to rename
</dd>
<dt><i>parent</i> (QWidget)</dt>
<dd>
reference to the parent widget
</dd>
</dl>
<a NAME="RenameDialog.__confirmUnsure" ID="RenameDialog.__confirmUnsure"></a>
<h4>RenameDialog.__confirmUnsure</h4>
<b>__confirmUnsure</b>(<i>data</i>)

<p>
        Private method to confirm unsure occurrences.
</p>
<dl>

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

<p>
        Protected method to initiate the calculation of the changes.
</p>
<a NAME="RenameDialog.on_buttonBox_clicked" ID="RenameDialog.on_buttonBox_clicked"></a>
<h4>RenameDialog.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="RenameDialog.on_newNameEdit_textChanged" ID="RenameDialog.on_newNameEdit_textChanged"></a>
<h4>RenameDialog.on_newNameEdit_textChanged</h4>
<b>on_newNameEdit_textChanged</b>(<i>text</i>)

<p>
        Private slot to react to changes of the new name.
</p>
<dl>

<dt><i>text</i> (str)</dt>
<dd>
text entered into the edit
</dd>
</dl>
<a NAME="RenameDialog.processChangeData" ID="RenameDialog.processChangeData"></a>
<h4>RenameDialog.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>