Mercurial Repositories > Rope Refactoring / file comparison

comparison: RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.ChangeSignatureDialog.html

RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.ChangeSignatureDialog.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.ChangeSignatureDialog</h1> 9 <h1>Plugin_Refactoring_Rope.RefactoringRope.ChangeSignatureDialog</h1>
10
11 <p> 10 <p>
12 Module implementing the Change Signature dialog. 11 Module implementing the Change Signature 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="#ChangeSignatureDialog">ChangeSignatureDialog</a></td> 22 <td><a href="#ChangeSignatureDialog">ChangeSignatureDialog</a></td>
25 <td>Class implementing the Change Signature dialog.</td> 23 <td>Class implementing the Change Signature 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="ChangeSignatureDialog" ID="ChangeSignatureDialog"></a> 34 <a NAME="ChangeSignatureDialog" ID="ChangeSignatureDialog"></a>
36 <h2>ChangeSignatureDialog</h2> 35 <h2>ChangeSignatureDialog</h2>
37
38 <p> 36 <p>
39 Class implementing the Change Signature dialog. 37 Class implementing the Change Signature dialog.
40 </p> 38 </p>
39
41 <h3>Derived from</h3> 40 <h3>Derived from</h3>
42 RefactoringDialogBase, Ui_ChangeSignatureDialog 41 RefactoringDialogBase, Ui_ChangeSignatureDialog
43 <h3>Class Attributes</h3> 42 <h3>Class Attributes</h3>
44 43 <table>
45 <table> 44 <tr><td>DefaultRole</td></tr>
46 <tr><td>DefaultRole</td></tr><tr><td>IsAddedRole</td></tr><tr><td>NameRole</td></tr><tr><td>ValueRole</td></tr> 45 <tr><td>IsAddedRole</td></tr>
47 </table> 46 <tr><td>NameRole</td></tr>
47 <tr><td>ValueRole</td></tr>
48 </table>
49
48 <h3>Class Methods</h3> 50 <h3>Class Methods</h3>
49 51 <table>
50 <table> 52 <tr><td>None</td></tr>
51 <tr><td>None</td></tr> 53 </table>
52 </table> 54
53 <h3>Methods</h3> 55 <h3>Methods</h3>
54 56 <table>
55 <table>
56
57 <tr> 57 <tr>
58 <td><a href="#ChangeSignatureDialog.__init__">ChangeSignatureDialog</a></td> 58 <td><a href="#ChangeSignatureDialog.__init__">ChangeSignatureDialog</a></td>
59 <td>Constructor</td> 59 <td>Constructor</td>
60 </tr> 60 </tr>
61 <tr> 61 <tr>
97 <tr> 97 <tr>
98 <td><a href="#ChangeSignatureDialog.processChangeData">processChangeData</a></td> 98 <td><a href="#ChangeSignatureDialog.processChangeData">processChangeData</a></td>
99 <td>Public method to process the change data sent by the refactoring client.</td> 99 <td>Public method to process the change data sent by the refactoring client.</td>
100 </tr> 100 </tr>
101 </table> 101 </table>
102
102 <h3>Static Methods</h3> 103 <h3>Static Methods</h3>
103 104 <table>
104 <table> 105 <tr><td>None</td></tr>
105 <tr><td>None</td></tr> 106 </table>
106 </table> 107
107 108
108 <a NAME="ChangeSignatureDialog.__init__" ID="ChangeSignatureDialog.__init__"></a> 109 <a NAME="ChangeSignatureDialog.__init__" ID="ChangeSignatureDialog.__init__"></a>
109 <h4>ChangeSignatureDialog (Constructor)</h4> 110 <h4>ChangeSignatureDialog (Constructor)</h4>
110 <b>ChangeSignatureDialog</b>(<i>refactoring, title, filename, offset, parent=None</i>) 111 <b>ChangeSignatureDialog</b>(<i>refactoring, title, filename, offset, parent=None</i>)
111
112 <p> 112 <p>
113 Constructor 113 Constructor
114 </p> 114 </p>
115
115 <dl> 116 <dl>
116 117
117 <dt><i>refactoring</i> (RefactoringServer)</dt> 118 <dt><i>refactoring</i> (RefactoringServer)</dt>
118 <dd> 119 <dd>
119 reference to the main refactoring object 120 reference to the main refactoring object
136 </dd> 137 </dd>
137 </dl> 138 </dl>
138 <a NAME="ChangeSignatureDialog.__getParameterIndex" ID="ChangeSignatureDialog.__getParameterIndex"></a> 139 <a NAME="ChangeSignatureDialog.__getParameterIndex" ID="ChangeSignatureDialog.__getParameterIndex"></a>
139 <h4>ChangeSignatureDialog.__getParameterIndex</h4> 140 <h4>ChangeSignatureDialog.__getParameterIndex</h4>
140 <b>__getParameterIndex</b>(<i>definition_info, name</i>) 141 <b>__getParameterIndex</b>(<i>definition_info, name</i>)
141
142 <p> 142 <p>
143 Private method to calculate the index of the given paramter. 143 Private method to calculate the index of the given paramter.
144 </p> 144 </p>
145
145 <dl> 146 <dl>
146 147
147 <dt><i>definition_info</i> (list of lists of two str)</dt> 148 <dt><i>definition_info</i> (list of lists of two str)</dt>
148 <dd> 149 <dd>
149 list of lists containing the method signature 150 list of lists containing the method signature
167 </dd> 168 </dd>
168 </dl> 169 </dl>
169 <a NAME="ChangeSignatureDialog.__processSignature" ID="ChangeSignatureDialog.__processSignature"></a> 170 <a NAME="ChangeSignatureDialog.__processSignature" ID="ChangeSignatureDialog.__processSignature"></a>
170 <h4>ChangeSignatureDialog.__processSignature</h4> 171 <h4>ChangeSignatureDialog.__processSignature</h4>
171 <b>__processSignature</b>(<i>data</i>) 172 <b>__processSignature</b>(<i>data</i>)
172
173 <p> 173 <p>
174 Private method to process the inline type data sent by the refactoring 174 Private method to process the inline type data sent by the refactoring
175 client in order to polish the dialog. 175 client in order to polish the dialog.
176 </p> 176 </p>
177
177 <dl> 178 <dl>
178 179
179 <dt><i>data</i> (dict)</dt> 180 <dt><i>data</i> (dict)</dt>
180 <dd> 181 <dd>
181 dictionary containing the inline type data 182 dictionary containing the inline type data
182 </dd> 183 </dd>
183 </dl> 184 </dl>
184 <a NAME="ChangeSignatureDialog._calculateChanges" ID="ChangeSignatureDialog._calculateChanges"></a> 185 <a NAME="ChangeSignatureDialog._calculateChanges" ID="ChangeSignatureDialog._calculateChanges"></a>
185 <h4>ChangeSignatureDialog._calculateChanges</h4> 186 <h4>ChangeSignatureDialog._calculateChanges</h4>
186 <b>_calculateChanges</b>(<i></i>) 187 <b>_calculateChanges</b>(<i></i>)
187
188 <p> 188 <p>
189 Protected method to initiate the calculation of the changes. 189 Protected method to initiate the calculation of the changes.
190 </p> 190 </p>
191
191 <a NAME="ChangeSignatureDialog.on_addButton_clicked" ID="ChangeSignatureDialog.on_addButton_clicked"></a> 192 <a NAME="ChangeSignatureDialog.on_addButton_clicked" ID="ChangeSignatureDialog.on_addButton_clicked"></a>
192 <h4>ChangeSignatureDialog.on_addButton_clicked</h4> 193 <h4>ChangeSignatureDialog.on_addButton_clicked</h4>
193 <b>on_addButton_clicked</b>(<i></i>) 194 <b>on_addButton_clicked</b>(<i></i>)
194
195 <p> 195 <p>
196 Private slot to add a new parameter. 196 Private slot to add a new parameter.
197 </p> 197 </p>
198
198 <a NAME="ChangeSignatureDialog.on_buttonBox_clicked" ID="ChangeSignatureDialog.on_buttonBox_clicked"></a> 199 <a NAME="ChangeSignatureDialog.on_buttonBox_clicked" ID="ChangeSignatureDialog.on_buttonBox_clicked"></a>
199 <h4>ChangeSignatureDialog.on_buttonBox_clicked</h4> 200 <h4>ChangeSignatureDialog.on_buttonBox_clicked</h4>
200 <b>on_buttonBox_clicked</b>(<i>button</i>) 201 <b>on_buttonBox_clicked</b>(<i>button</i>)
201
202 <p> 202 <p>
203 Private slot to act on the button pressed. 203 Private slot to act on the button pressed.
204 </p> 204 </p>
205
205 <dl> 206 <dl>
206 207
207 <dt><i>button</i> (QAbstractButton)</dt> 208 <dt><i>button</i> (QAbstractButton)</dt>
208 <dd> 209 <dd>
209 reference to the button pressed 210 reference to the button pressed
210 </dd> 211 </dd>
211 </dl> 212 </dl>
212 <a NAME="ChangeSignatureDialog.on_downButton_clicked" ID="ChangeSignatureDialog.on_downButton_clicked"></a> 213 <a NAME="ChangeSignatureDialog.on_downButton_clicked" ID="ChangeSignatureDialog.on_downButton_clicked"></a>
213 <h4>ChangeSignatureDialog.on_downButton_clicked</h4> 214 <h4>ChangeSignatureDialog.on_downButton_clicked</h4>
214 <b>on_downButton_clicked</b>(<i></i>) 215 <b>on_downButton_clicked</b>(<i></i>)
215
216 <p> 216 <p>
217 Private slot called to move the selected item down in the list. 217 Private slot called to move the selected item down in the list.
218 </p> 218 </p>
219
219 <a NAME="ChangeSignatureDialog.on_parameterList_currentRowChanged" ID="ChangeSignatureDialog.on_parameterList_currentRowChanged"></a> 220 <a NAME="ChangeSignatureDialog.on_parameterList_currentRowChanged" ID="ChangeSignatureDialog.on_parameterList_currentRowChanged"></a>
220 <h4>ChangeSignatureDialog.on_parameterList_currentRowChanged</h4> 221 <h4>ChangeSignatureDialog.on_parameterList_currentRowChanged</h4>
221 <b>on_parameterList_currentRowChanged</b>(<i>currentRow</i>) 222 <b>on_parameterList_currentRowChanged</b>(<i>currentRow</i>)
222
223 <p> 223 <p>
224 Private slot called, when the current row is changed. 224 Private slot called, when the current row is changed.
225 </p> 225 </p>
226
226 <dl> 227 <dl>
227 228
228 <dt><i>currentRow</i> (int)</dt> 229 <dt><i>currentRow</i> (int)</dt>
229 <dd> 230 <dd>
230 index of the current row 231 index of the current row
231 </dd> 232 </dd>
232 </dl> 233 </dl>
233 <a NAME="ChangeSignatureDialog.on_removeButton_clicked" ID="ChangeSignatureDialog.on_removeButton_clicked"></a> 234 <a NAME="ChangeSignatureDialog.on_removeButton_clicked" ID="ChangeSignatureDialog.on_removeButton_clicked"></a>
234 <h4>ChangeSignatureDialog.on_removeButton_clicked</h4> 235 <h4>ChangeSignatureDialog.on_removeButton_clicked</h4>
235 <b>on_removeButton_clicked</b>(<i></i>) 236 <b>on_removeButton_clicked</b>(<i></i>)
236
237 <p> 237 <p>
238 Private slot to remove a parameter. 238 Private slot to remove a parameter.
239 </p> 239 </p>
240
240 <a NAME="ChangeSignatureDialog.on_upButton_clicked" ID="ChangeSignatureDialog.on_upButton_clicked"></a> 241 <a NAME="ChangeSignatureDialog.on_upButton_clicked" ID="ChangeSignatureDialog.on_upButton_clicked"></a>
241 <h4>ChangeSignatureDialog.on_upButton_clicked</h4> 242 <h4>ChangeSignatureDialog.on_upButton_clicked</h4>
242 <b>on_upButton_clicked</b>(<i></i>) 243 <b>on_upButton_clicked</b>(<i></i>)
243
244 <p> 244 <p>
245 Private slot called to move the selected item up in the list. 245 Private slot called to move the selected item up in the list.
246 </p> 246 </p>
247
247 <a NAME="ChangeSignatureDialog.processChangeData" ID="ChangeSignatureDialog.processChangeData"></a> 248 <a NAME="ChangeSignatureDialog.processChangeData" ID="ChangeSignatureDialog.processChangeData"></a>
248 <h4>ChangeSignatureDialog.processChangeData</h4> 249 <h4>ChangeSignatureDialog.processChangeData</h4>
249 <b>processChangeData</b>(<i>data</i>) 250 <b>processChangeData</b>(<i>data</i>)
250
251 <p> 251 <p>
252 Public method to process the change data sent by the refactoring 252 Public method to process the change data sent by the refactoring
253 client. 253 client.
254 </p> 254 </p>
255
255 <dl> 256 <dl>
256 257
257 <dt><i>data</i> (dict)</dt> 258 <dt><i>data</i> (dict)</dt>
258 <dd> 259 <dd>
259 dictionary containing the change data 260 dictionary containing the change data

Mercurial Repository: Rope Refactoring

eric ide

mercurial