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
server_client_variant
changeset 204
b4bf79b956bc
parent 44
8aa985c8dee5
child 321
d51e810107ec
equal deleted inserted replaced
203:c38750e1bafd 204:b4bf79b956bc
61 <td>Constructor</td> 61 <td>Constructor</td>
62 </tr><tr> 62 </tr><tr>
63 <td><a href="#ChangeSignatureDialog.__getParameterIndex">__getParameterIndex</a></td> 63 <td><a href="#ChangeSignatureDialog.__getParameterIndex">__getParameterIndex</a></td>
64 <td>Private method to calculate the index of the given paramter.</td> 64 <td>Private method to calculate the index of the given paramter.</td>
65 </tr><tr> 65 </tr><tr>
66 <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>
68 </tr><tr>
66 <td><a href="#ChangeSignatureDialog._calculateChanges">_calculateChanges</a></td> 69 <td><a href="#ChangeSignatureDialog._calculateChanges">_calculateChanges</a></td>
67 <td>Protected method to calculate the changes.</td> 70 <td>Protected method to initiate the calculation of the changes.</td>
68 </tr><tr> 71 </tr><tr>
69 <td><a href="#ChangeSignatureDialog.on_addButton_clicked">on_addButton_clicked</a></td> 72 <td><a href="#ChangeSignatureDialog.on_addButton_clicked">on_addButton_clicked</a></td>
70 <td>Private slot to add a new parameter.</td> 73 <td>Private slot to add a new parameter.</td>
71 </tr><tr> 74 </tr><tr>
72 <td><a href="#ChangeSignatureDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> 75 <td><a href="#ChangeSignatureDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
81 <td><a href="#ChangeSignatureDialog.on_removeButton_clicked">on_removeButton_clicked</a></td> 84 <td><a href="#ChangeSignatureDialog.on_removeButton_clicked">on_removeButton_clicked</a></td>
82 <td>Private slot to remove a parameter.</td> 85 <td>Private slot to remove a parameter.</td>
83 </tr><tr> 86 </tr><tr>
84 <td><a href="#ChangeSignatureDialog.on_upButton_clicked">on_upButton_clicked</a></td> 87 <td><a href="#ChangeSignatureDialog.on_upButton_clicked">on_upButton_clicked</a></td>
85 <td>Private slot called to move the selected item up in the list.</td> 88 <td>Private slot called to move the selected item up in the list.</td>
89 </tr><tr>
90 <td><a href="#ChangeSignatureDialog.processChangeData">processChangeData</a></td>
91 <td>Public method to process the change data sent by the refactoring client.</td>
86 </tr> 92 </tr>
87 </table> 93 </table>
88 <h3>Static Methods</h3> 94 <h3>Static Methods</h3>
89 <table> 95 <table>
90 <tr><td>None</td></tr> 96 <tr><td>None</td></tr>
91 </table> 97 </table>
92 <a NAME="ChangeSignatureDialog.__init__" ID="ChangeSignatureDialog.__init__"></a> 98 <a NAME="ChangeSignatureDialog.__init__" ID="ChangeSignatureDialog.__init__"></a>
93 <h4>ChangeSignatureDialog (Constructor)</h4> 99 <h4>ChangeSignatureDialog (Constructor)</h4>
94 <b>ChangeSignatureDialog</b>(<i>refactoring, title, changer, parent=None</i>) 100 <b>ChangeSignatureDialog</b>(<i>refactoring, title, filename, offset, parent=None</i>)
95 <p> 101 <p>
96 Constructor 102 Constructor
97 </p><dl> 103 </p><dl>
98 <dt><i>refactoring</i></dt> 104 <dt><i>refactoring</i> (RefactoringServer)</dt>
99 <dd> 105 <dd>
100 reference to the main refactoring object 106 reference to the main refactoring object
101 (Refactoring) 107 </dd><dt><i>title</i> (str)</dt>
102 </dd><dt><i>title</i></dt> 108 <dd>
103 <dd> 109 title of the dialog
104 title of the dialog (string) 110 </dd><dt><i>filename</i> (str)</dt>
105 </dd><dt><i>changer</i></dt> 111 <dd>
106 <dd> 112 file name to be worked on
107 reference to the signature changer object 113 </dd><dt><i>offset</i> (int or None)</dt>
108 (rope.refactor.change_signature.ChangeSignature) 114 <dd>
109 </dd><dt><i>parent</i></dt> 115 offset within file
110 <dd> 116 </dd><dt><i>parent</i> (QWidget)</dt>
111 reference to the parent widget (QWidget) 117 <dd>
118 reference to the parent widget
112 </dd> 119 </dd>
113 </dl><a NAME="ChangeSignatureDialog.__getParameterIndex" ID="ChangeSignatureDialog.__getParameterIndex"></a> 120 </dl><a NAME="ChangeSignatureDialog.__getParameterIndex" ID="ChangeSignatureDialog.__getParameterIndex"></a>
114 <h4>ChangeSignatureDialog.__getParameterIndex</h4> 121 <h4>ChangeSignatureDialog.__getParameterIndex</h4>
115 <b>__getParameterIndex</b>(<i>definition_info, name</i>) 122 <b>__getParameterIndex</b>(<i>definition_info, name</i>)
116 <p> 123 <p>
117 Private method to calculate the index of the given paramter. 124 Private method to calculate the index of the given paramter.
118 </p><dl> 125 </p><dl>
119 <dt><i>definition_info</i></dt> 126 <dt><i>definition_info</i> (list of lists of two str)</dt>
120 <dd> 127 <dd>
121 object containing the method definition 128 list of lists containing the method signature
122 </dd><dt><i>name</i></dt> 129 definition
123 <dd> 130 </dd><dt><i>name</i> (str)</dt>
124 parameter name (string) 131 <dd>
132 parameter name
125 </dd> 133 </dd>
126 </dl><dl> 134 </dl><dl>
127 <dt>Returns:</dt> 135 <dt>Returns:</dt>
128 <dd> 136 <dd>
129 index of the parameter (integer) 137 index of the parameter
138 </dd>
139 </dl><dl>
140 <dt>Return Type:</dt>
141 <dd>
142 int
143 </dd>
144 </dl><a NAME="ChangeSignatureDialog.__processSignature" ID="ChangeSignatureDialog.__processSignature"></a>
145 <h4>ChangeSignatureDialog.__processSignature</h4>
146 <b>__processSignature</b>(<i>data</i>)
147 <p>
148 Private method to process the inline type data sent by the refactoring
149 client in order to polish the dialog.
150 </p><dl>
151 <dt><i>data</i> (dict)</dt>
152 <dd>
153 dictionary containing the inline type data
130 </dd> 154 </dd>
131 </dl><a NAME="ChangeSignatureDialog._calculateChanges" ID="ChangeSignatureDialog._calculateChanges"></a> 155 </dl><a NAME="ChangeSignatureDialog._calculateChanges" ID="ChangeSignatureDialog._calculateChanges"></a>
132 <h4>ChangeSignatureDialog._calculateChanges</h4> 156 <h4>ChangeSignatureDialog._calculateChanges</h4>
133 <b>_calculateChanges</b>(<i>handle</i>) 157 <b>_calculateChanges</b>(<i></i>)
134 <p> 158 <p>
135 Protected method to calculate the changes. 159 Protected method to initiate the calculation of the changes.
136 </p><dl> 160 </p><a NAME="ChangeSignatureDialog.on_addButton_clicked" ID="ChangeSignatureDialog.on_addButton_clicked"></a>
137 <dt><i>handle</i></dt>
138 <dd>
139 reference to the task handle
140 (rope.base.taskhandle.TaskHandle)
141 </dd>
142 </dl><dl>
143 <dt>Returns:</dt>
144 <dd>
145 reference to the Changes object (rope.base.change.ChangeSet)
146 </dd>
147 </dl><a NAME="ChangeSignatureDialog.on_addButton_clicked" ID="ChangeSignatureDialog.on_addButton_clicked"></a>
148 <h4>ChangeSignatureDialog.on_addButton_clicked</h4> 161 <h4>ChangeSignatureDialog.on_addButton_clicked</h4>
149 <b>on_addButton_clicked</b>(<i></i>) 162 <b>on_addButton_clicked</b>(<i></i>)
150 <p> 163 <p>
151 Private slot to add a new parameter. 164 Private slot to add a new parameter.
152 </p><a NAME="ChangeSignatureDialog.on_buttonBox_clicked" ID="ChangeSignatureDialog.on_buttonBox_clicked"></a> 165 </p><a NAME="ChangeSignatureDialog.on_buttonBox_clicked" ID="ChangeSignatureDialog.on_buttonBox_clicked"></a>
153 <h4>ChangeSignatureDialog.on_buttonBox_clicked</h4> 166 <h4>ChangeSignatureDialog.on_buttonBox_clicked</h4>
154 <b>on_buttonBox_clicked</b>(<i>button</i>) 167 <b>on_buttonBox_clicked</b>(<i>button</i>)
155 <p> 168 <p>
156 Private slot to act on the button pressed. 169 Private slot to act on the button pressed.
157 </p><dl> 170 </p><dl>
158 <dt><i>button</i></dt> 171 <dt><i>button</i> (QAbstractButton)</dt>
159 <dd> 172 <dd>
160 reference to the button pressed (QAbstractButton) 173 reference to the button pressed
161 </dd> 174 </dd>
162 </dl><a NAME="ChangeSignatureDialog.on_downButton_clicked" ID="ChangeSignatureDialog.on_downButton_clicked"></a> 175 </dl><a NAME="ChangeSignatureDialog.on_downButton_clicked" ID="ChangeSignatureDialog.on_downButton_clicked"></a>
163 <h4>ChangeSignatureDialog.on_downButton_clicked</h4> 176 <h4>ChangeSignatureDialog.on_downButton_clicked</h4>
164 <b>on_downButton_clicked</b>(<i></i>) 177 <b>on_downButton_clicked</b>(<i></i>)
165 <p> 178 <p>
168 <h4>ChangeSignatureDialog.on_parameterList_currentRowChanged</h4> 181 <h4>ChangeSignatureDialog.on_parameterList_currentRowChanged</h4>
169 <b>on_parameterList_currentRowChanged</b>(<i>currentRow</i>) 182 <b>on_parameterList_currentRowChanged</b>(<i>currentRow</i>)
170 <p> 183 <p>
171 Private slot called, when the current row is changed. 184 Private slot called, when the current row is changed.
172 </p><dl> 185 </p><dl>
173 <dt><i>currentRow</i></dt> 186 <dt><i>currentRow</i> (int)</dt>
174 <dd> 187 <dd>
175 index of the current row (integer) 188 index of the current row
176 </dd> 189 </dd>
177 </dl><a NAME="ChangeSignatureDialog.on_removeButton_clicked" ID="ChangeSignatureDialog.on_removeButton_clicked"></a> 190 </dl><a NAME="ChangeSignatureDialog.on_removeButton_clicked" ID="ChangeSignatureDialog.on_removeButton_clicked"></a>
178 <h4>ChangeSignatureDialog.on_removeButton_clicked</h4> 191 <h4>ChangeSignatureDialog.on_removeButton_clicked</h4>
179 <b>on_removeButton_clicked</b>(<i></i>) 192 <b>on_removeButton_clicked</b>(<i></i>)
180 <p> 193 <p>
182 </p><a NAME="ChangeSignatureDialog.on_upButton_clicked" ID="ChangeSignatureDialog.on_upButton_clicked"></a> 195 </p><a NAME="ChangeSignatureDialog.on_upButton_clicked" ID="ChangeSignatureDialog.on_upButton_clicked"></a>
183 <h4>ChangeSignatureDialog.on_upButton_clicked</h4> 196 <h4>ChangeSignatureDialog.on_upButton_clicked</h4>
184 <b>on_upButton_clicked</b>(<i></i>) 197 <b>on_upButton_clicked</b>(<i></i>)
185 <p> 198 <p>
186 Private slot called to move the selected item up in the list. 199 Private slot called to move the selected item up in the list.
187 </p> 200 </p><a NAME="ChangeSignatureDialog.processChangeData" ID="ChangeSignatureDialog.processChangeData"></a>
201 <h4>ChangeSignatureDialog.processChangeData</h4>
202 <b>processChangeData</b>(<i>data</i>)
203 <p>
204 Public method to process the change data sent by the refactoring
205 client.
206 </p><dl>
207 <dt><i>data</i> (dict)</dt>
208 <dd>
209 dictionary containing the change data
210 </dd>
211 </dl>
188 <div align="right"><a href="#top">Up</a></div> 212 <div align="right"><a href="#top">Up</a></div>
189 <hr /> 213 <hr />
190 </body></html> 214 </body></html>

Mercurial Repository: Rope Refactoring

eric ide

mercurial