RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.ProgressHandle.html

changeset 17
a0fac63ef73f
child 44
8aa985c8dee5
diff -r 65b340b40844 -r a0fac63ef73f RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.ProgressHandle.html
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.ProgressHandle.html	Sun Jan 30 18:26:37 2011 +0100
@@ -0,0 +1,105 @@
+<?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.ProgressHandle</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.ProgressHandle</h1>
+<p>
+Module implementing a TaskHandle class with a progress dialog.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#ProgressHandle">ProgressHandle</a></td>
+<td>Class implementing TaskHandle with a progress dialog.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr /><hr />
+<a NAME="ProgressHandle" ID="ProgressHandle"></a>
+<h2>ProgressHandle</h2>
+<p>
+    Class implementing TaskHandle with a progress dialog.
+</p>
+<h3>Derived from</h3>
+rope.base.taskhandle.TaskHandle
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#ProgressHandle.__init__">ProgressHandle</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#ProgressHandle.__updateProgress">__updateProgress</a></td>
+<td>Private slot to handle the task progress.</td>
+</tr><tr>
+<td><a href="#ProgressHandle.reset">reset</a></td>
+<td>Public slot to reset the progress dialog.</td>
+</tr><tr>
+<td><a href="#ProgressHandle.show">show</a></td>
+<td>Public slot to show the progress dialog.</td>
+</tr>
+</table>
+<a NAME="ProgressHandle.__init__" ID="ProgressHandle.__init__"></a>
+<h4>ProgressHandle (Constructor)</h4>
+<b>ProgressHandle</b>(<i>title, interruptable=True, parent=None</i>)
+<p>
+        Constructor
+</p><dl>
+<dt><i>title</i></dt>
+<dd>
+title for the taskhandle (string)
+</dd><dt><i>interruptable</i></dt>
+<dd>
+flag indicating, that the task may be
+            interrupted (boolean)
+</dd><dt><i>parent</i></dt>
+<dd>
+reference to the parent widget (QWidget)
+</dd>
+</dl><a NAME="ProgressHandle.__updateProgress" ID="ProgressHandle.__updateProgress"></a>
+<h4>ProgressHandle.__updateProgress</h4>
+<b>__updateProgress</b>(<i></i>)
+<p>
+        Private slot to handle the task progress.
+</p><a NAME="ProgressHandle.reset" ID="ProgressHandle.reset"></a>
+<h4>ProgressHandle.reset</h4>
+<b>reset</b>(<i></i>)
+<p>
+        Public slot to reset the progress dialog.
+</p><a NAME="ProgressHandle.show" ID="ProgressHandle.show"></a>
+<h4>ProgressHandle.show</h4>
+<b>show</b>(<i></i>)
+<p>
+        Public slot to show the progress dialog.
+</p>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial