diff -r 65b340b40844 -r a0fac63ef73f RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.ChangeSignatureDialog.html
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.ChangeSignatureDialog.html Sun Jan 30 18:26:37 2011 +0100
@@ -0,0 +1,183 @@
+<?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.ChangeSignatureDialog</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.ChangeSignatureDialog</h1>
+<p>
+Module implementing the Change Signature dialog.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#ChangeSignatureDialog">ChangeSignatureDialog</a></td>
+<td>Class implementing the Change Signature dialog.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr /><hr />
+<a NAME="ChangeSignatureDialog" ID="ChangeSignatureDialog"></a>
+<h2>ChangeSignatureDialog</h2>
+<p>
+ Class implementing the Change Signature dialog.
+</p>
+<h3>Derived from</h3>
+RefactoringDialogBase, Ui_ChangeSignatureDialog
+<h3>Class Attributes</h3>
+<table>
+<tr><td>DefaultRole</td></tr><tr><td>IsAddedRole</td></tr><tr><td>NameRole</td></tr><tr><td>ValueRole</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#ChangeSignatureDialog.__init__">ChangeSignatureDialog</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#ChangeSignatureDialog.__getParameterIndex">__getParameterIndex</a></td>
+<td>Private method to calculate the index of the given paramter.</td>
+</tr><tr>
+<td><a href="#ChangeSignatureDialog._calculateChanges">_calculateChanges</a></td>
+<td>Protected method to calculate the changes.</td>
+</tr><tr>
+<td><a href="#ChangeSignatureDialog.on_addButton_clicked">on_addButton_clicked</a></td>
+<td>Private slot to add a new parameter.</td>
+</tr><tr>
+<td><a href="#ChangeSignatureDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
+<td>Private slot to act on the button pressed.</td>
+</tr><tr>
+<td><a href="#ChangeSignatureDialog.on_downButton_clicked">on_downButton_clicked</a></td>
+<td>Private slot called to move the selected item down in the list.</td>
+</tr><tr>
+<td><a href="#ChangeSignatureDialog.on_parameterList_currentRowChanged">on_parameterList_currentRowChanged</a></td>
+<td>Private slot called, when the current row is changed.</td>
+</tr><tr>
+<td><a href="#ChangeSignatureDialog.on_removeButton_clicked">on_removeButton_clicked</a></td>
+<td>Private slot to remove a parameter.</td>
+</tr><tr>
+<td><a href="#ChangeSignatureDialog.on_upButton_clicked">on_upButton_clicked</a></td>
+<td>Private slot called to move the selected item up in the list.</td>
+</tr>
+</table>
+<a NAME="ChangeSignatureDialog.__init__" ID="ChangeSignatureDialog.__init__"></a>
+<h4>ChangeSignatureDialog (Constructor)</h4>
+<b>ChangeSignatureDialog</b>(<i>refactoring, title, changer, 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>changer</i></dt>
+<dd>
+reference to the signature changer object
+ (rope.refactor.change_signature.ChangeSignature)
+</dd><dt><i>parent</i></dt>
+<dd>
+reference to the parent widget (QWidget)
+</dd>
+</dl><a NAME="ChangeSignatureDialog.__getParameterIndex" ID="ChangeSignatureDialog.__getParameterIndex"></a>
+<h4>ChangeSignatureDialog.__getParameterIndex</h4>
+<b>__getParameterIndex</b>(<i>definition_info, name</i>)
+<p>
+ Private method to calculate the index of the given paramter.
+</p><dl>
+<dt><i>definition_info</i></dt>
+<dd>
+object containing the method definition
+</dd><dt><i>name</i></dt>
+<dd>
+parameter name (string)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+index of the parameter (integer)
+</dd>
+</dl><a NAME="ChangeSignatureDialog._calculateChanges" ID="ChangeSignatureDialog._calculateChanges"></a>
+<h4>ChangeSignatureDialog._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="ChangeSignatureDialog.on_addButton_clicked" ID="ChangeSignatureDialog.on_addButton_clicked"></a>
+<h4>ChangeSignatureDialog.on_addButton_clicked</h4>
+<b>on_addButton_clicked</b>(<i></i>)
+<p>
+ Private slot to add a new parameter.
+</p><a NAME="ChangeSignatureDialog.on_buttonBox_clicked" ID="ChangeSignatureDialog.on_buttonBox_clicked"></a>
+<h4>ChangeSignatureDialog.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="ChangeSignatureDialog.on_downButton_clicked" ID="ChangeSignatureDialog.on_downButton_clicked"></a>
+<h4>ChangeSignatureDialog.on_downButton_clicked</h4>
+<b>on_downButton_clicked</b>(<i></i>)
+<p>
+ Private slot called to move the selected item down in the list.
+</p><a NAME="ChangeSignatureDialog.on_parameterList_currentRowChanged" ID="ChangeSignatureDialog.on_parameterList_currentRowChanged"></a>
+<h4>ChangeSignatureDialog.on_parameterList_currentRowChanged</h4>
+<b>on_parameterList_currentRowChanged</b>(<i>currentRow</i>)
+<p>
+ Private slot called, when the current row is changed.
+</p><dl>
+<dt><i>currentRow</i></dt>
+<dd>
+index of the current row (integer)
+</dd>
+</dl><a NAME="ChangeSignatureDialog.on_removeButton_clicked" ID="ChangeSignatureDialog.on_removeButton_clicked"></a>
+<h4>ChangeSignatureDialog.on_removeButton_clicked</h4>
+<b>on_removeButton_clicked</b>(<i></i>)
+<p>
+ Private slot to remove a parameter.
+</p><a NAME="ChangeSignatureDialog.on_upButton_clicked" ID="ChangeSignatureDialog.on_upButton_clicked"></a>
+<h4>ChangeSignatureDialog.on_upButton_clicked</h4>
+<b>on_upButton_clicked</b>(<i></i>)
+<p>
+ Private slot called to move the selected item up in the list.
+</p>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file
