diff -r 65b340b40844 -r a0fac63ef73f RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.RefactoringDialogBase.html
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.RefactoringDialogBase.html Sun Jan 30 18:26:37 2011 +0100
@@ -0,0 +1,148 @@
+<?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.RefactoringDialogBase</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.RefactoringDialogBase</h1>
+<p>
+Module implementing the Refactoring dialog base class.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#RefactoringDialogBase">RefactoringDialogBase</a></td>
+<td>Class implementing the Refactoring dialog base class.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr /><hr />
+<a NAME="RefactoringDialogBase" ID="RefactoringDialogBase"></a>
+<h2>RefactoringDialogBase</h2>
+<p>
+ Class implementing the Refactoring dialog base class.
+</p>
+<h3>Derived from</h3>
+QDialog
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#RefactoringDialogBase.__init__">RefactoringDialogBase</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#RefactoringDialogBase.__createProgressHandle">__createProgressHandle</a></td>
+<td>Private method to create a TaskHandle to update a progress dialog.</td>
+</tr><tr>
+<td><a href="#RefactoringDialogBase.__getChanges">__getChanges</a></td>
+<td>Private method to build the Changes object.</td>
+</tr><tr>
+<td><a href="#RefactoringDialogBase._calculateChanges">_calculateChanges</a></td>
+<td>Protected method to calculate the changes.</td>
+</tr><tr>
+<td><a href="#RefactoringDialogBase.applyChanges">applyChanges</a></td>
+<td>Public method to apply the changes.</td>
+</tr><tr>
+<td><a href="#RefactoringDialogBase.previewChanges">previewChanges</a></td>
+<td>Public method to preview the changes.</td>
+</tr>
+</table>
+<a NAME="RefactoringDialogBase.__init__" ID="RefactoringDialogBase.__init__"></a>
+<h4>RefactoringDialogBase (Constructor)</h4>
+<b>RefactoringDialogBase</b>(<i>refactoring, title, 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>parent</i></dt>
+<dd>
+reference to the parent widget (QWidget)
+</dd>
+</dl><a NAME="RefactoringDialogBase.__createProgressHandle" ID="RefactoringDialogBase.__createProgressHandle"></a>
+<h4>RefactoringDialogBase.__createProgressHandle</h4>
+<b>__createProgressHandle</b>(<i>interruptable=True</i>)
+<p>
+ Private method to create a TaskHandle to update a progress dialog.
+</p><dl>
+<dt><i>interruptable</i></dt>
+<dd>
+flag indicating, that the task may be
+ interrupted (boolean)
+</dd>
+</dl><a NAME="RefactoringDialogBase.__getChanges" ID="RefactoringDialogBase.__getChanges"></a>
+<h4>RefactoringDialogBase.__getChanges</h4>
+<b>__getChanges</b>(<i></i>)
+<p>
+ Private method to build the Changes object.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+reference to the Changes object (rope.base.change.ChangeSet)
+</dd>
+</dl><a NAME="RefactoringDialogBase._calculateChanges" ID="RefactoringDialogBase._calculateChanges"></a>
+<h4>RefactoringDialogBase._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="RefactoringDialogBase.applyChanges" ID="RefactoringDialogBase.applyChanges"></a>
+<h4>RefactoringDialogBase.applyChanges</h4>
+<b>applyChanges</b>(<i>changes = None</i>)
+<p>
+ Public method to apply the changes.
+</p><dl>
+<dt><i>reference</i></dt>
+<dd>
+to the Changes object (rope.base.change.ChangeSet)
+</dd>
+</dl><a NAME="RefactoringDialogBase.previewChanges" ID="RefactoringDialogBase.previewChanges"></a>
+<h4>RefactoringDialogBase.previewChanges</h4>
+<b>previewChanges</b>(<i></i>)
+<p>
+ Public method to preview the changes.
+</p>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file
