Mercurial Repositories > Rope Refactoring / file comparison

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

RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.RefactoringServer.html

changeset 321
d51e810107ec
parent 295
8318a6881e63
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.RefactoringServer</h1> 23 <h1>Plugin_Refactoring_Rope.RefactoringRope.RefactoringServer</h1>
24
23 <p> 25 <p>
24 Module implementing the refactoring interface to rope. 26 Module implementing the refactoring interface to rope.
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>
34
31 <table> 35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#RefactoringServer">RefactoringServer</a></td> 38 <td><a href="#RefactoringServer">RefactoringServer</a></td>
34 <td>Class implementing the refactoring interface to rope.</td> 39 <td>Class implementing the refactoring interface to rope.</td>
35 </tr> 40 </tr>
36 </table> 41 </table>
37 <h3>Functions</h3> 42 <h3>Functions</h3>
43
38 <table> 44 <table>
39 <tr><td>None</td></tr> 45 <tr><td>None</td></tr>
40 </table> 46 </table>
41 <hr /><hr /> 47 <hr />
48 <hr />
42 <a NAME="RefactoringServer" ID="RefactoringServer"></a> 49 <a NAME="RefactoringServer" ID="RefactoringServer"></a>
43 <h2>RefactoringServer</h2> 50 <h2>RefactoringServer</h2>
51
44 <p> 52 <p>
45 Class implementing the refactoring interface to rope. 53 Class implementing the refactoring interface to rope.
46 </p> 54 </p>
47 <h3>Derived from</h3> 55 <h3>Derived from</h3>
48 JsonServer 56 JsonServer
49 <h3>Class Attributes</h3> 57 <h3>Class Attributes</h3>
58
50 <table> 59 <table>
51 <tr><td>None</td></tr> 60 <tr><td>None</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>
68
58 <table> 69 <table>
70
59 <tr> 71 <tr>
60 <td><a href="#RefactoringServer.__init__">RefactoringServer</a></td> 72 <td><a href="#RefactoringServer.__init__">RefactoringServer</a></td>
61 <td>Constructor</td> 73 <td>Constructor</td>
62 </tr><tr> 74 </tr>
75 <tr>
63 <td><a href="#RefactoringServer.__changeOccurrences">__changeOccurrences</a></td> 76 <td><a href="#RefactoringServer.__changeOccurrences">__changeOccurrences</a></td>
64 <td>Private slot to perform the Change Occurrences refactoring.</td> 77 <td>Private slot to perform the Change Occurrences refactoring.</td>
65 </tr><tr> 78 </tr>
79 <tr>
66 <td><a href="#RefactoringServer.__changeSignature">__changeSignature</a></td> 80 <td><a href="#RefactoringServer.__changeSignature">__changeSignature</a></td>
67 <td>Private slot to change the signature of a method or function.</td> 81 <td>Private slot to change the signature of a method or function.</td>
68 </tr><tr> 82 </tr>
83 <tr>
69 <td><a href="#RefactoringServer.__clearHistory">__clearHistory</a></td> 84 <td><a href="#RefactoringServer.__clearHistory">__clearHistory</a></td>
70 <td>Private slot to clear the redo and undo lists.</td> 85 <td>Private slot to clear the redo and undo lists.</td>
71 </tr><tr> 86 </tr>
87 <tr>
72 <td><a href="#RefactoringServer.__configChanged">__configChanged</a></td> 88 <td><a href="#RefactoringServer.__configChanged">__configChanged</a></td>
73 <td>Private slot called, when the rope config file has changed.</td> 89 <td>Private slot called, when the rope config file has changed.</td>
74 </tr><tr> 90 </tr>
91 <tr>
75 <td><a href="#RefactoringServer.__convertLocalToAttribute">__convertLocalToAttribute</a></td> 92 <td><a href="#RefactoringServer.__convertLocalToAttribute">__convertLocalToAttribute</a></td>
76 <td>Private slot to convert a local variable to an attribute.</td> 93 <td>Private slot to convert a local variable to an attribute.</td>
77 </tr><tr> 94 </tr>
95 <tr>
78 <td><a href="#RefactoringServer.__defaultConfig">__defaultConfig</a></td> 96 <td><a href="#RefactoringServer.__defaultConfig">__defaultConfig</a></td>
79 <td>Private slot to return the contents of rope's default configuration.</td> 97 <td>Private slot to return the contents of rope's default configuration.</td>
80 </tr><tr> 98 </tr>
99 <tr>
81 <td><a href="#RefactoringServer.__doExtract">__doExtract</a></td> 100 <td><a href="#RefactoringServer.__doExtract">__doExtract</a></td>
82 <td>Private method to perform the extract refactoring.</td> 101 <td>Private method to perform the extract refactoring.</td>
83 </tr><tr> 102 </tr>
103 <tr>
84 <td><a href="#RefactoringServer.__doImports">__doImports</a></td> 104 <td><a href="#RefactoringServer.__doImports">__doImports</a></td>
85 <td>Private method to perform the various imports refactorings.</td> 105 <td>Private method to perform the various imports refactorings.</td>
86 </tr><tr> 106 </tr>
107 <tr>
87 <td><a href="#RefactoringServer.__doRename">__doRename</a></td> 108 <td><a href="#RefactoringServer.__doRename">__doRename</a></td>
88 <td>Private method to perform the various renaming refactorings.</td> 109 <td>Private method to perform the various renaming refactorings.</td>
89 </tr><tr> 110 </tr>
111 <tr>
90 <td><a href="#RefactoringServer.__editConfig">__editConfig</a></td> 112 <td><a href="#RefactoringServer.__editConfig">__editConfig</a></td>
91 <td>Private slot to open the rope configuration file in an editor.</td> 113 <td>Private slot to open the rope configuration file in an editor.</td>
92 </tr><tr> 114 </tr>
115 <tr>
93 <td><a href="#RefactoringServer.__encapsulateAttribute">__encapsulateAttribute</a></td> 116 <td><a href="#RefactoringServer.__encapsulateAttribute">__encapsulateAttribute</a></td>
94 <td>Private slot to encapsulate an attribute.</td> 117 <td>Private slot to encapsulate an attribute.</td>
95 </tr><tr> 118 </tr>
119 <tr>
96 <td><a href="#RefactoringServer.__extractLocalVariable">__extractLocalVariable</a></td> 120 <td><a href="#RefactoringServer.__extractLocalVariable">__extractLocalVariable</a></td>
97 <td>Private slot to handle the Extract Local Variable action.</td> 121 <td>Private slot to handle the Extract Local Variable action.</td>
98 </tr><tr> 122 </tr>
123 <tr>
99 <td><a href="#RefactoringServer.__extractMethod">__extractMethod</a></td> 124 <td><a href="#RefactoringServer.__extractMethod">__extractMethod</a></td>
100 <td>Private slot to handle the Extract Method action.</td> 125 <td>Private slot to handle the Extract Method action.</td>
101 </tr><tr> 126 </tr>
127 <tr>
102 <td><a href="#RefactoringServer.__getOffset">__getOffset</a></td> 128 <td><a href="#RefactoringServer.__getOffset">__getOffset</a></td>
103 <td>Private method to get the offset into the text treating CRLF as ONE character.</td> 129 <td>Private method to get the offset into the text treating CRLF as ONE character.</td>
104 </tr><tr> 130 </tr>
131 <tr>
105 <td><a href="#RefactoringServer.__historyDialogClosed">__historyDialogClosed</a></td> 132 <td><a href="#RefactoringServer.__historyDialogClosed">__historyDialogClosed</a></td>
106 <td>Private slot handling the closing of the history dialog.</td> 133 <td>Private slot handling the closing of the history dialog.</td>
107 </tr><tr> 134 </tr>
135 <tr>
108 <td><a href="#RefactoringServer.__importsExpandStar">__importsExpandStar</a></td> 136 <td><a href="#RefactoringServer.__importsExpandStar">__importsExpandStar</a></td>
109 <td>Private slot to expand star imports.</td> 137 <td>Private slot to expand star imports.</td>
110 </tr><tr> 138 </tr>
139 <tr>
111 <td><a href="#RefactoringServer.__importsFromToImport">__importsFromToImport</a></td> 140 <td><a href="#RefactoringServer.__importsFromToImport">__importsFromToImport</a></td>
112 <td>Private slot to transform from imports to plain imports.</td> 141 <td>Private slot to transform from imports to plain imports.</td>
113 </tr><tr> 142 </tr>
143 <tr>
114 <td><a href="#RefactoringServer.__importsHandleLong">__importsHandleLong</a></td> 144 <td><a href="#RefactoringServer.__importsHandleLong">__importsHandleLong</a></td>
115 <td>Private slot to handle long imports.</td> 145 <td>Private slot to handle long imports.</td>
116 </tr><tr> 146 </tr>
147 <tr>
117 <td><a href="#RefactoringServer.__importsOrganize">__importsOrganize</a></td> 148 <td><a href="#RefactoringServer.__importsOrganize">__importsOrganize</a></td>
118 <td>Private slot to organize imports.</td> 149 <td>Private slot to organize imports.</td>
119 </tr><tr> 150 </tr>
151 <tr>
120 <td><a href="#RefactoringServer.__importsRelativeToAbsolute">__importsRelativeToAbsolute</a></td> 152 <td><a href="#RefactoringServer.__importsRelativeToAbsolute">__importsRelativeToAbsolute</a></td>
121 <td>Private slot to transform relative to absolute imports.</td> 153 <td>Private slot to transform relative to absolute imports.</td>
122 </tr><tr> 154 </tr>
155 <tr>
123 <td><a href="#RefactoringServer.__initActions">__initActions</a></td> 156 <td><a href="#RefactoringServer.__initActions">__initActions</a></td>
124 <td>Private method to define the refactoring actions.</td> 157 <td>Private method to define the refactoring actions.</td>
125 </tr><tr> 158 </tr>
159 <tr>
126 <td><a href="#RefactoringServer.__initMenu">__initMenu</a></td> 160 <td><a href="#RefactoringServer.__initMenu">__initMenu</a></td>
127 <td>Private slot to initialize the refactoring menu.</td> 161 <td>Private slot to initialize the refactoring menu.</td>
128 </tr><tr> 162 </tr>
163 <tr>
129 <td><a href="#RefactoringServer.__inline">__inline</a></td> 164 <td><a href="#RefactoringServer.__inline">__inline</a></td>
130 <td>Private slot to handle the Inline Local Variable action.</td> 165 <td>Private slot to handle the Inline Local Variable action.</td>
131 </tr><tr> 166 </tr>
167 <tr>
132 <td><a href="#RefactoringServer.__inlineArgumentDefault">__inlineArgumentDefault</a></td> 168 <td><a href="#RefactoringServer.__inlineArgumentDefault">__inlineArgumentDefault</a></td>
133 <td>Private slot to inline the default value of a parameter of a method or function.</td> 169 <td>Private slot to inline the default value of a parameter of a method or function.</td>
134 </tr><tr> 170 </tr>
171 <tr>
135 <td><a href="#RefactoringServer.__introduceFactoryMethod">__introduceFactoryMethod</a></td> 172 <td><a href="#RefactoringServer.__introduceFactoryMethod">__introduceFactoryMethod</a></td>
136 <td>Private slot to introduce a factory method or global function.</td> 173 <td>Private slot to introduce a factory method or global function.</td>
137 </tr><tr> 174 </tr>
175 <tr>
138 <td><a href="#RefactoringServer.__introduceParameter">__introduceParameter</a></td> 176 <td><a href="#RefactoringServer.__introduceParameter">__introduceParameter</a></td>
139 <td>Private slot to introduce a parameter in a function.</td> 177 <td>Private slot to introduce a parameter in a function.</td>
140 </tr><tr> 178 </tr>
179 <tr>
141 <td><a href="#RefactoringServer.__methodToMethodObject">__methodToMethodObject</a></td> 180 <td><a href="#RefactoringServer.__methodToMethodObject">__methodToMethodObject</a></td>
142 <td>Private slot to change the signature of a method or function.</td> 181 <td>Private slot to change the signature of a method or function.</td>
143 </tr><tr> 182 </tr>
183 <tr>
144 <td><a href="#RefactoringServer.__move">__move</a></td> 184 <td><a href="#RefactoringServer.__move">__move</a></td>
145 <td>Private slot to handle the Move Method action.</td> 185 <td>Private slot to handle the Move Method action.</td>
146 </tr><tr> 186 </tr>
187 <tr>
147 <td><a href="#RefactoringServer.__performSOA">__performSOA</a></td> 188 <td><a href="#RefactoringServer.__performSOA">__performSOA</a></td>
148 <td>Private slot to perform SOA on all modules.</td> 189 <td>Private slot to perform SOA on all modules.</td>
149 </tr><tr> 190 </tr>
191 <tr>
150 <td><a href="#RefactoringServer.__processChanges">__processChanges</a></td> 192 <td><a href="#RefactoringServer.__processChanges">__processChanges</a></td>
151 <td>Private method to process the changes data sent by the refactoring client.</td> 193 <td>Private method to process the changes data sent by the refactoring client.</td>
152 </tr><tr> 194 </tr>
195 <tr>
153 <td><a href="#RefactoringServer.__processClientException">__processClientException</a></td> 196 <td><a href="#RefactoringServer.__processClientException">__processClientException</a></td>
154 <td>Private method to handle exceptions of the refactoring client.</td> 197 <td>Private method to handle exceptions of the refactoring client.</td>
155 </tr><tr> 198 </tr>
199 <tr>
156 <td><a href="#RefactoringServer.__processHistoryResult">__processHistoryResult</a></td> 200 <td><a href="#RefactoringServer.__processHistoryResult">__processHistoryResult</a></td>
157 <td>Private method to process the history data sent by the refactoring client.</td> 201 <td>Private method to process the history data sent by the refactoring client.</td>
158 </tr><tr> 202 </tr>
203 <tr>
159 <td><a href="#RefactoringServer.__processProgress">__processProgress</a></td> 204 <td><a href="#RefactoringServer.__processProgress">__processProgress</a></td>
160 <td>Private method to handle Progress commands.</td> 205 <td>Private method to handle Progress commands.</td>
161 </tr><tr> 206 </tr>
207 <tr>
162 <td><a href="#RefactoringServer.__queryDefinition">__queryDefinition</a></td> 208 <td><a href="#RefactoringServer.__queryDefinition">__queryDefinition</a></td>
163 <td>Private slot to handle the Find Definition action.</td> 209 <td>Private slot to handle the Find Definition action.</td>
164 </tr><tr> 210 </tr>
211 <tr>
165 <td><a href="#RefactoringServer.__queryDefinitionResult">__queryDefinitionResult</a></td> 212 <td><a href="#RefactoringServer.__queryDefinitionResult">__queryDefinitionResult</a></td>
166 <td>Private method to handle the "Query Definition" result sent by the client.</td> 213 <td>Private method to handle the "Query Definition" result sent by the client.</td>
167 </tr><tr> 214 </tr>
215 <tr>
168 <td><a href="#RefactoringServer.__queryImplementations">__queryImplementations</a></td> 216 <td><a href="#RefactoringServer.__queryImplementations">__queryImplementations</a></td>
169 <td>Private slot to handle the Find Implementations action.</td> 217 <td>Private slot to handle the Find Implementations action.</td>
170 </tr><tr> 218 </tr>
219 <tr>
171 <td><a href="#RefactoringServer.__queryImplementationsResult">__queryImplementationsResult</a></td> 220 <td><a href="#RefactoringServer.__queryImplementationsResult">__queryImplementationsResult</a></td>
172 <td>Private method to handle the "Query Implementations" result sent by the client.</td> 221 <td>Private method to handle the "Query Implementations" result sent by the client.</td>
173 </tr><tr> 222 </tr>
223 <tr>
174 <td><a href="#RefactoringServer.__queryReferences">__queryReferences</a></td> 224 <td><a href="#RefactoringServer.__queryReferences">__queryReferences</a></td>
175 <td>Private slot to handle the Find References action.</td> 225 <td>Private slot to handle the Find References action.</td>
176 </tr><tr> 226 </tr>
227 <tr>
177 <td><a href="#RefactoringServer.__queryReferencesResult">__queryReferencesResult</a></td> 228 <td><a href="#RefactoringServer.__queryReferencesResult">__queryReferencesResult</a></td>
178 <td>Private method to handle the "Query References" result sent by the client.</td> 229 <td>Private method to handle the "Query References" result sent by the client.</td>
179 </tr><tr> 230 </tr>
231 <tr>
180 <td><a href="#RefactoringServer.__refactoringDialogClosed">__refactoringDialogClosed</a></td> 232 <td><a href="#RefactoringServer.__refactoringDialogClosed">__refactoringDialogClosed</a></td>
181 <td>Private slot handling the closing of a refactoring dialog.</td> 233 <td>Private slot handling the closing of a refactoring dialog.</td>
182 </tr><tr> 234 </tr>
235 <tr>
183 <td><a href="#RefactoringServer.__rename">__rename</a></td> 236 <td><a href="#RefactoringServer.__rename">__rename</a></td>
184 <td>Private slot to handle the Rename action.</td> 237 <td>Private slot to handle the Rename action.</td>
185 </tr><tr> 238 </tr>
239 <tr>
186 <td><a href="#RefactoringServer.__renameLocal">__renameLocal</a></td> 240 <td><a href="#RefactoringServer.__renameLocal">__renameLocal</a></td>
187 <td>Private slot to handle the Local Rename action.</td> 241 <td>Private slot to handle the Local Rename action.</td>
188 </tr><tr> 242 </tr>
243 <tr>
189 <td><a href="#RefactoringServer.__renameModule">__renameModule</a></td> 244 <td><a href="#RefactoringServer.__renameModule">__renameModule</a></td>
190 <td>Private slot to handle the Rename Current Module action.</td> 245 <td>Private slot to handle the Rename Current Module action.</td>
191 </tr><tr> 246 </tr>
247 <tr>
192 <td><a href="#RefactoringServer.__restructure">__restructure</a></td> 248 <td><a href="#RefactoringServer.__restructure">__restructure</a></td>
193 <td>Private slot to restructure code.</td> 249 <td>Private slot to restructure code.</td>
194 </tr><tr> 250 </tr>
251 <tr>
195 <td><a href="#RefactoringServer.__ropeConfigFile">__ropeConfigFile</a></td> 252 <td><a href="#RefactoringServer.__ropeConfigFile">__ropeConfigFile</a></td>
196 <td>Private method to get the name of the rope configuration file.</td> 253 <td>Private method to get the name of the rope configuration file.</td>
197 </tr><tr> 254 </tr>
255 <tr>
198 <td><a href="#RefactoringServer.__ropeInfo">__ropeInfo</a></td> 256 <td><a href="#RefactoringServer.__ropeInfo">__ropeInfo</a></td>
199 <td>Private slot to show some info about rope.</td> 257 <td>Private slot to show some info about rope.</td>
200 </tr><tr> 258 </tr>
259 <tr>
201 <td><a href="#RefactoringServer.__setConfig">__setConfig</a></td> 260 <td><a href="#RefactoringServer.__setConfig">__setConfig</a></td>
202 <td>Private method to set the rope client configuration data.</td> 261 <td>Private method to set the rope client configuration data.</td>
203 </tr><tr> 262 </tr>
263 <tr>
204 <td><a href="#RefactoringServer.__showFileHistory">__showFileHistory</a></td> 264 <td><a href="#RefactoringServer.__showFileHistory">__showFileHistory</a></td>
205 <td>Private method to show the refactoring history of the current file.</td> 265 <td>Private method to show the refactoring history of the current file.</td>
206 </tr><tr> 266 </tr>
267 <tr>
207 <td><a href="#RefactoringServer.__showProjectHistory">__showProjectHistory</a></td> 268 <td><a href="#RefactoringServer.__showProjectHistory">__showProjectHistory</a></td>
208 <td>Private method to show the project refactoring history.</td> 269 <td>Private method to show the project refactoring history.</td>
209 </tr><tr> 270 </tr>
271 <tr>
210 <td><a href="#RefactoringServer.__showRefactoringHistoryMenu">__showRefactoringHistoryMenu</a></td> 272 <td><a href="#RefactoringServer.__showRefactoringHistoryMenu">__showRefactoringHistoryMenu</a></td>
211 <td>Private slot called before the refactoring history menu is shown.</td> 273 <td>Private slot called before the refactoring history menu is shown.</td>
212 </tr><tr> 274 </tr>
275 <tr>
213 <td><a href="#RefactoringServer.__showRopeHelp">__showRopeHelp</a></td> 276 <td><a href="#RefactoringServer.__showRopeHelp">__showRopeHelp</a></td>
214 <td>Private slot to show help about the refactorings offered by Rope.</td> 277 <td>Private slot to show help about the refactorings offered by Rope.</td>
215 </tr><tr> 278 </tr>
279 <tr>
216 <td><a href="#RefactoringServer.__soaFinished">__soaFinished</a></td> 280 <td><a href="#RefactoringServer.__soaFinished">__soaFinished</a></td>
217 <td>Private method to handle the "Soa Finished" result sent by the client.</td> 281 <td>Private method to handle the "Soa Finished" result sent by the client.</td>
218 </tr><tr> 282 </tr>
283 <tr>
219 <td><a href="#RefactoringServer.__startRefactoringClient">__startRefactoringClient</a></td> 284 <td><a href="#RefactoringServer.__startRefactoringClient">__startRefactoringClient</a></td>
220 <td>Private method to start the refactoring client.</td> 285 <td>Private method to start the refactoring client.</td>
221 </tr><tr> 286 </tr>
287 <tr>
222 <td><a href="#RefactoringServer.__transformModuleToPackage">__transformModuleToPackage</a></td> 288 <td><a href="#RefactoringServer.__transformModuleToPackage">__transformModuleToPackage</a></td>
223 <td>Private slot to transform a module to a package.</td> 289 <td>Private slot to transform a module to a package.</td>
224 </tr><tr> 290 </tr>
291 <tr>
225 <td><a href="#RefactoringServer.__updateConfig">__updateConfig</a></td> 292 <td><a href="#RefactoringServer.__updateConfig">__updateConfig</a></td>
226 <td>Private slot to update the configuration file.</td> 293 <td>Private slot to update the configuration file.</td>
227 </tr><tr> 294 </tr>
295 <tr>
228 <td><a href="#RefactoringServer.__useFunction">__useFunction</a></td> 296 <td><a href="#RefactoringServer.__useFunction">__useFunction</a></td>
229 <td>Private slot to use a function wherever possible.</td> 297 <td>Private slot to use a function wherever possible.</td>
230 </tr><tr> 298 </tr>
299 <tr>
231 <td><a href="#RefactoringServer.activate">activate</a></td> 300 <td><a href="#RefactoringServer.activate">activate</a></td>
232 <td>Public method to activate the refactoring server.</td> 301 <td>Public method to activate the refactoring server.</td>
233 </tr><tr> 302 </tr>
303 <tr>
234 <td><a href="#RefactoringServer.confirmAllBuffersSaved">confirmAllBuffersSaved</a></td> 304 <td><a href="#RefactoringServer.confirmAllBuffersSaved">confirmAllBuffersSaved</a></td>
235 <td>Public method to check, if any editor has unsaved changes.</td> 305 <td>Public method to check, if any editor has unsaved changes.</td>
236 </tr><tr> 306 </tr>
307 <tr>
237 <td><a href="#RefactoringServer.confirmBufferIsSaved">confirmBufferIsSaved</a></td> 308 <td><a href="#RefactoringServer.confirmBufferIsSaved">confirmBufferIsSaved</a></td>
238 <td>Public method to check, if an editor has unsaved changes.</td> 309 <td>Public method to check, if an editor has unsaved changes.</td>
239 </tr><tr> 310 </tr>
311 <tr>
240 <td><a href="#RefactoringServer.deactivate">deactivate</a></td> 312 <td><a href="#RefactoringServer.deactivate">deactivate</a></td>
241 <td>Public method to deactivate the refactoring server.</td> 313 <td>Public method to deactivate the refactoring server.</td>
242 </tr><tr> 314 </tr>
315 <tr>
243 <td><a href="#RefactoringServer.getActions">getActions</a></td> 316 <td><a href="#RefactoringServer.getActions">getActions</a></td>
244 <td>Public method to get a list of all actions.</td> 317 <td>Public method to get a list of all actions.</td>
245 </tr><tr> 318 </tr>
319 <tr>
246 <td><a href="#RefactoringServer.getMainWindow">getMainWindow</a></td> 320 <td><a href="#RefactoringServer.getMainWindow">getMainWindow</a></td>
247 <td>Public method to get a reference to the IDE main window.</td> 321 <td>Public method to get a reference to the IDE main window.</td>
248 </tr><tr> 322 </tr>
323 <tr>
249 <td><a href="#RefactoringServer.handleCall">handleCall</a></td> 324 <td><a href="#RefactoringServer.handleCall">handleCall</a></td>
250 <td>Public method to handle a method call from the client.</td> 325 <td>Public method to handle a method call from the client.</td>
251 </tr><tr> 326 </tr>
327 <tr>
252 <td><a href="#RefactoringServer.handleNewConnection">handleNewConnection</a></td> 328 <td><a href="#RefactoringServer.handleNewConnection">handleNewConnection</a></td>
253 <td>Public slot for new incoming connections from a client.</td> 329 <td>Public slot for new incoming connections from a client.</td>
254 </tr><tr> 330 </tr>
331 <tr>
255 <td><a href="#RefactoringServer.handleRopeError">handleRopeError</a></td> 332 <td><a href="#RefactoringServer.handleRopeError">handleRopeError</a></td>
256 <td>Public method to handle a rope error.</td> 333 <td>Public method to handle a rope error.</td>
257 </tr><tr> 334 </tr>
335 <tr>
258 <td><a href="#RefactoringServer.projectClosed">projectClosed</a></td> 336 <td><a href="#RefactoringServer.projectClosed">projectClosed</a></td>
259 <td>Public slot to handle the projectClosed signal.</td> 337 <td>Public slot to handle the projectClosed signal.</td>
260 </tr><tr> 338 </tr>
339 <tr>
261 <td><a href="#RefactoringServer.projectOpened">projectOpened</a></td> 340 <td><a href="#RefactoringServer.projectOpened">projectOpened</a></td>
262 <td>Public slot to handle the projectOpened signal.</td> 341 <td>Public slot to handle the projectOpened signal.</td>
263 </tr><tr> 342 </tr>
343 <tr>
264 <td><a href="#RefactoringServer.refreshEditors">refreshEditors</a></td> 344 <td><a href="#RefactoringServer.refreshEditors">refreshEditors</a></td>
265 <td>Public method to refresh modified editors.</td> 345 <td>Public method to refresh modified editors.</td>
266 </tr><tr> 346 </tr>
347 <tr>
267 <td><a href="#RefactoringServer.reportChanged">reportChanged</a></td> 348 <td><a href="#RefactoringServer.reportChanged">reportChanged</a></td>
268 <td>Public slot to report some changed sources.</td> 349 <td>Public slot to report some changed sources.</td>
269 </tr> 350 </tr>
270 </table> 351 </table>
271 <h3>Static Methods</h3> 352 <h3>Static Methods</h3>
353
272 <table> 354 <table>
273 <tr><td>None</td></tr> 355 <tr><td>None</td></tr>
274 </table> 356 </table>
357
275 <a NAME="RefactoringServer.__init__" ID="RefactoringServer.__init__"></a> 358 <a NAME="RefactoringServer.__init__" ID="RefactoringServer.__init__"></a>
276 <h4>RefactoringServer (Constructor)</h4> 359 <h4>RefactoringServer (Constructor)</h4>
277 <b>RefactoringServer</b>(<i>plugin, parent=None</i>) 360 <b>RefactoringServer</b>(<i>plugin, parent=None</i>)
361
278 <p> 362 <p>
279 Constructor 363 Constructor
280 </p><dl> 364 </p>
365 <dl>
366
281 <dt><i>plugin</i> (RefactoringRopePlugin)</dt> 367 <dt><i>plugin</i> (RefactoringRopePlugin)</dt>
282 <dd> 368 <dd>
283 reference to the plugin object 369 reference to the plugin object
284 </dd><dt><i>parent</i> (QObject)</dt> 370 </dd>
371 <dt><i>parent</i> (QObject)</dt>
285 <dd> 372 <dd>
286 parent 373 parent
287 </dd> 374 </dd>
288 </dl><a NAME="RefactoringServer.__changeOccurrences" ID="RefactoringServer.__changeOccurrences"></a> 375 </dl>
376 <a NAME="RefactoringServer.__changeOccurrences" ID="RefactoringServer.__changeOccurrences"></a>
289 <h4>RefactoringServer.__changeOccurrences</h4> 377 <h4>RefactoringServer.__changeOccurrences</h4>
290 <b>__changeOccurrences</b>(<i></i>) 378 <b>__changeOccurrences</b>(<i></i>)
379
291 <p> 380 <p>
292 Private slot to perform the Change Occurrences refactoring. 381 Private slot to perform the Change Occurrences refactoring.
293 </p><a NAME="RefactoringServer.__changeSignature" ID="RefactoringServer.__changeSignature"></a> 382 </p>
383 <a NAME="RefactoringServer.__changeSignature" ID="RefactoringServer.__changeSignature"></a>
294 <h4>RefactoringServer.__changeSignature</h4> 384 <h4>RefactoringServer.__changeSignature</h4>
295 <b>__changeSignature</b>(<i></i>) 385 <b>__changeSignature</b>(<i></i>)
386
296 <p> 387 <p>
297 Private slot to change the signature of a method or function. 388 Private slot to change the signature of a method or function.
298 </p><a NAME="RefactoringServer.__clearHistory" ID="RefactoringServer.__clearHistory"></a> 389 </p>
390 <a NAME="RefactoringServer.__clearHistory" ID="RefactoringServer.__clearHistory"></a>
299 <h4>RefactoringServer.__clearHistory</h4> 391 <h4>RefactoringServer.__clearHistory</h4>
300 <b>__clearHistory</b>(<i></i>) 392 <b>__clearHistory</b>(<i></i>)
393
301 <p> 394 <p>
302 Private slot to clear the redo and undo lists. 395 Private slot to clear the redo and undo lists.
303 </p><a NAME="RefactoringServer.__configChanged" ID="RefactoringServer.__configChanged"></a> 396 </p>
397 <a NAME="RefactoringServer.__configChanged" ID="RefactoringServer.__configChanged"></a>
304 <h4>RefactoringServer.__configChanged</h4> 398 <h4>RefactoringServer.__configChanged</h4>
305 <b>__configChanged</b>(<i></i>) 399 <b>__configChanged</b>(<i></i>)
400
306 <p> 401 <p>
307 Private slot called, when the rope config file has changed. 402 Private slot called, when the rope config file has changed.
308 </p><a NAME="RefactoringServer.__convertLocalToAttribute" ID="RefactoringServer.__convertLocalToAttribute"></a> 403 </p>
404 <a NAME="RefactoringServer.__convertLocalToAttribute" ID="RefactoringServer.__convertLocalToAttribute"></a>
309 <h4>RefactoringServer.__convertLocalToAttribute</h4> 405 <h4>RefactoringServer.__convertLocalToAttribute</h4>
310 <b>__convertLocalToAttribute</b>(<i></i>) 406 <b>__convertLocalToAttribute</b>(<i></i>)
407
311 <p> 408 <p>
312 Private slot to convert a local variable to an attribute. 409 Private slot to convert a local variable to an attribute.
313 </p><a NAME="RefactoringServer.__defaultConfig" ID="RefactoringServer.__defaultConfig"></a> 410 </p>
411 <a NAME="RefactoringServer.__defaultConfig" ID="RefactoringServer.__defaultConfig"></a>
314 <h4>RefactoringServer.__defaultConfig</h4> 412 <h4>RefactoringServer.__defaultConfig</h4>
315 <b>__defaultConfig</b>(<i></i>) 413 <b>__defaultConfig</b>(<i></i>)
414
316 <p> 415 <p>
317 Private slot to return the contents of rope's default configuration. 416 Private slot to return the contents of rope's default configuration.
318 </p><dl> 417 </p>
418 <dl>
319 <dt>Returns:</dt> 419 <dt>Returns:</dt>
320 <dd> 420 <dd>
321 string containing the source of rope's default 421 string containing the source of rope's default
322 configuration 422 configuration
323 </dd> 423 </dd>
324 </dl><dl> 424 </dl>
425 <dl>
325 <dt>Return Type:</dt> 426 <dt>Return Type:</dt>
326 <dd> 427 <dd>
327 str 428 str
328 </dd> 429 </dd>
329 </dl><a NAME="RefactoringServer.__doExtract" ID="RefactoringServer.__doExtract"></a> 430 </dl>
431 <a NAME="RefactoringServer.__doExtract" ID="RefactoringServer.__doExtract"></a>
330 <h4>RefactoringServer.__doExtract</h4> 432 <h4>RefactoringServer.__doExtract</h4>
331 <b>__doExtract</b>(<i>title, kind</i>) 433 <b>__doExtract</b>(<i>title, kind</i>)
434
332 <p> 435 <p>
333 Private method to perform the extract refactoring. 436 Private method to perform the extract refactoring.
334 </p><dl> 437 </p>
438 <dl>
439
335 <dt><i>title</i> (str)</dt> 440 <dt><i>title</i> (str)</dt>
336 <dd> 441 <dd>
337 title of the refactoring 442 title of the refactoring
338 </dd><dt><i>kind</i> (str ("method" or "variable"))</dt> 443 </dd>
444 <dt><i>kind</i> (str ("method" or "variable"))</dt>
339 <dd> 445 <dd>
340 kind of extraction to be done 446 kind of extraction to be done
341 </dd> 447 </dd>
342 </dl><a NAME="RefactoringServer.__doImports" ID="RefactoringServer.__doImports"></a> 448 </dl>
449 <a NAME="RefactoringServer.__doImports" ID="RefactoringServer.__doImports"></a>
343 <h4>RefactoringServer.__doImports</h4> 450 <h4>RefactoringServer.__doImports</h4>
344 <b>__doImports</b>(<i>title, methodName</i>) 451 <b>__doImports</b>(<i>title, methodName</i>)
452
345 <p> 453 <p>
346 Private method to perform the various imports refactorings. 454 Private method to perform the various imports refactorings.
347 </p><dl> 455 </p>
456 <dl>
457
348 <dt><i>title</i> (str)</dt> 458 <dt><i>title</i> (str)</dt>
349 <dd> 459 <dd>
350 title to be used for the import refactoring 460 title to be used for the import refactoring
351 </dd><dt><i>methodName</i> (str)</dt> 461 </dd>
462 <dt><i>methodName</i> (str)</dt>
352 <dd> 463 <dd>
353 name of the method performing the import refactoring 464 name of the method performing the import refactoring
354 </dd> 465 </dd>
355 </dl><a NAME="RefactoringServer.__doRename" ID="RefactoringServer.__doRename"></a> 466 </dl>
467 <a NAME="RefactoringServer.__doRename" ID="RefactoringServer.__doRename"></a>
356 <h4>RefactoringServer.__doRename</h4> 468 <h4>RefactoringServer.__doRename</h4>
357 <b>__doRename</b>(<i>title, isLocal=False, renameModule=False</i>) 469 <b>__doRename</b>(<i>title, isLocal=False, renameModule=False</i>)
470
358 <p> 471 <p>
359 Private method to perform the various renaming refactorings. 472 Private method to perform the various renaming refactorings.
360 </p><dl> 473 </p>
474 <dl>
475
361 <dt><i>title</i> (str)</dt> 476 <dt><i>title</i> (str)</dt>
362 <dd> 477 <dd>
363 title of the refactoring 478 title of the refactoring
364 </dd><dt><i>isLocal</i> (bool)</dt> 479 </dd>
480 <dt><i>isLocal</i> (bool)</dt>
365 <dd> 481 <dd>
366 flag indicating to restrict refactoring to 482 flag indicating to restrict refactoring to
367 the local file 483 the local file
368 </dd><dt><i>renameModule</i> (bool)</dt> 484 </dd>
485 <dt><i>renameModule</i> (bool)</dt>
369 <dd> 486 <dd>
370 flag indicating a module rename refactoring 487 flag indicating a module rename refactoring
371 </dd> 488 </dd>
372 </dl><a NAME="RefactoringServer.__editConfig" ID="RefactoringServer.__editConfig"></a> 489 </dl>
490 <a NAME="RefactoringServer.__editConfig" ID="RefactoringServer.__editConfig"></a>
373 <h4>RefactoringServer.__editConfig</h4> 491 <h4>RefactoringServer.__editConfig</h4>
374 <b>__editConfig</b>(<i></i>) 492 <b>__editConfig</b>(<i></i>)
493
375 <p> 494 <p>
376 Private slot to open the rope configuration file in an editor. 495 Private slot to open the rope configuration file in an editor.
377 </p><a NAME="RefactoringServer.__encapsulateAttribute" ID="RefactoringServer.__encapsulateAttribute"></a> 496 </p>
497 <a NAME="RefactoringServer.__encapsulateAttribute" ID="RefactoringServer.__encapsulateAttribute"></a>
378 <h4>RefactoringServer.__encapsulateAttribute</h4> 498 <h4>RefactoringServer.__encapsulateAttribute</h4>
379 <b>__encapsulateAttribute</b>(<i></i>) 499 <b>__encapsulateAttribute</b>(<i></i>)
500
380 <p> 501 <p>
381 Private slot to encapsulate an attribute. 502 Private slot to encapsulate an attribute.
382 </p><a NAME="RefactoringServer.__extractLocalVariable" ID="RefactoringServer.__extractLocalVariable"></a> 503 </p>
504 <a NAME="RefactoringServer.__extractLocalVariable" ID="RefactoringServer.__extractLocalVariable"></a>
383 <h4>RefactoringServer.__extractLocalVariable</h4> 505 <h4>RefactoringServer.__extractLocalVariable</h4>
384 <b>__extractLocalVariable</b>(<i></i>) 506 <b>__extractLocalVariable</b>(<i></i>)
507
385 <p> 508 <p>
386 Private slot to handle the Extract Local Variable action. 509 Private slot to handle the Extract Local Variable action.
387 </p><a NAME="RefactoringServer.__extractMethod" ID="RefactoringServer.__extractMethod"></a> 510 </p>
511 <a NAME="RefactoringServer.__extractMethod" ID="RefactoringServer.__extractMethod"></a>
388 <h4>RefactoringServer.__extractMethod</h4> 512 <h4>RefactoringServer.__extractMethod</h4>
389 <b>__extractMethod</b>(<i></i>) 513 <b>__extractMethod</b>(<i></i>)
514
390 <p> 515 <p>
391 Private slot to handle the Extract Method action. 516 Private slot to handle the Extract Method action.
392 </p><a NAME="RefactoringServer.__getOffset" ID="RefactoringServer.__getOffset"></a> 517 </p>
518 <a NAME="RefactoringServer.__getOffset" ID="RefactoringServer.__getOffset"></a>
393 <h4>RefactoringServer.__getOffset</h4> 519 <h4>RefactoringServer.__getOffset</h4>
394 <b>__getOffset</b>(<i>editor, line, index</i>) 520 <b>__getOffset</b>(<i>editor, line, index</i>)
521
395 <p> 522 <p>
396 Private method to get the offset into the text treating CRLF as ONE 523 Private method to get the offset into the text treating CRLF as ONE
397 character. 524 character.
398 </p><p> 525 </p>
526 <p>
399 Note: rope seems to convert all EOL styles to just \n. 527 Note: rope seems to convert all EOL styles to just \n.
400 </p><dl> 528 </p>
529 <dl>
530
401 <dt><i>editor</i> (QScintilla.Editor.Editor)</dt> 531 <dt><i>editor</i> (QScintilla.Editor.Editor)</dt>
402 <dd> 532 <dd>
403 reference to the editor 533 reference to the editor
404 </dd><dt><i>line</i> (int)</dt> 534 </dd>
535 <dt><i>line</i> (int)</dt>
405 <dd> 536 <dd>
406 line for the offset 537 line for the offset
407 </dd><dt><i>index</i> (int)</dt> 538 </dd>
539 <dt><i>index</i> (int)</dt>
408 <dd> 540 <dd>
409 index into line for the offset 541 index into line for the offset
410 </dd> 542 </dd>
411 </dl><dl> 543 </dl>
544 <dl>
412 <dt>Returns:</dt> 545 <dt>Returns:</dt>
413 <dd> 546 <dd>
414 rope compliant offset into the file 547 rope compliant offset into the file
415 </dd> 548 </dd>
416 </dl><dl> 549 </dl>
550 <dl>
417 <dt>Return Type:</dt> 551 <dt>Return Type:</dt>
418 <dd> 552 <dd>
419 int 553 int
420 </dd> 554 </dd>
421 </dl><a NAME="RefactoringServer.__historyDialogClosed" ID="RefactoringServer.__historyDialogClosed"></a> 555 </dl>
556 <a NAME="RefactoringServer.__historyDialogClosed" ID="RefactoringServer.__historyDialogClosed"></a>
422 <h4>RefactoringServer.__historyDialogClosed</h4> 557 <h4>RefactoringServer.__historyDialogClosed</h4>
423 <b>__historyDialogClosed</b>(<i></i>) 558 <b>__historyDialogClosed</b>(<i></i>)
559
424 <p> 560 <p>
425 Private slot handling the closing of the history dialog. 561 Private slot handling the closing of the history dialog.
426 </p><a NAME="RefactoringServer.__importsExpandStar" ID="RefactoringServer.__importsExpandStar"></a> 562 </p>
563 <a NAME="RefactoringServer.__importsExpandStar" ID="RefactoringServer.__importsExpandStar"></a>
427 <h4>RefactoringServer.__importsExpandStar</h4> 564 <h4>RefactoringServer.__importsExpandStar</h4>
428 <b>__importsExpandStar</b>(<i></i>) 565 <b>__importsExpandStar</b>(<i></i>)
566
429 <p> 567 <p>
430 Private slot to expand star imports. 568 Private slot to expand star imports.
431 </p><a NAME="RefactoringServer.__importsFromToImport" ID="RefactoringServer.__importsFromToImport"></a> 569 </p>
570 <a NAME="RefactoringServer.__importsFromToImport" ID="RefactoringServer.__importsFromToImport"></a>
432 <h4>RefactoringServer.__importsFromToImport</h4> 571 <h4>RefactoringServer.__importsFromToImport</h4>
433 <b>__importsFromToImport</b>(<i></i>) 572 <b>__importsFromToImport</b>(<i></i>)
573
434 <p> 574 <p>
435 Private slot to transform from imports to plain imports. 575 Private slot to transform from imports to plain imports.
436 </p><a NAME="RefactoringServer.__importsHandleLong" ID="RefactoringServer.__importsHandleLong"></a> 576 </p>
577 <a NAME="RefactoringServer.__importsHandleLong" ID="RefactoringServer.__importsHandleLong"></a>
437 <h4>RefactoringServer.__importsHandleLong</h4> 578 <h4>RefactoringServer.__importsHandleLong</h4>
438 <b>__importsHandleLong</b>(<i></i>) 579 <b>__importsHandleLong</b>(<i></i>)
580
439 <p> 581 <p>
440 Private slot to handle long imports. 582 Private slot to handle long imports.
441 </p><a NAME="RefactoringServer.__importsOrganize" ID="RefactoringServer.__importsOrganize"></a> 583 </p>
584 <a NAME="RefactoringServer.__importsOrganize" ID="RefactoringServer.__importsOrganize"></a>
442 <h4>RefactoringServer.__importsOrganize</h4> 585 <h4>RefactoringServer.__importsOrganize</h4>
443 <b>__importsOrganize</b>(<i></i>) 586 <b>__importsOrganize</b>(<i></i>)
587
444 <p> 588 <p>
445 Private slot to organize imports. 589 Private slot to organize imports.
446 </p><a NAME="RefactoringServer.__importsRelativeToAbsolute" ID="RefactoringServer.__importsRelativeToAbsolute"></a> 590 </p>
591 <a NAME="RefactoringServer.__importsRelativeToAbsolute" ID="RefactoringServer.__importsRelativeToAbsolute"></a>
447 <h4>RefactoringServer.__importsRelativeToAbsolute</h4> 592 <h4>RefactoringServer.__importsRelativeToAbsolute</h4>
448 <b>__importsRelativeToAbsolute</b>(<i></i>) 593 <b>__importsRelativeToAbsolute</b>(<i></i>)
594
449 <p> 595 <p>
450 Private slot to transform relative to absolute imports. 596 Private slot to transform relative to absolute imports.
451 </p><a NAME="RefactoringServer.__initActions" ID="RefactoringServer.__initActions"></a> 597 </p>
598 <a NAME="RefactoringServer.__initActions" ID="RefactoringServer.__initActions"></a>
452 <h4>RefactoringServer.__initActions</h4> 599 <h4>RefactoringServer.__initActions</h4>
453 <b>__initActions</b>(<i></i>) 600 <b>__initActions</b>(<i></i>)
601
454 <p> 602 <p>
455 Private method to define the refactoring actions. 603 Private method to define the refactoring actions.
456 </p><a NAME="RefactoringServer.__initMenu" ID="RefactoringServer.__initMenu"></a> 604 </p>
605 <a NAME="RefactoringServer.__initMenu" ID="RefactoringServer.__initMenu"></a>
457 <h4>RefactoringServer.__initMenu</h4> 606 <h4>RefactoringServer.__initMenu</h4>
458 <b>__initMenu</b>(<i></i>) 607 <b>__initMenu</b>(<i></i>)
608
459 <p> 609 <p>
460 Private slot to initialize the refactoring menu. 610 Private slot to initialize the refactoring menu.
461 </p><dl> 611 </p>
612 <dl>
462 <dt>Returns:</dt> 613 <dt>Returns:</dt>
463 <dd> 614 <dd>
464 the menu generated 615 the menu generated
465 </dd> 616 </dd>
466 </dl><dl> 617 </dl>
618 <dl>
467 <dt>Return Type:</dt> 619 <dt>Return Type:</dt>
468 <dd> 620 <dd>
469 QMenu 621 QMenu
470 </dd> 622 </dd>
471 </dl><a NAME="RefactoringServer.__inline" ID="RefactoringServer.__inline"></a> 623 </dl>
624 <a NAME="RefactoringServer.__inline" ID="RefactoringServer.__inline"></a>
472 <h4>RefactoringServer.__inline</h4> 625 <h4>RefactoringServer.__inline</h4>
473 <b>__inline</b>(<i></i>) 626 <b>__inline</b>(<i></i>)
627
474 <p> 628 <p>
475 Private slot to handle the Inline Local Variable action. 629 Private slot to handle the Inline Local Variable action.
476 </p><a NAME="RefactoringServer.__inlineArgumentDefault" ID="RefactoringServer.__inlineArgumentDefault"></a> 630 </p>
631 <a NAME="RefactoringServer.__inlineArgumentDefault" ID="RefactoringServer.__inlineArgumentDefault"></a>
477 <h4>RefactoringServer.__inlineArgumentDefault</h4> 632 <h4>RefactoringServer.__inlineArgumentDefault</h4>
478 <b>__inlineArgumentDefault</b>(<i></i>) 633 <b>__inlineArgumentDefault</b>(<i></i>)
634
479 <p> 635 <p>
480 Private slot to inline the default value of a parameter of a 636 Private slot to inline the default value of a parameter of a
481 method or function. 637 method or function.
482 </p><a NAME="RefactoringServer.__introduceFactoryMethod" ID="RefactoringServer.__introduceFactoryMethod"></a> 638 </p>
639 <a NAME="RefactoringServer.__introduceFactoryMethod" ID="RefactoringServer.__introduceFactoryMethod"></a>
483 <h4>RefactoringServer.__introduceFactoryMethod</h4> 640 <h4>RefactoringServer.__introduceFactoryMethod</h4>
484 <b>__introduceFactoryMethod</b>(<i></i>) 641 <b>__introduceFactoryMethod</b>(<i></i>)
642
485 <p> 643 <p>
486 Private slot to introduce a factory method or global function. 644 Private slot to introduce a factory method or global function.
487 </p><a NAME="RefactoringServer.__introduceParameter" ID="RefactoringServer.__introduceParameter"></a> 645 </p>
646 <a NAME="RefactoringServer.__introduceParameter" ID="RefactoringServer.__introduceParameter"></a>
488 <h4>RefactoringServer.__introduceParameter</h4> 647 <h4>RefactoringServer.__introduceParameter</h4>
489 <b>__introduceParameter</b>(<i></i>) 648 <b>__introduceParameter</b>(<i></i>)
649
490 <p> 650 <p>
491 Private slot to introduce a parameter in a function. 651 Private slot to introduce a parameter in a function.
492 </p><a NAME="RefactoringServer.__methodToMethodObject" ID="RefactoringServer.__methodToMethodObject"></a> 652 </p>
653 <a NAME="RefactoringServer.__methodToMethodObject" ID="RefactoringServer.__methodToMethodObject"></a>
493 <h4>RefactoringServer.__methodToMethodObject</h4> 654 <h4>RefactoringServer.__methodToMethodObject</h4>
494 <b>__methodToMethodObject</b>(<i></i>) 655 <b>__methodToMethodObject</b>(<i></i>)
656
495 <p> 657 <p>
496 Private slot to change the signature of a method or function. 658 Private slot to change the signature of a method or function.
497 </p><a NAME="RefactoringServer.__move" ID="RefactoringServer.__move"></a> 659 </p>
660 <a NAME="RefactoringServer.__move" ID="RefactoringServer.__move"></a>
498 <h4>RefactoringServer.__move</h4> 661 <h4>RefactoringServer.__move</h4>
499 <b>__move</b>(<i>moveKind</i>) 662 <b>__move</b>(<i>moveKind</i>)
663
500 <p> 664 <p>
501 Private slot to handle the Move Method action. 665 Private slot to handle the Move Method action.
502 </p><dl> 666 </p>
667 <dl>
668
503 <dt><i>moveKind</i> (str (one of 'move_method' or 'move_module'))</dt> 669 <dt><i>moveKind</i> (str (one of 'move_method' or 'move_module'))</dt>
504 <dd> 670 <dd>
505 kind of move to be performed 671 kind of move to be performed
506 </dd> 672 </dd>
507 </dl><a NAME="RefactoringServer.__performSOA" ID="RefactoringServer.__performSOA"></a> 673 </dl>
674 <a NAME="RefactoringServer.__performSOA" ID="RefactoringServer.__performSOA"></a>
508 <h4>RefactoringServer.__performSOA</h4> 675 <h4>RefactoringServer.__performSOA</h4>
509 <b>__performSOA</b>(<i></i>) 676 <b>__performSOA</b>(<i></i>)
677
510 <p> 678 <p>
511 Private slot to perform SOA on all modules. 679 Private slot to perform SOA on all modules.
512 </p><a NAME="RefactoringServer.__processChanges" ID="RefactoringServer.__processChanges"></a> 680 </p>
681 <a NAME="RefactoringServer.__processChanges" ID="RefactoringServer.__processChanges"></a>
513 <h4>RefactoringServer.__processChanges</h4> 682 <h4>RefactoringServer.__processChanges</h4>
514 <b>__processChanges</b>(<i>result</i>) 683 <b>__processChanges</b>(<i>result</i>)
684
515 <p> 685 <p>
516 Private method to process the changes data sent by the refactoring 686 Private method to process the changes data sent by the refactoring
517 client. 687 client.
518 </p><dl> 688 </p>
689 <dl>
690
519 <dt><i>result</i> (dict)</dt> 691 <dt><i>result</i> (dict)</dt>
520 <dd> 692 <dd>
521 dictionary containing the changes data 693 dictionary containing the changes data
522 </dd> 694 </dd>
523 </dl><a NAME="RefactoringServer.__processClientException" ID="RefactoringServer.__processClientException"></a> 695 </dl>
696 <a NAME="RefactoringServer.__processClientException" ID="RefactoringServer.__processClientException"></a>
524 <h4>RefactoringServer.__processClientException</h4> 697 <h4>RefactoringServer.__processClientException</h4>
525 <b>__processClientException</b>(<i>params</i>) 698 <b>__processClientException</b>(<i>params</i>)
699
526 <p> 700 <p>
527 Private method to handle exceptions of the refactoring client. 701 Private method to handle exceptions of the refactoring client.
528 </p><dl> 702 </p>
703 <dl>
704
529 <dt><i>params</i> (dict)</dt> 705 <dt><i>params</i> (dict)</dt>
530 <dd> 706 <dd>
531 dictionary containing the exception data 707 dictionary containing the exception data
532 </dd> 708 </dd>
533 </dl><a NAME="RefactoringServer.__processHistoryResult" ID="RefactoringServer.__processHistoryResult"></a> 709 </dl>
710 <a NAME="RefactoringServer.__processHistoryResult" ID="RefactoringServer.__processHistoryResult"></a>
534 <h4>RefactoringServer.__processHistoryResult</h4> 711 <h4>RefactoringServer.__processHistoryResult</h4>
535 <b>__processHistoryResult</b>(<i>result</i>) 712 <b>__processHistoryResult</b>(<i>result</i>)
713
536 <p> 714 <p>
537 Private method to process the history data sent by the refactoring 715 Private method to process the history data sent by the refactoring
538 client. 716 client.
539 </p><dl> 717 </p>
718 <dl>
719
540 <dt><i>result</i> (dict)</dt> 720 <dt><i>result</i> (dict)</dt>
541 <dd> 721 <dd>
542 dictionary containing the history data 722 dictionary containing the history data
543 </dd> 723 </dd>
544 </dl><a NAME="RefactoringServer.__processProgress" ID="RefactoringServer.__processProgress"></a> 724 </dl>
725 <a NAME="RefactoringServer.__processProgress" ID="RefactoringServer.__processProgress"></a>
545 <h4>RefactoringServer.__processProgress</h4> 726 <h4>RefactoringServer.__processProgress</h4>
546 <b>__processProgress</b>(<i>params</i>) 727 <b>__processProgress</b>(<i>params</i>)
728
547 <p> 729 <p>
548 Private method to handle Progress commands. 730 Private method to handle Progress commands.
549 </p><dl> 731 </p>
732 <dl>
733
550 <dt><i>params</i> (dict)</dt> 734 <dt><i>params</i> (dict)</dt>
551 <dd> 735 <dd>
552 dictionary containing the progress data 736 dictionary containing the progress data
553 </dd> 737 </dd>
554 </dl><a NAME="RefactoringServer.__queryDefinition" ID="RefactoringServer.__queryDefinition"></a> 738 </dl>
739 <a NAME="RefactoringServer.__queryDefinition" ID="RefactoringServer.__queryDefinition"></a>
555 <h4>RefactoringServer.__queryDefinition</h4> 740 <h4>RefactoringServer.__queryDefinition</h4>
556 <b>__queryDefinition</b>(<i></i>) 741 <b>__queryDefinition</b>(<i></i>)
742
557 <p> 743 <p>
558 Private slot to handle the Find Definition action. 744 Private slot to handle the Find Definition action.
559 </p><a NAME="RefactoringServer.__queryDefinitionResult" ID="RefactoringServer.__queryDefinitionResult"></a> 745 </p>
746 <a NAME="RefactoringServer.__queryDefinitionResult" ID="RefactoringServer.__queryDefinitionResult"></a>
560 <h4>RefactoringServer.__queryDefinitionResult</h4> 747 <h4>RefactoringServer.__queryDefinitionResult</h4>
561 <b>__queryDefinitionResult</b>(<i>result</i>) 748 <b>__queryDefinitionResult</b>(<i>result</i>)
749
562 <p> 750 <p>
563 Private method to handle the "Query Definition" result sent by 751 Private method to handle the "Query Definition" result sent by
564 the client. 752 the client.
565 </p><dl> 753 </p>
754 <dl>
755
566 <dt><i>result</i> (dict)</dt> 756 <dt><i>result</i> (dict)</dt>
567 <dd> 757 <dd>
568 dictionary containing the result data 758 dictionary containing the result data
569 </dd> 759 </dd>
570 </dl><a NAME="RefactoringServer.__queryImplementations" ID="RefactoringServer.__queryImplementations"></a> 760 </dl>
761 <a NAME="RefactoringServer.__queryImplementations" ID="RefactoringServer.__queryImplementations"></a>
571 <h4>RefactoringServer.__queryImplementations</h4> 762 <h4>RefactoringServer.__queryImplementations</h4>
572 <b>__queryImplementations</b>(<i></i>) 763 <b>__queryImplementations</b>(<i></i>)
764
573 <p> 765 <p>
574 Private slot to handle the Find Implementations action. 766 Private slot to handle the Find Implementations action.
575 </p><a NAME="RefactoringServer.__queryImplementationsResult" ID="RefactoringServer.__queryImplementationsResult"></a> 767 </p>
768 <a NAME="RefactoringServer.__queryImplementationsResult" ID="RefactoringServer.__queryImplementationsResult"></a>
576 <h4>RefactoringServer.__queryImplementationsResult</h4> 769 <h4>RefactoringServer.__queryImplementationsResult</h4>
577 <b>__queryImplementationsResult</b>(<i>result</i>) 770 <b>__queryImplementationsResult</b>(<i>result</i>)
771
578 <p> 772 <p>
579 Private method to handle the "Query Implementations" result sent by 773 Private method to handle the "Query Implementations" result sent by
580 the client. 774 the client.
581 </p><dl> 775 </p>
776 <dl>
777
582 <dt><i>result</i> (dict)</dt> 778 <dt><i>result</i> (dict)</dt>
583 <dd> 779 <dd>
584 dictionary containing the result data 780 dictionary containing the result data
585 </dd> 781 </dd>
586 </dl><a NAME="RefactoringServer.__queryReferences" ID="RefactoringServer.__queryReferences"></a> 782 </dl>
783 <a NAME="RefactoringServer.__queryReferences" ID="RefactoringServer.__queryReferences"></a>
587 <h4>RefactoringServer.__queryReferences</h4> 784 <h4>RefactoringServer.__queryReferences</h4>
588 <b>__queryReferences</b>(<i></i>) 785 <b>__queryReferences</b>(<i></i>)
786
589 <p> 787 <p>
590 Private slot to handle the Find References action. 788 Private slot to handle the Find References action.
591 </p><a NAME="RefactoringServer.__queryReferencesResult" ID="RefactoringServer.__queryReferencesResult"></a> 789 </p>
790 <a NAME="RefactoringServer.__queryReferencesResult" ID="RefactoringServer.__queryReferencesResult"></a>
592 <h4>RefactoringServer.__queryReferencesResult</h4> 791 <h4>RefactoringServer.__queryReferencesResult</h4>
593 <b>__queryReferencesResult</b>(<i>result</i>) 792 <b>__queryReferencesResult</b>(<i>result</i>)
793
594 <p> 794 <p>
595 Private method to handle the "Query References" result sent by 795 Private method to handle the "Query References" result sent by
596 the client. 796 the client.
597 </p><dl> 797 </p>
798 <dl>
799
598 <dt><i>result</i> (dict)</dt> 800 <dt><i>result</i> (dict)</dt>
599 <dd> 801 <dd>
600 dictionary containing the result data 802 dictionary containing the result data
601 </dd> 803 </dd>
602 </dl><a NAME="RefactoringServer.__refactoringDialogClosed" ID="RefactoringServer.__refactoringDialogClosed"></a> 804 </dl>
805 <a NAME="RefactoringServer.__refactoringDialogClosed" ID="RefactoringServer.__refactoringDialogClosed"></a>
603 <h4>RefactoringServer.__refactoringDialogClosed</h4> 806 <h4>RefactoringServer.__refactoringDialogClosed</h4>
604 <b>__refactoringDialogClosed</b>(<i>changeGroup</i>) 807 <b>__refactoringDialogClosed</b>(<i>changeGroup</i>)
808
605 <p> 809 <p>
606 Private slot handling the closing of a refactoring dialog. 810 Private slot handling the closing of a refactoring dialog.
607 </p><dl> 811 </p>
812 <dl>
813
608 <dt><i>changeGroup</i> (str)</dt> 814 <dt><i>changeGroup</i> (str)</dt>
609 <dd> 815 <dd>
610 name of the refactoring change group the dialog 816 name of the refactoring change group the dialog
611 belonged to 817 belonged to
612 </dd> 818 </dd>
613 </dl><a NAME="RefactoringServer.__rename" ID="RefactoringServer.__rename"></a> 819 </dl>
820 <a NAME="RefactoringServer.__rename" ID="RefactoringServer.__rename"></a>
614 <h4>RefactoringServer.__rename</h4> 821 <h4>RefactoringServer.__rename</h4>
615 <b>__rename</b>(<i></i>) 822 <b>__rename</b>(<i></i>)
823
616 <p> 824 <p>
617 Private slot to handle the Rename action. 825 Private slot to handle the Rename action.
618 </p><a NAME="RefactoringServer.__renameLocal" ID="RefactoringServer.__renameLocal"></a> 826 </p>
827 <a NAME="RefactoringServer.__renameLocal" ID="RefactoringServer.__renameLocal"></a>
619 <h4>RefactoringServer.__renameLocal</h4> 828 <h4>RefactoringServer.__renameLocal</h4>
620 <b>__renameLocal</b>(<i></i>) 829 <b>__renameLocal</b>(<i></i>)
830
621 <p> 831 <p>
622 Private slot to handle the Local Rename action. 832 Private slot to handle the Local Rename action.
623 </p><a NAME="RefactoringServer.__renameModule" ID="RefactoringServer.__renameModule"></a> 833 </p>
834 <a NAME="RefactoringServer.__renameModule" ID="RefactoringServer.__renameModule"></a>
624 <h4>RefactoringServer.__renameModule</h4> 835 <h4>RefactoringServer.__renameModule</h4>
625 <b>__renameModule</b>(<i></i>) 836 <b>__renameModule</b>(<i></i>)
837
626 <p> 838 <p>
627 Private slot to handle the Rename Current Module action. 839 Private slot to handle the Rename Current Module action.
628 </p><a NAME="RefactoringServer.__restructure" ID="RefactoringServer.__restructure"></a> 840 </p>
841 <a NAME="RefactoringServer.__restructure" ID="RefactoringServer.__restructure"></a>
629 <h4>RefactoringServer.__restructure</h4> 842 <h4>RefactoringServer.__restructure</h4>
630 <b>__restructure</b>(<i></i>) 843 <b>__restructure</b>(<i></i>)
844
631 <p> 845 <p>
632 Private slot to restructure code. 846 Private slot to restructure code.
633 </p><a NAME="RefactoringServer.__ropeConfigFile" ID="RefactoringServer.__ropeConfigFile"></a> 847 </p>
848 <a NAME="RefactoringServer.__ropeConfigFile" ID="RefactoringServer.__ropeConfigFile"></a>
634 <h4>RefactoringServer.__ropeConfigFile</h4> 849 <h4>RefactoringServer.__ropeConfigFile</h4>
635 <b>__ropeConfigFile</b>(<i></i>) 850 <b>__ropeConfigFile</b>(<i></i>)
851
636 <p> 852 <p>
637 Private method to get the name of the rope configuration file. 853 Private method to get the name of the rope configuration file.
638 </p><dl> 854 </p>
855 <dl>
639 <dt>Returns:</dt> 856 <dt>Returns:</dt>
640 <dd> 857 <dd>
641 name of the rope configuration file 858 name of the rope configuration file
642 </dd> 859 </dd>
643 </dl><dl> 860 </dl>
861 <dl>
644 <dt>Return Type:</dt> 862 <dt>Return Type:</dt>
645 <dd> 863 <dd>
646 str 864 str
647 </dd> 865 </dd>
648 </dl><a NAME="RefactoringServer.__ropeInfo" ID="RefactoringServer.__ropeInfo"></a> 866 </dl>
867 <a NAME="RefactoringServer.__ropeInfo" ID="RefactoringServer.__ropeInfo"></a>
649 <h4>RefactoringServer.__ropeInfo</h4> 868 <h4>RefactoringServer.__ropeInfo</h4>
650 <b>__ropeInfo</b>(<i></i>) 869 <b>__ropeInfo</b>(<i></i>)
870
651 <p> 871 <p>
652 Private slot to show some info about rope. 872 Private slot to show some info about rope.
653 </p><a NAME="RefactoringServer.__setConfig" ID="RefactoringServer.__setConfig"></a> 873 </p>
874 <a NAME="RefactoringServer.__setConfig" ID="RefactoringServer.__setConfig"></a>
654 <h4>RefactoringServer.__setConfig</h4> 875 <h4>RefactoringServer.__setConfig</h4>
655 <b>__setConfig</b>(<i>params</i>) 876 <b>__setConfig</b>(<i>params</i>)
877
656 <p> 878 <p>
657 Private method to set the rope client configuration data. 879 Private method to set the rope client configuration data.
658 </p><dl> 880 </p>
881 <dl>
882
659 <dt><i>params</i> (dict)</dt> 883 <dt><i>params</i> (dict)</dt>
660 <dd> 884 <dd>
661 dictionary containing the configuration data 885 dictionary containing the configuration data
662 </dd> 886 </dd>
663 </dl><a NAME="RefactoringServer.__showFileHistory" ID="RefactoringServer.__showFileHistory"></a> 887 </dl>
888 <a NAME="RefactoringServer.__showFileHistory" ID="RefactoringServer.__showFileHistory"></a>
664 <h4>RefactoringServer.__showFileHistory</h4> 889 <h4>RefactoringServer.__showFileHistory</h4>
665 <b>__showFileHistory</b>(<i></i>) 890 <b>__showFileHistory</b>(<i></i>)
891
666 <p> 892 <p>
667 Private method to show the refactoring history of the current file. 893 Private method to show the refactoring history of the current file.
668 </p><a NAME="RefactoringServer.__showProjectHistory" ID="RefactoringServer.__showProjectHistory"></a> 894 </p>
895 <a NAME="RefactoringServer.__showProjectHistory" ID="RefactoringServer.__showProjectHistory"></a>
669 <h4>RefactoringServer.__showProjectHistory</h4> 896 <h4>RefactoringServer.__showProjectHistory</h4>
670 <b>__showProjectHistory</b>(<i></i>) 897 <b>__showProjectHistory</b>(<i></i>)
898
671 <p> 899 <p>
672 Private method to show the project refactoring history. 900 Private method to show the project refactoring history.
673 </p><a NAME="RefactoringServer.__showRefactoringHistoryMenu" ID="RefactoringServer.__showRefactoringHistoryMenu"></a> 901 </p>
902 <a NAME="RefactoringServer.__showRefactoringHistoryMenu" ID="RefactoringServer.__showRefactoringHistoryMenu"></a>
674 <h4>RefactoringServer.__showRefactoringHistoryMenu</h4> 903 <h4>RefactoringServer.__showRefactoringHistoryMenu</h4>
675 <b>__showRefactoringHistoryMenu</b>(<i></i>) 904 <b>__showRefactoringHistoryMenu</b>(<i></i>)
905
676 <p> 906 <p>
677 Private slot called before the refactoring history menu is shown. 907 Private slot called before the refactoring history menu is shown.
678 </p><a NAME="RefactoringServer.__showRopeHelp" ID="RefactoringServer.__showRopeHelp"></a> 908 </p>
909 <a NAME="RefactoringServer.__showRopeHelp" ID="RefactoringServer.__showRopeHelp"></a>
679 <h4>RefactoringServer.__showRopeHelp</h4> 910 <h4>RefactoringServer.__showRopeHelp</h4>
680 <b>__showRopeHelp</b>(<i></i>) 911 <b>__showRopeHelp</b>(<i></i>)
912
681 <p> 913 <p>
682 Private slot to show help about the refactorings offered by Rope. 914 Private slot to show help about the refactorings offered by Rope.
683 </p><a NAME="RefactoringServer.__soaFinished" ID="RefactoringServer.__soaFinished"></a> 915 </p>
916 <a NAME="RefactoringServer.__soaFinished" ID="RefactoringServer.__soaFinished"></a>
684 <h4>RefactoringServer.__soaFinished</h4> 917 <h4>RefactoringServer.__soaFinished</h4>
685 <b>__soaFinished</b>(<i>result</i>) 918 <b>__soaFinished</b>(<i>result</i>)
919
686 <p> 920 <p>
687 Private method to handle the "Soa Finished" result sent by 921 Private method to handle the "Soa Finished" result sent by
688 the client. 922 the client.
689 </p><dl> 923 </p>
924 <dl>
925
690 <dt><i>result</i> (dict)</dt> 926 <dt><i>result</i> (dict)</dt>
691 <dd> 927 <dd>
692 dictionary containing the result data 928 dictionary containing the result data
693 </dd> 929 </dd>
694 </dl><a NAME="RefactoringServer.__startRefactoringClient" ID="RefactoringServer.__startRefactoringClient"></a> 930 </dl>
931 <a NAME="RefactoringServer.__startRefactoringClient" ID="RefactoringServer.__startRefactoringClient"></a>
695 <h4>RefactoringServer.__startRefactoringClient</h4> 932 <h4>RefactoringServer.__startRefactoringClient</h4>
696 <b>__startRefactoringClient</b>(<i>interpreter, clientEnv</i>) 933 <b>__startRefactoringClient</b>(<i>interpreter, clientEnv</i>)
934
697 <p> 935 <p>
698 Private method to start the refactoring client. 936 Private method to start the refactoring client.
699 </p><dl> 937 </p>
938 <dl>
939
700 <dt><i>interpreter</i> (str)</dt> 940 <dt><i>interpreter</i> (str)</dt>
701 <dd> 941 <dd>
702 interpreter to be used for the refactoring client 942 interpreter to be used for the refactoring client
703 </dd><dt><i>clientEnv</i> (dict)</dt> 943 </dd>
944 <dt><i>clientEnv</i> (dict)</dt>
704 <dd> 945 <dd>
705 dictionary with environment variables to run the 946 dictionary with environment variables to run the
706 interpreter with 947 interpreter with
707 </dd> 948 </dd>
708 </dl><dl> 949 </dl>
950 <dl>
709 <dt>Returns:</dt> 951 <dt>Returns:</dt>
710 <dd> 952 <dd>
711 flag indicating a successful client start 953 flag indicating a successful client start
712 </dd> 954 </dd>
713 </dl><dl> 955 </dl>
956 <dl>
714 <dt>Return Type:</dt> 957 <dt>Return Type:</dt>
715 <dd> 958 <dd>
716 bool 959 bool
717 </dd> 960 </dd>
718 </dl><a NAME="RefactoringServer.__transformModuleToPackage" ID="RefactoringServer.__transformModuleToPackage"></a> 961 </dl>
962 <a NAME="RefactoringServer.__transformModuleToPackage" ID="RefactoringServer.__transformModuleToPackage"></a>
719 <h4>RefactoringServer.__transformModuleToPackage</h4> 963 <h4>RefactoringServer.__transformModuleToPackage</h4>
720 <b>__transformModuleToPackage</b>(<i></i>) 964 <b>__transformModuleToPackage</b>(<i></i>)
965
721 <p> 966 <p>
722 Private slot to transform a module to a package. 967 Private slot to transform a module to a package.
723 </p><a NAME="RefactoringServer.__updateConfig" ID="RefactoringServer.__updateConfig"></a> 968 </p>
969 <a NAME="RefactoringServer.__updateConfig" ID="RefactoringServer.__updateConfig"></a>
724 <h4>RefactoringServer.__updateConfig</h4> 970 <h4>RefactoringServer.__updateConfig</h4>
725 <b>__updateConfig</b>(<i></i>) 971 <b>__updateConfig</b>(<i></i>)
972
726 <p> 973 <p>
727 Private slot to update the configuration file. 974 Private slot to update the configuration file.
728 </p><a NAME="RefactoringServer.__useFunction" ID="RefactoringServer.__useFunction"></a> 975 </p>
976 <a NAME="RefactoringServer.__useFunction" ID="RefactoringServer.__useFunction"></a>
729 <h4>RefactoringServer.__useFunction</h4> 977 <h4>RefactoringServer.__useFunction</h4>
730 <b>__useFunction</b>(<i></i>) 978 <b>__useFunction</b>(<i></i>)
979
731 <p> 980 <p>
732 Private slot to use a function wherever possible. 981 Private slot to use a function wherever possible.
733 </p><a NAME="RefactoringServer.activate" ID="RefactoringServer.activate"></a> 982 </p>
983 <a NAME="RefactoringServer.activate" ID="RefactoringServer.activate"></a>
734 <h4>RefactoringServer.activate</h4> 984 <h4>RefactoringServer.activate</h4>
735 <b>activate</b>(<i></i>) 985 <b>activate</b>(<i></i>)
986
736 <p> 987 <p>
737 Public method to activate the refactoring server. 988 Public method to activate the refactoring server.
738 </p><p> 989 </p>
990 <p>
739 This is performed when the rope plug-in is activated. 991 This is performed when the rope plug-in is activated.
740 </p><a NAME="RefactoringServer.confirmAllBuffersSaved" ID="RefactoringServer.confirmAllBuffersSaved"></a> 992 </p>
993 <a NAME="RefactoringServer.confirmAllBuffersSaved" ID="RefactoringServer.confirmAllBuffersSaved"></a>
741 <h4>RefactoringServer.confirmAllBuffersSaved</h4> 994 <h4>RefactoringServer.confirmAllBuffersSaved</h4>
742 <b>confirmAllBuffersSaved</b>(<i></i>) 995 <b>confirmAllBuffersSaved</b>(<i></i>)
996
743 <p> 997 <p>
744 Public method to check, if any editor has unsaved changes. 998 Public method to check, if any editor has unsaved changes.
745 </p><dl> 999 </p>
1000 <dl>
746 <dt>Returns:</dt> 1001 <dt>Returns:</dt>
747 <dd> 1002 <dd>
748 flag indicating, that no editor contains unsaved edits 1003 flag indicating, that no editor contains unsaved edits
749 </dd> 1004 </dd>
750 </dl><dl> 1005 </dl>
1006 <dl>
751 <dt>Return Type:</dt> 1007 <dt>Return Type:</dt>
752 <dd> 1008 <dd>
753 bool 1009 bool
754 </dd> 1010 </dd>
755 </dl><a NAME="RefactoringServer.confirmBufferIsSaved" ID="RefactoringServer.confirmBufferIsSaved"></a> 1011 </dl>
1012 <a NAME="RefactoringServer.confirmBufferIsSaved" ID="RefactoringServer.confirmBufferIsSaved"></a>
756 <h4>RefactoringServer.confirmBufferIsSaved</h4> 1013 <h4>RefactoringServer.confirmBufferIsSaved</h4>
757 <b>confirmBufferIsSaved</b>(<i>editor</i>) 1014 <b>confirmBufferIsSaved</b>(<i>editor</i>)
1015
758 <p> 1016 <p>
759 Public method to check, if an editor has unsaved changes. 1017 Public method to check, if an editor has unsaved changes.
760 </p><dl> 1018 </p>
1019 <dl>
1020
761 <dt><i>editor</i> (QScintilla.Editor.Editor)</dt> 1021 <dt><i>editor</i> (QScintilla.Editor.Editor)</dt>
762 <dd> 1022 <dd>
763 reference to the editor to be checked 1023 reference to the editor to be checked
764 </dd> 1024 </dd>
765 </dl><dl> 1025 </dl>
1026 <dl>
766 <dt>Returns:</dt> 1027 <dt>Returns:</dt>
767 <dd> 1028 <dd>
768 flag indicating, that the editor doesn't contain 1029 flag indicating, that the editor doesn't contain
769 unsaved edits 1030 unsaved edits
770 </dd> 1031 </dd>
771 </dl><dl> 1032 </dl>
1033 <dl>
772 <dt>Return Type:</dt> 1034 <dt>Return Type:</dt>
773 <dd> 1035 <dd>
774 bool 1036 bool
775 </dd> 1037 </dd>
776 </dl><a NAME="RefactoringServer.deactivate" ID="RefactoringServer.deactivate"></a> 1038 </dl>
1039 <a NAME="RefactoringServer.deactivate" ID="RefactoringServer.deactivate"></a>
777 <h4>RefactoringServer.deactivate</h4> 1040 <h4>RefactoringServer.deactivate</h4>
778 <b>deactivate</b>(<i></i>) 1041 <b>deactivate</b>(<i></i>)
1042
779 <p> 1043 <p>
780 Public method to deactivate the refactoring server. 1044 Public method to deactivate the refactoring server.
781 </p><a NAME="RefactoringServer.getActions" ID="RefactoringServer.getActions"></a> 1045 </p>
1046 <a NAME="RefactoringServer.getActions" ID="RefactoringServer.getActions"></a>
782 <h4>RefactoringServer.getActions</h4> 1047 <h4>RefactoringServer.getActions</h4>
783 <b>getActions</b>(<i></i>) 1048 <b>getActions</b>(<i></i>)
1049
784 <p> 1050 <p>
785 Public method to get a list of all actions. 1051 Public method to get a list of all actions.
786 </p><dl> 1052 </p>
1053 <dl>
787 <dt>Returns:</dt> 1054 <dt>Returns:</dt>
788 <dd> 1055 <dd>
789 list of all actions 1056 list of all actions
790 </dd> 1057 </dd>
791 </dl><dl> 1058 </dl>
1059 <dl>
792 <dt>Return Type:</dt> 1060 <dt>Return Type:</dt>
793 <dd> 1061 <dd>
794 list of E5Action 1062 list of E5Action
795 </dd> 1063 </dd>
796 </dl><a NAME="RefactoringServer.getMainWindow" ID="RefactoringServer.getMainWindow"></a> 1064 </dl>
1065 <a NAME="RefactoringServer.getMainWindow" ID="RefactoringServer.getMainWindow"></a>
797 <h4>RefactoringServer.getMainWindow</h4> 1066 <h4>RefactoringServer.getMainWindow</h4>
798 <b>getMainWindow</b>(<i></i>) 1067 <b>getMainWindow</b>(<i></i>)
1068
799 <p> 1069 <p>
800 Public method to get a reference to the IDE main window. 1070 Public method to get a reference to the IDE main window.
801 </p><dl> 1071 </p>
1072 <dl>
802 <dt>Returns:</dt> 1073 <dt>Returns:</dt>
803 <dd> 1074 <dd>
804 reference to the IDE main window 1075 reference to the IDE main window
805 </dd> 1076 </dd>
806 </dl><dl> 1077 </dl>
1078 <dl>
807 <dt>Return Type:</dt> 1079 <dt>Return Type:</dt>
808 <dd> 1080 <dd>
809 UserInterface 1081 UserInterface
810 </dd> 1082 </dd>
811 </dl><a NAME="RefactoringServer.handleCall" ID="RefactoringServer.handleCall"></a> 1083 </dl>
1084 <a NAME="RefactoringServer.handleCall" ID="RefactoringServer.handleCall"></a>
812 <h4>RefactoringServer.handleCall</h4> 1085 <h4>RefactoringServer.handleCall</h4>
813 <b>handleCall</b>(<i>method, params</i>) 1086 <b>handleCall</b>(<i>method, params</i>)
1087
814 <p> 1088 <p>
815 Public method to handle a method call from the client. 1089 Public method to handle a method call from the client.
816 </p><dl> 1090 </p>
1091 <dl>
1092
817 <dt><i>method</i> (str)</dt> 1093 <dt><i>method</i> (str)</dt>
818 <dd> 1094 <dd>
819 requested method name 1095 requested method name
820 </dd><dt><i>params</i> (dict)</dt> 1096 </dd>
1097 <dt><i>params</i> (dict)</dt>
821 <dd> 1098 <dd>
822 dictionary with method specific parameters 1099 dictionary with method specific parameters
823 </dd> 1100 </dd>
824 </dl><a NAME="RefactoringServer.handleNewConnection" ID="RefactoringServer.handleNewConnection"></a> 1101 </dl>
1102 <a NAME="RefactoringServer.handleNewConnection" ID="RefactoringServer.handleNewConnection"></a>
825 <h4>RefactoringServer.handleNewConnection</h4> 1103 <h4>RefactoringServer.handleNewConnection</h4>
826 <b>handleNewConnection</b>(<i></i>) 1104 <b>handleNewConnection</b>(<i></i>)
1105
827 <p> 1106 <p>
828 Public slot for new incoming connections from a client. 1107 Public slot for new incoming connections from a client.
829 </p><a NAME="RefactoringServer.handleRopeError" ID="RefactoringServer.handleRopeError"></a> 1108 </p>
1109 <a NAME="RefactoringServer.handleRopeError" ID="RefactoringServer.handleRopeError"></a>
830 <h4>RefactoringServer.handleRopeError</h4> 1110 <h4>RefactoringServer.handleRopeError</h4>
831 <b>handleRopeError</b>(<i>result</i>) 1111 <b>handleRopeError</b>(<i>result</i>)
1112
832 <p> 1113 <p>
833 Public method to handle a rope error. 1114 Public method to handle a rope error.
834 </p><dl> 1115 </p>
1116 <dl>
1117
835 <dt><i>result</i> (dict)</dt> 1118 <dt><i>result</i> (dict)</dt>
836 <dd> 1119 <dd>
837 dictionary containing the error information 1120 dictionary containing the error information
838 </dd> 1121 </dd>
839 </dl><dl> 1122 </dl>
1123 <dl>
840 <dt>Returns:</dt> 1124 <dt>Returns:</dt>
841 <dd> 1125 <dd>
842 flag indicating, that the error is to be ignored 1126 flag indicating, that the error is to be ignored
843 </dd> 1127 </dd>
844 </dl><dl> 1128 </dl>
1129 <dl>
845 <dt>Return Type:</dt> 1130 <dt>Return Type:</dt>
846 <dd> 1131 <dd>
847 bool 1132 bool
848 </dd> 1133 </dd>
849 </dl><a NAME="RefactoringServer.projectClosed" ID="RefactoringServer.projectClosed"></a> 1134 </dl>
1135 <a NAME="RefactoringServer.projectClosed" ID="RefactoringServer.projectClosed"></a>
850 <h4>RefactoringServer.projectClosed</h4> 1136 <h4>RefactoringServer.projectClosed</h4>
851 <b>projectClosed</b>(<i></i>) 1137 <b>projectClosed</b>(<i></i>)
1138
852 <p> 1139 <p>
853 Public slot to handle the projectClosed signal. 1140 Public slot to handle the projectClosed signal.
854 </p><a NAME="RefactoringServer.projectOpened" ID="RefactoringServer.projectOpened"></a> 1141 </p>
1142 <a NAME="RefactoringServer.projectOpened" ID="RefactoringServer.projectOpened"></a>
855 <h4>RefactoringServer.projectOpened</h4> 1143 <h4>RefactoringServer.projectOpened</h4>
856 <b>projectOpened</b>(<i></i>) 1144 <b>projectOpened</b>(<i></i>)
1145
857 <p> 1146 <p>
858 Public slot to handle the projectOpened signal. 1147 Public slot to handle the projectOpened signal.
859 </p><a NAME="RefactoringServer.refreshEditors" ID="RefactoringServer.refreshEditors"></a> 1148 </p>
1149 <a NAME="RefactoringServer.refreshEditors" ID="RefactoringServer.refreshEditors"></a>
860 <h4>RefactoringServer.refreshEditors</h4> 1150 <h4>RefactoringServer.refreshEditors</h4>
861 <b>refreshEditors</b>(<i>changedFiles</i>) 1151 <b>refreshEditors</b>(<i>changedFiles</i>)
1152
862 <p> 1153 <p>
863 Public method to refresh modified editors. 1154 Public method to refresh modified editors.
864 </p><dl> 1155 </p>
1156 <dl>
1157
865 <dt><i>changedFiles</i> (list of str)</dt> 1158 <dt><i>changedFiles</i> (list of str)</dt>
866 <dd> 1159 <dd>
867 list of changed files 1160 list of changed files
868 </dd> 1161 </dd>
869 </dl><a NAME="RefactoringServer.reportChanged" ID="RefactoringServer.reportChanged"></a> 1162 </dl>
1163 <a NAME="RefactoringServer.reportChanged" ID="RefactoringServer.reportChanged"></a>
870 <h4>RefactoringServer.reportChanged</h4> 1164 <h4>RefactoringServer.reportChanged</h4>
871 <b>reportChanged</b>(<i>filename, oldSource</i>) 1165 <b>reportChanged</b>(<i>filename, oldSource</i>)
1166
872 <p> 1167 <p>
873 Public slot to report some changed sources. 1168 Public slot to report some changed sources.
874 </p><dl> 1169 </p>
1170 <dl>
1171
875 <dt><i>filename</i> (str)</dt> 1172 <dt><i>filename</i> (str)</dt>
876 <dd> 1173 <dd>
877 file name of the changed source 1174 file name of the changed source
878 </dd><dt><i>oldSource</i> (str)</dt> 1175 </dd>
1176 <dt><i>oldSource</i> (str)</dt>
879 <dd> 1177 <dd>
880 source code before the change 1178 source code before the change
881 </dd> 1179 </dd>
882 </dl> 1180 </dl>
883 <div align="right"><a href="#top">Up</a></div> 1181 <div align="right"><a href="#top">Up</a></div>

Mercurial Repository: Rope Refactoring

eric ide

mercurial