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

changeset 17
a0fac63ef73f
child 44
8aa985c8dee5
diff -r 65b340b40844 -r a0fac63ef73f RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.RenameDialog.html
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.RenameDialog.html	Sun Jan 30 18:26:37 2011 +0100
@@ -0,0 +1,153 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
+'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
+<html><head>
+<title>Plugin_Refactoring_Rope.RefactoringRope.RenameDialog</title>
+<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.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>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 calculate 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>
+</table>
+<a NAME="RenameDialog.__init__" ID="RenameDialog.__init__"></a>
+<h4>RenameDialog (Constructor)</h4>
+<b>RenameDialog</b>(<i>refactoring, title, renamer, resource=None, parent=None</i>)
+<p>
+        Constructor
+</p><dl>
+<dt><i>refactoring</i></dt>
+<dd>
+reference to the main refactoring object
+            (Refactoring)
+</dd><dt><i>title</i></dt>
+<dd>
+title of the dialog (string)
+</dd><dt><i>renamer</i></dt>
+<dd>
+reference to the renamer object
+            (rope.refactor.rename.Rename)
+</dd><dt><i>resource</i></dt>
+<dd>
+reference to a resource object, if the action is to
+            be applied to the local file only (rope.base.resources.File)
+</dd><dt><i>parent</i></dt>
+<dd>
+reference to the parent widget (QWidget)
+</dd>
+</dl><a NAME="RenameDialog.__confirmUnsure" ID="RenameDialog.__confirmUnsure"></a>
+<h4>RenameDialog.__confirmUnsure</h4>
+<b>__confirmUnsure</b>(<i>occurrence</i>)
+<p>
+        Private method to confirm unsure occurrences.
+</p><dl>
+<dt><i>occurrence</i></dt>
+<dd>
+reference to the occurrence object
+            (rope.refactor.occurrences.Occurrence)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating an occurrence (boolean)
+</dd>
+</dl><a NAME="RenameDialog._calculateChanges" ID="RenameDialog._calculateChanges"></a>
+<h4>RenameDialog._calculateChanges</h4>
+<b>_calculateChanges</b>(<i>handle</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="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></dt>
+<dd>
+reference to the button pressed (QAbstractButton)
+</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></dt>
+<dd>
+text entered into the edit (string)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial