Mercurial Repositories > Rope Refactoring / file comparison
comparison: RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.MoveDialog.html
RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.MoveDialog.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.MoveDialog</h1> | 23 <h1>Plugin_Refactoring_Rope.RefactoringRope.MoveDialog</h1> |
| 24 | |
| 23 <p> | 25 <p> |
| 24 Module implementing the Move Method or Module dialog. | 26 Module implementing the Move Method or Module 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> |
| 31 <table> | 34 |
| 35 <table> | |
| 36 | |
| 32 <tr> | 37 <tr> |
| 33 <td><a href="#MoveDialog">MoveDialog</a></td> | 38 <td><a href="#MoveDialog">MoveDialog</a></td> |
| 34 <td>Class implementing the Move Method or Module dialog.</td> | 39 <td>Class implementing the Move Method or Module dialog.</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="MoveDialog" ID="MoveDialog"></a> | 49 <a NAME="MoveDialog" ID="MoveDialog"></a> |
| 43 <h2>MoveDialog</h2> | 50 <h2>MoveDialog</h2> |
| 51 | |
| 44 <p> | 52 <p> |
| 45 Class implementing the Move Method or Module dialog. | 53 Class implementing the Move Method or Module dialog. |
| 46 </p> | 54 </p> |
| 47 <h3>Derived from</h3> | 55 <h3>Derived from</h3> |
| 48 RefactoringDialogBase, Ui_MoveDialog | 56 RefactoringDialogBase, Ui_MoveDialog |
| 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="#MoveDialog.__init__">MoveDialog</a></td> | 72 <td><a href="#MoveDialog.__init__">MoveDialog</a></td> |
| 61 <td>Constructor</td> | 73 <td>Constructor</td> |
| 62 </tr><tr> | 74 </tr> |
| 75 <tr> | |
| 63 <td><a href="#MoveDialog.__checkDestination">__checkDestination</a></td> | 76 <td><a href="#MoveDialog.__checkDestination">__checkDestination</a></td> |
| 64 <td>Private method to check the destination entered.</td> | 77 <td>Private method to check the destination entered.</td> |
| 65 </tr><tr> | 78 </tr> |
| 79 <tr> | |
| 66 <td><a href="#MoveDialog.__processMoveType">__processMoveType</a></td> | 80 <td><a href="#MoveDialog.__processMoveType">__processMoveType</a></td> |
| 67 <td>Private method to process the move type data sent by the refactoring client in order to polish the dialog.</td> | 81 <td>Private method to process the move type data sent by the refactoring client in order to polish the dialog.</td> |
| 68 </tr><tr> | 82 </tr> |
| 83 <tr> | |
| 69 <td><a href="#MoveDialog.__updateUI">__updateUI</a></td> | 84 <td><a href="#MoveDialog.__updateUI">__updateUI</a></td> |
| 70 <td>Private method to perform various UI updates.</td> | 85 <td>Private method to perform various UI updates.</td> |
| 71 </tr><tr> | 86 </tr> |
| 87 <tr> | |
| 72 <td><a href="#MoveDialog._calculateChanges">_calculateChanges</a></td> | 88 <td><a href="#MoveDialog._calculateChanges">_calculateChanges</a></td> |
| 73 <td>Protected method to initiate the calculation of the changes.</td> | 89 <td>Protected method to initiate the calculation of the changes.</td> |
| 74 </tr><tr> | 90 </tr> |
| 91 <tr> | |
| 75 <td><a href="#MoveDialog.on_attributeEdit_textChanged">on_attributeEdit_textChanged</a></td> | 92 <td><a href="#MoveDialog.on_attributeEdit_textChanged">on_attributeEdit_textChanged</a></td> |
| 76 <td>Private slot to react to changes of the attribute.</td> | 93 <td>Private slot to react to changes of the attribute.</td> |
| 77 </tr><tr> | 94 </tr> |
| 95 <tr> | |
| 78 <td><a href="#MoveDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | 96 <td><a href="#MoveDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> |
| 79 <td>Private slot to act on the button pressed.</td> | 97 <td>Private slot to act on the button pressed.</td> |
| 80 </tr><tr> | 98 </tr> |
| 99 <tr> | |
| 81 <td><a href="#MoveDialog.on_destinationEdit_textChanged">on_destinationEdit_textChanged</a></td> | 100 <td><a href="#MoveDialog.on_destinationEdit_textChanged">on_destinationEdit_textChanged</a></td> |
| 82 <td>Private slot to react to changes of the destination module.</td> | 101 <td>Private slot to react to changes of the destination module.</td> |
| 83 </tr><tr> | 102 </tr> |
| 103 <tr> | |
| 84 <td><a href="#MoveDialog.on_methodEdit_textChanged">on_methodEdit_textChanged</a></td> | 104 <td><a href="#MoveDialog.on_methodEdit_textChanged">on_methodEdit_textChanged</a></td> |
| 85 <td>Private slot to react to changes of the method.</td> | 105 <td>Private slot to react to changes of the method.</td> |
| 86 </tr><tr> | 106 </tr> |
| 107 <tr> | |
| 87 <td><a href="#MoveDialog.on_selectButton_clicked">on_selectButton_clicked</a></td> | 108 <td><a href="#MoveDialog.on_selectButton_clicked">on_selectButton_clicked</a></td> |
| 88 <td>Private slot called to select the destination module via a file selection dialog.</td> | 109 <td>Private slot called to select the destination module via a file selection dialog.</td> |
| 89 </tr><tr> | 110 </tr> |
| 111 <tr> | |
| 90 <td><a href="#MoveDialog.processChangeData">processChangeData</a></td> | 112 <td><a href="#MoveDialog.processChangeData">processChangeData</a></td> |
| 91 <td>Public method to process the change data sent by the refactoring client.</td> | 113 <td>Public method to process the change data sent by the refactoring client.</td> |
| 92 </tr> | 114 </tr> |
| 93 </table> | 115 </table> |
| 94 <h3>Static Methods</h3> | 116 <h3>Static Methods</h3> |
| 95 <table> | 117 |
| 96 <tr><td>None</td></tr> | 118 <table> |
| 97 </table> | 119 <tr><td>None</td></tr> |
| 120 </table> | |
| 121 | |
| 98 <a NAME="MoveDialog.__init__" ID="MoveDialog.__init__"></a> | 122 <a NAME="MoveDialog.__init__" ID="MoveDialog.__init__"></a> |
| 99 <h4>MoveDialog (Constructor)</h4> | 123 <h4>MoveDialog (Constructor)</h4> |
| 100 <b>MoveDialog</b>(<i>refactoring, title, filename, offset, parent=None</i>) | 124 <b>MoveDialog</b>(<i>refactoring, title, filename, offset, parent=None</i>) |
| 125 | |
| 101 <p> | 126 <p> |
| 102 Constructor | 127 Constructor |
| 103 </p><dl> | 128 </p> |
| 129 <dl> | |
| 130 | |
| 104 <dt><i>refactoring</i> (RefactoringServer)</dt> | 131 <dt><i>refactoring</i> (RefactoringServer)</dt> |
| 105 <dd> | 132 <dd> |
| 106 reference to the main refactoring object | 133 reference to the main refactoring object |
| 107 </dd><dt><i>title</i> (str)</dt> | 134 </dd> |
| 135 <dt><i>title</i> (str)</dt> | |
| 108 <dd> | 136 <dd> |
| 109 title of the dialog | 137 title of the dialog |
| 110 </dd><dt><i>filename</i> (str)</dt> | 138 </dd> |
| 139 <dt><i>filename</i> (str)</dt> | |
| 111 <dd> | 140 <dd> |
| 112 file name to be worked on | 141 file name to be worked on |
| 113 </dd><dt><i>offset</i> (int or None)</dt> | 142 </dd> |
| 143 <dt><i>offset</i> (int or None)</dt> | |
| 114 <dd> | 144 <dd> |
| 115 offset within file | 145 offset within file |
| 116 </dd><dt><i>parent</i> (QWidget)</dt> | 146 </dd> |
| 147 <dt><i>parent</i> (QWidget)</dt> | |
| 117 <dd> | 148 <dd> |
| 118 reference to the parent widget | 149 reference to the parent widget |
| 119 </dd> | 150 </dd> |
| 120 </dl><a NAME="MoveDialog.__checkDestination" ID="MoveDialog.__checkDestination"></a> | 151 </dl> |
| 152 <a NAME="MoveDialog.__checkDestination" ID="MoveDialog.__checkDestination"></a> | |
| 121 <h4>MoveDialog.__checkDestination</h4> | 153 <h4>MoveDialog.__checkDestination</h4> |
| 122 <b>__checkDestination</b>(<i></i>) | 154 <b>__checkDestination</b>(<i></i>) |
| 155 | |
| 123 <p> | 156 <p> |
| 124 Private method to check the destination entered. | 157 Private method to check the destination entered. |
| 125 </p><dl> | 158 </p> |
| 159 <dl> | |
| 126 <dt>Returns:</dt> | 160 <dt>Returns:</dt> |
| 127 <dd> | 161 <dd> |
| 128 flag indicating a valid entry | 162 flag indicating a valid entry |
| 129 </dd> | 163 </dd> |
| 130 </dl><dl> | 164 </dl> |
| 165 <dl> | |
| 131 <dt>Return Type:</dt> | 166 <dt>Return Type:</dt> |
| 132 <dd> | 167 <dd> |
| 133 bool | 168 bool |
| 134 </dd> | 169 </dd> |
| 135 </dl><a NAME="MoveDialog.__processMoveType" ID="MoveDialog.__processMoveType"></a> | 170 </dl> |
| 171 <a NAME="MoveDialog.__processMoveType" ID="MoveDialog.__processMoveType"></a> | |
| 136 <h4>MoveDialog.__processMoveType</h4> | 172 <h4>MoveDialog.__processMoveType</h4> |
| 137 <b>__processMoveType</b>(<i>data</i>) | 173 <b>__processMoveType</b>(<i>data</i>) |
| 174 | |
| 138 <p> | 175 <p> |
| 139 Private method to process the move type data sent by the refactoring | 176 Private method to process the move type data sent by the refactoring |
| 140 client in order to polish the dialog. | 177 client in order to polish the dialog. |
| 141 </p><dl> | 178 </p> |
| 179 <dl> | |
| 180 | |
| 142 <dt><i>data</i> (dict)</dt> | 181 <dt><i>data</i> (dict)</dt> |
| 143 <dd> | 182 <dd> |
| 144 dictionary containing the move type data | 183 dictionary containing the move type data |
| 145 </dd> | 184 </dd> |
| 146 </dl><a NAME="MoveDialog.__updateUI" ID="MoveDialog.__updateUI"></a> | 185 </dl> |
| 186 <a NAME="MoveDialog.__updateUI" ID="MoveDialog.__updateUI"></a> | |
| 147 <h4>MoveDialog.__updateUI</h4> | 187 <h4>MoveDialog.__updateUI</h4> |
| 148 <b>__updateUI</b>(<i></i>) | 188 <b>__updateUI</b>(<i></i>) |
| 189 | |
| 149 <p> | 190 <p> |
| 150 Private method to perform various UI updates. | 191 Private method to perform various UI updates. |
| 151 </p><a NAME="MoveDialog._calculateChanges" ID="MoveDialog._calculateChanges"></a> | 192 </p> |
| 193 <a NAME="MoveDialog._calculateChanges" ID="MoveDialog._calculateChanges"></a> | |
| 152 <h4>MoveDialog._calculateChanges</h4> | 194 <h4>MoveDialog._calculateChanges</h4> |
| 153 <b>_calculateChanges</b>(<i></i>) | 195 <b>_calculateChanges</b>(<i></i>) |
| 196 | |
| 154 <p> | 197 <p> |
| 155 Protected method to initiate the calculation of the changes. | 198 Protected method to initiate the calculation of the changes. |
| 156 </p><a NAME="MoveDialog.on_attributeEdit_textChanged" ID="MoveDialog.on_attributeEdit_textChanged"></a> | 199 </p> |
| 200 <a NAME="MoveDialog.on_attributeEdit_textChanged" ID="MoveDialog.on_attributeEdit_textChanged"></a> | |
| 157 <h4>MoveDialog.on_attributeEdit_textChanged</h4> | 201 <h4>MoveDialog.on_attributeEdit_textChanged</h4> |
| 158 <b>on_attributeEdit_textChanged</b>(<i>text</i>) | 202 <b>on_attributeEdit_textChanged</b>(<i>text</i>) |
| 203 | |
| 159 <p> | 204 <p> |
| 160 Private slot to react to changes of the attribute. | 205 Private slot to react to changes of the attribute. |
| 161 </p><dl> | 206 </p> |
| 207 <dl> | |
| 208 | |
| 162 <dt><i>text</i> (str)</dt> | 209 <dt><i>text</i> (str)</dt> |
| 163 <dd> | 210 <dd> |
| 164 text entered into the edit | 211 text entered into the edit |
| 165 </dd> | 212 </dd> |
| 166 </dl><a NAME="MoveDialog.on_buttonBox_clicked" ID="MoveDialog.on_buttonBox_clicked"></a> | 213 </dl> |
| 214 <a NAME="MoveDialog.on_buttonBox_clicked" ID="MoveDialog.on_buttonBox_clicked"></a> | |
| 167 <h4>MoveDialog.on_buttonBox_clicked</h4> | 215 <h4>MoveDialog.on_buttonBox_clicked</h4> |
| 168 <b>on_buttonBox_clicked</b>(<i>button</i>) | 216 <b>on_buttonBox_clicked</b>(<i>button</i>) |
| 217 | |
| 169 <p> | 218 <p> |
| 170 Private slot to act on the button pressed. | 219 Private slot to act on the button pressed. |
| 171 </p><dl> | 220 </p> |
| 221 <dl> | |
| 222 | |
| 172 <dt><i>button</i> (QAbstractButton)</dt> | 223 <dt><i>button</i> (QAbstractButton)</dt> |
| 173 <dd> | 224 <dd> |
| 174 reference to the button pressed | 225 reference to the button pressed |
| 175 </dd> | 226 </dd> |
| 176 </dl><a NAME="MoveDialog.on_destinationEdit_textChanged" ID="MoveDialog.on_destinationEdit_textChanged"></a> | 227 </dl> |
| 228 <a NAME="MoveDialog.on_destinationEdit_textChanged" ID="MoveDialog.on_destinationEdit_textChanged"></a> | |
| 177 <h4>MoveDialog.on_destinationEdit_textChanged</h4> | 229 <h4>MoveDialog.on_destinationEdit_textChanged</h4> |
| 178 <b>on_destinationEdit_textChanged</b>(<i>text</i>) | 230 <b>on_destinationEdit_textChanged</b>(<i>text</i>) |
| 231 | |
| 179 <p> | 232 <p> |
| 180 Private slot to react to changes of the destination module. | 233 Private slot to react to changes of the destination module. |
| 181 </p><dl> | 234 </p> |
| 235 <dl> | |
| 236 | |
| 182 <dt><i>text</i> (str)</dt> | 237 <dt><i>text</i> (str)</dt> |
| 183 <dd> | 238 <dd> |
| 184 text entered into the edit | 239 text entered into the edit |
| 185 </dd> | 240 </dd> |
| 186 </dl><a NAME="MoveDialog.on_methodEdit_textChanged" ID="MoveDialog.on_methodEdit_textChanged"></a> | 241 </dl> |
| 242 <a NAME="MoveDialog.on_methodEdit_textChanged" ID="MoveDialog.on_methodEdit_textChanged"></a> | |
| 187 <h4>MoveDialog.on_methodEdit_textChanged</h4> | 243 <h4>MoveDialog.on_methodEdit_textChanged</h4> |
| 188 <b>on_methodEdit_textChanged</b>(<i>text</i>) | 244 <b>on_methodEdit_textChanged</b>(<i>text</i>) |
| 245 | |
| 189 <p> | 246 <p> |
| 190 Private slot to react to changes of the method. | 247 Private slot to react to changes of the method. |
| 191 </p><dl> | 248 </p> |
| 249 <dl> | |
| 250 | |
| 192 <dt><i>text</i> (str)</dt> | 251 <dt><i>text</i> (str)</dt> |
| 193 <dd> | 252 <dd> |
| 194 text entered into the edit | 253 text entered into the edit |
| 195 </dd> | 254 </dd> |
| 196 </dl><a NAME="MoveDialog.on_selectButton_clicked" ID="MoveDialog.on_selectButton_clicked"></a> | 255 </dl> |
| 256 <a NAME="MoveDialog.on_selectButton_clicked" ID="MoveDialog.on_selectButton_clicked"></a> | |
| 197 <h4>MoveDialog.on_selectButton_clicked</h4> | 257 <h4>MoveDialog.on_selectButton_clicked</h4> |
| 198 <b>on_selectButton_clicked</b>(<i></i>) | 258 <b>on_selectButton_clicked</b>(<i></i>) |
| 259 | |
| 199 <p> | 260 <p> |
| 200 Private slot called to select the destination module via a file | 261 Private slot called to select the destination module via a file |
| 201 selection dialog. | 262 selection dialog. |
| 202 </p><a NAME="MoveDialog.processChangeData" ID="MoveDialog.processChangeData"></a> | 263 </p> |
| 264 <a NAME="MoveDialog.processChangeData" ID="MoveDialog.processChangeData"></a> | |
| 203 <h4>MoveDialog.processChangeData</h4> | 265 <h4>MoveDialog.processChangeData</h4> |
| 204 <b>processChangeData</b>(<i>data</i>) | 266 <b>processChangeData</b>(<i>data</i>) |
| 267 | |
| 205 <p> | 268 <p> |
| 206 Public method to process the change data sent by the refactoring | 269 Public method to process the change data sent by the refactoring |
| 207 client. | 270 client. |
| 208 </p><dl> | 271 </p> |
| 272 <dl> | |
| 273 | |
| 209 <dt><i>data</i> (dict)</dt> | 274 <dt><i>data</i> (dict)</dt> |
| 210 <dd> | 275 <dd> |
| 211 dictionary containing the change data | 276 dictionary containing the change data |
| 212 </dd> | 277 </dd> |
| 213 </dl> | 278 </dl> |
