RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.InlineArgumentDefaultDialog.html

changeset 17
a0fac63ef73f
child 44
8aa985c8dee5
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.InlineArgumentDefaultDialog.html	Sun Jan 30 18:26:37 2011 +0100
@@ -0,0 +1,146 @@
+<?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.InlineArgumentDefaultDialog</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.InlineArgumentDefaultDialog</h1>
+<p>
+Module implementing the Inline Argument Default dialog.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#InlineArgumentDefaultDialog">InlineArgumentDefaultDialog</a></td>
+<td>Class implementing the Inline Argument Default dialog.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr /><hr />
+<a NAME="InlineArgumentDefaultDialog" ID="InlineArgumentDefaultDialog"></a>
+<h2>InlineArgumentDefaultDialog</h2>
+<p>
+    Class implementing the Inline Argument Default dialog.
+</p>
+<h3>Derived from</h3>
+RefactoringDialogBase, Ui_InlineArgumentDefaultDialog
+<h3>Class Attributes</h3>
+<table>
+<tr><td>NameRole</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#InlineArgumentDefaultDialog.__init__">InlineArgumentDefaultDialog</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#InlineArgumentDefaultDialog.__getParameterIndex">__getParameterIndex</a></td>
+<td>Private method to calculate the index of the given paramter.</td>
+</tr><tr>
+<td><a href="#InlineArgumentDefaultDialog._calculateChanges">_calculateChanges</a></td>
+<td>Protected method to calculate the changes.</td>
+</tr><tr>
+<td><a href="#InlineArgumentDefaultDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
+<td>Private slot to act on the button pressed.</td>
+</tr><tr>
+<td><a href="#InlineArgumentDefaultDialog.on_parameterList_itemSelectionChanged">on_parameterList_itemSelectionChanged</a></td>
+<td>Private slot called, when the selection changes.</td>
+</tr>
+</table>
+<a NAME="InlineArgumentDefaultDialog.__init__" ID="InlineArgumentDefaultDialog.__init__"></a>
+<h4>InlineArgumentDefaultDialog (Constructor)</h4>
+<b>InlineArgumentDefaultDialog</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="InlineArgumentDefaultDialog.__getParameterIndex" ID="InlineArgumentDefaultDialog.__getParameterIndex"></a>
+<h4>InlineArgumentDefaultDialog.__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="InlineArgumentDefaultDialog._calculateChanges" ID="InlineArgumentDefaultDialog._calculateChanges"></a>
+<h4>InlineArgumentDefaultDialog._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="InlineArgumentDefaultDialog.on_buttonBox_clicked" ID="InlineArgumentDefaultDialog.on_buttonBox_clicked"></a>
+<h4>InlineArgumentDefaultDialog.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="InlineArgumentDefaultDialog.on_parameterList_itemSelectionChanged" ID="InlineArgumentDefaultDialog.on_parameterList_itemSelectionChanged"></a>
+<h4>InlineArgumentDefaultDialog.on_parameterList_itemSelectionChanged</h4>
+<b>on_parameterList_itemSelectionChanged</b>(<i></i>)
+<p>
+        Private slot called, when the selection changes.
+</p>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial