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
- changeset 321
- d51e810107ec
- parent 204
- b4bf79b956bc
- child 360
- 2b35968f3d02
equal
deleted
inserted
replaced
| 320:91b171fdd85f | 321:d51e810107ec |
|---|---|
| 16 | 16 |
| 17 a { color: #BA6D36; } | 17 a { color: #BA6D36; } |
| 18 | 18 |
| 19 </style> | 19 </style> |
| 20 </head> | 20 </head> |
| 21 <body><a NAME="top" ID="top"></a> | 21 <body> |
| 22 <a NAME="top" ID="top"></a> | |
| 22 <h1>Plugin_Refactoring_Rope.RefactoringRope.ProgressHandle</h1> | 23 <h1>Plugin_Refactoring_Rope.RefactoringRope.ProgressHandle</h1> |
| 24 | |
| 23 <p> | 25 <p> |
| 24 Module implementing a distributed TaskHandle class with a progress dialog. | 26 Module implementing a distributed TaskHandle class with a progress dialog. |
| 25 </p> | 27 </p> |
| 26 <h3>Global Attributes</h3> | 28 <h3>Global Attributes</h3> |
| 29 | |
| 27 <table> | 30 <table> |
| 28 <tr><td>None</td></tr> | 31 <tr><td>None</td></tr> |
| 29 </table> | 32 </table> |
| 30 <h3>Classes</h3> | 33 <h3>Classes</h3> |
| 34 | |
| 31 <table> | 35 <table> |
| 36 | |
| 32 <tr> | 37 <tr> |
| 33 <td><a href="#ProgressHandle">ProgressHandle</a></td> | 38 <td><a href="#ProgressHandle">ProgressHandle</a></td> |
| 34 <td>Class implementing distributed TaskHandle with a progress dialog.</td> | 39 <td>Class implementing distributed TaskHandle with a progress dialog.</td> |
| 35 </tr> | 40 </tr> |
| 36 </table> | 41 </table> |
| 37 <h3>Functions</h3> | 42 <h3>Functions</h3> |
| 43 | |
| 38 <table> | 44 <table> |
| 39 <tr><td>None</td></tr> | 45 <tr><td>None</td></tr> |
| 40 </table> | 46 </table> |
| 41 <hr /><hr /> | 47 <hr /> |
| 48 <hr /> | |
| 42 <a NAME="ProgressHandle" ID="ProgressHandle"></a> | 49 <a NAME="ProgressHandle" ID="ProgressHandle"></a> |
| 43 <h2>ProgressHandle</h2> | 50 <h2>ProgressHandle</h2> |
| 51 | |
| 44 <p> | 52 <p> |
| 45 Class implementing distributed TaskHandle with a progress dialog. | 53 Class implementing distributed TaskHandle with a progress dialog. |
| 46 </p><p> | 54 </p> |
| 55 <p> | |
| 47 This is the client side. | 56 This is the client side. |
| 48 </p> | 57 </p> |
| 49 <h3>Derived from</h3> | 58 <h3>Derived from</h3> |
| 50 rope.base.taskhandle.TaskHandle | 59 rope.base.taskhandle.TaskHandle |
| 51 <h3>Class Attributes</h3> | 60 <h3>Class Attributes</h3> |
| 61 | |
| 52 <table> | 62 <table> |
| 53 <tr><td>None</td></tr> | 63 <tr><td>None</td></tr> |
| 54 </table> | 64 </table> |
| 55 <h3>Class Methods</h3> | 65 <h3>Class Methods</h3> |
| 66 | |
| 56 <table> | 67 <table> |
| 57 <tr><td>None</td></tr> | 68 <tr><td>None</td></tr> |
| 58 </table> | 69 </table> |
| 59 <h3>Methods</h3> | 70 <h3>Methods</h3> |
| 71 | |
| 60 <table> | 72 <table> |
| 73 | |
| 61 <tr> | 74 <tr> |
| 62 <td><a href="#ProgressHandle.__init__">ProgressHandle</a></td> | 75 <td><a href="#ProgressHandle.__init__">ProgressHandle</a></td> |
| 63 <td>Constructor</td> | 76 <td>Constructor</td> |
| 64 </tr><tr> | 77 </tr> |
| 78 <tr> | |
| 65 <td><a href="#ProgressHandle.__updateProgress">__updateProgress</a></td> | 79 <td><a href="#ProgressHandle.__updateProgress">__updateProgress</a></td> |
| 66 <td>Private slot to handle the task progress.</td> | 80 <td>Private slot to handle the task progress.</td> |
| 67 </tr><tr> | 81 </tr> |
| 82 <tr> | |
| 68 <td><a href="#ProgressHandle.reset">reset</a></td> | 83 <td><a href="#ProgressHandle.reset">reset</a></td> |
| 69 <td>Public slot to reset the progress dialog.</td> | 84 <td>Public slot to reset the progress dialog.</td> |
| 70 </tr> | 85 </tr> |
| 71 </table> | 86 </table> |
| 72 <h3>Static Methods</h3> | 87 <h3>Static Methods</h3> |
| 88 | |
| 73 <table> | 89 <table> |
| 74 <tr><td>None</td></tr> | 90 <tr><td>None</td></tr> |
| 75 </table> | 91 </table> |
| 92 | |
| 76 <a NAME="ProgressHandle.__init__" ID="ProgressHandle.__init__"></a> | 93 <a NAME="ProgressHandle.__init__" ID="ProgressHandle.__init__"></a> |
| 77 <h4>ProgressHandle (Constructor)</h4> | 94 <h4>ProgressHandle (Constructor)</h4> |
| 78 <b>ProgressHandle</b>(<i>client, title, interruptable=True</i>) | 95 <b>ProgressHandle</b>(<i>client, title, interruptable=True</i>) |
| 96 | |
| 79 <p> | 97 <p> |
| 80 Constructor | 98 Constructor |
| 81 </p><dl> | 99 </p> |
| 100 <dl> | |
| 101 | |
| 82 <dt><i>client</i> (JsonClient)</dt> | 102 <dt><i>client</i> (JsonClient)</dt> |
| 83 <dd> | 103 <dd> |
| 84 reference to the JSON client | 104 reference to the JSON client |
| 85 </dd><dt><i>title</i> (str)</dt> | 105 </dd> |
| 106 <dt><i>title</i> (str)</dt> | |
| 86 <dd> | 107 <dd> |
| 87 title for the taskhandle | 108 title for the taskhandle |
| 88 </dd><dt><i>interruptable</i> (bool)</dt> | 109 </dd> |
| 110 <dt><i>interruptable</i> (bool)</dt> | |
| 89 <dd> | 111 <dd> |
| 90 flag indicating, that the task may be | 112 flag indicating, that the task may be |
| 91 interrupted | 113 interrupted |
| 92 </dd> | 114 </dd> |
| 93 </dl><a NAME="ProgressHandle.__updateProgress" ID="ProgressHandle.__updateProgress"></a> | 115 </dl> |
| 116 <a NAME="ProgressHandle.__updateProgress" ID="ProgressHandle.__updateProgress"></a> | |
| 94 <h4>ProgressHandle.__updateProgress</h4> | 117 <h4>ProgressHandle.__updateProgress</h4> |
| 95 <b>__updateProgress</b>(<i></i>) | 118 <b>__updateProgress</b>(<i></i>) |
| 119 | |
| 96 <p> | 120 <p> |
| 97 Private slot to handle the task progress. | 121 Private slot to handle the task progress. |
| 98 </p><a NAME="ProgressHandle.reset" ID="ProgressHandle.reset"></a> | 122 </p> |
| 123 <a NAME="ProgressHandle.reset" ID="ProgressHandle.reset"></a> | |
| 99 <h4>ProgressHandle.reset</h4> | 124 <h4>ProgressHandle.reset</h4> |
| 100 <b>reset</b>(<i></i>) | 125 <b>reset</b>(<i></i>) |
| 126 | |
| 101 <p> | 127 <p> |
| 102 Public slot to reset the progress dialog. | 128 Public slot to reset the progress dialog. |
| 103 </p> | 129 </p> |
| 104 <div align="right"><a href="#top">Up</a></div> | 130 <div align="right"><a href="#top">Up</a></div> |
| 105 <hr /> | 131 <hr /> |
