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

changeset 295
8318a6881e63
parent 285
247d62c682dc
child 321
d51e810107ec
equal deleted inserted replaced
294:78e4a6823a98 295:8318a6881e63
70 <td>Private slot to clear the redo and undo lists.</td> 70 <td>Private slot to clear the redo and undo lists.</td>
71 </tr><tr> 71 </tr><tr>
72 <td><a href="#RefactoringServer.__configChanged">__configChanged</a></td> 72 <td><a href="#RefactoringServer.__configChanged">__configChanged</a></td>
73 <td>Private slot called, when the rope config file has changed.</td> 73 <td>Private slot called, when the rope config file has changed.</td>
74 </tr><tr> 74 </tr><tr>
75 <td><a href="#RefactoringServer.__connectMouseClickHandler">__connectMouseClickHandler</a></td>
76 <td>Private method to connect the mouse click handler to an editor.</td>
77 </tr><tr>
78 <td><a href="#RefactoringServer.__convertLocalToAttribute">__convertLocalToAttribute</a></td> 75 <td><a href="#RefactoringServer.__convertLocalToAttribute">__convertLocalToAttribute</a></td>
79 <td>Private slot to convert a local variable to an attribute.</td> 76 <td>Private slot to convert a local variable to an attribute.</td>
80 </tr><tr> 77 </tr><tr>
81 <td><a href="#RefactoringServer.__defaultConfig">__defaultConfig</a></td> 78 <td><a href="#RefactoringServer.__defaultConfig">__defaultConfig</a></td>
82 <td>Private slot to return the contents of rope's default configuration.</td> 79 <td>Private slot to return the contents of rope's default configuration.</td>
83 </tr><tr> 80 </tr><tr>
84 <td><a href="#RefactoringServer.__disconnectMouseClickHandler">__disconnectMouseClickHandler</a></td>
85 <td>Private method to disconnect the mouse click handler from an editor.</td>
86 </tr><tr>
87 <td><a href="#RefactoringServer.__doExtract">__doExtract</a></td> 81 <td><a href="#RefactoringServer.__doExtract">__doExtract</a></td>
88 <td>Private method to perform the extract refactoring.</td> 82 <td>Private method to perform the extract refactoring.</td>
89 </tr><tr> 83 </tr><tr>
90 <td><a href="#RefactoringServer.__doImports">__doImports</a></td> 84 <td><a href="#RefactoringServer.__doImports">__doImports</a></td>
91 <td>Private method to perform the various imports refactorings.</td> 85 <td>Private method to perform the various imports refactorings.</td>
241 <td>Public method to check, if any editor has unsaved changes.</td> 235 <td>Public method to check, if any editor has unsaved changes.</td>
242 </tr><tr> 236 </tr><tr>
243 <td><a href="#RefactoringServer.confirmBufferIsSaved">confirmBufferIsSaved</a></td> 237 <td><a href="#RefactoringServer.confirmBufferIsSaved">confirmBufferIsSaved</a></td>
244 <td>Public method to check, if an editor has unsaved changes.</td> 238 <td>Public method to check, if an editor has unsaved changes.</td>
245 </tr><tr> 239 </tr><tr>
246 <td><a href="#RefactoringServer.connectEditor">connectEditor</a></td>
247 <td>Public method to connect an editor.</td>
248 </tr><tr>
249 <td><a href="#RefactoringServer.deactivate">deactivate</a></td> 240 <td><a href="#RefactoringServer.deactivate">deactivate</a></td>
250 <td>Public method to deactivate the refactoring server.</td> 241 <td>Public method to deactivate the refactoring server.</td>
251 </tr><tr> 242 </tr><tr>
252 <td><a href="#RefactoringServer.disconnectEditor">disconnectEditor</a></td>
253 <td>Public method to disconnect an editor.</td>
254 </tr><tr>
255 <td><a href="#RefactoringServer.getActions">getActions</a></td> 243 <td><a href="#RefactoringServer.getActions">getActions</a></td>
256 <td>Public method to get a list of all actions.</td> 244 <td>Public method to get a list of all actions.</td>
257 </tr><tr> 245 </tr><tr>
258 <td><a href="#RefactoringServer.getMainWindow">getMainWindow</a></td> 246 <td><a href="#RefactoringServer.getMainWindow">getMainWindow</a></td>
259 <td>Public method to get a reference to the IDE main window.</td> 247 <td>Public method to get a reference to the IDE main window.</td>
260 </tr><tr>
261 <td><a href="#RefactoringServer.gotoDefinition">gotoDefinition</a></td>
262 <td>Public slot to find the definition for the word at the cursor position and go to it.</td>
263 </tr><tr> 248 </tr><tr>
264 <td><a href="#RefactoringServer.handleCall">handleCall</a></td> 249 <td><a href="#RefactoringServer.handleCall">handleCall</a></td>
265 <td>Public method to handle a method call from the client.</td> 250 <td>Public method to handle a method call from the client.</td>
266 </tr><tr> 251 </tr><tr>
267 <td><a href="#RefactoringServer.handleNewConnection">handleNewConnection</a></td> 252 <td><a href="#RefactoringServer.handleNewConnection">handleNewConnection</a></td>
318 </p><a NAME="RefactoringServer.__configChanged" ID="RefactoringServer.__configChanged"></a> 303 </p><a NAME="RefactoringServer.__configChanged" ID="RefactoringServer.__configChanged"></a>
319 <h4>RefactoringServer.__configChanged</h4> 304 <h4>RefactoringServer.__configChanged</h4>
320 <b>__configChanged</b>(<i></i>) 305 <b>__configChanged</b>(<i></i>)
321 <p> 306 <p>
322 Private slot called, when the rope config file has changed. 307 Private slot called, when the rope config file has changed.
323 </p><a NAME="RefactoringServer.__connectMouseClickHandler" ID="RefactoringServer.__connectMouseClickHandler"></a> 308 </p><a NAME="RefactoringServer.__convertLocalToAttribute" ID="RefactoringServer.__convertLocalToAttribute"></a>
324 <h4>RefactoringServer.__connectMouseClickHandler</h4>
325 <b>__connectMouseClickHandler</b>(<i>editor</i>)
326 <p>
327 Private method to connect the mouse click handler to an editor.
328 </p><dl>
329 <dt><i>editor</i> (QScintilla.Editor.Editor)</dt>
330 <dd>
331 reference to the editor
332 </dd>
333 </dl><a NAME="RefactoringServer.__convertLocalToAttribute" ID="RefactoringServer.__convertLocalToAttribute"></a>
334 <h4>RefactoringServer.__convertLocalToAttribute</h4> 309 <h4>RefactoringServer.__convertLocalToAttribute</h4>
335 <b>__convertLocalToAttribute</b>(<i></i>) 310 <b>__convertLocalToAttribute</b>(<i></i>)
336 <p> 311 <p>
337 Private slot to convert a local variable to an attribute. 312 Private slot to convert a local variable to an attribute.
338 </p><a NAME="RefactoringServer.__defaultConfig" ID="RefactoringServer.__defaultConfig"></a> 313 </p><a NAME="RefactoringServer.__defaultConfig" ID="RefactoringServer.__defaultConfig"></a>
348 </dd> 323 </dd>
349 </dl><dl> 324 </dl><dl>
350 <dt>Return Type:</dt> 325 <dt>Return Type:</dt>
351 <dd> 326 <dd>
352 str 327 str
353 </dd>
354 </dl><a NAME="RefactoringServer.__disconnectMouseClickHandler" ID="RefactoringServer.__disconnectMouseClickHandler"></a>
355 <h4>RefactoringServer.__disconnectMouseClickHandler</h4>
356 <b>__disconnectMouseClickHandler</b>(<i>editor</i>)
357 <p>
358 Private method to disconnect the mouse click handler from an editor.
359 </p><dl>
360 <dt><i>editor</i> (QScintilla.Editor.Editor)</dt>
361 <dd>
362 reference to the editor
363 </dd> 328 </dd>
364 </dl><a NAME="RefactoringServer.__doExtract" ID="RefactoringServer.__doExtract"></a> 329 </dl><a NAME="RefactoringServer.__doExtract" ID="RefactoringServer.__doExtract"></a>
365 <h4>RefactoringServer.__doExtract</h4> 330 <h4>RefactoringServer.__doExtract</h4>
366 <b>__doExtract</b>(<i>title, kind</i>) 331 <b>__doExtract</b>(<i>title, kind</i>)
367 <p> 332 <p>
806 </dl><dl> 771 </dl><dl>
807 <dt>Return Type:</dt> 772 <dt>Return Type:</dt>
808 <dd> 773 <dd>
809 bool 774 bool
810 </dd> 775 </dd>
811 </dl><a NAME="RefactoringServer.connectEditor" ID="RefactoringServer.connectEditor"></a>
812 <h4>RefactoringServer.connectEditor</h4>
813 <b>connectEditor</b>(<i>editor</i>)
814 <p>
815 Public method to connect an editor.
816 </p><dl>
817 <dt><i>editor</i> (QScintilla.Editor.Editor)</dt>
818 <dd>
819 reference to the editor
820 </dd>
821 </dl><a NAME="RefactoringServer.deactivate" ID="RefactoringServer.deactivate"></a> 776 </dl><a NAME="RefactoringServer.deactivate" ID="RefactoringServer.deactivate"></a>
822 <h4>RefactoringServer.deactivate</h4> 777 <h4>RefactoringServer.deactivate</h4>
823 <b>deactivate</b>(<i></i>) 778 <b>deactivate</b>(<i></i>)
824 <p> 779 <p>
825 Public method to deactivate the refactoring server. 780 Public method to deactivate the refactoring server.
826 </p><a NAME="RefactoringServer.disconnectEditor" ID="RefactoringServer.disconnectEditor"></a> 781 </p><a NAME="RefactoringServer.getActions" ID="RefactoringServer.getActions"></a>
827 <h4>RefactoringServer.disconnectEditor</h4>
828 <b>disconnectEditor</b>(<i>editor</i>)
829 <p>
830 Public method to disconnect an editor.
831 </p><dl>
832 <dt><i>editor</i> (QScintilla.Editor.Editor)</dt>
833 <dd>
834 reference to the editor
835 </dd>
836 </dl><a NAME="RefactoringServer.getActions" ID="RefactoringServer.getActions"></a>
837 <h4>RefactoringServer.getActions</h4> 782 <h4>RefactoringServer.getActions</h4>
838 <b>getActions</b>(<i></i>) 783 <b>getActions</b>(<i></i>)
839 <p> 784 <p>
840 Public method to get a list of all actions. 785 Public method to get a list of all actions.
841 </p><dl> 786 </p><dl>
860 </dd> 805 </dd>
861 </dl><dl> 806 </dl><dl>
862 <dt>Return Type:</dt> 807 <dt>Return Type:</dt>
863 <dd> 808 <dd>
864 UserInterface 809 UserInterface
865 </dd>
866 </dl><a NAME="RefactoringServer.gotoDefinition" ID="RefactoringServer.gotoDefinition"></a>
867 <h4>RefactoringServer.gotoDefinition</h4>
868 <b>gotoDefinition</b>(<i>editor</i>)
869 <p>
870 Public slot to find the definition for the word at the cursor position
871 and go to it.
872 </p><p>
873 Note: This is executed upon a mouse click sequence.
874 </p><dl>
875 <dt><i>editor</i> (QScintilla.Editor.Editor)</dt>
876 <dd>
877 reference to the calling editor
878 </dd> 810 </dd>
879 </dl><a NAME="RefactoringServer.handleCall" ID="RefactoringServer.handleCall"></a> 811 </dl><a NAME="RefactoringServer.handleCall" ID="RefactoringServer.handleCall"></a>
880 <h4>RefactoringServer.handleCall</h4> 812 <h4>RefactoringServer.handleCall</h4>
881 <b>handleCall</b>(<i>method, params</i>) 813 <b>handleCall</b>(<i>method, params</i>)
882 <p> 814 <p>

eric ide

mercurial