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
- branch
- server_client_variant
- changeset 204
- b4bf79b956bc
- child 214
- ccc3918ac38c
equal
deleted
inserted
replaced
| 203:c38750e1bafd | 204:b4bf79b956bc |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>Plugin_Refactoring_Rope.RefactoringRope.RefactoringServer</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <style> | |
| 6 body { | |
| 7 background: #EDECE6; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #85774A; } | |
| 13 h2 { color: white; background: #85774A; } | |
| 14 h3 { color: white; background: #9D936E; } | |
| 15 h4 { color: white; background: #9D936E; } | |
| 16 | |
| 17 a { color: #BA6D36; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | |
| 21 <body><a NAME="top" ID="top"></a> | |
| 22 <h1>Plugin_Refactoring_Rope.RefactoringRope.RefactoringServer</h1> | |
| 23 <p> | |
| 24 Module implementing the refactoring interface to rope. | |
| 25 </p> | |
| 26 <h3>Global Attributes</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <h3>Classes</h3> | |
| 31 <table> | |
| 32 <tr> | |
| 33 <td><a href="#RefactoringServer">RefactoringServer</a></td> | |
| 34 <td>Class implementing the refactoring interface to rope.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <h3>Functions</h3> | |
| 38 <table> | |
| 39 <tr><td>None</td></tr> | |
| 40 </table> | |
| 41 <hr /><hr /> | |
| 42 <a NAME="RefactoringServer" ID="RefactoringServer"></a> | |
| 43 <h2>RefactoringServer</h2> | |
| 44 <p> | |
| 45 Class implementing the refactoring interface to rope. | |
| 46 </p> | |
| 47 <h3>Derived from</h3> | |
| 48 JsonServer | |
| 49 <h3>Class Attributes</h3> | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Class Methods</h3> | |
| 54 <table> | |
| 55 <tr><td>None</td></tr> | |
| 56 </table> | |
| 57 <h3>Methods</h3> | |
| 58 <table> | |
| 59 <tr> | |
| 60 <td><a href="#RefactoringServer.__init__">RefactoringServer</a></td> | |
| 61 <td>Constructor</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#RefactoringServer.__changeOccurrences">__changeOccurrences</a></td> | |
| 64 <td>Private slot to perform the Change Occurrences refactoring.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#RefactoringServer.__changeSignature">__changeSignature</a></td> | |
| 67 <td>Private slot to change the signature of a method or function.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#RefactoringServer.__clearHistory">__clearHistory</a></td> | |
| 70 <td>Private slot to clear the redo and undo lists.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#RefactoringServer.__configChanged">__configChanged</a></td> | |
| 73 <td>Private slot called, when the rope config file has changed.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#RefactoringServer.__convertLocalToAttribute">__convertLocalToAttribute</a></td> | |
| 76 <td>Private slot to convert a local variable to an attribute.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#RefactoringServer.__defaultConfig">__defaultConfig</a></td> | |
| 79 <td>Private slot to return the contents of rope's default configuration.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#RefactoringServer.__doExtract">__doExtract</a></td> | |
| 82 <td>Private method to perform the extract refactoring.</td> | |
| 83 </tr><tr> | |
| 84 <td><a href="#RefactoringServer.__doImports">__doImports</a></td> | |
| 85 <td>Private method to perform the various imports refactorings.</td> | |
| 86 </tr><tr> | |
| 87 <td><a href="#RefactoringServer.__doRename">__doRename</a></td> | |
| 88 <td>Private method to perform the various renaming refactorings.</td> | |
| 89 </tr><tr> | |
| 90 <td><a href="#RefactoringServer.__editConfig">__editConfig</a></td> | |
| 91 <td>Private slot to open the rope configuration file in an editor.</td> | |
| 92 </tr><tr> | |
| 93 <td><a href="#RefactoringServer.__encapsulateAttribute">__encapsulateAttribute</a></td> | |
| 94 <td>Private slot to encapsulate an attribute.</td> | |
| 95 </tr><tr> | |
| 96 <td><a href="#RefactoringServer.__extractLocalVariable">__extractLocalVariable</a></td> | |
| 97 <td>Private slot to handle the Extract Local Variable action.</td> | |
| 98 </tr><tr> | |
| 99 <td><a href="#RefactoringServer.__extractMethod">__extractMethod</a></td> | |
| 100 <td>Private slot to handle the Extract Method action.</td> | |
| 101 </tr><tr> | |
| 102 <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> | |
| 104 </tr><tr> | |
| 105 <td><a href="#RefactoringServer.__historyDialogClosed">__historyDialogClosed</a></td> | |
| 106 <td>Private slot handling the closing of the history dialog.</td> | |
| 107 </tr><tr> | |
| 108 <td><a href="#RefactoringServer.__importsExpandStar">__importsExpandStar</a></td> | |
| 109 <td>Private slot to expand star imports.</td> | |
| 110 </tr><tr> | |
| 111 <td><a href="#RefactoringServer.__importsFromToImport">__importsFromToImport</a></td> | |
| 112 <td>Private slot to transform from imports to plain imports.</td> | |
| 113 </tr><tr> | |
| 114 <td><a href="#RefactoringServer.__importsHandleLong">__importsHandleLong</a></td> | |
| 115 <td>Private slot to handle long imports.</td> | |
| 116 </tr><tr> | |
| 117 <td><a href="#RefactoringServer.__importsOrganize">__importsOrganize</a></td> | |
| 118 <td>Private slot to organize imports.</td> | |
| 119 </tr><tr> | |
| 120 <td><a href="#RefactoringServer.__importsRelativeToAbsolute">__importsRelativeToAbsolute</a></td> | |
| 121 <td>Private slot to transform relative to absolute imports.</td> | |
| 122 </tr><tr> | |
| 123 <td><a href="#RefactoringServer.__initActions">__initActions</a></td> | |
| 124 <td>Private method to define the refactoring actions.</td> | |
| 125 </tr><tr> | |
| 126 <td><a href="#RefactoringServer.__initMenu">__initMenu</a></td> | |
| 127 <td>Private slot to initialize the refactoring menu.</td> | |
| 128 </tr><tr> | |
| 129 <td><a href="#RefactoringServer.__inline">__inline</a></td> | |
| 130 <td>Private slot to handle the Inline Local Variable action.</td> | |
| 131 </tr><tr> | |
| 132 <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> | |
| 134 </tr><tr> | |
| 135 <td><a href="#RefactoringServer.__introduceFactoryMethod">__introduceFactoryMethod</a></td> | |
| 136 <td>Private slot to introduce a factory method or global function.</td> | |
| 137 </tr><tr> | |
| 138 <td><a href="#RefactoringServer.__introduceParameter">__introduceParameter</a></td> | |
| 139 <td>Private slot to introduce a parameter in a function.</td> | |
| 140 </tr><tr> | |
| 141 <td><a href="#RefactoringServer.__methodToMethodObject">__methodToMethodObject</a></td> | |
| 142 <td>Private slot to change the signature of a method or function.</td> | |
| 143 </tr><tr> | |
| 144 <td><a href="#RefactoringServer.__move">__move</a></td> | |
| 145 <td>Private slot to handle the Move Method action.</td> | |
| 146 </tr><tr> | |
| 147 <td><a href="#RefactoringServer.__performSOA">__performSOA</a></td> | |
| 148 <td>Private slot to perform SOA on all modules.</td> | |
| 149 </tr><tr> | |
| 150 <td><a href="#RefactoringServer.__processChanges">__processChanges</a></td> | |
| 151 <td>Private method to process the changes data sent by the refactoring client.</td> | |
| 152 </tr><tr> | |
| 153 <td><a href="#RefactoringServer.__processClientException">__processClientException</a></td> | |
| 154 <td>Private method to handle exceptions of the refactoring client.</td> | |
| 155 </tr><tr> | |
| 156 <td><a href="#RefactoringServer.__processHistoryResult">__processHistoryResult</a></td> | |
| 157 <td>Private method to process the history data sent by the refactoring client.</td> | |
| 158 </tr><tr> | |
| 159 <td><a href="#RefactoringServer.__processProgress">__processProgress</a></td> | |
| 160 <td>Private method to handle Progress commands.</td> | |
| 161 </tr><tr> | |
| 162 <td><a href="#RefactoringServer.__queryDefinition">__queryDefinition</a></td> | |
| 163 <td>Private slot to handle the Find Definition action.</td> | |
| 164 </tr><tr> | |
| 165 <td><a href="#RefactoringServer.__queryDefinitionResult">__queryDefinitionResult</a></td> | |
| 166 <td>Private method to handle the "Query Definition" result sent by the client.</td> | |
| 167 </tr><tr> | |
| 168 <td><a href="#RefactoringServer.__queryImplementations">__queryImplementations</a></td> | |
| 169 <td>Private slot to handle the Find Implementations action.</td> | |
| 170 </tr><tr> | |
| 171 <td><a href="#RefactoringServer.__queryImplementationsResult">__queryImplementationsResult</a></td> | |
| 172 <td>Private method to handle the "Query Implementations" result sent by the client.</td> | |
| 173 </tr><tr> | |
| 174 <td><a href="#RefactoringServer.__queryReferences">__queryReferences</a></td> | |
| 175 <td>Private slot to handle the Find References action.</td> | |
| 176 </tr><tr> | |
| 177 <td><a href="#RefactoringServer.__queryReferencesResult">__queryReferencesResult</a></td> | |
| 178 <td>Private method to handle the "Query References" result sent by the client.</td> | |
| 179 </tr><tr> | |
| 180 <td><a href="#RefactoringServer.__refactoringDialogClosed">__refactoringDialogClosed</a></td> | |
| 181 <td>Private slot handling the closing of a refactoring dialog.</td> | |
| 182 </tr><tr> | |
| 183 <td><a href="#RefactoringServer.__rename">__rename</a></td> | |
| 184 <td>Private slot to handle the Rename action.</td> | |
| 185 </tr><tr> | |
| 186 <td><a href="#RefactoringServer.__renameLocal">__renameLocal</a></td> | |
| 187 <td>Private slot to handle the Local Rename action.</td> | |
| 188 </tr><tr> | |
| 189 <td><a href="#RefactoringServer.__renameModule">__renameModule</a></td> | |
| 190 <td>Private slot to handle the Rename Current Module action.</td> | |
| 191 </tr><tr> | |
| 192 <td><a href="#RefactoringServer.__restructure">__restructure</a></td> | |
| 193 <td>Private slot to restructure code.</td> | |
| 194 </tr><tr> | |
| 195 <td><a href="#RefactoringServer.__ropeConfigFile">__ropeConfigFile</a></td> | |
| 196 <td>Private method to get the name of the rope configuration file.</td> | |
| 197 </tr><tr> | |
| 198 <td><a href="#RefactoringServer.__ropeInfo">__ropeInfo</a></td> | |
| 199 <td>Private slot to show some info about rope.</td> | |
| 200 </tr><tr> | |
| 201 <td><a href="#RefactoringServer.__setConfig">__setConfig</a></td> | |
| 202 <td>Private method to set the rope client configuration data.</td> | |
| 203 </tr><tr> | |
| 204 <td><a href="#RefactoringServer.__showFileHistory">__showFileHistory</a></td> | |
| 205 <td>Private method to show the refactoring history of the current file.</td> | |
| 206 </tr><tr> | |
| 207 <td><a href="#RefactoringServer.__showProjectHistory">__showProjectHistory</a></td> | |
| 208 <td>Private method to show the project refactoring history.</td> | |
| 209 </tr><tr> | |
| 210 <td><a href="#RefactoringServer.__showRefactoringHistoryMenu">__showRefactoringHistoryMenu</a></td> | |
| 211 <td>Private slot called before the refactoring history menu is shown.</td> | |
| 212 </tr><tr> | |
| 213 <td><a href="#RefactoringServer.__showRopeHelp">__showRopeHelp</a></td> | |
| 214 <td>Private slot to show help about the refactorings offered by Rope.</td> | |
| 215 </tr><tr> | |
| 216 <td><a href="#RefactoringServer.__soaFinished">__soaFinished</a></td> | |
| 217 <td>Private method to handle the "Soa Finished" result sent by the client.</td> | |
| 218 </tr><tr> | |
| 219 <td><a href="#RefactoringServer.__startRefactoringClient">__startRefactoringClient</a></td> | |
| 220 <td>Private method to start the refactoring client.</td> | |
| 221 </tr><tr> | |
| 222 <td><a href="#RefactoringServer.__transformModuleToPackage">__transformModuleToPackage</a></td> | |
| 223 <td>Private slot to transform a module to a package.</td> | |
| 224 </tr><tr> | |
| 225 <td><a href="#RefactoringServer.__updateConfig">__updateConfig</a></td> | |
| 226 <td>Private slot to update the configuration file.</td> | |
| 227 </tr><tr> | |
| 228 <td><a href="#RefactoringServer.__useFunction">__useFunction</a></td> | |
| 229 <td>Private slot to use a function wherever possible.</td> | |
| 230 </tr><tr> | |
| 231 <td><a href="#RefactoringServer.activate">activate</a></td> | |
| 232 <td>Public method to activate the refactoring server.</td> | |
| 233 </tr><tr> | |
| 234 <td><a href="#RefactoringServer.confirmAllBuffersSaved">confirmAllBuffersSaved</a></td> | |
| 235 <td>Public method to check, if any editor has unsaved changes.</td> | |
| 236 </tr><tr> | |
| 237 <td><a href="#RefactoringServer.confirmBufferIsSaved">confirmBufferIsSaved</a></td> | |
| 238 <td>Public method to check, if an editor has unsaved changes.</td> | |
| 239 </tr><tr> | |
| 240 <td><a href="#RefactoringServer.deactivate">deactivate</a></td> | |
| 241 <td>Public method to deactivate the refactoring server.</td> | |
| 242 </tr><tr> | |
| 243 <td><a href="#RefactoringServer.getActions">getActions</a></td> | |
| 244 <td>Public method to get a list of all actions.</td> | |
| 245 </tr><tr> | |
| 246 <td><a href="#RefactoringServer.getMainWindow">getMainWindow</a></td> | |
| 247 <td>Public method to get a reference to the IDE main window.</td> | |
| 248 </tr><tr> | |
| 249 <td><a href="#RefactoringServer.gotoDefinition">gotoDefinition</a></td> | |
| 250 <td>Public slot to find the definition for the word at the cursor position and go to it.</td> | |
| 251 </tr><tr> | |
| 252 <td><a href="#RefactoringServer.handleCall">handleCall</a></td> | |
| 253 <td>Public method to handle a method call from the client.</td> | |
| 254 </tr><tr> | |
| 255 <td><a href="#RefactoringServer.handleNewConnection">handleNewConnection</a></td> | |
| 256 <td>Public slot for new incoming connections from a client.</td> | |
| 257 </tr><tr> | |
| 258 <td><a href="#RefactoringServer.handleRopeError">handleRopeError</a></td> | |
| 259 <td>Public method to handle a rope error.</td> | |
| 260 </tr><tr> | |
| 261 <td><a href="#RefactoringServer.projectClosed">projectClosed</a></td> | |
| 262 <td>Public slot to handle the projectClosed signal.</td> | |
| 263 </tr><tr> | |
| 264 <td><a href="#RefactoringServer.projectOpened">projectOpened</a></td> | |
| 265 <td>Public slot to handle the projectOpened signal.</td> | |
| 266 </tr><tr> | |
| 267 <td><a href="#RefactoringServer.refreshEditors">refreshEditors</a></td> | |
| 268 <td>Public method to refresh modified editors.</td> | |
| 269 </tr><tr> | |
| 270 <td><a href="#RefactoringServer.reportChanged">reportChanged</a></td> | |
| 271 <td>Public slot to report some changed sources.</td> | |
| 272 </tr> | |
| 273 </table> | |
| 274 <h3>Static Methods</h3> | |
| 275 <table> | |
| 276 <tr><td>None</td></tr> | |
| 277 </table> | |
| 278 <a NAME="RefactoringServer.__init__" ID="RefactoringServer.__init__"></a> | |
| 279 <h4>RefactoringServer (Constructor)</h4> | |
| 280 <b>RefactoringServer</b>(<i>plugin, parent=None</i>) | |
| 281 <p> | |
| 282 Constructor | |
| 283 </p><dl> | |
| 284 <dt><i>plugin</i> (RefactoringRopePlugin)</dt> | |
| 285 <dd> | |
| 286 reference to the plugin object | |
| 287 </dd><dt><i>parent</i> (QObject)</dt> | |
| 288 <dd> | |
| 289 parent | |
| 290 </dd> | |
| 291 </dl><a NAME="RefactoringServer.__changeOccurrences" ID="RefactoringServer.__changeOccurrences"></a> | |
| 292 <h4>RefactoringServer.__changeOccurrences</h4> | |
| 293 <b>__changeOccurrences</b>(<i></i>) | |
| 294 <p> | |
| 295 Private slot to perform the Change Occurrences refactoring. | |
| 296 </p><a NAME="RefactoringServer.__changeSignature" ID="RefactoringServer.__changeSignature"></a> | |
| 297 <h4>RefactoringServer.__changeSignature</h4> | |
| 298 <b>__changeSignature</b>(<i></i>) | |
| 299 <p> | |
| 300 Private slot to change the signature of a method or function. | |
| 301 </p><a NAME="RefactoringServer.__clearHistory" ID="RefactoringServer.__clearHistory"></a> | |
| 302 <h4>RefactoringServer.__clearHistory</h4> | |
| 303 <b>__clearHistory</b>(<i></i>) | |
| 304 <p> | |
| 305 Private slot to clear the redo and undo lists. | |
| 306 </p><a NAME="RefactoringServer.__configChanged" ID="RefactoringServer.__configChanged"></a> | |
| 307 <h4>RefactoringServer.__configChanged</h4> | |
| 308 <b>__configChanged</b>(<i></i>) | |
| 309 <p> | |
| 310 Private slot called, when the rope config file has changed. | |
| 311 </p><a NAME="RefactoringServer.__convertLocalToAttribute" ID="RefactoringServer.__convertLocalToAttribute"></a> | |
| 312 <h4>RefactoringServer.__convertLocalToAttribute</h4> | |
| 313 <b>__convertLocalToAttribute</b>(<i></i>) | |
| 314 <p> | |
| 315 Private slot to convert a local variable to an attribute. | |
| 316 </p><a NAME="RefactoringServer.__defaultConfig" ID="RefactoringServer.__defaultConfig"></a> | |
| 317 <h4>RefactoringServer.__defaultConfig</h4> | |
| 318 <b>__defaultConfig</b>(<i></i>) | |
| 319 <p> | |
| 320 Private slot to return the contents of rope's default configuration. | |
| 321 </p><dl> | |
| 322 <dt>Returns:</dt> | |
| 323 <dd> | |
| 324 string containing the source of rope's default | |
| 325 configuration | |
| 326 </dd> | |
| 327 </dl><dl> | |
| 328 <dt>Return Type:</dt> | |
| 329 <dd> | |
| 330 str | |
| 331 </dd> | |
| 332 </dl><a NAME="RefactoringServer.__doExtract" ID="RefactoringServer.__doExtract"></a> | |
| 333 <h4>RefactoringServer.__doExtract</h4> | |
| 334 <b>__doExtract</b>(<i>title, kind</i>) | |
| 335 <p> | |
| 336 Private method to perform the extract refactoring. | |
| 337 </p><dl> | |
| 338 <dt><i>title</i> (str)</dt> | |
| 339 <dd> | |
| 340 title of the refactoring | |
| 341 </dd><dt><i>kind</i> (str ("method" or "variable"))</dt> | |
| 342 <dd> | |
| 343 kind of extraction to be done | |
| 344 </dd> | |
| 345 </dl><a NAME="RefactoringServer.__doImports" ID="RefactoringServer.__doImports"></a> | |
| 346 <h4>RefactoringServer.__doImports</h4> | |
| 347 <b>__doImports</b>(<i>title, methodName</i>) | |
| 348 <p> | |
| 349 Private method to perform the various imports refactorings. | |
| 350 </p><dl> | |
| 351 <dt><i>title</i> (str)</dt> | |
| 352 <dd> | |
| 353 title to be used for the import refactoring | |
| 354 </dd><dt><i>methodName</i> (str)</dt> | |
| 355 <dd> | |
| 356 name of the method performing the import refactoring | |
| 357 </dd> | |
| 358 </dl><a NAME="RefactoringServer.__doRename" ID="RefactoringServer.__doRename"></a> | |
| 359 <h4>RefactoringServer.__doRename</h4> | |
| 360 <b>__doRename</b>(<i>title, isLocal=False, renameModule=False</i>) | |
| 361 <p> | |
| 362 Private method to perform the various renaming refactorings. | |
| 363 </p><dl> | |
| 364 <dt><i>title</i> (str)</dt> | |
| 365 <dd> | |
| 366 title of the refactoring | |
| 367 </dd><dt><i>isLocal</i> (bool)</dt> | |
| 368 <dd> | |
| 369 flag indicating to restrict refactoring to | |
| 370 the local file | |
| 371 </dd><dt><i>renameModule</i> (bool)</dt> | |
| 372 <dd> | |
| 373 flag indicating a module rename refactoring | |
| 374 </dd> | |
| 375 </dl><a NAME="RefactoringServer.__editConfig" ID="RefactoringServer.__editConfig"></a> | |
| 376 <h4>RefactoringServer.__editConfig</h4> | |
| 377 <b>__editConfig</b>(<i></i>) | |
| 378 <p> | |
| 379 Private slot to open the rope configuration file in an editor. | |
| 380 </p><a NAME="RefactoringServer.__encapsulateAttribute" ID="RefactoringServer.__encapsulateAttribute"></a> | |
| 381 <h4>RefactoringServer.__encapsulateAttribute</h4> | |
| 382 <b>__encapsulateAttribute</b>(<i></i>) | |
| 383 <p> | |
| 384 Private slot to encapsulate an attribute. | |
| 385 </p><a NAME="RefactoringServer.__extractLocalVariable" ID="RefactoringServer.__extractLocalVariable"></a> | |
| 386 <h4>RefactoringServer.__extractLocalVariable</h4> | |
| 387 <b>__extractLocalVariable</b>(<i></i>) | |
| 388 <p> | |
| 389 Private slot to handle the Extract Local Variable action. | |
| 390 </p><a NAME="RefactoringServer.__extractMethod" ID="RefactoringServer.__extractMethod"></a> | |
| 391 <h4>RefactoringServer.__extractMethod</h4> | |
| 392 <b>__extractMethod</b>(<i></i>) | |
| 393 <p> | |
| 394 Private slot to handle the Extract Method action. | |
| 395 </p><a NAME="RefactoringServer.__getOffset" ID="RefactoringServer.__getOffset"></a> | |
| 396 <h4>RefactoringServer.__getOffset</h4> | |
| 397 <b>__getOffset</b>(<i>editor, line, index</i>) | |
| 398 <p> | |
| 399 Private method to get the offset into the text treating CRLF as ONE | |
| 400 character. | |
| 401 </p><p> | |
| 402 Note: rope seems to convert all EOL styles to just \n. | |
| 403 </p><dl> | |
| 404 <dt><i>editor</i> (QScintilla.Editor)</dt> | |
| 405 <dd> | |
| 406 reference to the editor | |
| 407 </dd><dt><i>line</i> (int)</dt> | |
| 408 <dd> | |
| 409 line for the offset | |
| 410 </dd><dt><i>index</i> (int)</dt> | |
| 411 <dd> | |
| 412 index into line for the offset | |
| 413 </dd> | |
| 414 </dl><dl> | |
| 415 <dt>Returns:</dt> | |
| 416 <dd> | |
| 417 rope compliant offset into the file | |
| 418 </dd> | |
| 419 </dl><dl> | |
| 420 <dt>Return Type:</dt> | |
| 421 <dd> | |
| 422 int | |
| 423 </dd> | |
| 424 </dl><a NAME="RefactoringServer.__historyDialogClosed" ID="RefactoringServer.__historyDialogClosed"></a> | |
| 425 <h4>RefactoringServer.__historyDialogClosed</h4> | |
| 426 <b>__historyDialogClosed</b>(<i></i>) | |
| 427 <p> | |
| 428 Private slot handling the closing of the history dialog. | |
| 429 </p><a NAME="RefactoringServer.__importsExpandStar" ID="RefactoringServer.__importsExpandStar"></a> | |
| 430 <h4>RefactoringServer.__importsExpandStar</h4> | |
| 431 <b>__importsExpandStar</b>(<i></i>) | |
| 432 <p> | |
| 433 Private slot to expand star imports. | |
| 434 </p><a NAME="RefactoringServer.__importsFromToImport" ID="RefactoringServer.__importsFromToImport"></a> | |
| 435 <h4>RefactoringServer.__importsFromToImport</h4> | |
| 436 <b>__importsFromToImport</b>(<i></i>) | |
| 437 <p> | |
| 438 Private slot to transform from imports to plain imports. | |
| 439 </p><a NAME="RefactoringServer.__importsHandleLong" ID="RefactoringServer.__importsHandleLong"></a> | |
| 440 <h4>RefactoringServer.__importsHandleLong</h4> | |
| 441 <b>__importsHandleLong</b>(<i></i>) | |
| 442 <p> | |
| 443 Private slot to handle long imports. | |
| 444 </p><a NAME="RefactoringServer.__importsOrganize" ID="RefactoringServer.__importsOrganize"></a> | |
| 445 <h4>RefactoringServer.__importsOrganize</h4> | |
| 446 <b>__importsOrganize</b>(<i></i>) | |
| 447 <p> | |
| 448 Private slot to organize imports. | |
| 449 </p><a NAME="RefactoringServer.__importsRelativeToAbsolute" ID="RefactoringServer.__importsRelativeToAbsolute"></a> | |
| 450 <h4>RefactoringServer.__importsRelativeToAbsolute</h4> | |
| 451 <b>__importsRelativeToAbsolute</b>(<i></i>) | |
| 452 <p> | |
| 453 Private slot to transform relative to absolute imports. | |
| 454 </p><a NAME="RefactoringServer.__initActions" ID="RefactoringServer.__initActions"></a> | |
| 455 <h4>RefactoringServer.__initActions</h4> | |
| 456 <b>__initActions</b>(<i></i>) | |
| 457 <p> | |
| 458 Private method to define the refactoring actions. | |
| 459 </p><a NAME="RefactoringServer.__initMenu" ID="RefactoringServer.__initMenu"></a> | |
| 460 <h4>RefactoringServer.__initMenu</h4> | |
| 461 <b>__initMenu</b>(<i></i>) | |
| 462 <p> | |
| 463 Private slot to initialize the refactoring menu. | |
| 464 </p><dl> | |
| 465 <dt>Returns:</dt> | |
| 466 <dd> | |
| 467 the menu generated | |
| 468 </dd> | |
| 469 </dl><dl> | |
| 470 <dt>Return Type:</dt> | |
| 471 <dd> | |
| 472 QMenu | |
| 473 </dd> | |
| 474 </dl><a NAME="RefactoringServer.__inline" ID="RefactoringServer.__inline"></a> | |
| 475 <h4>RefactoringServer.__inline</h4> | |
| 476 <b>__inline</b>(<i></i>) | |
| 477 <p> | |
| 478 Private slot to handle the Inline Local Variable action. | |
| 479 </p><a NAME="RefactoringServer.__inlineArgumentDefault" ID="RefactoringServer.__inlineArgumentDefault"></a> | |
| 480 <h4>RefactoringServer.__inlineArgumentDefault</h4> | |
| 481 <b>__inlineArgumentDefault</b>(<i></i>) | |
| 482 <p> | |
| 483 Private slot to inline the default value of a parameter of a | |
| 484 method or function. | |
| 485 </p><a NAME="RefactoringServer.__introduceFactoryMethod" ID="RefactoringServer.__introduceFactoryMethod"></a> | |
| 486 <h4>RefactoringServer.__introduceFactoryMethod</h4> | |
| 487 <b>__introduceFactoryMethod</b>(<i></i>) | |
| 488 <p> | |
| 489 Private slot to introduce a factory method or global function. | |
| 490 </p><a NAME="RefactoringServer.__introduceParameter" ID="RefactoringServer.__introduceParameter"></a> | |
| 491 <h4>RefactoringServer.__introduceParameter</h4> | |
| 492 <b>__introduceParameter</b>(<i></i>) | |
| 493 <p> | |
| 494 Private slot to introduce a parameter in a function. | |
| 495 </p><a NAME="RefactoringServer.__methodToMethodObject" ID="RefactoringServer.__methodToMethodObject"></a> | |
| 496 <h4>RefactoringServer.__methodToMethodObject</h4> | |
| 497 <b>__methodToMethodObject</b>(<i></i>) | |
| 498 <p> | |
| 499 Private slot to change the signature of a method or function. | |
| 500 </p><a NAME="RefactoringServer.__move" ID="RefactoringServer.__move"></a> | |
| 501 <h4>RefactoringServer.__move</h4> | |
| 502 <b>__move</b>(<i>moveKind</i>) | |
| 503 <p> | |
| 504 Private slot to handle the Move Method action. | |
| 505 </p><dl> | |
| 506 <dt><i>moveKind</i> (str (one of 'move_method' or 'move_module'))</dt> | |
| 507 <dd> | |
| 508 kind of move to be performed | |
| 509 </dd> | |
| 510 </dl><a NAME="RefactoringServer.__performSOA" ID="RefactoringServer.__performSOA"></a> | |
| 511 <h4>RefactoringServer.__performSOA</h4> | |
| 512 <b>__performSOA</b>(<i></i>) | |
| 513 <p> | |
| 514 Private slot to perform SOA on all modules. | |
| 515 </p><a NAME="RefactoringServer.__processChanges" ID="RefactoringServer.__processChanges"></a> | |
| 516 <h4>RefactoringServer.__processChanges</h4> | |
| 517 <b>__processChanges</b>(<i>result</i>) | |
| 518 <p> | |
| 519 Private method to process the changes data sent by the refactoring | |
| 520 client. | |
| 521 </p><dl> | |
| 522 <dt><i>result</i> (dict)</dt> | |
| 523 <dd> | |
| 524 dictionary containing the changes data | |
| 525 </dd> | |
| 526 </dl><a NAME="RefactoringServer.__processClientException" ID="RefactoringServer.__processClientException"></a> | |
| 527 <h4>RefactoringServer.__processClientException</h4> | |
| 528 <b>__processClientException</b>(<i>params</i>) | |
| 529 <p> | |
| 530 Private method to handle exceptions of the refactoring client. | |
| 531 </p><dl> | |
| 532 <dt><i>params</i> (dict)</dt> | |
| 533 <dd> | |
| 534 dictionary containing the exception data | |
| 535 </dd> | |
| 536 </dl><a NAME="RefactoringServer.__processHistoryResult" ID="RefactoringServer.__processHistoryResult"></a> | |
| 537 <h4>RefactoringServer.__processHistoryResult</h4> | |
| 538 <b>__processHistoryResult</b>(<i>result</i>) | |
| 539 <p> | |
| 540 Private method to process the history data sent by the refactoring | |
| 541 client. | |
| 542 </p><dl> | |
| 543 <dt><i>result</i> (dict)</dt> | |
| 544 <dd> | |
| 545 dictionary containing the history data | |
| 546 </dd> | |
| 547 </dl><a NAME="RefactoringServer.__processProgress" ID="RefactoringServer.__processProgress"></a> | |
| 548 <h4>RefactoringServer.__processProgress</h4> | |
| 549 <b>__processProgress</b>(<i>params</i>) | |
| 550 <p> | |
| 551 Private method to handle Progress commands. | |
| 552 </p><dl> | |
| 553 <dt><i>params</i> (dict)</dt> | |
| 554 <dd> | |
| 555 dictionary containing the progress data | |
| 556 </dd> | |
| 557 </dl><a NAME="RefactoringServer.__queryDefinition" ID="RefactoringServer.__queryDefinition"></a> | |
| 558 <h4>RefactoringServer.__queryDefinition</h4> | |
| 559 <b>__queryDefinition</b>(<i></i>) | |
| 560 <p> | |
| 561 Private slot to handle the Find Definition action. | |
| 562 </p><a NAME="RefactoringServer.__queryDefinitionResult" ID="RefactoringServer.__queryDefinitionResult"></a> | |
| 563 <h4>RefactoringServer.__queryDefinitionResult</h4> | |
| 564 <b>__queryDefinitionResult</b>(<i>result</i>) | |
| 565 <p> | |
| 566 Private method to handle the "Query Definition" result sent by | |
| 567 the client. | |
| 568 </p><dl> | |
| 569 <dt><i>result</i> (dict)</dt> | |
| 570 <dd> | |
| 571 dictionary containing the result data | |
| 572 </dd> | |
| 573 </dl><a NAME="RefactoringServer.__queryImplementations" ID="RefactoringServer.__queryImplementations"></a> | |
| 574 <h4>RefactoringServer.__queryImplementations</h4> | |
| 575 <b>__queryImplementations</b>(<i></i>) | |
| 576 <p> | |
| 577 Private slot to handle the Find Implementations action. | |
| 578 </p><a NAME="RefactoringServer.__queryImplementationsResult" ID="RefactoringServer.__queryImplementationsResult"></a> | |
| 579 <h4>RefactoringServer.__queryImplementationsResult</h4> | |
| 580 <b>__queryImplementationsResult</b>(<i>result</i>) | |
| 581 <p> | |
| 582 Private method to handle the "Query Implementations" result sent by | |
| 583 the client. | |
| 584 </p><dl> | |
| 585 <dt><i>result</i> (dict)</dt> | |
| 586 <dd> | |
| 587 dictionary containing the result data | |
| 588 </dd> | |
| 589 </dl><a NAME="RefactoringServer.__queryReferences" ID="RefactoringServer.__queryReferences"></a> | |
| 590 <h4>RefactoringServer.__queryReferences</h4> | |
| 591 <b>__queryReferences</b>(<i></i>) | |
| 592 <p> | |
| 593 Private slot to handle the Find References action. | |
| 594 </p><a NAME="RefactoringServer.__queryReferencesResult" ID="RefactoringServer.__queryReferencesResult"></a> | |
| 595 <h4>RefactoringServer.__queryReferencesResult</h4> | |
| 596 <b>__queryReferencesResult</b>(<i>result</i>) | |
| 597 <p> | |
| 598 Private method to handle the "Query References" result sent by | |
| 599 the client. | |
| 600 </p><dl> | |
| 601 <dt><i>result</i> (dict)</dt> | |
| 602 <dd> | |
| 603 dictionary containing the result data | |
| 604 </dd> | |
| 605 </dl><a NAME="RefactoringServer.__refactoringDialogClosed" ID="RefactoringServer.__refactoringDialogClosed"></a> | |
| 606 <h4>RefactoringServer.__refactoringDialogClosed</h4> | |
| 607 <b>__refactoringDialogClosed</b>(<i>changeGroup</i>) | |
| 608 <p> | |
| 609 Private slot handling the closing of a refactoring dialog. | |
| 610 </p><dl> | |
| 611 <dt><i>changeGroup</i> (str)</dt> | |
| 612 <dd> | |
| 613 name of the refactoring change group the dialog | |
| 614 belonged to | |
| 615 </dd> | |
| 616 </dl><a NAME="RefactoringServer.__rename" ID="RefactoringServer.__rename"></a> | |
| 617 <h4>RefactoringServer.__rename</h4> | |
| 618 <b>__rename</b>(<i></i>) | |
| 619 <p> | |
| 620 Private slot to handle the Rename action. | |
| 621 </p><a NAME="RefactoringServer.__renameLocal" ID="RefactoringServer.__renameLocal"></a> | |
| 622 <h4>RefactoringServer.__renameLocal</h4> | |
| 623 <b>__renameLocal</b>(<i></i>) | |
| 624 <p> | |
| 625 Private slot to handle the Local Rename action. | |
| 626 </p><a NAME="RefactoringServer.__renameModule" ID="RefactoringServer.__renameModule"></a> | |
| 627 <h4>RefactoringServer.__renameModule</h4> | |
| 628 <b>__renameModule</b>(<i></i>) | |
| 629 <p> | |
| 630 Private slot to handle the Rename Current Module action. | |
| 631 </p><a NAME="RefactoringServer.__restructure" ID="RefactoringServer.__restructure"></a> | |
| 632 <h4>RefactoringServer.__restructure</h4> | |
| 633 <b>__restructure</b>(<i></i>) | |
| 634 <p> | |
| 635 Private slot to restructure code. | |
| 636 </p><a NAME="RefactoringServer.__ropeConfigFile" ID="RefactoringServer.__ropeConfigFile"></a> | |
| 637 <h4>RefactoringServer.__ropeConfigFile</h4> | |
| 638 <b>__ropeConfigFile</b>(<i></i>) | |
| 639 <p> | |
| 640 Private method to get the name of the rope configuration file. | |
| 641 </p><dl> | |
| 642 <dt>Returns:</dt> | |
| 643 <dd> | |
| 644 name of the rope configuration file | |
| 645 </dd> | |
| 646 </dl><dl> | |
| 647 <dt>Return Type:</dt> | |
| 648 <dd> | |
| 649 str | |
| 650 </dd> | |
| 651 </dl><a NAME="RefactoringServer.__ropeInfo" ID="RefactoringServer.__ropeInfo"></a> | |
| 652 <h4>RefactoringServer.__ropeInfo</h4> | |
| 653 <b>__ropeInfo</b>(<i></i>) | |
| 654 <p> | |
| 655 Private slot to show some info about rope. | |
| 656 </p><a NAME="RefactoringServer.__setConfig" ID="RefactoringServer.__setConfig"></a> | |
| 657 <h4>RefactoringServer.__setConfig</h4> | |
| 658 <b>__setConfig</b>(<i>params</i>) | |
| 659 <p> | |
| 660 Private method to set the rope client configuration data. | |
| 661 </p><dl> | |
| 662 <dt><i>params</i> (dict)</dt> | |
| 663 <dd> | |
| 664 dictionary containing the configuration data | |
| 665 </dd> | |
| 666 </dl><a NAME="RefactoringServer.__showFileHistory" ID="RefactoringServer.__showFileHistory"></a> | |
| 667 <h4>RefactoringServer.__showFileHistory</h4> | |
| 668 <b>__showFileHistory</b>(<i></i>) | |
| 669 <p> | |
| 670 Private method to show the refactoring history of the current file. | |
| 671 </p><a NAME="RefactoringServer.__showProjectHistory" ID="RefactoringServer.__showProjectHistory"></a> | |
| 672 <h4>RefactoringServer.__showProjectHistory</h4> | |
| 673 <b>__showProjectHistory</b>(<i></i>) | |
| 674 <p> | |
| 675 Private method to show the project refactoring history. | |
| 676 </p><a NAME="RefactoringServer.__showRefactoringHistoryMenu" ID="RefactoringServer.__showRefactoringHistoryMenu"></a> | |
| 677 <h4>RefactoringServer.__showRefactoringHistoryMenu</h4> | |
| 678 <b>__showRefactoringHistoryMenu</b>(<i></i>) | |
| 679 <p> | |
| 680 Private slot called before the refactoring history menu is shown. | |
| 681 </p><a NAME="RefactoringServer.__showRopeHelp" ID="RefactoringServer.__showRopeHelp"></a> | |
| 682 <h4>RefactoringServer.__showRopeHelp</h4> | |
| 683 <b>__showRopeHelp</b>(<i></i>) | |
| 684 <p> | |
| 685 Private slot to show help about the refactorings offered by Rope. | |
| 686 </p><a NAME="RefactoringServer.__soaFinished" ID="RefactoringServer.__soaFinished"></a> | |
| 687 <h4>RefactoringServer.__soaFinished</h4> | |
| 688 <b>__soaFinished</b>(<i>result</i>) | |
| 689 <p> | |
| 690 Private method to handle the "Soa Finished" result sent by | |
| 691 the client. | |
| 692 </p><dl> | |
| 693 <dt><i>result</i> (dict)</dt> | |
| 694 <dd> | |
| 695 dictionary containing the result data | |
| 696 </dd> | |
| 697 </dl><a NAME="RefactoringServer.__startRefactoringClient" ID="RefactoringServer.__startRefactoringClient"></a> | |
| 698 <h4>RefactoringServer.__startRefactoringClient</h4> | |
| 699 <b>__startRefactoringClient</b>(<i>interpreter</i>) | |
| 700 <p> | |
| 701 Private method to start the refactoring client. | |
| 702 </p><dl> | |
| 703 <dt><i>interpreter</i> (str)</dt> | |
| 704 <dd> | |
| 705 interpreter to be used for the refactoring client | |
| 706 </dd> | |
| 707 </dl><dl> | |
| 708 <dt>Returns:</dt> | |
| 709 <dd> | |
| 710 flag indicating a successful client start | |
| 711 </dd> | |
| 712 </dl><dl> | |
| 713 <dt>Return Type:</dt> | |
| 714 <dd> | |
| 715 bool | |
| 716 </dd> | |
| 717 </dl><a NAME="RefactoringServer.__transformModuleToPackage" ID="RefactoringServer.__transformModuleToPackage"></a> | |
| 718 <h4>RefactoringServer.__transformModuleToPackage</h4> | |
| 719 <b>__transformModuleToPackage</b>(<i></i>) | |
| 720 <p> | |
| 721 Private slot to transform a module to a package. | |
| 722 </p><a NAME="RefactoringServer.__updateConfig" ID="RefactoringServer.__updateConfig"></a> | |
| 723 <h4>RefactoringServer.__updateConfig</h4> | |
| 724 <b>__updateConfig</b>(<i></i>) | |
| 725 <p> | |
| 726 Private slot to update the configuration file. | |
| 727 </p><a NAME="RefactoringServer.__useFunction" ID="RefactoringServer.__useFunction"></a> | |
| 728 <h4>RefactoringServer.__useFunction</h4> | |
| 729 <b>__useFunction</b>(<i></i>) | |
| 730 <p> | |
| 731 Private slot to use a function wherever possible. | |
| 732 </p><a NAME="RefactoringServer.activate" ID="RefactoringServer.activate"></a> | |
| 733 <h4>RefactoringServer.activate</h4> | |
| 734 <b>activate</b>(<i></i>) | |
| 735 <p> | |
| 736 Public method to activate the refactoring server. | |
| 737 </p><p> | |
| 738 This is performed when the rope plug-in is activated. | |
| 739 </p><a NAME="RefactoringServer.confirmAllBuffersSaved" ID="RefactoringServer.confirmAllBuffersSaved"></a> | |
| 740 <h4>RefactoringServer.confirmAllBuffersSaved</h4> | |
| 741 <b>confirmAllBuffersSaved</b>(<i></i>) | |
| 742 <p> | |
| 743 Public method to check, if any editor has unsaved changes. | |
| 744 </p><dl> | |
| 745 <dt>Returns:</dt> | |
| 746 <dd> | |
| 747 flag indicating, that no editor contains unsaved edits | |
| 748 </dd> | |
| 749 </dl><dl> | |
| 750 <dt>Return Type:</dt> | |
| 751 <dd> | |
| 752 bool | |
| 753 </dd> | |
| 754 </dl><a NAME="RefactoringServer.confirmBufferIsSaved" ID="RefactoringServer.confirmBufferIsSaved"></a> | |
| 755 <h4>RefactoringServer.confirmBufferIsSaved</h4> | |
| 756 <b>confirmBufferIsSaved</b>(<i>editor</i>) | |
| 757 <p> | |
| 758 Public method to check, if an editor has unsaved changes. | |
| 759 </p><dl> | |
| 760 <dt><i>editor</i> (QScintilla.Editor)</dt> | |
| 761 <dd> | |
| 762 reference to the editor to be checked | |
| 763 </dd> | |
| 764 </dl><dl> | |
| 765 <dt>Returns:</dt> | |
| 766 <dd> | |
| 767 flag indicating, that the editor doesn't contain | |
| 768 unsaved edits | |
| 769 </dd> | |
| 770 </dl><dl> | |
| 771 <dt>Return Type:</dt> | |
| 772 <dd> | |
| 773 bool | |
| 774 </dd> | |
| 775 </dl><a NAME="RefactoringServer.deactivate" ID="RefactoringServer.deactivate"></a> | |
| 776 <h4>RefactoringServer.deactivate</h4> | |
| 777 <b>deactivate</b>(<i></i>) | |
| 778 <p> | |
| 779 Public method to deactivate the refactoring server. | |
| 780 </p><a NAME="RefactoringServer.getActions" ID="RefactoringServer.getActions"></a> | |
| 781 <h4>RefactoringServer.getActions</h4> | |
| 782 <b>getActions</b>(<i></i>) | |
| 783 <p> | |
| 784 Public method to get a list of all actions. | |
| 785 </p><dl> | |
| 786 <dt>Returns:</dt> | |
| 787 <dd> | |
| 788 list of all actions | |
| 789 </dd> | |
| 790 </dl><dl> | |
| 791 <dt>Return Type:</dt> | |
| 792 <dd> | |
| 793 list of E5Action | |
| 794 </dd> | |
| 795 </dl><a NAME="RefactoringServer.getMainWindow" ID="RefactoringServer.getMainWindow"></a> | |
| 796 <h4>RefactoringServer.getMainWindow</h4> | |
| 797 <b>getMainWindow</b>(<i></i>) | |
| 798 <p> | |
| 799 Public method to get a reference to the IDE main window. | |
| 800 </p><dl> | |
| 801 <dt>Returns:</dt> | |
| 802 <dd> | |
| 803 reference to the IDE main window | |
| 804 </dd> | |
| 805 </dl><dl> | |
| 806 <dt>Return Type:</dt> | |
| 807 <dd> | |
| 808 UserInterface | |
| 809 </dd> | |
| 810 </dl><a NAME="RefactoringServer.gotoDefinition" ID="RefactoringServer.gotoDefinition"></a> | |
| 811 <h4>RefactoringServer.gotoDefinition</h4> | |
| 812 <b>gotoDefinition</b>(<i>editor</i>) | |
| 813 <p> | |
| 814 Public slot to find the definition for the word at the cursor position | |
| 815 and go to it. | |
| 816 </p><p> | |
| 817 Note: This is executed upon a mouse click sequence. | |
| 818 </p><dl> | |
| 819 <dt><i>editor</i> (QScintilla.Editor)</dt> | |
| 820 <dd> | |
| 821 reference to the calling editor | |
| 822 </dd> | |
| 823 </dl><a NAME="RefactoringServer.handleCall" ID="RefactoringServer.handleCall"></a> | |
| 824 <h4>RefactoringServer.handleCall</h4> | |
| 825 <b>handleCall</b>(<i>method, params</i>) | |
| 826 <p> | |
| 827 Public method to handle a method call from the client. | |
| 828 </p><dl> | |
| 829 <dt><i>method</i> (str)</dt> | |
| 830 <dd> | |
| 831 requested method name | |
| 832 </dd><dt><i>params</i> (dict)</dt> | |
| 833 <dd> | |
| 834 dictionary with method specific parameters | |
| 835 </dd> | |
| 836 </dl><a NAME="RefactoringServer.handleNewConnection" ID="RefactoringServer.handleNewConnection"></a> | |
| 837 <h4>RefactoringServer.handleNewConnection</h4> | |
| 838 <b>handleNewConnection</b>(<i></i>) | |
| 839 <p> | |
| 840 Public slot for new incoming connections from a client. | |
| 841 </p><a NAME="RefactoringServer.handleRopeError" ID="RefactoringServer.handleRopeError"></a> | |
| 842 <h4>RefactoringServer.handleRopeError</h4> | |
| 843 <b>handleRopeError</b>(<i>result</i>) | |
| 844 <p> | |
| 845 Public method to handle a rope error. | |
| 846 </p><dl> | |
| 847 <dt><i>result</i> (dict)</dt> | |
| 848 <dd> | |
| 849 dictionary containing the error information | |
| 850 </dd> | |
| 851 </dl><dl> | |
| 852 <dt>Returns:</dt> | |
| 853 <dd> | |
| 854 flag indicating, that the error is to be ignored | |
| 855 </dd> | |
| 856 </dl><dl> | |
| 857 <dt>Return Type:</dt> | |
| 858 <dd> | |
| 859 bool | |
| 860 </dd> | |
| 861 </dl><a NAME="RefactoringServer.projectClosed" ID="RefactoringServer.projectClosed"></a> | |
| 862 <h4>RefactoringServer.projectClosed</h4> | |
| 863 <b>projectClosed</b>(<i></i>) | |
| 864 <p> | |
| 865 Public slot to handle the projectClosed signal. | |
| 866 </p><a NAME="RefactoringServer.projectOpened" ID="RefactoringServer.projectOpened"></a> | |
| 867 <h4>RefactoringServer.projectOpened</h4> | |
| 868 <b>projectOpened</b>(<i></i>) | |
| 869 <p> | |
| 870 Public slot to handle the projectOpened signal. | |
| 871 </p><a NAME="RefactoringServer.refreshEditors" ID="RefactoringServer.refreshEditors"></a> | |
| 872 <h4>RefactoringServer.refreshEditors</h4> | |
| 873 <b>refreshEditors</b>(<i>changedFiles</i>) | |
| 874 <p> | |
| 875 Public method to refresh modified editors. | |
| 876 </p><dl> | |
| 877 <dt><i>changedFiles</i> (list of str)</dt> | |
| 878 <dd> | |
| 879 list of changed files | |
| 880 </dd> | |
| 881 </dl><a NAME="RefactoringServer.reportChanged" ID="RefactoringServer.reportChanged"></a> | |
| 882 <h4>RefactoringServer.reportChanged</h4> | |
| 883 <b>reportChanged</b>(<i>filename, oldSource</i>) | |
| 884 <p> | |
| 885 Public slot to report some changed sources. | |
| 886 </p><dl> | |
| 887 <dt><i>filename</i> (str)</dt> | |
| 888 <dd> | |
| 889 file name of the changed source | |
| 890 </dd><dt><i>oldSource</i> (str)</dt> | |
| 891 <dd> | |
| 892 source code before the change | |
| 893 </dd> | |
| 894 </dl> | |
| 895 <div align="right"><a href="#top">Up</a></div> | |
| 896 <hr /> | |
| 897 </body></html> |
