Mercurial Repositories > Rope Refactoring / file comparison

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

RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.PluginRefactoringRope.html

changeset 100
2bfe9e3fad8d
parent 87
1fbf5fdbe721
child 101
5098ad8960ed
equal deleted inserted replaced
99:e21a49043f31 100:2bfe9e3fad8d
23 <p> 23 <p>
24 Module implementing the Rope refactoring plugin. 24 Module implementing the Rope refactoring plugin.
25 </p> 25 </p>
26 <h3>Global Attributes</h3> 26 <h3>Global Attributes</h3>
27 <table> 27 <table>
28 <tr><td>author</td></tr><tr><td>autoactivate</td></tr><tr><td>className</td></tr><tr><td>deactivateable</td></tr><tr><td>doNotCompile</td></tr><tr><td>error</td></tr><tr><td>internalPackages</td></tr><tr><td>longDescription</td></tr><tr><td>name</td></tr><tr><td>packageName</td></tr><tr><td>pyqtApi</td></tr><tr><td>python2Compatible</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr> 28 <tr><td>author</td></tr><tr><td>autoactivate</td></tr><tr><td>className</td></tr><tr><td>deactivateable</td></tr><tr><td>doNotCompile</td></tr><tr><td>error</td></tr><tr><td>internalPackages</td></tr><tr><td>longDescription</td></tr><tr><td>name</td></tr><tr><td>packageName</td></tr><tr><td>pyqtApi</td></tr><tr><td>python2Compatible</td></tr><tr><td>refactoringRopePluginObject</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr>
29 </table> 29 </table>
30 <h3>Classes</h3> 30 <h3>Classes</h3>
31 <table> 31 <table>
32 <tr> 32 <tr>
33 <td><a href="#RefactoringRopePlugin">RefactoringRopePlugin</a></td> 33 <td><a href="#RefactoringRopePlugin">RefactoringRopePlugin</a></td>
34 <td>Class implementing the Rope refactoring plugin.</td> 34 <td>Class implementing the Rope refactoring plugin.</td>
35 </tr> 35 </tr>
36 </table> 36 </table>
37 <h3>Functions</h3> 37 <h3>Functions</h3>
38 <table> 38 <table>
39 <tr><td>None</td></tr> 39 <tr>
40 <td><a href="#createAutoCompletionPage">createAutoCompletionPage</a></td>
41 <td>Module function to create the autocompletion configuration page.</td>
42 </tr><tr>
43 <td><a href="#createCallTipsPage">createCallTipsPage</a></td>
44 <td>Module function to create the calltips configuration page.</td>
45 </tr><tr>
46 <td><a href="#getConfigData">getConfigData</a></td>
47 <td>Module function returning data as required by the configuration dialog.</td>
48 </tr><tr>
49 <td><a href="#prepareUninstall">prepareUninstall</a></td>
50 <td>Module function to prepare for an uninstallation.</td>
51 </tr>
40 </table> 52 </table>
41 <hr /><hr /> 53 <hr /><hr />
42 <a NAME="RefactoringRopePlugin" ID="RefactoringRopePlugin"></a> 54 <a NAME="RefactoringRopePlugin" ID="RefactoringRopePlugin"></a>
43 <h2>RefactoringRopePlugin</h2> 55 <h2>RefactoringRopePlugin</h2>
44 <p> 56 <p>
46 </p> 58 </p>
47 <h3>Derived from</h3> 59 <h3>Derived from</h3>
48 QObject 60 QObject
49 <h3>Class Attributes</h3> 61 <h3>Class Attributes</h3>
50 <table> 62 <table>
51 <tr><td>None</td></tr> 63 <tr><td>PreferencesKey</td></tr>
52 </table> 64 </table>
53 <h3>Class Methods</h3> 65 <h3>Class Methods</h3>
54 <table> 66 <table>
55 <tr><td>None</td></tr> 67 <tr><td>None</td></tr>
56 </table> 68 </table>
61 <td>Constructor</td> 73 <td>Constructor</td>
62 </tr><tr> 74 </tr><tr>
63 <td><a href="#RefactoringRopePlugin.__checkUiVersion">__checkUiVersion</a></td> 75 <td><a href="#RefactoringRopePlugin.__checkUiVersion">__checkUiVersion</a></td>
64 <td>Private method to check, if the IDE has a suitable version.</td> 76 <td>Private method to check, if the IDE has a suitable version.</td>
65 </tr><tr> 77 </tr><tr>
78 <td><a href="#RefactoringRopePlugin.__codeAssist">__codeAssist</a></td>
79 <td>Private slot to show a list with completion proposals.</td>
80 </tr><tr>
81 <td><a href="#RefactoringRopePlugin.__completionListSelected">__completionListSelected</a></td>
82 <td>Private slot to handle the selection from the completion list.</td>
83 </tr><tr>
84 <td><a href="#RefactoringRopePlugin.__connectEditorSignals">__connectEditorSignals</a></td>
85 <td>Private method to connect to some signals of an editor.</td>
86 </tr><tr>
87 <td><a href="#RefactoringRopePlugin.__determineLanguage">__determineLanguage</a></td>
88 <td>Private method to determine the valid language strings.</td>
89 </tr><tr>
90 <td><a href="#RefactoringRopePlugin.__disconnectEditorSignals">__disconnectEditorSignals</a></td>
91 <td>Private method to disconnect to some signals of an editor.</td>
92 </tr><tr>
93 <td><a href="#RefactoringRopePlugin.__editorAboutToBeSaved">__editorAboutToBeSaved</a></td>
94 <td>Private slot to get the old contents of the named file.</td>
95 </tr><tr>
96 <td><a href="#RefactoringRopePlugin.__editorClosed">__editorClosed</a></td>
97 <td>Private slot called, when an editor was closed.</td>
98 </tr><tr>
99 <td><a href="#RefactoringRopePlugin.__editorLanguageChanged">__editorLanguageChanged</a></td>
100 <td>Private slot to handle the language change of an editor.</td>
101 </tr><tr>
102 <td><a href="#RefactoringRopePlugin.__editorOpened">__editorOpened</a></td>
103 <td>Private slot called, when a new editor was opened.</td>
104 </tr><tr>
105 <td><a href="#RefactoringRopePlugin.__editorSaved">__editorSaved</a></td>
106 <td>Private slot to activate SOA.</td>
107 </tr><tr>
66 <td><a href="#RefactoringRopePlugin.__initialize">__initialize</a></td> 108 <td><a href="#RefactoringRopePlugin.__initialize">__initialize</a></td>
67 <td>Private slot to (re)initialize the plugin.</td> 109 <td>Private slot to (re)initialize the plugin.</td>
68 </tr><tr> 110 </tr><tr>
69 <td><a href="#RefactoringRopePlugin.__loadTranslator">__loadTranslator</a></td> 111 <td><a href="#RefactoringRopePlugin.__loadTranslator">__loadTranslator</a></td>
70 <td>Private method to load the translation file.</td> 112 <td>Private method to load the translation file.</td>
73 <td>Private slot to handle the projectClosed signal.</td> 115 <td>Private slot to handle the projectClosed signal.</td>
74 </tr><tr> 116 </tr><tr>
75 <td><a href="#RefactoringRopePlugin.__projectOpened">__projectOpened</a></td> 117 <td><a href="#RefactoringRopePlugin.__projectOpened">__projectOpened</a></td>
76 <td>Private slot to handle the projectOpened signal.</td> 118 <td>Private slot to handle the projectOpened signal.</td>
77 </tr><tr> 119 </tr><tr>
120 <td><a href="#RefactoringRopePlugin.__setAutoCompletionHook">__setAutoCompletionHook</a></td>
121 <td>Private method to set the autocompletion hook.</td>
122 </tr><tr>
123 <td><a href="#RefactoringRopePlugin.__setCalltipsHook">__setCalltipsHook</a></td>
124 <td>Private method to set the calltip hook.</td>
125 </tr><tr>
126 <td><a href="#RefactoringRopePlugin.__unsetAutoCompletionHook">__unsetAutoCompletionHook</a></td>
127 <td>Private method to unset the autocompletion hook.</td>
128 </tr><tr>
129 <td><a href="#RefactoringRopePlugin.__unsetCalltipsHook">__unsetCalltipsHook</a></td>
130 <td>Private method to unset the calltip hook.</td>
131 </tr><tr>
78 <td><a href="#RefactoringRopePlugin.activate">activate</a></td> 132 <td><a href="#RefactoringRopePlugin.activate">activate</a></td>
79 <td>Public method to activate this plugin.</td> 133 <td>Public method to activate this plugin.</td>
80 </tr><tr> 134 </tr><tr>
135 <td><a href="#RefactoringRopePlugin.codeAssist">codeAssist</a></td>
136 <td>Public method to determine the autocompletion proposals.</td>
137 </tr><tr>
138 <td><a href="#RefactoringRopePlugin.codeAssistCallTip">codeAssistCallTip</a></td>
139 <td>Public method to return a list of calltips.</td>
140 </tr><tr>
81 <td><a href="#RefactoringRopePlugin.deactivate">deactivate</a></td> 141 <td><a href="#RefactoringRopePlugin.deactivate">deactivate</a></td>
82 <td>Public method to deactivate this plugin.</td> 142 <td>Public method to deactivate this plugin.</td>
143 </tr><tr>
144 <td><a href="#RefactoringRopePlugin.getPreferences">getPreferences</a></td>
145 <td>Public method to retrieve the various refactoring settings.</td>
146 </tr><tr>
147 <td><a href="#RefactoringRopePlugin.setPreferences">setPreferences</a></td>
148 <td>Public method to store the various refactoring settings.</td>
83 </tr> 149 </tr>
84 </table> 150 </table>
85 <h3>Static Methods</h3> 151 <h3>Static Methods</h3>
86 <table> 152 <table>
87 <tr><td>None</td></tr> 153 <tr><td>None</td></tr>
103 Private method to check, if the IDE has a suitable version. 169 Private method to check, if the IDE has a suitable version.
104 </p><dl> 170 </p><dl>
105 <dt>Returns:</dt> 171 <dt>Returns:</dt>
106 <dd> 172 <dd>
107 flag indicating a suitable version (boolean) 173 flag indicating a suitable version (boolean)
174 </dd>
175 </dl><a NAME="RefactoringRopePlugin.__codeAssist" ID="RefactoringRopePlugin.__codeAssist"></a>
176 <h4>RefactoringRopePlugin.__codeAssist</h4>
177 <b>__codeAssist</b>(<i></i>)
178 <p>
179 Private slot to show a list with completion proposals.
180 </p><a NAME="RefactoringRopePlugin.__completionListSelected" ID="RefactoringRopePlugin.__completionListSelected"></a>
181 <h4>RefactoringRopePlugin.__completionListSelected</h4>
182 <b>__completionListSelected</b>(<i>id, txt</i>)
183 <p>
184 Private slot to handle the selection from the completion list.
185 </p><dl>
186 <dt><i>id</i></dt>
187 <dd>
188 the ID of the user list (should be 1) (integer)
189 </dd><dt><i>txt</i></dt>
190 <dd>
191 the selected text (QString)
192 </dd>
193 </dl><a NAME="RefactoringRopePlugin.__connectEditorSignals" ID="RefactoringRopePlugin.__connectEditorSignals"></a>
194 <h4>RefactoringRopePlugin.__connectEditorSignals</h4>
195 <b>__connectEditorSignals</b>(<i>editor</i>)
196 <p>
197 Private method to connect to some signals of an editor.
198 </p><dl>
199 <dt><i>editor</i></dt>
200 <dd>
201 reference to the editor (QScintilla.Editor)
202 </dd>
203 </dl><a NAME="RefactoringRopePlugin.__determineLanguage" ID="RefactoringRopePlugin.__determineLanguage"></a>
204 <h4>RefactoringRopePlugin.__determineLanguage</h4>
205 <b>__determineLanguage</b>(<i></i>)
206 <p>
207 Private method to determine the valid language strings.
208 </p><dl>
209 <dt>Returns:</dt>
210 <dd>
211 list of valid language strings (list of string)
212 </dd>
213 </dl><a NAME="RefactoringRopePlugin.__disconnectEditorSignals" ID="RefactoringRopePlugin.__disconnectEditorSignals"></a>
214 <h4>RefactoringRopePlugin.__disconnectEditorSignals</h4>
215 <b>__disconnectEditorSignals</b>(<i>editor</i>)
216 <p>
217 Private method to disconnect to some signals of an editor.
218 </p><dl>
219 <dt><i>editor</i></dt>
220 <dd>
221 reference to the editor (QScintilla.Editor)
222 </dd>
223 </dl><a NAME="RefactoringRopePlugin.__editorAboutToBeSaved" ID="RefactoringRopePlugin.__editorAboutToBeSaved"></a>
224 <h4>RefactoringRopePlugin.__editorAboutToBeSaved</h4>
225 <b>__editorAboutToBeSaved</b>(<i>filename</i>)
226 <p>
227 Private slot to get the old contents of the named file.
228 </p><dl>
229 <dt><i>filename</i></dt>
230 <dd>
231 name of the file about to be saved (string)
232 </dd>
233 </dl><a NAME="RefactoringRopePlugin.__editorClosed" ID="RefactoringRopePlugin.__editorClosed"></a>
234 <h4>RefactoringRopePlugin.__editorClosed</h4>
235 <b>__editorClosed</b>(<i>editor</i>)
236 <p>
237 Private slot called, when an editor was closed.
238 </p><dl>
239 <dt><i>editor</i></dt>
240 <dd>
241 reference to the editor (QScintilla.Editor)
242 </dd>
243 </dl><a NAME="RefactoringRopePlugin.__editorLanguageChanged" ID="RefactoringRopePlugin.__editorLanguageChanged"></a>
244 <h4>RefactoringRopePlugin.__editorLanguageChanged</h4>
245 <b>__editorLanguageChanged</b>(<i>language</i>)
246 <p>
247 Private slot to handle the language change of an editor.
248 </p><dl>
249 <dt><i>language</i></dt>
250 <dd>
251 programming language of the editor (string)
252 </dd>
253 </dl><a NAME="RefactoringRopePlugin.__editorOpened" ID="RefactoringRopePlugin.__editorOpened"></a>
254 <h4>RefactoringRopePlugin.__editorOpened</h4>
255 <b>__editorOpened</b>(<i>editor</i>)
256 <p>
257 Private slot called, when a new editor was opened.
258 </p><dl>
259 <dt><i>editor</i></dt>
260 <dd>
261 reference to the new editor (QScintilla.Editor)
262 </dd>
263 </dl><a NAME="RefactoringRopePlugin.__editorSaved" ID="RefactoringRopePlugin.__editorSaved"></a>
264 <h4>RefactoringRopePlugin.__editorSaved</h4>
265 <b>__editorSaved</b>(<i>filename</i>)
266 <p>
267 Private slot to activate SOA.
268 </p><dl>
269 <dt><i>filename</i></dt>
270 <dd>
271 name of the file that was saved (string)
108 </dd> 272 </dd>
109 </dl><a NAME="RefactoringRopePlugin.__initialize" ID="RefactoringRopePlugin.__initialize"></a> 273 </dl><a NAME="RefactoringRopePlugin.__initialize" ID="RefactoringRopePlugin.__initialize"></a>
110 <h4>RefactoringRopePlugin.__initialize</h4> 274 <h4>RefactoringRopePlugin.__initialize</h4>
111 <b>__initialize</b>(<i></i>) 275 <b>__initialize</b>(<i></i>)
112 <p> 276 <p>
124 </p><a NAME="RefactoringRopePlugin.__projectOpened" ID="RefactoringRopePlugin.__projectOpened"></a> 288 </p><a NAME="RefactoringRopePlugin.__projectOpened" ID="RefactoringRopePlugin.__projectOpened"></a>
125 <h4>RefactoringRopePlugin.__projectOpened</h4> 289 <h4>RefactoringRopePlugin.__projectOpened</h4>
126 <b>__projectOpened</b>(<i></i>) 290 <b>__projectOpened</b>(<i></i>)
127 <p> 291 <p>
128 Private slot to handle the projectOpened signal. 292 Private slot to handle the projectOpened signal.
129 </p><a NAME="RefactoringRopePlugin.activate" ID="RefactoringRopePlugin.activate"></a> 293 </p><a NAME="RefactoringRopePlugin.__setAutoCompletionHook" ID="RefactoringRopePlugin.__setAutoCompletionHook"></a>
294 <h4>RefactoringRopePlugin.__setAutoCompletionHook</h4>
295 <b>__setAutoCompletionHook</b>(<i>editor</i>)
296 <p>
297 Private method to set the autocompletion hook.
298 </p><dl>
299 <dt><i>editor</i></dt>
300 <dd>
301 reference to the editor (QScintilla.Editor)
302 </dd>
303 </dl><a NAME="RefactoringRopePlugin.__setCalltipsHook" ID="RefactoringRopePlugin.__setCalltipsHook"></a>
304 <h4>RefactoringRopePlugin.__setCalltipsHook</h4>
305 <b>__setCalltipsHook</b>(<i>editor</i>)
306 <p>
307 Private method to set the calltip hook.
308 </p><dl>
309 <dt><i>editor</i></dt>
310 <dd>
311 reference to the editor (QScintilla.Editor)
312 </dd>
313 </dl><a NAME="RefactoringRopePlugin.__unsetAutoCompletionHook" ID="RefactoringRopePlugin.__unsetAutoCompletionHook"></a>
314 <h4>RefactoringRopePlugin.__unsetAutoCompletionHook</h4>
315 <b>__unsetAutoCompletionHook</b>(<i>editor</i>)
316 <p>
317 Private method to unset the autocompletion hook.
318 </p><dl>
319 <dt><i>editor</i></dt>
320 <dd>
321 reference to the editor (QScintilla.Editor)
322 </dd>
323 </dl><a NAME="RefactoringRopePlugin.__unsetCalltipsHook" ID="RefactoringRopePlugin.__unsetCalltipsHook"></a>
324 <h4>RefactoringRopePlugin.__unsetCalltipsHook</h4>
325 <b>__unsetCalltipsHook</b>(<i>editor</i>)
326 <p>
327 Private method to unset the calltip hook.
328 </p><dl>
329 <dt><i>editor</i></dt>
330 <dd>
331 reference to the editor (QScintilla.Editor)
332 </dd>
333 </dl><a NAME="RefactoringRopePlugin.activate" ID="RefactoringRopePlugin.activate"></a>
130 <h4>RefactoringRopePlugin.activate</h4> 334 <h4>RefactoringRopePlugin.activate</h4>
131 <b>activate</b>(<i></i>) 335 <b>activate</b>(<i></i>)
132 <p> 336 <p>
133 Public method to activate this plugin. 337 Public method to activate this plugin.
134 </p><dl> 338 </p><dl>
135 <dt>Returns:</dt> 339 <dt>Returns:</dt>
136 <dd> 340 <dd>
137 tuple of None and activation status (boolean) 341 tuple of None and activation status (boolean)
342 </dd>
343 </dl><a NAME="RefactoringRopePlugin.codeAssist" ID="RefactoringRopePlugin.codeAssist"></a>
344 <h4>RefactoringRopePlugin.codeAssist</h4>
345 <b>codeAssist</b>(<i>editor, context = False</i>)
346 <p>
347 Public method to determine the autocompletion proposals.
348 </p><dl>
349 <dt><i>editor</i></dt>
350 <dd>
351 reference to the editor object, that called this method
352 QScintilla.Editor)
353 </dd><dt><i>context</i></dt>
354 <dd>
355 flag indicating to autocomplete a context (boolean)
356 </dd>
357 </dl><a NAME="RefactoringRopePlugin.codeAssistCallTip" ID="RefactoringRopePlugin.codeAssistCallTip"></a>
358 <h4>RefactoringRopePlugin.codeAssistCallTip</h4>
359 <b>codeAssistCallTip</b>(<i>editor, pos, commas</i>)
360 <p>
361 Public method to return a list of calltips.
362 </p><dl>
363 <dt><i>editor</i></dt>
364 <dd>
365 reference to the editor (QScintilla.Editor)
366 </dd><dt><i>pos</i></dt>
367 <dd>
368 position in the text for the calltip (integer)
369 </dd><dt><i>commas</i></dt>
370 <dd>
371 minimum number of commas contained in the calltip
372 (integer)
373 </dd>
374 </dl><dl>
375 <dt>Returns:</dt>
376 <dd>
377 list of possible calltips (list of strings)
138 </dd> 378 </dd>
139 </dl><a NAME="RefactoringRopePlugin.deactivate" ID="RefactoringRopePlugin.deactivate"></a> 379 </dl><a NAME="RefactoringRopePlugin.deactivate" ID="RefactoringRopePlugin.deactivate"></a>
140 <h4>RefactoringRopePlugin.deactivate</h4> 380 <h4>RefactoringRopePlugin.deactivate</h4>
141 <b>deactivate</b>(<i></i>) 381 <b>deactivate</b>(<i></i>)
142 <p> 382 <p>
143 Public method to deactivate this plugin. 383 Public method to deactivate this plugin.
384 </p><a NAME="RefactoringRopePlugin.getPreferences" ID="RefactoringRopePlugin.getPreferences"></a>
385 <h4>RefactoringRopePlugin.getPreferences</h4>
386 <b>getPreferences</b>(<i>key</i>)
387 <p>
388 Public method to retrieve the various refactoring settings.
389 </p><dl>
390 <dt><i>key</i></dt>
391 <dd>
392 the key of the value to get
393 </dd><dt><i>prefClass</i></dt>
394 <dd>
395 preferences class used as the storage area
396 </dd>
397 </dl><dl>
398 <dt>Returns:</dt>
399 <dd>
400 the requested refactoring setting
401 </dd>
402 </dl><a NAME="RefactoringRopePlugin.setPreferences" ID="RefactoringRopePlugin.setPreferences"></a>
403 <h4>RefactoringRopePlugin.setPreferences</h4>
404 <b>setPreferences</b>(<i>key, value</i>)
405 <p>
406 Public method to store the various refactoring settings.
407 </p><dl>
408 <dt><i>key</i></dt>
409 <dd>
410 the key of the setting to be set (string)
411 </dd><dt><i>value</i></dt>
412 <dd>
413 the value to be set
414 </dd><dt><i>prefClass</i></dt>
415 <dd>
416 preferences class used as the storage area
417 </dd>
418 </dl>
419 <div align="right"><a href="#top">Up</a></div>
420 <hr /><hr />
421 <a NAME="createAutoCompletionPage" ID="createAutoCompletionPage"></a>
422 <h2>createAutoCompletionPage</h2>
423 <b>createAutoCompletionPage</b>(<i>configDlg</i>)
424 <p>
425 Module function to create the autocompletion configuration page.
426 </p><dl>
427 <dt><i>configDlg</i></dt>
428 <dd>
429 reference to the configuration dialog
430 </dd>
431 </dl><dl>
432 <dt>Returns:</dt>
433 <dd>
434 reference to the configuration page
435 </dd>
436 </dl>
437 <div align="right"><a href="#top">Up</a></div>
438 <hr /><hr />
439 <a NAME="createCallTipsPage" ID="createCallTipsPage"></a>
440 <h2>createCallTipsPage</h2>
441 <b>createCallTipsPage</b>(<i>configDlg</i>)
442 <p>
443 Module function to create the calltips configuration page.
444 </p><dl>
445 <dt><i>configDlg</i></dt>
446 <dd>
447 reference to the configuration dialog
448 </dd>
449 </dl><dl>
450 <dt>Returns:</dt>
451 <dd>
452 reference to the configuration page
453 </dd>
454 </dl>
455 <div align="right"><a href="#top">Up</a></div>
456 <hr /><hr />
457 <a NAME="getConfigData" ID="getConfigData"></a>
458 <h2>getConfigData</h2>
459 <b>getConfigData</b>(<i></i>)
460 <p>
461 Module function returning data as required by the configuration dialog.
462 </p><dl>
463 <dt>Returns:</dt>
464 <dd>
465 dictionary containing the relevant data
466 </dd>
467 </dl>
468 <div align="right"><a href="#top">Up</a></div>
469 <hr /><hr />
470 <a NAME="prepareUninstall" ID="prepareUninstall"></a>
471 <h2>prepareUninstall</h2>
472 <b>prepareUninstall</b>(<i></i>)
473 <p>
474 Module function to prepare for an uninstallation.
144 </p> 475 </p>
145 <div align="right"><a href="#top">Up</a></div> 476 <div align="right"><a href="#top">Up</a></div>
146 <hr /> 477 <hr />
147 </body></html> 478 </body></html>

Mercurial Repository: Rope Refactoring

eric ide

mercurial