--- a/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.ProgressHandle.html Fri Oct 11 19:05:23 2019 +0200 +++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.ProgressHandle.html Fri Oct 11 19:05:59 2019 +0200 @@ -18,86 +18,112 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>Plugin_Refactoring_Rope.RefactoringRope.ProgressHandle</h1> + <p> Module implementing a distributed 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 distributed TaskHandle with a progress dialog.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="ProgressHandle" ID="ProgressHandle"></a> <h2>ProgressHandle</h2> + <p> Class implementing distributed TaskHandle with a progress dialog. -</p><p> +</p> +<p> This is the client side. </p> <h3>Derived from</h3> rope.base.taskhandle.TaskHandle <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="#ProgressHandle.__init__">ProgressHandle</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#ProgressHandle.__updateProgress">__updateProgress</a></td> <td>Private slot to handle the task progress.</td> -</tr><tr> +</tr> +<tr> <td><a href="#ProgressHandle.reset">reset</a></td> <td>Public slot to reset the progress dialog.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="ProgressHandle.__init__" ID="ProgressHandle.__init__"></a> <h4>ProgressHandle (Constructor)</h4> <b>ProgressHandle</b>(<i>client, title, interruptable=True</i>) + <p> Constructor -</p><dl> +</p> +<dl> + <dt><i>client</i> (JsonClient)</dt> <dd> reference to the JSON client -</dd><dt><i>title</i> (str)</dt> +</dd> +<dt><i>title</i> (str)</dt> <dd> title for the taskhandle -</dd><dt><i>interruptable</i> (bool)</dt> +</dd> +<dt><i>interruptable</i> (bool)</dt> <dd> flag indicating, that the task may be interrupted </dd> -</dl><a NAME="ProgressHandle.__updateProgress" ID="ProgressHandle.__updateProgress"></a> +</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> +</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>