--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.RopeProgressDialog.html Fri Sep 29 10:32:30 2017 +0200 @@ -0,0 +1,104 @@ +<!DOCTYPE html> +<html><head> +<title>Plugin_Refactoring_Rope.RefactoringRope.RopeProgressDialog</title> +<meta charset="UTF-8"> +<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.RopeProgressDialog</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="#RopeProgressDialog">RopeProgressDialog</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="RopeProgressDialog" ID="RopeProgressDialog"></a> +<h2>RopeProgressDialog</h2> +<p> + Class implementing TaskHandle with a progress dialog. +</p> +<h3>Derived from</h3> +E5ProgressDialog +<h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Class Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#RopeProgressDialog.__init__">RopeProgressDialog</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#RopeProgressDialog.updateProgress">updateProgress</a></td> +<td>Public slot to handle the task progress.</td> +</tr> +</table> +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<a NAME="RopeProgressDialog.__init__" ID="RopeProgressDialog.__init__"></a> +<h4>RopeProgressDialog (Constructor)</h4> +<b>RopeProgressDialog</b>(<i>server, title, interruptable=True, parent=None</i>) +<p> + Constructor +</p><dl> +<dt><i>server</i> (JsonServer)</dt> +<dd> +reference to the JSON server +</dd><dt><i>title</i> (str)</dt> +<dd> +title for the dialog +</dd><dt><i>interruptable</i> (bool)</dt> +<dd> +flag indicating, that the task may be + interrupted +</dd><dt><i>parent</i> (QWidget)</dt> +<dd> +reference to the parent widget +</dd> +</dl><a NAME="RopeProgressDialog.updateProgress" ID="RopeProgressDialog.updateProgress"></a> +<h4>RopeProgressDialog.updateProgress</h4> +<b>updateProgress</b>(<i>params</i>) +<p> + Public slot to handle the task progress. +</p><dl> +<dt><i>params</i> (dict)</dt> +<dd> +dictionary containing the data to be set +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file