Mercurial Repositories > Rope Refactoring / file comparison
comparison: RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.RefactoringDialogBase.html
RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.RefactoringDialogBase.html
- branch
- server_client_variant
- changeset 204
- b4bf79b956bc
- parent 55
- d501156be247
- child 321
- d51e810107ec
equal
deleted
inserted
replaced
| 203:c38750e1bafd | 204:b4bf79b956bc |
|---|---|
| 58 <table> | 58 <table> |
| 59 <tr> | 59 <tr> |
| 60 <td><a href="#RefactoringDialogBase.__init__">RefactoringDialogBase</a></td> | 60 <td><a href="#RefactoringDialogBase.__init__">RefactoringDialogBase</a></td> |
| 61 <td>Constructor</td> | 61 <td>Constructor</td> |
| 62 </tr><tr> | 62 </tr><tr> |
| 63 <td><a href="#RefactoringDialogBase.__createProgressHandle">__createProgressHandle</a></td> | |
| 64 <td>Private method to create a TaskHandle to update a progress dialog.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#RefactoringDialogBase.__getChanges">__getChanges</a></td> | |
| 67 <td>Private method to build the Changes object.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#RefactoringDialogBase._calculateChanges">_calculateChanges</a></td> | 63 <td><a href="#RefactoringDialogBase._calculateChanges">_calculateChanges</a></td> |
| 70 <td>Protected method to calculate the changes.</td> | 64 <td>Protected method to initiate the calculation of changes.</td> |
| 71 </tr><tr> | 65 </tr><tr> |
| 72 <td><a href="#RefactoringDialogBase.applyChanges">applyChanges</a></td> | 66 <td><a href="#RefactoringDialogBase.applyChanges">applyChanges</a></td> |
| 73 <td>Public method to apply the changes.</td> | 67 <td>Public method to apply the changes.</td> |
| 74 </tr><tr> | 68 </tr><tr> |
| 69 <td><a href="#RefactoringDialogBase.closeEvent">closeEvent</a></td> | |
| 70 <td>Protected method handling close events.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#RefactoringDialogBase.getChangeGroupName">getChangeGroupName</a></td> | |
| 73 <td>Public method to get the name of the change group.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#RefactoringDialogBase.previewChanges">previewChanges</a></td> | 75 <td><a href="#RefactoringDialogBase.previewChanges">previewChanges</a></td> |
| 76 <td>Public method to preview the changes.</td> | 76 <td>Public method to preview the changes.</td> |
| 77 </tr><tr> | |
| 78 <td><a href="#RefactoringDialogBase.processChangeData">processChangeData</a></td> | |
| 79 <td>Public method to process the change data sent by the refactoring client.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#RefactoringDialogBase.requestPreview">requestPreview</a></td> | |
| 82 <td>Public method to request a preview of the calculated changes.</td> | |
| 77 </tr> | 83 </tr> |
| 78 </table> | 84 </table> |
| 79 <h3>Static Methods</h3> | 85 <h3>Static Methods</h3> |
| 80 <table> | 86 <table> |
| 81 <tr><td>None</td></tr> | 87 <tr><td>None</td></tr> |
| 84 <h4>RefactoringDialogBase (Constructor)</h4> | 90 <h4>RefactoringDialogBase (Constructor)</h4> |
| 85 <b>RefactoringDialogBase</b>(<i>refactoring, title, parent=None</i>) | 91 <b>RefactoringDialogBase</b>(<i>refactoring, title, parent=None</i>) |
| 86 <p> | 92 <p> |
| 87 Constructor | 93 Constructor |
| 88 </p><dl> | 94 </p><dl> |
| 89 <dt><i>refactoring</i></dt> | 95 <dt><i>refactoring</i> (RefactoringServer)</dt> |
| 90 <dd> | 96 <dd> |
| 91 reference to the main refactoring object | 97 reference to the main refactoring object |
| 92 (Refactoring) | 98 </dd><dt><i>title</i> (str)</dt> |
| 93 </dd><dt><i>title</i></dt> | |
| 94 <dd> | 99 <dd> |
| 95 title of the dialog (string) | 100 title of the dialog |
| 96 </dd><dt><i>parent</i></dt> | 101 </dd><dt><i>parent</i> (QWidget)</dt> |
| 97 <dd> | 102 <dd> |
| 98 reference to the parent widget (QWidget) | 103 reference to the parent widget |
| 99 </dd> | |
| 100 </dl><a NAME="RefactoringDialogBase.__createProgressHandle" ID="RefactoringDialogBase.__createProgressHandle"></a> | |
| 101 <h4>RefactoringDialogBase.__createProgressHandle</h4> | |
| 102 <b>__createProgressHandle</b>(<i>interruptable=True</i>) | |
| 103 <p> | |
| 104 Private method to create a TaskHandle to update a progress dialog. | |
| 105 </p><dl> | |
| 106 <dt><i>interruptable</i></dt> | |
| 107 <dd> | |
| 108 flag indicating, that the task may be | |
| 109 interrupted (boolean) | |
| 110 </dd> | |
| 111 </dl><a NAME="RefactoringDialogBase.__getChanges" ID="RefactoringDialogBase.__getChanges"></a> | |
| 112 <h4>RefactoringDialogBase.__getChanges</h4> | |
| 113 <b>__getChanges</b>(<i></i>) | |
| 114 <p> | |
| 115 Private method to build the Changes object. | |
| 116 </p><dl> | |
| 117 <dt>Returns:</dt> | |
| 118 <dd> | |
| 119 reference to the Changes object (rope.base.change.ChangeSet) | |
| 120 </dd> | 104 </dd> |
| 121 </dl><a NAME="RefactoringDialogBase._calculateChanges" ID="RefactoringDialogBase._calculateChanges"></a> | 105 </dl><a NAME="RefactoringDialogBase._calculateChanges" ID="RefactoringDialogBase._calculateChanges"></a> |
| 122 <h4>RefactoringDialogBase._calculateChanges</h4> | 106 <h4>RefactoringDialogBase._calculateChanges</h4> |
| 123 <b>_calculateChanges</b>(<i>handle</i>) | 107 <b>_calculateChanges</b>(<i></i>) |
| 124 <p> | 108 <p> |
| 125 Protected method to calculate the changes. | 109 Protected method to initiate the calculation of changes. |
| 126 </p><dl> | 110 </p><dl> |
| 127 <dt><i>handle</i></dt> | |
| 128 <dd> | |
| 129 reference to the task handle | |
| 130 (rope.base.taskhandle.TaskHandle) | |
| 131 </dd> | |
| 132 </dl><dl> | |
| 133 <dt>Returns:</dt> | |
| 134 <dd> | |
| 135 reference to the ChangeSet object (rope.base.change.ChangeSet) | |
| 136 </dd> | |
| 137 </dl><dl> | |
| 138 <dt>Raises <b>NotImplementedError</b>:</dt> | 111 <dt>Raises <b>NotImplementedError</b>:</dt> |
| 139 <dd> | 112 <dd> |
| 140 raised to indicate that this method must | 113 raised to indicate that this method must |
| 141 be overridden by subclasses | 114 be overridden by subclasses |
| 142 </dd> | 115 </dd> |
| 143 </dl><a NAME="RefactoringDialogBase.applyChanges" ID="RefactoringDialogBase.applyChanges"></a> | 116 </dl><a NAME="RefactoringDialogBase.applyChanges" ID="RefactoringDialogBase.applyChanges"></a> |
| 144 <h4>RefactoringDialogBase.applyChanges</h4> | 117 <h4>RefactoringDialogBase.applyChanges</h4> |
| 145 <b>applyChanges</b>(<i>changes=None</i>) | 118 <b>applyChanges</b>(<i></i>) |
| 146 <p> | 119 <p> |
| 147 Public method to apply the changes. | 120 Public method to apply the changes. |
| 121 </p><a NAME="RefactoringDialogBase.closeEvent" ID="RefactoringDialogBase.closeEvent"></a> | |
| 122 <h4>RefactoringDialogBase.closeEvent</h4> | |
| 123 <b>closeEvent</b>(<i>evt</i>) | |
| 124 <p> | |
| 125 Protected method handling close events. | |
| 148 </p><dl> | 126 </p><dl> |
| 149 <dt><i>changes</i></dt> | 127 <dt><i>evt</i> (QCloseEvent)</dt> |
| 150 <dd> | 128 <dd> |
| 151 reference to the ChangeSet object | 129 reference to the close event object |
| 152 (rope.base.change.ChangeSet) | 130 </dd> |
| 131 </dl><a NAME="RefactoringDialogBase.getChangeGroupName" ID="RefactoringDialogBase.getChangeGroupName"></a> | |
| 132 <h4>RefactoringDialogBase.getChangeGroupName</h4> | |
| 133 <b>getChangeGroupName</b>(<i></i>) | |
| 134 <p> | |
| 135 Public method to get the name of the change group. | |
| 136 </p><dl> | |
| 137 <dt>Returns:</dt> | |
| 138 <dd> | |
| 139 name of the associated change group | |
| 140 </dd> | |
| 141 </dl><dl> | |
| 142 <dt>Return Type:</dt> | |
| 143 <dd> | |
| 144 str | |
| 153 </dd> | 145 </dd> |
| 154 </dl><a NAME="RefactoringDialogBase.previewChanges" ID="RefactoringDialogBase.previewChanges"></a> | 146 </dl><a NAME="RefactoringDialogBase.previewChanges" ID="RefactoringDialogBase.previewChanges"></a> |
| 155 <h4>RefactoringDialogBase.previewChanges</h4> | 147 <h4>RefactoringDialogBase.previewChanges</h4> |
| 156 <b>previewChanges</b>(<i></i>) | 148 <b>previewChanges</b>(<i>data</i>) |
| 157 <p> | 149 <p> |
| 158 Public method to preview the changes. | 150 Public method to preview the changes. |
| 151 </p><dl> | |
| 152 <dt><i>data</i> (dict)</dt> | |
| 153 <dd> | |
| 154 dictionary containing the change data | |
| 155 </dd> | |
| 156 </dl><a NAME="RefactoringDialogBase.processChangeData" ID="RefactoringDialogBase.processChangeData"></a> | |
| 157 <h4>RefactoringDialogBase.processChangeData</h4> | |
| 158 <b>processChangeData</b>(<i>data</i>) | |
| 159 <p> | |
| 160 Public method to process the change data sent by the refactoring | |
| 161 client. | |
| 162 </p><dl> | |
| 163 <dt><i>data</i> (dict)</dt> | |
| 164 <dd> | |
| 165 dictionary containing the change data | |
| 166 </dd> | |
| 167 </dl><a NAME="RefactoringDialogBase.requestPreview" ID="RefactoringDialogBase.requestPreview"></a> | |
| 168 <h4>RefactoringDialogBase.requestPreview</h4> | |
| 169 <b>requestPreview</b>(<i></i>) | |
| 170 <p> | |
| 171 Public method to request a preview of the calculated changes. | |
| 159 </p> | 172 </p> |
| 160 <div align="right"><a href="#top">Up</a></div> | 173 <div align="right"><a href="#top">Up</a></div> |
| 161 <hr /> | 174 <hr /> |
| 162 </body></html> | 175 </body></html> |
