RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.InlineDialog.html

Sat, 12 Feb 2011 11:53:07 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sat, 12 Feb 2011 11:53:07 +0100
changeset 24
e18b36080a37
parent 17
a0fac63ef73f
child 44
8aa985c8dee5
permissions
-rw-r--r--

Updated source docu after making the code PEP-8 compliant.

<?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.InlineDialog</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.InlineDialog</h1>
<p>
Module implementing the Inline dialog.
</p>
<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>
<table>
<tr>
<td><a href="#InlineDialog">InlineDialog</a></td>
<td>Class implementing the Inline dialog.</td>
</tr>
</table>
<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>
<hr /><hr />
<a NAME="InlineDialog" ID="InlineDialog"></a>
<h2>InlineDialog</h2>
<p>
    Class implementing the Inline dialog.
</p>
<h3>Derived from</h3>
RefactoringDialogBase, Ui_InlineDialog
<h3>Class Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>
<table>
<tr>
<td><a href="#InlineDialog.__init__">InlineDialog</a></td>
<td>Constructor</td>
</tr><tr>
<td><a href="#InlineDialog._calculateChanges">_calculateChanges</a></td>
<td>Protected method to calculate the changes.</td>
</tr><tr>
<td><a href="#InlineDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
<td>Private slot to act on the button pressed.</td>
</tr>
</table>
<a NAME="InlineDialog.__init__" ID="InlineDialog.__init__"></a>
<h4>InlineDialog (Constructor)</h4>
<b>InlineDialog</b>(<i>refactoring, title, inliner, 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>inliner</i></dt>
<dd>
reference to the inliner object
            (rope.refactor.inline.InlineMethod,
             rope.refactor.inline.InlineVariable
             or rope.refactor.inline.InlineParameter)
</dd><dt><i>parent</i></dt>
<dd>
reference to the parent widget (QWidget)
</dd>
</dl><a NAME="InlineDialog._calculateChanges" ID="InlineDialog._calculateChanges"></a>
<h4>InlineDialog._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="InlineDialog.on_buttonBox_clicked" ID="InlineDialog.on_buttonBox_clicked"></a>
<h4>InlineDialog.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>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>

eric ide

mercurial