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
- branch
- server_client_variant
- changeset 204
- b4bf79b956bc
- parent 87
- 1fbf5fdbe721
- child 321
- d51e810107ec
equal
deleted
inserted
replaced
| 203:c38750e1bafd | 204:b4bf79b956bc |
|---|---|
| 19 </style> | 19 </style> |
| 20 </head> | 20 </head> |
| 21 <body><a NAME="top" ID="top"></a> | 21 <body><a NAME="top" ID="top"></a> |
| 22 <h1>Plugin_Refactoring_Rope.RefactoringRope.GetterSetterDialog</h1> | 22 <h1>Plugin_Refactoring_Rope.RefactoringRope.GetterSetterDialog</h1> |
| 23 <p> | 23 <p> |
| 24 Module implementing a dialog to create getter and setter method names. | 24 Module implementing the encapsulate attribute dialog. |
| 25 </p> | 25 </p> |
| 26 <h3>Global Attributes</h3> | 26 <h3>Global Attributes</h3> |
| 27 <table> | 27 <table> |
| 28 <tr><td>None</td></tr> | 28 <tr><td>None</td></tr> |
| 29 </table> | 29 </table> |
| 30 <h3>Classes</h3> | 30 <h3>Classes</h3> |
| 31 <table> | 31 <table> |
| 32 <tr> | 32 <tr> |
| 33 <td><a href="#GetterSetterDialog">GetterSetterDialog</a></td> | 33 <td><a href="#GetterSetterDialog">GetterSetterDialog</a></td> |
| 34 <td>Class implementing a dialog to create getter and setter method names.</td> | 34 <td>Class implementing the encapsulate attribute dialog.</td> |
| 35 </tr> | 35 </tr> |
| 36 </table> | 36 </table> |
| 37 <h3>Functions</h3> | 37 <h3>Functions</h3> |
| 38 <table> | 38 <table> |
| 39 <tr><td>None</td></tr> | 39 <tr><td>None</td></tr> |
| 40 </table> | 40 </table> |
| 41 <hr /><hr /> | 41 <hr /><hr /> |
| 42 <a NAME="GetterSetterDialog" ID="GetterSetterDialog"></a> | 42 <a NAME="GetterSetterDialog" ID="GetterSetterDialog"></a> |
| 43 <h2>GetterSetterDialog</h2> | 43 <h2>GetterSetterDialog</h2> |
| 44 <p> | 44 <p> |
| 45 Class implementing a dialog to create getter and setter method names. | 45 Class implementing the encapsulate attribute dialog. |
| 46 </p> | 46 </p> |
| 47 <h3>Derived from</h3> | 47 <h3>Derived from</h3> |
| 48 QDialog, Ui_GetterSetterDialog | 48 RefactoringDialogBase, Ui_GetterSetterDialog |
| 49 <h3>Class Attributes</h3> | 49 <h3>Class Attributes</h3> |
| 50 <table> | 50 <table> |
| 51 <tr><td>None</td></tr> | 51 <tr><td>None</td></tr> |
| 52 </table> | 52 </table> |
| 53 <h3>Class Methods</h3> | 53 <h3>Class Methods</h3> |
| 58 <table> | 58 <table> |
| 59 <tr> | 59 <tr> |
| 60 <td><a href="#GetterSetterDialog.__init__">GetterSetterDialog</a></td> | 60 <td><a href="#GetterSetterDialog.__init__">GetterSetterDialog</a></td> |
| 61 <td>Constructor</td> | 61 <td>Constructor</td> |
| 62 </tr><tr> | 62 </tr><tr> |
| 63 <td><a href="#GetterSetterDialog.getData">getData</a></td> | 63 <td><a href="#GetterSetterDialog.__processFieldName">__processFieldName</a></td> |
| 64 <td>Public method to return the getter and setter method names.</td> | 64 <td>Private method to process the field name data sent by the refactoring client in order to polish the dialog.</td> |
| 65 </tr><tr> | |
| 66 <td><a href="#GetterSetterDialog.__updateUI">__updateUI</a></td> | |
| 67 <td>Private slot to update the UI.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#GetterSetterDialog._calculateChanges">_calculateChanges</a></td> | |
| 70 <td>Protected method to initiate the calculation of the changes.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#GetterSetterDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | |
| 73 <td>Private slot to act on the button pressed.</td> | |
| 74 </tr><tr> | |
| 75 <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> | |
| 77 </tr><tr> | |
| 78 <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> | |
| 65 </tr><tr> | 80 </tr><tr> |
| 66 <td><a href="#GetterSetterDialog.on_typeCheckBox_toggled">on_typeCheckBox_toggled</a></td> | 81 <td><a href="#GetterSetterDialog.on_typeCheckBox_toggled">on_typeCheckBox_toggled</a></td> |
| 67 <td>Private slot to react to changes of the type checkbox.</td> | 82 <td>Private slot to react to changes of the type checkbox.</td> |
| 83 </tr><tr> | |
| 84 <td><a href="#GetterSetterDialog.processChangeData">processChangeData</a></td> | |
| 85 <td>Public method to process the change data sent by the refactoring client.</td> | |
| 68 </tr> | 86 </tr> |
| 69 </table> | 87 </table> |
| 70 <h3>Static Methods</h3> | 88 <h3>Static Methods</h3> |
| 71 <table> | 89 <table> |
| 72 <tr><td>None</td></tr> | 90 <tr><td>None</td></tr> |
| 73 </table> | 91 </table> |
| 74 <a NAME="GetterSetterDialog.__init__" ID="GetterSetterDialog.__init__"></a> | 92 <a NAME="GetterSetterDialog.__init__" ID="GetterSetterDialog.__init__"></a> |
| 75 <h4>GetterSetterDialog (Constructor)</h4> | 93 <h4>GetterSetterDialog (Constructor)</h4> |
| 76 <b>GetterSetterDialog</b>(<i>fieldName, parent=None</i>) | 94 <b>GetterSetterDialog</b>(<i>refactoring, title, filename, offset, parent=None</i>) |
| 77 <p> | 95 <p> |
| 78 Constructor | 96 Constructor |
| 79 </p><dl> | 97 </p><dl> |
| 80 <dt><i>fieldName</i></dt> | 98 <dt><i>refactoring</i> (RefactoringServer)</dt> |
| 81 <dd> | 99 <dd> |
| 82 name of the field to create getter and setter | 100 reference to the main refactoring object |
| 83 method names (string) | 101 </dd><dt><i>title</i> (str)</dt> |
| 84 </dd><dt><i>parent</i></dt> | |
| 85 <dd> | 102 <dd> |
| 86 parent widget of the dialog (QWidget) | 103 title of the dialog |
| 104 </dd><dt><i>filename</i> (str)</dt> | |
| 105 <dd> | |
| 106 file name to be worked on | |
| 107 </dd><dt><i>offset</i> (int or None)</dt> | |
| 108 <dd> | |
| 109 offset within file | |
| 110 </dd><dt><i>parent</i> (QWidget)</dt> | |
| 111 <dd> | |
| 112 reference to the parent widget | |
| 87 </dd> | 113 </dd> |
| 88 </dl><a NAME="GetterSetterDialog.getData" ID="GetterSetterDialog.getData"></a> | 114 </dl><a NAME="GetterSetterDialog.__processFieldName" ID="GetterSetterDialog.__processFieldName"></a> |
| 89 <h4>GetterSetterDialog.getData</h4> | 115 <h4>GetterSetterDialog.__processFieldName</h4> |
| 90 <b>getData</b>(<i></i>) | 116 <b>__processFieldName</b>(<i>data</i>) |
| 91 <p> | 117 <p> |
| 92 Public method to return the getter and setter method names. | 118 Private method to process the field name data sent by the refactoring |
| 119 client in order to polish the dialog. | |
| 93 </p><dl> | 120 </p><dl> |
| 94 <dt>Returns:</dt> | 121 <dt><i>data</i> (dict)</dt> |
| 95 <dd> | 122 <dd> |
| 96 tuple of two strings with getter and setter method names | 123 dictionary containing the inline type data |
| 124 </dd> | |
| 125 </dl><a NAME="GetterSetterDialog.__updateUI" ID="GetterSetterDialog.__updateUI"></a> | |
| 126 <h4>GetterSetterDialog.__updateUI</h4> | |
| 127 <b>__updateUI</b>(<i></i>) | |
| 128 <p> | |
| 129 Private slot to update the UI. | |
| 130 </p><a NAME="GetterSetterDialog._calculateChanges" ID="GetterSetterDialog._calculateChanges"></a> | |
| 131 <h4>GetterSetterDialog._calculateChanges</h4> | |
| 132 <b>_calculateChanges</b>(<i></i>) | |
| 133 <p> | |
| 134 Protected method to initiate the calculation of the changes. | |
| 135 </p><a NAME="GetterSetterDialog.on_buttonBox_clicked" ID="GetterSetterDialog.on_buttonBox_clicked"></a> | |
| 136 <h4>GetterSetterDialog.on_buttonBox_clicked</h4> | |
| 137 <b>on_buttonBox_clicked</b>(<i>button</i>) | |
| 138 <p> | |
| 139 Private slot to act on the button pressed. | |
| 140 </p><dl> | |
| 141 <dt><i>button</i> (QAbstractButton)</dt> | |
| 142 <dd> | |
| 143 reference to the button pressed | |
| 144 </dd> | |
| 145 </dl><a NAME="GetterSetterDialog.on_getterEdit_textChanged" ID="GetterSetterDialog.on_getterEdit_textChanged"></a> | |
| 146 <h4>GetterSetterDialog.on_getterEdit_textChanged</h4> | |
| 147 <b>on_getterEdit_textChanged</b>(<i>text</i>) | |
| 148 <p> | |
| 149 Private slot to react to changes of the getter method. | |
| 150 </p><dl> | |
| 151 <dt><i>text</i> (str)</dt> | |
| 152 <dd> | |
| 153 text entered into the edit | |
| 154 </dd> | |
| 155 </dl><a NAME="GetterSetterDialog.on_setterEdit_textChanged" ID="GetterSetterDialog.on_setterEdit_textChanged"></a> | |
| 156 <h4>GetterSetterDialog.on_setterEdit_textChanged</h4> | |
| 157 <b>on_setterEdit_textChanged</b>(<i>text</i>) | |
| 158 <p> | |
| 159 Private slot to react to changes of the setter method. | |
| 160 </p><dl> | |
| 161 <dt><i>text</i> (str)</dt> | |
| 162 <dd> | |
| 163 text entered into the edit | |
| 97 </dd> | 164 </dd> |
| 98 </dl><a NAME="GetterSetterDialog.on_typeCheckBox_toggled" ID="GetterSetterDialog.on_typeCheckBox_toggled"></a> | 165 </dl><a NAME="GetterSetterDialog.on_typeCheckBox_toggled" ID="GetterSetterDialog.on_typeCheckBox_toggled"></a> |
| 99 <h4>GetterSetterDialog.on_typeCheckBox_toggled</h4> | 166 <h4>GetterSetterDialog.on_typeCheckBox_toggled</h4> |
| 100 <b>on_typeCheckBox_toggled</b>(<i>checked</i>) | 167 <b>on_typeCheckBox_toggled</b>(<i>checked</i>) |
| 101 <p> | 168 <p> |
| 102 Private slot to react to changes of the type checkbox. | 169 Private slot to react to changes of the type checkbox. |
| 103 </p><dl> | 170 </p><dl> |
| 104 <dt><i>checked</i></dt> | 171 <dt><i>checked</i> (bool)</dt> |
| 105 <dd> | 172 <dd> |
| 106 state of the checkbox (boolean) | 173 state of the checkbox |
| 174 </dd> | |
| 175 </dl><a NAME="GetterSetterDialog.processChangeData" ID="GetterSetterDialog.processChangeData"></a> | |
| 176 <h4>GetterSetterDialog.processChangeData</h4> | |
| 177 <b>processChangeData</b>(<i>data</i>) | |
| 178 <p> | |
| 179 Public method to process the change data sent by the refactoring | |
| 180 client. | |
| 181 </p><dl> | |
| 182 <dt><i>data</i> (dict)</dt> | |
| 183 <dd> | |
| 184 dictionary containing the change data | |
| 107 </dd> | 185 </dd> |
| 108 </dl> | 186 </dl> |
| 109 <div align="right"><a href="#top">Up</a></div> | 187 <div align="right"><a href="#top">Up</a></div> |
| 110 <hr /> | 188 <hr /> |
| 111 </body></html> | 189 </body></html> |
