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
- changeset 321
- d51e810107ec
- parent 204
- b4bf79b956bc
- child 347
- b5048b5ff454
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.RefactoringDialogBase</h1> | 23 <h1>Plugin_Refactoring_Rope.RefactoringRope.RefactoringDialogBase</h1> |
| 24 | |
| 23 <p> | 25 <p> |
| 24 Module implementing the Refactoring dialog base class. | 26 Module implementing the Refactoring dialog base class. |
| 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> |
| 31 <table> | 34 |
| 35 <table> | |
| 36 | |
| 32 <tr> | 37 <tr> |
| 33 <td><a href="#RefactoringDialogBase">RefactoringDialogBase</a></td> | 38 <td><a href="#RefactoringDialogBase">RefactoringDialogBase</a></td> |
| 34 <td>Class implementing the Refactoring dialog base class.</td> | 39 <td>Class implementing the Refactoring dialog base class.</td> |
| 35 </tr> | 40 </tr> |
| 36 </table> | 41 </table> |
| 37 <h3>Functions</h3> | 42 <h3>Functions</h3> |
| 38 <table> | 43 |
| 39 <tr><td>None</td></tr> | 44 <table> |
| 40 </table> | 45 <tr><td>None</td></tr> |
| 41 <hr /><hr /> | 46 </table> |
| 47 <hr /> | |
| 48 <hr /> | |
| 42 <a NAME="RefactoringDialogBase" ID="RefactoringDialogBase"></a> | 49 <a NAME="RefactoringDialogBase" ID="RefactoringDialogBase"></a> |
| 43 <h2>RefactoringDialogBase</h2> | 50 <h2>RefactoringDialogBase</h2> |
| 51 | |
| 44 <p> | 52 <p> |
| 45 Class implementing the Refactoring dialog base class. | 53 Class implementing the Refactoring dialog base class. |
| 46 </p> | 54 </p> |
| 47 <h3>Derived from</h3> | 55 <h3>Derived from</h3> |
| 48 QDialog | 56 QDialog |
| 49 <h3>Class Attributes</h3> | 57 <h3>Class Attributes</h3> |
| 58 | |
| 50 <table> | 59 <table> |
| 51 <tr><td>None</td></tr> | 60 <tr><td>None</td></tr> |
| 52 </table> | 61 </table> |
| 53 <h3>Class Methods</h3> | 62 <h3>Class Methods</h3> |
| 63 | |
| 54 <table> | 64 <table> |
| 55 <tr><td>None</td></tr> | 65 <tr><td>None</td></tr> |
| 56 </table> | 66 </table> |
| 57 <h3>Methods</h3> | 67 <h3>Methods</h3> |
| 58 <table> | 68 |
| 69 <table> | |
| 70 | |
| 59 <tr> | 71 <tr> |
| 60 <td><a href="#RefactoringDialogBase.__init__">RefactoringDialogBase</a></td> | 72 <td><a href="#RefactoringDialogBase.__init__">RefactoringDialogBase</a></td> |
| 61 <td>Constructor</td> | 73 <td>Constructor</td> |
| 62 </tr><tr> | 74 </tr> |
| 75 <tr> | |
| 63 <td><a href="#RefactoringDialogBase._calculateChanges">_calculateChanges</a></td> | 76 <td><a href="#RefactoringDialogBase._calculateChanges">_calculateChanges</a></td> |
| 64 <td>Protected method to initiate the calculation of changes.</td> | 77 <td>Protected method to initiate the calculation of changes.</td> |
| 65 </tr><tr> | 78 </tr> |
| 79 <tr> | |
| 66 <td><a href="#RefactoringDialogBase.applyChanges">applyChanges</a></td> | 80 <td><a href="#RefactoringDialogBase.applyChanges">applyChanges</a></td> |
| 67 <td>Public method to apply the changes.</td> | 81 <td>Public method to apply the changes.</td> |
| 68 </tr><tr> | 82 </tr> |
| 83 <tr> | |
| 69 <td><a href="#RefactoringDialogBase.closeEvent">closeEvent</a></td> | 84 <td><a href="#RefactoringDialogBase.closeEvent">closeEvent</a></td> |
| 70 <td>Protected method handling close events.</td> | 85 <td>Protected method handling close events.</td> |
| 71 </tr><tr> | 86 </tr> |
| 87 <tr> | |
| 72 <td><a href="#RefactoringDialogBase.getChangeGroupName">getChangeGroupName</a></td> | 88 <td><a href="#RefactoringDialogBase.getChangeGroupName">getChangeGroupName</a></td> |
| 73 <td>Public method to get the name of the change group.</td> | 89 <td>Public method to get the name of the change group.</td> |
| 74 </tr><tr> | 90 </tr> |
| 91 <tr> | |
| 75 <td><a href="#RefactoringDialogBase.previewChanges">previewChanges</a></td> | 92 <td><a href="#RefactoringDialogBase.previewChanges">previewChanges</a></td> |
| 76 <td>Public method to preview the changes.</td> | 93 <td>Public method to preview the changes.</td> |
| 77 </tr><tr> | 94 </tr> |
| 95 <tr> | |
| 78 <td><a href="#RefactoringDialogBase.processChangeData">processChangeData</a></td> | 96 <td><a href="#RefactoringDialogBase.processChangeData">processChangeData</a></td> |
| 79 <td>Public method to process the change data sent by the refactoring client.</td> | 97 <td>Public method to process the change data sent by the refactoring client.</td> |
| 80 </tr><tr> | 98 </tr> |
| 99 <tr> | |
| 81 <td><a href="#RefactoringDialogBase.requestPreview">requestPreview</a></td> | 100 <td><a href="#RefactoringDialogBase.requestPreview">requestPreview</a></td> |
| 82 <td>Public method to request a preview of the calculated changes.</td> | 101 <td>Public method to request a preview of the calculated changes.</td> |
| 83 </tr> | 102 </tr> |
| 84 </table> | 103 </table> |
| 85 <h3>Static Methods</h3> | 104 <h3>Static Methods</h3> |
| 86 <table> | 105 |
| 87 <tr><td>None</td></tr> | 106 <table> |
| 88 </table> | 107 <tr><td>None</td></tr> |
| 108 </table> | |
| 109 | |
| 89 <a NAME="RefactoringDialogBase.__init__" ID="RefactoringDialogBase.__init__"></a> | 110 <a NAME="RefactoringDialogBase.__init__" ID="RefactoringDialogBase.__init__"></a> |
| 90 <h4>RefactoringDialogBase (Constructor)</h4> | 111 <h4>RefactoringDialogBase (Constructor)</h4> |
| 91 <b>RefactoringDialogBase</b>(<i>refactoring, title, parent=None</i>) | 112 <b>RefactoringDialogBase</b>(<i>refactoring, title, parent=None</i>) |
| 113 | |
| 92 <p> | 114 <p> |
| 93 Constructor | 115 Constructor |
| 94 </p><dl> | 116 </p> |
| 117 <dl> | |
| 118 | |
| 95 <dt><i>refactoring</i> (RefactoringServer)</dt> | 119 <dt><i>refactoring</i> (RefactoringServer)</dt> |
| 96 <dd> | 120 <dd> |
| 97 reference to the main refactoring object | 121 reference to the main refactoring object |
| 98 </dd><dt><i>title</i> (str)</dt> | 122 </dd> |
| 123 <dt><i>title</i> (str)</dt> | |
| 99 <dd> | 124 <dd> |
| 100 title of the dialog | 125 title of the dialog |
| 101 </dd><dt><i>parent</i> (QWidget)</dt> | 126 </dd> |
| 127 <dt><i>parent</i> (QWidget)</dt> | |
| 102 <dd> | 128 <dd> |
| 103 reference to the parent widget | 129 reference to the parent widget |
| 104 </dd> | 130 </dd> |
| 105 </dl><a NAME="RefactoringDialogBase._calculateChanges" ID="RefactoringDialogBase._calculateChanges"></a> | 131 </dl> |
| 132 <a NAME="RefactoringDialogBase._calculateChanges" ID="RefactoringDialogBase._calculateChanges"></a> | |
| 106 <h4>RefactoringDialogBase._calculateChanges</h4> | 133 <h4>RefactoringDialogBase._calculateChanges</h4> |
| 107 <b>_calculateChanges</b>(<i></i>) | 134 <b>_calculateChanges</b>(<i></i>) |
| 135 | |
| 108 <p> | 136 <p> |
| 109 Protected method to initiate the calculation of changes. | 137 Protected method to initiate the calculation of changes. |
| 110 </p><dl> | 138 </p> |
| 139 <dl> | |
| 140 | |
| 111 <dt>Raises <b>NotImplementedError</b>:</dt> | 141 <dt>Raises <b>NotImplementedError</b>:</dt> |
| 112 <dd> | 142 <dd> |
| 113 raised to indicate that this method must | 143 raised to indicate that this method must |
| 114 be overridden by subclasses | 144 be overridden by subclasses |
| 115 </dd> | 145 </dd> |
| 116 </dl><a NAME="RefactoringDialogBase.applyChanges" ID="RefactoringDialogBase.applyChanges"></a> | 146 </dl> |
| 147 <a NAME="RefactoringDialogBase.applyChanges" ID="RefactoringDialogBase.applyChanges"></a> | |
| 117 <h4>RefactoringDialogBase.applyChanges</h4> | 148 <h4>RefactoringDialogBase.applyChanges</h4> |
| 118 <b>applyChanges</b>(<i></i>) | 149 <b>applyChanges</b>(<i></i>) |
| 150 | |
| 119 <p> | 151 <p> |
| 120 Public method to apply the changes. | 152 Public method to apply the changes. |
| 121 </p><a NAME="RefactoringDialogBase.closeEvent" ID="RefactoringDialogBase.closeEvent"></a> | 153 </p> |
| 154 <a NAME="RefactoringDialogBase.closeEvent" ID="RefactoringDialogBase.closeEvent"></a> | |
| 122 <h4>RefactoringDialogBase.closeEvent</h4> | 155 <h4>RefactoringDialogBase.closeEvent</h4> |
| 123 <b>closeEvent</b>(<i>evt</i>) | 156 <b>closeEvent</b>(<i>evt</i>) |
| 157 | |
| 124 <p> | 158 <p> |
| 125 Protected method handling close events. | 159 Protected method handling close events. |
| 126 </p><dl> | 160 </p> |
| 161 <dl> | |
| 162 | |
| 127 <dt><i>evt</i> (QCloseEvent)</dt> | 163 <dt><i>evt</i> (QCloseEvent)</dt> |
| 128 <dd> | 164 <dd> |
| 129 reference to the close event object | 165 reference to the close event object |
| 130 </dd> | 166 </dd> |
| 131 </dl><a NAME="RefactoringDialogBase.getChangeGroupName" ID="RefactoringDialogBase.getChangeGroupName"></a> | 167 </dl> |
| 168 <a NAME="RefactoringDialogBase.getChangeGroupName" ID="RefactoringDialogBase.getChangeGroupName"></a> | |
| 132 <h4>RefactoringDialogBase.getChangeGroupName</h4> | 169 <h4>RefactoringDialogBase.getChangeGroupName</h4> |
| 133 <b>getChangeGroupName</b>(<i></i>) | 170 <b>getChangeGroupName</b>(<i></i>) |
| 171 | |
| 134 <p> | 172 <p> |
| 135 Public method to get the name of the change group. | 173 Public method to get the name of the change group. |
| 136 </p><dl> | 174 </p> |
| 175 <dl> | |
| 137 <dt>Returns:</dt> | 176 <dt>Returns:</dt> |
| 138 <dd> | 177 <dd> |
| 139 name of the associated change group | 178 name of the associated change group |
| 140 </dd> | 179 </dd> |
| 141 </dl><dl> | 180 </dl> |
| 181 <dl> | |
| 142 <dt>Return Type:</dt> | 182 <dt>Return Type:</dt> |
| 143 <dd> | 183 <dd> |
| 144 str | 184 str |
| 145 </dd> | 185 </dd> |
| 146 </dl><a NAME="RefactoringDialogBase.previewChanges" ID="RefactoringDialogBase.previewChanges"></a> | 186 </dl> |
| 187 <a NAME="RefactoringDialogBase.previewChanges" ID="RefactoringDialogBase.previewChanges"></a> | |
| 147 <h4>RefactoringDialogBase.previewChanges</h4> | 188 <h4>RefactoringDialogBase.previewChanges</h4> |
| 148 <b>previewChanges</b>(<i>data</i>) | 189 <b>previewChanges</b>(<i>data</i>) |
| 190 | |
| 149 <p> | 191 <p> |
| 150 Public method to preview the changes. | 192 Public method to preview the changes. |
| 151 </p><dl> | 193 </p> |
| 194 <dl> | |
| 195 | |
| 152 <dt><i>data</i> (dict)</dt> | 196 <dt><i>data</i> (dict)</dt> |
| 153 <dd> | 197 <dd> |
| 154 dictionary containing the change data | 198 dictionary containing the change data |
| 155 </dd> | 199 </dd> |
| 156 </dl><a NAME="RefactoringDialogBase.processChangeData" ID="RefactoringDialogBase.processChangeData"></a> | 200 </dl> |
| 201 <a NAME="RefactoringDialogBase.processChangeData" ID="RefactoringDialogBase.processChangeData"></a> | |
| 157 <h4>RefactoringDialogBase.processChangeData</h4> | 202 <h4>RefactoringDialogBase.processChangeData</h4> |
| 158 <b>processChangeData</b>(<i>data</i>) | 203 <b>processChangeData</b>(<i>data</i>) |
| 204 | |
| 159 <p> | 205 <p> |
| 160 Public method to process the change data sent by the refactoring | 206 Public method to process the change data sent by the refactoring |
| 161 client. | 207 client. |
| 162 </p><dl> | 208 </p> |
| 209 <dl> | |
| 210 | |
| 163 <dt><i>data</i> (dict)</dt> | 211 <dt><i>data</i> (dict)</dt> |
| 164 <dd> | 212 <dd> |
| 165 dictionary containing the change data | 213 dictionary containing the change data |
| 166 </dd> | 214 </dd> |
| 167 </dl><a NAME="RefactoringDialogBase.requestPreview" ID="RefactoringDialogBase.requestPreview"></a> | 215 </dl> |
| 216 <a NAME="RefactoringDialogBase.requestPreview" ID="RefactoringDialogBase.requestPreview"></a> | |
| 168 <h4>RefactoringDialogBase.requestPreview</h4> | 217 <h4>RefactoringDialogBase.requestPreview</h4> |
| 169 <b>requestPreview</b>(<i></i>) | 218 <b>requestPreview</b>(<i></i>) |
| 219 | |
| 170 <p> | 220 <p> |
| 171 Public method to request a preview of the calculated changes. | 221 Public method to request a preview of the calculated changes. |
| 172 </p> | 222 </p> |
| 173 <div align="right"><a href="#top">Up</a></div> | 223 <div align="right"><a href="#top">Up</a></div> |
| 174 <hr /> | 224 <hr /> |
