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

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.ChangeSignatureDialog</h1> 23 <h1>Plugin_Refactoring_Rope.RefactoringRope.ChangeSignatureDialog</h1>
24
23 <p> 25 <p>
24 Module implementing the Change Signature dialog. 26 Module implementing the Change Signature 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="#ChangeSignatureDialog">ChangeSignatureDialog</a></td> 38 <td><a href="#ChangeSignatureDialog">ChangeSignatureDialog</a></td>
34 <td>Class implementing the Change Signature dialog.</td> 39 <td>Class implementing the Change Signature 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="ChangeSignatureDialog" ID="ChangeSignatureDialog"></a> 49 <a NAME="ChangeSignatureDialog" ID="ChangeSignatureDialog"></a>
43 <h2>ChangeSignatureDialog</h2> 50 <h2>ChangeSignatureDialog</h2>
51
44 <p> 52 <p>
45 Class implementing the Change Signature dialog. 53 Class implementing the Change Signature dialog.
46 </p> 54 </p>
47 <h3>Derived from</h3> 55 <h3>Derived from</h3>
48 RefactoringDialogBase, Ui_ChangeSignatureDialog 56 RefactoringDialogBase, Ui_ChangeSignatureDialog
49 <h3>Class Attributes</h3> 57 <h3>Class Attributes</h3>
58
50 <table> 59 <table>
51 <tr><td>DefaultRole</td></tr><tr><td>IsAddedRole</td></tr><tr><td>NameRole</td></tr><tr><td>ValueRole</td></tr> 60 <tr><td>DefaultRole</td></tr><tr><td>IsAddedRole</td></tr><tr><td>NameRole</td></tr><tr><td>ValueRole</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="#ChangeSignatureDialog.__init__">ChangeSignatureDialog</a></td> 72 <td><a href="#ChangeSignatureDialog.__init__">ChangeSignatureDialog</a></td>
61 <td>Constructor</td> 73 <td>Constructor</td>
62 </tr><tr> 74 </tr>
75 <tr>
63 <td><a href="#ChangeSignatureDialog.__getParameterIndex">__getParameterIndex</a></td> 76 <td><a href="#ChangeSignatureDialog.__getParameterIndex">__getParameterIndex</a></td>
64 <td>Private method to calculate the index of the given paramter.</td> 77 <td>Private method to calculate the index of the given paramter.</td>
65 </tr><tr> 78 </tr>
79 <tr>
66 <td><a href="#ChangeSignatureDialog.__processSignature">__processSignature</a></td> 80 <td><a href="#ChangeSignatureDialog.__processSignature">__processSignature</a></td>
67 <td>Private method to process the inline type data sent by the refactoring client in order to polish the dialog.</td> 81 <td>Private method to process the inline 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="#ChangeSignatureDialog._calculateChanges">_calculateChanges</a></td> 84 <td><a href="#ChangeSignatureDialog._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="#ChangeSignatureDialog.on_addButton_clicked">on_addButton_clicked</a></td> 88 <td><a href="#ChangeSignatureDialog.on_addButton_clicked">on_addButton_clicked</a></td>
73 <td>Private slot to add a new parameter.</td> 89 <td>Private slot to add a new parameter.</td>
74 </tr><tr> 90 </tr>
91 <tr>
75 <td><a href="#ChangeSignatureDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> 92 <td><a href="#ChangeSignatureDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
76 <td>Private slot to act on the button pressed.</td> 93 <td>Private slot to act on the button pressed.</td>
77 </tr><tr> 94 </tr>
95 <tr>
78 <td><a href="#ChangeSignatureDialog.on_downButton_clicked">on_downButton_clicked</a></td> 96 <td><a href="#ChangeSignatureDialog.on_downButton_clicked">on_downButton_clicked</a></td>
79 <td>Private slot called to move the selected item down in the list.</td> 97 <td>Private slot called to move the selected item down in the list.</td>
80 </tr><tr> 98 </tr>
99 <tr>
81 <td><a href="#ChangeSignatureDialog.on_parameterList_currentRowChanged">on_parameterList_currentRowChanged</a></td> 100 <td><a href="#ChangeSignatureDialog.on_parameterList_currentRowChanged">on_parameterList_currentRowChanged</a></td>
82 <td>Private slot called, when the current row is changed.</td> 101 <td>Private slot called, when the current row is changed.</td>
83 </tr><tr> 102 </tr>
103 <tr>
84 <td><a href="#ChangeSignatureDialog.on_removeButton_clicked">on_removeButton_clicked</a></td> 104 <td><a href="#ChangeSignatureDialog.on_removeButton_clicked">on_removeButton_clicked</a></td>
85 <td>Private slot to remove a parameter.</td> 105 <td>Private slot to remove a parameter.</td>
86 </tr><tr> 106 </tr>
107 <tr>
87 <td><a href="#ChangeSignatureDialog.on_upButton_clicked">on_upButton_clicked</a></td> 108 <td><a href="#ChangeSignatureDialog.on_upButton_clicked">on_upButton_clicked</a></td>
88 <td>Private slot called to move the selected item up in the list.</td> 109 <td>Private slot called to move the selected item up in the list.</td>
89 </tr><tr> 110 </tr>
111 <tr>
90 <td><a href="#ChangeSignatureDialog.processChangeData">processChangeData</a></td> 112 <td><a href="#ChangeSignatureDialog.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="ChangeSignatureDialog.__init__" ID="ChangeSignatureDialog.__init__"></a> 122 <a NAME="ChangeSignatureDialog.__init__" ID="ChangeSignatureDialog.__init__"></a>
99 <h4>ChangeSignatureDialog (Constructor)</h4> 123 <h4>ChangeSignatureDialog (Constructor)</h4>
100 <b>ChangeSignatureDialog</b>(<i>refactoring, title, filename, offset, parent=None</i>) 124 <b>ChangeSignatureDialog</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="ChangeSignatureDialog.__getParameterIndex" ID="ChangeSignatureDialog.__getParameterIndex"></a> 151 </dl>
152 <a NAME="ChangeSignatureDialog.__getParameterIndex" ID="ChangeSignatureDialog.__getParameterIndex"></a>
121 <h4>ChangeSignatureDialog.__getParameterIndex</h4> 153 <h4>ChangeSignatureDialog.__getParameterIndex</h4>
122 <b>__getParameterIndex</b>(<i>definition_info, name</i>) 154 <b>__getParameterIndex</b>(<i>definition_info, name</i>)
155
123 <p> 156 <p>
124 Private method to calculate the index of the given paramter. 157 Private method to calculate the index of the given paramter.
125 </p><dl> 158 </p>
159 <dl>
160
126 <dt><i>definition_info</i> (list of lists of two str)</dt> 161 <dt><i>definition_info</i> (list of lists of two str)</dt>
127 <dd> 162 <dd>
128 list of lists containing the method signature 163 list of lists containing the method signature
129 definition 164 definition
130 </dd><dt><i>name</i> (str)</dt> 165 </dd>
166 <dt><i>name</i> (str)</dt>
131 <dd> 167 <dd>
132 parameter name 168 parameter name
133 </dd> 169 </dd>
134 </dl><dl> 170 </dl>
171 <dl>
135 <dt>Returns:</dt> 172 <dt>Returns:</dt>
136 <dd> 173 <dd>
137 index of the parameter 174 index of the parameter
138 </dd> 175 </dd>
139 </dl><dl> 176 </dl>
177 <dl>
140 <dt>Return Type:</dt> 178 <dt>Return Type:</dt>
141 <dd> 179 <dd>
142 int 180 int
143 </dd> 181 </dd>
144 </dl><a NAME="ChangeSignatureDialog.__processSignature" ID="ChangeSignatureDialog.__processSignature"></a> 182 </dl>
183 <a NAME="ChangeSignatureDialog.__processSignature" ID="ChangeSignatureDialog.__processSignature"></a>
145 <h4>ChangeSignatureDialog.__processSignature</h4> 184 <h4>ChangeSignatureDialog.__processSignature</h4>
146 <b>__processSignature</b>(<i>data</i>) 185 <b>__processSignature</b>(<i>data</i>)
186
147 <p> 187 <p>
148 Private method to process the inline type data sent by the refactoring 188 Private method to process the inline type data sent by the refactoring
149 client in order to polish the dialog. 189 client in order to polish the dialog.
150 </p><dl> 190 </p>
191 <dl>
192
151 <dt><i>data</i> (dict)</dt> 193 <dt><i>data</i> (dict)</dt>
152 <dd> 194 <dd>
153 dictionary containing the inline type data 195 dictionary containing the inline type data
154 </dd> 196 </dd>
155 </dl><a NAME="ChangeSignatureDialog._calculateChanges" ID="ChangeSignatureDialog._calculateChanges"></a> 197 </dl>
198 <a NAME="ChangeSignatureDialog._calculateChanges" ID="ChangeSignatureDialog._calculateChanges"></a>
156 <h4>ChangeSignatureDialog._calculateChanges</h4> 199 <h4>ChangeSignatureDialog._calculateChanges</h4>
157 <b>_calculateChanges</b>(<i></i>) 200 <b>_calculateChanges</b>(<i></i>)
201
158 <p> 202 <p>
159 Protected method to initiate the calculation of the changes. 203 Protected method to initiate the calculation of the changes.
160 </p><a NAME="ChangeSignatureDialog.on_addButton_clicked" ID="ChangeSignatureDialog.on_addButton_clicked"></a> 204 </p>
205 <a NAME="ChangeSignatureDialog.on_addButton_clicked" ID="ChangeSignatureDialog.on_addButton_clicked"></a>
161 <h4>ChangeSignatureDialog.on_addButton_clicked</h4> 206 <h4>ChangeSignatureDialog.on_addButton_clicked</h4>
162 <b>on_addButton_clicked</b>(<i></i>) 207 <b>on_addButton_clicked</b>(<i></i>)
208
163 <p> 209 <p>
164 Private slot to add a new parameter. 210 Private slot to add a new parameter.
165 </p><a NAME="ChangeSignatureDialog.on_buttonBox_clicked" ID="ChangeSignatureDialog.on_buttonBox_clicked"></a> 211 </p>
212 <a NAME="ChangeSignatureDialog.on_buttonBox_clicked" ID="ChangeSignatureDialog.on_buttonBox_clicked"></a>
166 <h4>ChangeSignatureDialog.on_buttonBox_clicked</h4> 213 <h4>ChangeSignatureDialog.on_buttonBox_clicked</h4>
167 <b>on_buttonBox_clicked</b>(<i>button</i>) 214 <b>on_buttonBox_clicked</b>(<i>button</i>)
215
168 <p> 216 <p>
169 Private slot to act on the button pressed. 217 Private slot to act on the button pressed.
170 </p><dl> 218 </p>
219 <dl>
220
171 <dt><i>button</i> (QAbstractButton)</dt> 221 <dt><i>button</i> (QAbstractButton)</dt>
172 <dd> 222 <dd>
173 reference to the button pressed 223 reference to the button pressed
174 </dd> 224 </dd>
175 </dl><a NAME="ChangeSignatureDialog.on_downButton_clicked" ID="ChangeSignatureDialog.on_downButton_clicked"></a> 225 </dl>
226 <a NAME="ChangeSignatureDialog.on_downButton_clicked" ID="ChangeSignatureDialog.on_downButton_clicked"></a>
176 <h4>ChangeSignatureDialog.on_downButton_clicked</h4> 227 <h4>ChangeSignatureDialog.on_downButton_clicked</h4>
177 <b>on_downButton_clicked</b>(<i></i>) 228 <b>on_downButton_clicked</b>(<i></i>)
229
178 <p> 230 <p>
179 Private slot called to move the selected item down in the list. 231 Private slot called to move the selected item down in the list.
180 </p><a NAME="ChangeSignatureDialog.on_parameterList_currentRowChanged" ID="ChangeSignatureDialog.on_parameterList_currentRowChanged"></a> 232 </p>
233 <a NAME="ChangeSignatureDialog.on_parameterList_currentRowChanged" ID="ChangeSignatureDialog.on_parameterList_currentRowChanged"></a>
181 <h4>ChangeSignatureDialog.on_parameterList_currentRowChanged</h4> 234 <h4>ChangeSignatureDialog.on_parameterList_currentRowChanged</h4>
182 <b>on_parameterList_currentRowChanged</b>(<i>currentRow</i>) 235 <b>on_parameterList_currentRowChanged</b>(<i>currentRow</i>)
236
183 <p> 237 <p>
184 Private slot called, when the current row is changed. 238 Private slot called, when the current row is changed.
185 </p><dl> 239 </p>
240 <dl>
241
186 <dt><i>currentRow</i> (int)</dt> 242 <dt><i>currentRow</i> (int)</dt>
187 <dd> 243 <dd>
188 index of the current row 244 index of the current row
189 </dd> 245 </dd>
190 </dl><a NAME="ChangeSignatureDialog.on_removeButton_clicked" ID="ChangeSignatureDialog.on_removeButton_clicked"></a> 246 </dl>
247 <a NAME="ChangeSignatureDialog.on_removeButton_clicked" ID="ChangeSignatureDialog.on_removeButton_clicked"></a>
191 <h4>ChangeSignatureDialog.on_removeButton_clicked</h4> 248 <h4>ChangeSignatureDialog.on_removeButton_clicked</h4>
192 <b>on_removeButton_clicked</b>(<i></i>) 249 <b>on_removeButton_clicked</b>(<i></i>)
250
193 <p> 251 <p>
194 Private slot to remove a parameter. 252 Private slot to remove a parameter.
195 </p><a NAME="ChangeSignatureDialog.on_upButton_clicked" ID="ChangeSignatureDialog.on_upButton_clicked"></a> 253 </p>
254 <a NAME="ChangeSignatureDialog.on_upButton_clicked" ID="ChangeSignatureDialog.on_upButton_clicked"></a>
196 <h4>ChangeSignatureDialog.on_upButton_clicked</h4> 255 <h4>ChangeSignatureDialog.on_upButton_clicked</h4>
197 <b>on_upButton_clicked</b>(<i></i>) 256 <b>on_upButton_clicked</b>(<i></i>)
257
198 <p> 258 <p>
199 Private slot called to move the selected item up in the list. 259 Private slot called to move the selected item up in the list.
200 </p><a NAME="ChangeSignatureDialog.processChangeData" ID="ChangeSignatureDialog.processChangeData"></a> 260 </p>
261 <a NAME="ChangeSignatureDialog.processChangeData" ID="ChangeSignatureDialog.processChangeData"></a>
201 <h4>ChangeSignatureDialog.processChangeData</h4> 262 <h4>ChangeSignatureDialog.processChangeData</h4>
202 <b>processChangeData</b>(<i>data</i>) 263 <b>processChangeData</b>(<i>data</i>)
264
203 <p> 265 <p>
204 Public method to process the change data sent by the refactoring 266 Public method to process the change data sent by the refactoring
205 client. 267 client.
206 </p><dl> 268 </p>
269 <dl>
270
207 <dt><i>data</i> (dict)</dt> 271 <dt><i>data</i> (dict)</dt>
208 <dd> 272 <dd>
209 dictionary containing the change data 273 dictionary containing the change data
210 </dd> 274 </dd>
211 </dl> 275 </dl>

Mercurial Repository: Rope Refactoring

eric ide

mercurial