Mercurial Repositories > Rope Refactoring / file comparison
comparison: RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.GetterSetterDialog.html
RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.GetterSetterDialog.html
- changeset 321
- d51e810107ec
- parent 204
- b4bf79b956bc
- child 375
- c61a2f18ed78
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.GetterSetterDialog</h1> | 23 <h1>Plugin_Refactoring_Rope.RefactoringRope.GetterSetterDialog</h1> |
| 24 | |
| 23 <p> | 25 <p> |
| 24 Module implementing the encapsulate attribute dialog. | 26 Module implementing the encapsulate attribute 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="#GetterSetterDialog">GetterSetterDialog</a></td> | 38 <td><a href="#GetterSetterDialog">GetterSetterDialog</a></td> |
| 34 <td>Class implementing the encapsulate attribute dialog.</td> | 39 <td>Class implementing the encapsulate attribute 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="GetterSetterDialog" ID="GetterSetterDialog"></a> | 49 <a NAME="GetterSetterDialog" ID="GetterSetterDialog"></a> |
| 43 <h2>GetterSetterDialog</h2> | 50 <h2>GetterSetterDialog</h2> |
| 51 | |
| 44 <p> | 52 <p> |
| 45 Class implementing the encapsulate attribute dialog. | 53 Class implementing the encapsulate attribute dialog. |
| 46 </p> | 54 </p> |
| 47 <h3>Derived from</h3> | 55 <h3>Derived from</h3> |
| 48 RefactoringDialogBase, Ui_GetterSetterDialog | 56 RefactoringDialogBase, Ui_GetterSetterDialog |
| 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="#GetterSetterDialog.__init__">GetterSetterDialog</a></td> | 72 <td><a href="#GetterSetterDialog.__init__">GetterSetterDialog</a></td> |
| 61 <td>Constructor</td> | 73 <td>Constructor</td> |
| 62 </tr><tr> | 74 </tr> |
| 75 <tr> | |
| 63 <td><a href="#GetterSetterDialog.__processFieldName">__processFieldName</a></td> | 76 <td><a href="#GetterSetterDialog.__processFieldName">__processFieldName</a></td> |
| 64 <td>Private method to process the field name data sent by the refactoring client in order to polish the dialog.</td> | 77 <td>Private method to process the field name data sent by the refactoring client in order to polish the dialog.</td> |
| 65 </tr><tr> | 78 </tr> |
| 79 <tr> | |
| 66 <td><a href="#GetterSetterDialog.__updateUI">__updateUI</a></td> | 80 <td><a href="#GetterSetterDialog.__updateUI">__updateUI</a></td> |
| 67 <td>Private slot to update the UI.</td> | 81 <td>Private slot to update the UI.</td> |
| 68 </tr><tr> | 82 </tr> |
| 83 <tr> | |
| 69 <td><a href="#GetterSetterDialog._calculateChanges">_calculateChanges</a></td> | 84 <td><a href="#GetterSetterDialog._calculateChanges">_calculateChanges</a></td> |
| 70 <td>Protected method to initiate the calculation of the changes.</td> | 85 <td>Protected method to initiate the calculation of the changes.</td> |
| 71 </tr><tr> | 86 </tr> |
| 87 <tr> | |
| 72 <td><a href="#GetterSetterDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | 88 <td><a href="#GetterSetterDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> |
| 73 <td>Private slot to act on the button pressed.</td> | 89 <td>Private slot to act on the button pressed.</td> |
| 74 </tr><tr> | 90 </tr> |
| 91 <tr> | |
| 75 <td><a href="#GetterSetterDialog.on_getterEdit_textChanged">on_getterEdit_textChanged</a></td> | 92 <td><a href="#GetterSetterDialog.on_getterEdit_textChanged">on_getterEdit_textChanged</a></td> |
| 76 <td>Private slot to react to changes of the getter method.</td> | 93 <td>Private slot to react to changes of the getter method.</td> |
| 77 </tr><tr> | 94 </tr> |
| 95 <tr> | |
| 78 <td><a href="#GetterSetterDialog.on_setterEdit_textChanged">on_setterEdit_textChanged</a></td> | 96 <td><a href="#GetterSetterDialog.on_setterEdit_textChanged">on_setterEdit_textChanged</a></td> |
| 79 <td>Private slot to react to changes of the setter method.</td> | 97 <td>Private slot to react to changes of the setter method.</td> |
| 80 </tr><tr> | 98 </tr> |
| 99 <tr> | |
| 81 <td><a href="#GetterSetterDialog.on_typeCheckBox_toggled">on_typeCheckBox_toggled</a></td> | 100 <td><a href="#GetterSetterDialog.on_typeCheckBox_toggled">on_typeCheckBox_toggled</a></td> |
| 82 <td>Private slot to react to changes of the type checkbox.</td> | 101 <td>Private slot to react to changes of the type checkbox.</td> |
| 83 </tr><tr> | 102 </tr> |
| 103 <tr> | |
| 84 <td><a href="#GetterSetterDialog.processChangeData">processChangeData</a></td> | 104 <td><a href="#GetterSetterDialog.processChangeData">processChangeData</a></td> |
| 85 <td>Public method to process the change data sent by the refactoring client.</td> | 105 <td>Public method to process the change data sent by the refactoring client.</td> |
| 86 </tr> | 106 </tr> |
| 87 </table> | 107 </table> |
| 88 <h3>Static Methods</h3> | 108 <h3>Static Methods</h3> |
| 89 <table> | 109 |
| 90 <tr><td>None</td></tr> | 110 <table> |
| 91 </table> | 111 <tr><td>None</td></tr> |
| 112 </table> | |
| 113 | |
| 92 <a NAME="GetterSetterDialog.__init__" ID="GetterSetterDialog.__init__"></a> | 114 <a NAME="GetterSetterDialog.__init__" ID="GetterSetterDialog.__init__"></a> |
| 93 <h4>GetterSetterDialog (Constructor)</h4> | 115 <h4>GetterSetterDialog (Constructor)</h4> |
| 94 <b>GetterSetterDialog</b>(<i>refactoring, title, filename, offset, parent=None</i>) | 116 <b>GetterSetterDialog</b>(<i>refactoring, title, filename, offset, parent=None</i>) |
| 117 | |
| 95 <p> | 118 <p> |
| 96 Constructor | 119 Constructor |
| 97 </p><dl> | 120 </p> |
| 121 <dl> | |
| 122 | |
| 98 <dt><i>refactoring</i> (RefactoringServer)</dt> | 123 <dt><i>refactoring</i> (RefactoringServer)</dt> |
| 99 <dd> | 124 <dd> |
| 100 reference to the main refactoring object | 125 reference to the main refactoring object |
| 101 </dd><dt><i>title</i> (str)</dt> | 126 </dd> |
| 127 <dt><i>title</i> (str)</dt> | |
| 102 <dd> | 128 <dd> |
| 103 title of the dialog | 129 title of the dialog |
| 104 </dd><dt><i>filename</i> (str)</dt> | 130 </dd> |
| 131 <dt><i>filename</i> (str)</dt> | |
| 105 <dd> | 132 <dd> |
| 106 file name to be worked on | 133 file name to be worked on |
| 107 </dd><dt><i>offset</i> (int or None)</dt> | 134 </dd> |
| 135 <dt><i>offset</i> (int or None)</dt> | |
| 108 <dd> | 136 <dd> |
| 109 offset within file | 137 offset within file |
| 110 </dd><dt><i>parent</i> (QWidget)</dt> | 138 </dd> |
| 139 <dt><i>parent</i> (QWidget)</dt> | |
| 111 <dd> | 140 <dd> |
| 112 reference to the parent widget | 141 reference to the parent widget |
| 113 </dd> | 142 </dd> |
| 114 </dl><a NAME="GetterSetterDialog.__processFieldName" ID="GetterSetterDialog.__processFieldName"></a> | 143 </dl> |
| 144 <a NAME="GetterSetterDialog.__processFieldName" ID="GetterSetterDialog.__processFieldName"></a> | |
| 115 <h4>GetterSetterDialog.__processFieldName</h4> | 145 <h4>GetterSetterDialog.__processFieldName</h4> |
| 116 <b>__processFieldName</b>(<i>data</i>) | 146 <b>__processFieldName</b>(<i>data</i>) |
| 147 | |
| 117 <p> | 148 <p> |
| 118 Private method to process the field name data sent by the refactoring | 149 Private method to process the field name data sent by the refactoring |
| 119 client in order to polish the dialog. | 150 client in order to polish the dialog. |
| 120 </p><dl> | 151 </p> |
| 152 <dl> | |
| 153 | |
| 121 <dt><i>data</i> (dict)</dt> | 154 <dt><i>data</i> (dict)</dt> |
| 122 <dd> | 155 <dd> |
| 123 dictionary containing the inline type data | 156 dictionary containing the inline type data |
| 124 </dd> | 157 </dd> |
| 125 </dl><a NAME="GetterSetterDialog.__updateUI" ID="GetterSetterDialog.__updateUI"></a> | 158 </dl> |
| 159 <a NAME="GetterSetterDialog.__updateUI" ID="GetterSetterDialog.__updateUI"></a> | |
| 126 <h4>GetterSetterDialog.__updateUI</h4> | 160 <h4>GetterSetterDialog.__updateUI</h4> |
| 127 <b>__updateUI</b>(<i></i>) | 161 <b>__updateUI</b>(<i></i>) |
| 162 | |
| 128 <p> | 163 <p> |
| 129 Private slot to update the UI. | 164 Private slot to update the UI. |
| 130 </p><a NAME="GetterSetterDialog._calculateChanges" ID="GetterSetterDialog._calculateChanges"></a> | 165 </p> |
| 166 <a NAME="GetterSetterDialog._calculateChanges" ID="GetterSetterDialog._calculateChanges"></a> | |
| 131 <h4>GetterSetterDialog._calculateChanges</h4> | 167 <h4>GetterSetterDialog._calculateChanges</h4> |
| 132 <b>_calculateChanges</b>(<i></i>) | 168 <b>_calculateChanges</b>(<i></i>) |
| 169 | |
| 133 <p> | 170 <p> |
| 134 Protected method to initiate the calculation of the changes. | 171 Protected method to initiate the calculation of the changes. |
| 135 </p><a NAME="GetterSetterDialog.on_buttonBox_clicked" ID="GetterSetterDialog.on_buttonBox_clicked"></a> | 172 </p> |
| 173 <a NAME="GetterSetterDialog.on_buttonBox_clicked" ID="GetterSetterDialog.on_buttonBox_clicked"></a> | |
| 136 <h4>GetterSetterDialog.on_buttonBox_clicked</h4> | 174 <h4>GetterSetterDialog.on_buttonBox_clicked</h4> |
| 137 <b>on_buttonBox_clicked</b>(<i>button</i>) | 175 <b>on_buttonBox_clicked</b>(<i>button</i>) |
| 176 | |
| 138 <p> | 177 <p> |
| 139 Private slot to act on the button pressed. | 178 Private slot to act on the button pressed. |
| 140 </p><dl> | 179 </p> |
| 180 <dl> | |
| 181 | |
| 141 <dt><i>button</i> (QAbstractButton)</dt> | 182 <dt><i>button</i> (QAbstractButton)</dt> |
| 142 <dd> | 183 <dd> |
| 143 reference to the button pressed | 184 reference to the button pressed |
| 144 </dd> | 185 </dd> |
| 145 </dl><a NAME="GetterSetterDialog.on_getterEdit_textChanged" ID="GetterSetterDialog.on_getterEdit_textChanged"></a> | 186 </dl> |
| 187 <a NAME="GetterSetterDialog.on_getterEdit_textChanged" ID="GetterSetterDialog.on_getterEdit_textChanged"></a> | |
| 146 <h4>GetterSetterDialog.on_getterEdit_textChanged</h4> | 188 <h4>GetterSetterDialog.on_getterEdit_textChanged</h4> |
| 147 <b>on_getterEdit_textChanged</b>(<i>text</i>) | 189 <b>on_getterEdit_textChanged</b>(<i>text</i>) |
| 190 | |
| 148 <p> | 191 <p> |
| 149 Private slot to react to changes of the getter method. | 192 Private slot to react to changes of the getter method. |
| 150 </p><dl> | 193 </p> |
| 194 <dl> | |
| 195 | |
| 151 <dt><i>text</i> (str)</dt> | 196 <dt><i>text</i> (str)</dt> |
| 152 <dd> | 197 <dd> |
| 153 text entered into the edit | 198 text entered into the edit |
| 154 </dd> | 199 </dd> |
| 155 </dl><a NAME="GetterSetterDialog.on_setterEdit_textChanged" ID="GetterSetterDialog.on_setterEdit_textChanged"></a> | 200 </dl> |
| 201 <a NAME="GetterSetterDialog.on_setterEdit_textChanged" ID="GetterSetterDialog.on_setterEdit_textChanged"></a> | |
| 156 <h4>GetterSetterDialog.on_setterEdit_textChanged</h4> | 202 <h4>GetterSetterDialog.on_setterEdit_textChanged</h4> |
| 157 <b>on_setterEdit_textChanged</b>(<i>text</i>) | 203 <b>on_setterEdit_textChanged</b>(<i>text</i>) |
| 204 | |
| 158 <p> | 205 <p> |
| 159 Private slot to react to changes of the setter method. | 206 Private slot to react to changes of the setter method. |
| 160 </p><dl> | 207 </p> |
| 208 <dl> | |
| 209 | |
| 161 <dt><i>text</i> (str)</dt> | 210 <dt><i>text</i> (str)</dt> |
| 162 <dd> | 211 <dd> |
| 163 text entered into the edit | 212 text entered into the edit |
| 164 </dd> | 213 </dd> |
| 165 </dl><a NAME="GetterSetterDialog.on_typeCheckBox_toggled" ID="GetterSetterDialog.on_typeCheckBox_toggled"></a> | 214 </dl> |
| 215 <a NAME="GetterSetterDialog.on_typeCheckBox_toggled" ID="GetterSetterDialog.on_typeCheckBox_toggled"></a> | |
| 166 <h4>GetterSetterDialog.on_typeCheckBox_toggled</h4> | 216 <h4>GetterSetterDialog.on_typeCheckBox_toggled</h4> |
| 167 <b>on_typeCheckBox_toggled</b>(<i>checked</i>) | 217 <b>on_typeCheckBox_toggled</b>(<i>checked</i>) |
| 218 | |
| 168 <p> | 219 <p> |
| 169 Private slot to react to changes of the type checkbox. | 220 Private slot to react to changes of the type checkbox. |
| 170 </p><dl> | 221 </p> |
| 222 <dl> | |
| 223 | |
| 171 <dt><i>checked</i> (bool)</dt> | 224 <dt><i>checked</i> (bool)</dt> |
| 172 <dd> | 225 <dd> |
| 173 state of the checkbox | 226 state of the checkbox |
| 174 </dd> | 227 </dd> |
| 175 </dl><a NAME="GetterSetterDialog.processChangeData" ID="GetterSetterDialog.processChangeData"></a> | 228 </dl> |
| 229 <a NAME="GetterSetterDialog.processChangeData" ID="GetterSetterDialog.processChangeData"></a> | |
| 176 <h4>GetterSetterDialog.processChangeData</h4> | 230 <h4>GetterSetterDialog.processChangeData</h4> |
| 177 <b>processChangeData</b>(<i>data</i>) | 231 <b>processChangeData</b>(<i>data</i>) |
| 232 | |
| 178 <p> | 233 <p> |
| 179 Public method to process the change data sent by the refactoring | 234 Public method to process the change data sent by the refactoring |
| 180 client. | 235 client. |
| 181 </p><dl> | 236 </p> |
| 237 <dl> | |
| 238 | |
| 182 <dt><i>data</i> (dict)</dt> | 239 <dt><i>data</i> (dict)</dt> |
| 183 <dd> | 240 <dd> |
| 184 dictionary containing the change data | 241 dictionary containing the change data |
| 185 </dd> | 242 </dd> |
| 186 </dl> | 243 </dl> |
