Mercurial Repositories > Rope Refactoring / file comparison
comparison: RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.ProgressHandle.html
RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.ProgressHandle.html
- branch
- server_client_variant
- changeset 204
- b4bf79b956bc
- parent 44
- 8aa985c8dee5
- child 321
- d51e810107ec
equal
deleted
inserted
replaced
| 203:c38750e1bafd | 204:b4bf79b956bc |
|---|---|
| 19 </style> | 19 </style> |
| 20 </head> | 20 </head> |
| 21 <body><a NAME="top" ID="top"></a> | 21 <body><a NAME="top" ID="top"></a> |
| 22 <h1>Plugin_Refactoring_Rope.RefactoringRope.ProgressHandle</h1> | 22 <h1>Plugin_Refactoring_Rope.RefactoringRope.ProgressHandle</h1> |
| 23 <p> | 23 <p> |
| 24 Module implementing a TaskHandle class with a progress dialog. | 24 Module implementing a distributed TaskHandle class with a progress dialog. |
| 25 </p> | 25 </p> |
| 26 <h3>Global Attributes</h3> | 26 <h3>Global Attributes</h3> |
| 27 <table> | 27 <table> |
| 28 <tr><td>None</td></tr> | 28 <tr><td>None</td></tr> |
| 29 </table> | 29 </table> |
| 30 <h3>Classes</h3> | 30 <h3>Classes</h3> |
| 31 <table> | 31 <table> |
| 32 <tr> | 32 <tr> |
| 33 <td><a href="#ProgressHandle">ProgressHandle</a></td> | 33 <td><a href="#ProgressHandle">ProgressHandle</a></td> |
| 34 <td>Class implementing TaskHandle with a progress dialog.</td> | 34 <td>Class implementing distributed TaskHandle with a progress dialog.</td> |
| 35 </tr> | 35 </tr> |
| 36 </table> | 36 </table> |
| 37 <h3>Functions</h3> | 37 <h3>Functions</h3> |
| 38 <table> | 38 <table> |
| 39 <tr><td>None</td></tr> | 39 <tr><td>None</td></tr> |
| 40 </table> | 40 </table> |
| 41 <hr /><hr /> | 41 <hr /><hr /> |
| 42 <a NAME="ProgressHandle" ID="ProgressHandle"></a> | 42 <a NAME="ProgressHandle" ID="ProgressHandle"></a> |
| 43 <h2>ProgressHandle</h2> | 43 <h2>ProgressHandle</h2> |
| 44 <p> | 44 <p> |
| 45 Class implementing TaskHandle with a progress dialog. | 45 Class implementing distributed TaskHandle with a progress dialog. |
| 46 </p><p> | |
| 47 This is the client side. | |
| 46 </p> | 48 </p> |
| 47 <h3>Derived from</h3> | 49 <h3>Derived from</h3> |
| 48 rope.base.taskhandle.TaskHandle | 50 rope.base.taskhandle.TaskHandle |
| 49 <h3>Class Attributes</h3> | 51 <h3>Class Attributes</h3> |
| 50 <table> | 52 <table> |
| 63 <td><a href="#ProgressHandle.__updateProgress">__updateProgress</a></td> | 65 <td><a href="#ProgressHandle.__updateProgress">__updateProgress</a></td> |
| 64 <td>Private slot to handle the task progress.</td> | 66 <td>Private slot to handle the task progress.</td> |
| 65 </tr><tr> | 67 </tr><tr> |
| 66 <td><a href="#ProgressHandle.reset">reset</a></td> | 68 <td><a href="#ProgressHandle.reset">reset</a></td> |
| 67 <td>Public slot to reset the progress dialog.</td> | 69 <td>Public slot to reset the progress dialog.</td> |
| 68 </tr><tr> | |
| 69 <td><a href="#ProgressHandle.show">show</a></td> | |
| 70 <td>Public slot to show the progress dialog.</td> | |
| 71 </tr> | 70 </tr> |
| 72 </table> | 71 </table> |
| 73 <h3>Static Methods</h3> | 72 <h3>Static Methods</h3> |
| 74 <table> | 73 <table> |
| 75 <tr><td>None</td></tr> | 74 <tr><td>None</td></tr> |
| 76 </table> | 75 </table> |
| 77 <a NAME="ProgressHandle.__init__" ID="ProgressHandle.__init__"></a> | 76 <a NAME="ProgressHandle.__init__" ID="ProgressHandle.__init__"></a> |
| 78 <h4>ProgressHandle (Constructor)</h4> | 77 <h4>ProgressHandle (Constructor)</h4> |
| 79 <b>ProgressHandle</b>(<i>title, interruptable=True, parent=None</i>) | 78 <b>ProgressHandle</b>(<i>client, title, interruptable=True</i>) |
| 80 <p> | 79 <p> |
| 81 Constructor | 80 Constructor |
| 82 </p><dl> | 81 </p><dl> |
| 83 <dt><i>title</i></dt> | 82 <dt><i>client</i> (JsonClient)</dt> |
| 84 <dd> | 83 <dd> |
| 85 title for the taskhandle (string) | 84 reference to the JSON client |
| 86 </dd><dt><i>interruptable</i></dt> | 85 </dd><dt><i>title</i> (str)</dt> |
| 86 <dd> | |
| 87 title for the taskhandle | |
| 88 </dd><dt><i>interruptable</i> (bool)</dt> | |
| 87 <dd> | 89 <dd> |
| 88 flag indicating, that the task may be | 90 flag indicating, that the task may be |
| 89 interrupted (boolean) | 91 interrupted |
| 90 </dd><dt><i>parent</i></dt> | |
| 91 <dd> | |
| 92 reference to the parent widget (QWidget) | |
| 93 </dd> | 92 </dd> |
| 94 </dl><a NAME="ProgressHandle.__updateProgress" ID="ProgressHandle.__updateProgress"></a> | 93 </dl><a NAME="ProgressHandle.__updateProgress" ID="ProgressHandle.__updateProgress"></a> |
| 95 <h4>ProgressHandle.__updateProgress</h4> | 94 <h4>ProgressHandle.__updateProgress</h4> |
| 96 <b>__updateProgress</b>(<i></i>) | 95 <b>__updateProgress</b>(<i></i>) |
| 97 <p> | 96 <p> |
| 99 </p><a NAME="ProgressHandle.reset" ID="ProgressHandle.reset"></a> | 98 </p><a NAME="ProgressHandle.reset" ID="ProgressHandle.reset"></a> |
| 100 <h4>ProgressHandle.reset</h4> | 99 <h4>ProgressHandle.reset</h4> |
| 101 <b>reset</b>(<i></i>) | 100 <b>reset</b>(<i></i>) |
| 102 <p> | 101 <p> |
| 103 Public slot to reset the progress dialog. | 102 Public slot to reset the progress dialog. |
| 104 </p><a NAME="ProgressHandle.show" ID="ProgressHandle.show"></a> | |
| 105 <h4>ProgressHandle.show</h4> | |
| 106 <b>show</b>(<i></i>) | |
| 107 <p> | |
| 108 Public slot to show the progress dialog. | |
| 109 </p> | 103 </p> |
| 110 <div align="right"><a href="#top">Up</a></div> | 104 <div align="right"><a href="#top">Up</a></div> |
| 111 <hr /> | 105 <hr /> |
| 112 </body></html> | 106 </body></html> |
