RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.GetterSetterDialog.html

branch
eric7
changeset 416
45159308166f
parent 375
c61a2f18ed78
equal deleted inserted replaced
415:78af27bb8201 416:45159308166f
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>Plugin_Refactoring_Rope.RefactoringRope.GetterSetterDialog</h1> 9 <h1>Plugin_Refactoring_Rope.RefactoringRope.GetterSetterDialog</h1>
10
11 <p> 10 <p>
12 Module implementing the encapsulate attribute dialog. 11 Module implementing the encapsulate attribute dialog.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15 15 <table>
16 <table> 16 <tr><td>None</td></tr>
17 <tr><td>None</td></tr> 17 </table>
18 </table> 18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#GetterSetterDialog">GetterSetterDialog</a></td> 22 <td><a href="#GetterSetterDialog">GetterSetterDialog</a></td>
25 <td>Class implementing the encapsulate attribute dialog.</td> 23 <td>Class implementing the encapsulate attribute dialog.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29 28 <table>
30 <table> 29 <tr><td>None</td></tr>
31 <tr><td>None</td></tr> 30 </table>
32 </table> 31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="GetterSetterDialog" ID="GetterSetterDialog"></a> 34 <a NAME="GetterSetterDialog" ID="GetterSetterDialog"></a>
36 <h2>GetterSetterDialog</h2> 35 <h2>GetterSetterDialog</h2>
37
38 <p> 36 <p>
39 Class implementing the encapsulate attribute dialog. 37 Class implementing the encapsulate attribute dialog.
40 </p> 38 </p>
39
41 <h3>Derived from</h3> 40 <h3>Derived from</h3>
42 RefactoringDialogBase, Ui_GetterSetterDialog 41 RefactoringDialogBase, Ui_GetterSetterDialog
43 <h3>Class Attributes</h3> 42 <h3>Class Attributes</h3>
44 43 <table>
45 <table> 44 <tr><td>None</td></tr>
46 <tr><td>None</td></tr> 45 </table>
47 </table> 46
48 <h3>Class Methods</h3> 47 <h3>Class Methods</h3>
49 48 <table>
50 <table> 49 <tr><td>None</td></tr>
51 <tr><td>None</td></tr> 50 </table>
52 </table> 51
53 <h3>Methods</h3> 52 <h3>Methods</h3>
54 53 <table>
55 <table>
56
57 <tr> 54 <tr>
58 <td><a href="#GetterSetterDialog.__init__">GetterSetterDialog</a></td> 55 <td><a href="#GetterSetterDialog.__init__">GetterSetterDialog</a></td>
59 <td>Constructor</td> 56 <td>Constructor</td>
60 </tr> 57 </tr>
61 <tr> 58 <tr>
89 <tr> 86 <tr>
90 <td><a href="#GetterSetterDialog.processChangeData">processChangeData</a></td> 87 <td><a href="#GetterSetterDialog.processChangeData">processChangeData</a></td>
91 <td>Public method to process the change data sent by the refactoring client.</td> 88 <td>Public method to process the change data sent by the refactoring client.</td>
92 </tr> 89 </tr>
93 </table> 90 </table>
91
94 <h3>Static Methods</h3> 92 <h3>Static Methods</h3>
95 93 <table>
96 <table> 94 <tr><td>None</td></tr>
97 <tr><td>None</td></tr> 95 </table>
98 </table> 96
99 97
100 <a NAME="GetterSetterDialog.__init__" ID="GetterSetterDialog.__init__"></a> 98 <a NAME="GetterSetterDialog.__init__" ID="GetterSetterDialog.__init__"></a>
101 <h4>GetterSetterDialog (Constructor)</h4> 99 <h4>GetterSetterDialog (Constructor)</h4>
102 <b>GetterSetterDialog</b>(<i>refactoring, title, filename, offset, parent=None</i>) 100 <b>GetterSetterDialog</b>(<i>refactoring, title, filename, offset, parent=None</i>)
103
104 <p> 101 <p>
105 Constructor 102 Constructor
106 </p> 103 </p>
104
107 <dl> 105 <dl>
108 106
109 <dt><i>refactoring</i> (RefactoringServer)</dt> 107 <dt><i>refactoring</i> (RefactoringServer)</dt>
110 <dd> 108 <dd>
111 reference to the main refactoring object 109 reference to the main refactoring object
128 </dd> 126 </dd>
129 </dl> 127 </dl>
130 <a NAME="GetterSetterDialog.__processFieldName" ID="GetterSetterDialog.__processFieldName"></a> 128 <a NAME="GetterSetterDialog.__processFieldName" ID="GetterSetterDialog.__processFieldName"></a>
131 <h4>GetterSetterDialog.__processFieldName</h4> 129 <h4>GetterSetterDialog.__processFieldName</h4>
132 <b>__processFieldName</b>(<i>data</i>) 130 <b>__processFieldName</b>(<i>data</i>)
133
134 <p> 131 <p>
135 Private method to process the field name data sent by the refactoring 132 Private method to process the field name data sent by the refactoring
136 client in order to polish the dialog. 133 client in order to polish the dialog.
137 </p> 134 </p>
135
138 <dl> 136 <dl>
139 137
140 <dt><i>data</i> (dict)</dt> 138 <dt><i>data</i> (dict)</dt>
141 <dd> 139 <dd>
142 dictionary containing the inline type data 140 dictionary containing the inline type data
143 </dd> 141 </dd>
144 </dl> 142 </dl>
145 <a NAME="GetterSetterDialog.__updateUI" ID="GetterSetterDialog.__updateUI"></a> 143 <a NAME="GetterSetterDialog.__updateUI" ID="GetterSetterDialog.__updateUI"></a>
146 <h4>GetterSetterDialog.__updateUI</h4> 144 <h4>GetterSetterDialog.__updateUI</h4>
147 <b>__updateUI</b>(<i></i>) 145 <b>__updateUI</b>(<i></i>)
148
149 <p> 146 <p>
150 Private slot to update the UI. 147 Private slot to update the UI.
151 </p> 148 </p>
149
152 <a NAME="GetterSetterDialog._calculateChanges" ID="GetterSetterDialog._calculateChanges"></a> 150 <a NAME="GetterSetterDialog._calculateChanges" ID="GetterSetterDialog._calculateChanges"></a>
153 <h4>GetterSetterDialog._calculateChanges</h4> 151 <h4>GetterSetterDialog._calculateChanges</h4>
154 <b>_calculateChanges</b>(<i></i>) 152 <b>_calculateChanges</b>(<i></i>)
155
156 <p> 153 <p>
157 Protected method to initiate the calculation of the changes. 154 Protected method to initiate the calculation of the changes.
158 </p> 155 </p>
156
159 <a NAME="GetterSetterDialog.on_buttonBox_clicked" ID="GetterSetterDialog.on_buttonBox_clicked"></a> 157 <a NAME="GetterSetterDialog.on_buttonBox_clicked" ID="GetterSetterDialog.on_buttonBox_clicked"></a>
160 <h4>GetterSetterDialog.on_buttonBox_clicked</h4> 158 <h4>GetterSetterDialog.on_buttonBox_clicked</h4>
161 <b>on_buttonBox_clicked</b>(<i>button</i>) 159 <b>on_buttonBox_clicked</b>(<i>button</i>)
162
163 <p> 160 <p>
164 Private slot to act on the button pressed. 161 Private slot to act on the button pressed.
165 </p> 162 </p>
163
166 <dl> 164 <dl>
167 165
168 <dt><i>button</i> (QAbstractButton)</dt> 166 <dt><i>button</i> (QAbstractButton)</dt>
169 <dd> 167 <dd>
170 reference to the button pressed 168 reference to the button pressed
171 </dd> 169 </dd>
172 </dl> 170 </dl>
173 <a NAME="GetterSetterDialog.on_getterEdit_textChanged" ID="GetterSetterDialog.on_getterEdit_textChanged"></a> 171 <a NAME="GetterSetterDialog.on_getterEdit_textChanged" ID="GetterSetterDialog.on_getterEdit_textChanged"></a>
174 <h4>GetterSetterDialog.on_getterEdit_textChanged</h4> 172 <h4>GetterSetterDialog.on_getterEdit_textChanged</h4>
175 <b>on_getterEdit_textChanged</b>(<i>text</i>) 173 <b>on_getterEdit_textChanged</b>(<i>text</i>)
176
177 <p> 174 <p>
178 Private slot to react to changes of the getter method. 175 Private slot to react to changes of the getter method.
179 </p> 176 </p>
177
180 <dl> 178 <dl>
181 179
182 <dt><i>text</i> (str)</dt> 180 <dt><i>text</i> (str)</dt>
183 <dd> 181 <dd>
184 text entered into the edit 182 text entered into the edit
185 </dd> 183 </dd>
186 </dl> 184 </dl>
187 <a NAME="GetterSetterDialog.on_setterEdit_textChanged" ID="GetterSetterDialog.on_setterEdit_textChanged"></a> 185 <a NAME="GetterSetterDialog.on_setterEdit_textChanged" ID="GetterSetterDialog.on_setterEdit_textChanged"></a>
188 <h4>GetterSetterDialog.on_setterEdit_textChanged</h4> 186 <h4>GetterSetterDialog.on_setterEdit_textChanged</h4>
189 <b>on_setterEdit_textChanged</b>(<i>text</i>) 187 <b>on_setterEdit_textChanged</b>(<i>text</i>)
190
191 <p> 188 <p>
192 Private slot to react to changes of the setter method. 189 Private slot to react to changes of the setter method.
193 </p> 190 </p>
191
194 <dl> 192 <dl>
195 193
196 <dt><i>text</i> (str)</dt> 194 <dt><i>text</i> (str)</dt>
197 <dd> 195 <dd>
198 text entered into the edit 196 text entered into the edit
199 </dd> 197 </dd>
200 </dl> 198 </dl>
201 <a NAME="GetterSetterDialog.on_typeCheckBox_toggled" ID="GetterSetterDialog.on_typeCheckBox_toggled"></a> 199 <a NAME="GetterSetterDialog.on_typeCheckBox_toggled" ID="GetterSetterDialog.on_typeCheckBox_toggled"></a>
202 <h4>GetterSetterDialog.on_typeCheckBox_toggled</h4> 200 <h4>GetterSetterDialog.on_typeCheckBox_toggled</h4>
203 <b>on_typeCheckBox_toggled</b>(<i>checked</i>) 201 <b>on_typeCheckBox_toggled</b>(<i>checked</i>)
204
205 <p> 202 <p>
206 Private slot to react to changes of the type checkbox. 203 Private slot to react to changes of the type checkbox.
207 </p> 204 </p>
205
208 <dl> 206 <dl>
209 207
210 <dt><i>checked</i> (bool)</dt> 208 <dt><i>checked</i> (bool)</dt>
211 <dd> 209 <dd>
212 state of the checkbox 210 state of the checkbox
213 </dd> 211 </dd>
214 </dl> 212 </dl>
215 <a NAME="GetterSetterDialog.processChangeData" ID="GetterSetterDialog.processChangeData"></a> 213 <a NAME="GetterSetterDialog.processChangeData" ID="GetterSetterDialog.processChangeData"></a>
216 <h4>GetterSetterDialog.processChangeData</h4> 214 <h4>GetterSetterDialog.processChangeData</h4>
217 <b>processChangeData</b>(<i>data</i>) 215 <b>processChangeData</b>(<i>data</i>)
218
219 <p> 216 <p>
220 Public method to process the change data sent by the refactoring 217 Public method to process the change data sent by the refactoring
221 client. 218 client.
222 </p> 219 </p>
220
223 <dl> 221 <dl>
224 222
225 <dt><i>data</i> (dict)</dt> 223 <dt><i>data</i> (dict)</dt>
226 <dd> 224 <dd>
227 dictionary containing the change data 225 dictionary containing the change data

eric ide

mercurial