Mercurial Repositories > Rope Refactoring / file comparison

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

RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.PluginRefactoringRope.html

changeset 321
d51e810107ec
parent 295
8318a6881e63
child 335
9438c2ed7732
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.PluginRefactoringRope</h1> 23 <h1>Plugin_Refactoring_Rope.PluginRefactoringRope</h1>
24
23 <p> 25 <p>
24 Module implementing the Rope refactoring plugin. 26 Module implementing the Rope refactoring plugin.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <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>refactoringRopePluginObject</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr> 31 <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> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
34
31 <table> 35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#RefactoringRopePlugin">RefactoringRopePlugin</a></td> 38 <td><a href="#RefactoringRopePlugin">RefactoringRopePlugin</a></td>
34 <td>Class implementing the Rope refactoring plugin.</td> 39 <td>Class implementing the Rope refactoring plugin.</td>
35 </tr> 40 </tr>
36 </table> 41 </table>
37 <h3>Functions</h3> 42 <h3>Functions</h3>
43
38 <table> 44 <table>
45
39 <tr> 46 <tr>
40 <td><a href="#createAutoCompletionPage">createAutoCompletionPage</a></td> 47 <td><a href="#createAutoCompletionPage">createAutoCompletionPage</a></td>
41 <td>Module function to create the autocompletion configuration page.</td> 48 <td>Module function to create the autocompletion configuration page.</td>
42 </tr><tr> 49 </tr>
50 <tr>
43 <td><a href="#createCallTipsPage">createCallTipsPage</a></td> 51 <td><a href="#createCallTipsPage">createCallTipsPage</a></td>
44 <td>Module function to create the calltips configuration page.</td> 52 <td>Module function to create the calltips configuration page.</td>
45 </tr><tr> 53 </tr>
54 <tr>
46 <td><a href="#createMouseClickHandlerPage">createMouseClickHandlerPage</a></td> 55 <td><a href="#createMouseClickHandlerPage">createMouseClickHandlerPage</a></td>
47 <td>Module function to create the mouse click handler configuration page.</td> 56 <td>Module function to create the mouse click handler configuration page.</td>
48 </tr><tr> 57 </tr>
58 <tr>
49 <td><a href="#getConfigData">getConfigData</a></td> 59 <td><a href="#getConfigData">getConfigData</a></td>
50 <td>Module function returning data as required by the configuration dialog.</td> 60 <td>Module function returning data as required by the configuration dialog.</td>
51 </tr><tr> 61 </tr>
62 <tr>
52 <td><a href="#prepareUninstall">prepareUninstall</a></td> 63 <td><a href="#prepareUninstall">prepareUninstall</a></td>
53 <td>Module function to prepare for an uninstallation.</td> 64 <td>Module function to prepare for an uninstallation.</td>
54 </tr> 65 </tr>
55 </table> 66 </table>
56 <hr /><hr /> 67 <hr />
68 <hr />
57 <a NAME="RefactoringRopePlugin" ID="RefactoringRopePlugin"></a> 69 <a NAME="RefactoringRopePlugin" ID="RefactoringRopePlugin"></a>
58 <h2>RefactoringRopePlugin</h2> 70 <h2>RefactoringRopePlugin</h2>
71
59 <p> 72 <p>
60 Class implementing the Rope refactoring plugin. 73 Class implementing the Rope refactoring plugin.
61 </p> 74 </p>
62 <h3>Derived from</h3> 75 <h3>Derived from</h3>
63 QObject 76 QObject
64 <h3>Class Attributes</h3> 77 <h3>Class Attributes</h3>
78
65 <table> 79 <table>
66 <tr><td>PreferencesKey</td></tr> 80 <tr><td>PreferencesKey</td></tr>
67 </table> 81 </table>
68 <h3>Class Methods</h3> 82 <h3>Class Methods</h3>
83
69 <table> 84 <table>
70 <tr><td>None</td></tr> 85 <tr><td>None</td></tr>
71 </table> 86 </table>
72 <h3>Methods</h3> 87 <h3>Methods</h3>
88
73 <table> 89 <table>
90
74 <tr> 91 <tr>
75 <td><a href="#RefactoringRopePlugin.__init__">RefactoringRopePlugin</a></td> 92 <td><a href="#RefactoringRopePlugin.__init__">RefactoringRopePlugin</a></td>
76 <td>Constructor</td> 93 <td>Constructor</td>
77 </tr><tr> 94 </tr>
95 <tr>
78 <td><a href="#RefactoringRopePlugin.__connectEditor">__connectEditor</a></td> 96 <td><a href="#RefactoringRopePlugin.__connectEditor">__connectEditor</a></td>
79 <td>Private method to connect an editor.</td> 97 <td>Private method to connect an editor.</td>
80 </tr><tr> 98 </tr>
99 <tr>
81 <td><a href="#RefactoringRopePlugin.__connectMouseClickHandler">__connectMouseClickHandler</a></td> 100 <td><a href="#RefactoringRopePlugin.__connectMouseClickHandler">__connectMouseClickHandler</a></td>
82 <td>Private method to connect the mouse click handler to an editor.</td> 101 <td>Private method to connect the mouse click handler to an editor.</td>
83 </tr><tr> 102 </tr>
103 <tr>
84 <td><a href="#RefactoringRopePlugin.__determineLanguage">__determineLanguage</a></td> 104 <td><a href="#RefactoringRopePlugin.__determineLanguage">__determineLanguage</a></td>
85 <td>Private method to determine the valid language strings.</td> 105 <td>Private method to determine the valid language strings.</td>
86 </tr><tr> 106 </tr>
107 <tr>
87 <td><a href="#RefactoringRopePlugin.__disconnectEditor">__disconnectEditor</a></td> 108 <td><a href="#RefactoringRopePlugin.__disconnectEditor">__disconnectEditor</a></td>
88 <td>Private method to disconnect an editor.</td> 109 <td>Private method to disconnect an editor.</td>
89 </tr><tr> 110 </tr>
111 <tr>
90 <td><a href="#RefactoringRopePlugin.__disconnectMouseClickHandler">__disconnectMouseClickHandler</a></td> 112 <td><a href="#RefactoringRopePlugin.__disconnectMouseClickHandler">__disconnectMouseClickHandler</a></td>
91 <td>Private method to disconnect the mouse click handler from an editor.</td> 113 <td>Private method to disconnect the mouse click handler from an editor.</td>
92 </tr><tr> 114 </tr>
115 <tr>
93 <td><a href="#RefactoringRopePlugin.__editorAboutToBeSaved">__editorAboutToBeSaved</a></td> 116 <td><a href="#RefactoringRopePlugin.__editorAboutToBeSaved">__editorAboutToBeSaved</a></td>
94 <td>Private slot to get the old contents of the named file.</td> 117 <td>Private slot to get the old contents of the named file.</td>
95 </tr><tr> 118 </tr>
119 <tr>
96 <td><a href="#RefactoringRopePlugin.__editorClosed">__editorClosed</a></td> 120 <td><a href="#RefactoringRopePlugin.__editorClosed">__editorClosed</a></td>
97 <td>Private slot called, when an editor was closed.</td> 121 <td>Private slot called, when an editor was closed.</td>
98 </tr><tr> 122 </tr>
123 <tr>
99 <td><a href="#RefactoringRopePlugin.__editorLanguageChanged">__editorLanguageChanged</a></td> 124 <td><a href="#RefactoringRopePlugin.__editorLanguageChanged">__editorLanguageChanged</a></td>
100 <td>Private slot to handle the language change of an editor.</td> 125 <td>Private slot to handle the language change of an editor.</td>
101 </tr><tr> 126 </tr>
127 <tr>
102 <td><a href="#RefactoringRopePlugin.__editorOpened">__editorOpened</a></td> 128 <td><a href="#RefactoringRopePlugin.__editorOpened">__editorOpened</a></td>
103 <td>Private slot called, when a new editor was opened.</td> 129 <td>Private slot called, when a new editor was opened.</td>
104 </tr><tr> 130 </tr>
131 <tr>
105 <td><a href="#RefactoringRopePlugin.__editorSaved">__editorSaved</a></td> 132 <td><a href="#RefactoringRopePlugin.__editorSaved">__editorSaved</a></td>
106 <td>Private slot to activate SOA.</td> 133 <td>Private slot to activate SOA.</td>
107 </tr><tr> 134 </tr>
135 <tr>
108 <td><a href="#RefactoringRopePlugin.__initialize">__initialize</a></td> 136 <td><a href="#RefactoringRopePlugin.__initialize">__initialize</a></td>
109 <td>Private slot to (re)initialize the plugin.</td> 137 <td>Private slot to (re)initialize the plugin.</td>
110 </tr><tr> 138 </tr>
139 <tr>
111 <td><a href="#RefactoringRopePlugin.__loadTranslator">__loadTranslator</a></td> 140 <td><a href="#RefactoringRopePlugin.__loadTranslator">__loadTranslator</a></td>
112 <td>Private method to load the translation file.</td> 141 <td>Private method to load the translation file.</td>
113 </tr><tr> 142 </tr>
143 <tr>
114 <td><a href="#RefactoringRopePlugin.__setAutoCompletionHook">__setAutoCompletionHook</a></td> 144 <td><a href="#RefactoringRopePlugin.__setAutoCompletionHook">__setAutoCompletionHook</a></td>
115 <td>Private method to set the autocompletion hook.</td> 145 <td>Private method to set the autocompletion hook.</td>
116 </tr><tr> 146 </tr>
147 <tr>
117 <td><a href="#RefactoringRopePlugin.__setCalltipsHook">__setCalltipsHook</a></td> 148 <td><a href="#RefactoringRopePlugin.__setCalltipsHook">__setCalltipsHook</a></td>
118 <td>Private method to set the calltip hook.</td> 149 <td>Private method to set the calltip hook.</td>
119 </tr><tr> 150 </tr>
151 <tr>
120 <td><a href="#RefactoringRopePlugin.__shutdown">__shutdown</a></td> 152 <td><a href="#RefactoringRopePlugin.__shutdown">__shutdown</a></td>
121 <td>Private slot handling the shutdown signal of the plug-in manager.</td> 153 <td>Private slot handling the shutdown signal of the plug-in manager.</td>
122 </tr><tr> 154 </tr>
155 <tr>
123 <td><a href="#RefactoringRopePlugin.__unsetAutoCompletionHook">__unsetAutoCompletionHook</a></td> 156 <td><a href="#RefactoringRopePlugin.__unsetAutoCompletionHook">__unsetAutoCompletionHook</a></td>
124 <td>Private method to unset the autocompletion hook.</td> 157 <td>Private method to unset the autocompletion hook.</td>
125 </tr><tr> 158 </tr>
159 <tr>
126 <td><a href="#RefactoringRopePlugin.__unsetCalltipsHook">__unsetCalltipsHook</a></td> 160 <td><a href="#RefactoringRopePlugin.__unsetCalltipsHook">__unsetCalltipsHook</a></td>
127 <td>Private method to unset the calltip hook.</td> 161 <td>Private method to unset the calltip hook.</td>
128 </tr><tr> 162 </tr>
163 <tr>
129 <td><a href="#RefactoringRopePlugin.activate">activate</a></td> 164 <td><a href="#RefactoringRopePlugin.activate">activate</a></td>
130 <td>Public method to activate this plugin.</td> 165 <td>Public method to activate this plugin.</td>
131 </tr><tr> 166 </tr>
167 <tr>
132 <td><a href="#RefactoringRopePlugin.deactivate">deactivate</a></td> 168 <td><a href="#RefactoringRopePlugin.deactivate">deactivate</a></td>
133 <td>Public method to deactivate this plugin.</td> 169 <td>Public method to deactivate this plugin.</td>
134 </tr><tr> 170 </tr>
171 <tr>
135 <td><a href="#RefactoringRopePlugin.getCodeAssistServer">getCodeAssistServer</a></td> 172 <td><a href="#RefactoringRopePlugin.getCodeAssistServer">getCodeAssistServer</a></td>
136 <td>Public method to get a reference to the code assist server.</td> 173 <td>Public method to get a reference to the code assist server.</td>
137 </tr><tr> 174 </tr>
175 <tr>
138 <td><a href="#RefactoringRopePlugin.getPreferences">getPreferences</a></td> 176 <td><a href="#RefactoringRopePlugin.getPreferences">getPreferences</a></td>
139 <td>Public method to retrieve the various refactoring settings.</td> 177 <td>Public method to retrieve the various refactoring settings.</td>
140 </tr><tr> 178 </tr>
179 <tr>
141 <td><a href="#RefactoringRopePlugin.setPreferences">setPreferences</a></td> 180 <td><a href="#RefactoringRopePlugin.setPreferences">setPreferences</a></td>
142 <td>Public method to store the various refactoring settings.</td> 181 <td>Public method to store the various refactoring settings.</td>
143 </tr> 182 </tr>
144 </table> 183 </table>
145 <h3>Static Methods</h3> 184 <h3>Static Methods</h3>
185
146 <table> 186 <table>
147 <tr><td>None</td></tr> 187 <tr><td>None</td></tr>
148 </table> 188 </table>
189
149 <a NAME="RefactoringRopePlugin.__init__" ID="RefactoringRopePlugin.__init__"></a> 190 <a NAME="RefactoringRopePlugin.__init__" ID="RefactoringRopePlugin.__init__"></a>
150 <h4>RefactoringRopePlugin (Constructor)</h4> 191 <h4>RefactoringRopePlugin (Constructor)</h4>
151 <b>RefactoringRopePlugin</b>(<i>ui</i>) 192 <b>RefactoringRopePlugin</b>(<i>ui</i>)
193
152 <p> 194 <p>
153 Constructor 195 Constructor
154 </p><dl> 196 </p>
197 <dl>
198
155 <dt><i>ui</i> (UI.UserInterface)</dt> 199 <dt><i>ui</i> (UI.UserInterface)</dt>
156 <dd> 200 <dd>
157 reference to the user interface object 201 reference to the user interface object
158 </dd> 202 </dd>
159 </dl><a NAME="RefactoringRopePlugin.__connectEditor" ID="RefactoringRopePlugin.__connectEditor"></a> 203 </dl>
204 <a NAME="RefactoringRopePlugin.__connectEditor" ID="RefactoringRopePlugin.__connectEditor"></a>
160 <h4>RefactoringRopePlugin.__connectEditor</h4> 205 <h4>RefactoringRopePlugin.__connectEditor</h4>
161 <b>__connectEditor</b>(<i>editor</i>) 206 <b>__connectEditor</b>(<i>editor</i>)
207
162 <p> 208 <p>
163 Private method to connect an editor. 209 Private method to connect an editor.
164 </p><dl> 210 </p>
211 <dl>
212
165 <dt><i>editor</i> (QScintilla.Editor.Editor)</dt> 213 <dt><i>editor</i> (QScintilla.Editor.Editor)</dt>
166 <dd> 214 <dd>
167 reference to the editor 215 reference to the editor
168 </dd> 216 </dd>
169 </dl><a NAME="RefactoringRopePlugin.__connectMouseClickHandler" ID="RefactoringRopePlugin.__connectMouseClickHandler"></a> 217 </dl>
218 <a NAME="RefactoringRopePlugin.__connectMouseClickHandler" ID="RefactoringRopePlugin.__connectMouseClickHandler"></a>
170 <h4>RefactoringRopePlugin.__connectMouseClickHandler</h4> 219 <h4>RefactoringRopePlugin.__connectMouseClickHandler</h4>
171 <b>__connectMouseClickHandler</b>(<i>editor</i>) 220 <b>__connectMouseClickHandler</b>(<i>editor</i>)
221
172 <p> 222 <p>
173 Private method to connect the mouse click handler to an editor. 223 Private method to connect the mouse click handler to an editor.
174 </p><dl> 224 </p>
225 <dl>
226
175 <dt><i>editor</i> (QScintilla.Editor)</dt> 227 <dt><i>editor</i> (QScintilla.Editor)</dt>
176 <dd> 228 <dd>
177 reference to the editor 229 reference to the editor
178 </dd> 230 </dd>
179 </dl><a NAME="RefactoringRopePlugin.__determineLanguage" ID="RefactoringRopePlugin.__determineLanguage"></a> 231 </dl>
232 <a NAME="RefactoringRopePlugin.__determineLanguage" ID="RefactoringRopePlugin.__determineLanguage"></a>
180 <h4>RefactoringRopePlugin.__determineLanguage</h4> 233 <h4>RefactoringRopePlugin.__determineLanguage</h4>
181 <b>__determineLanguage</b>(<i></i>) 234 <b>__determineLanguage</b>(<i></i>)
235
182 <p> 236 <p>
183 Private method to determine the valid language strings. 237 Private method to determine the valid language strings.
184 </p><dl> 238 </p>
239 <dl>
185 <dt>Returns:</dt> 240 <dt>Returns:</dt>
186 <dd> 241 <dd>
187 list of valid language strings 242 list of valid language strings
188 </dd> 243 </dd>
189 </dl><dl> 244 </dl>
245 <dl>
190 <dt>Return Type:</dt> 246 <dt>Return Type:</dt>
191 <dd> 247 <dd>
192 list of str 248 list of str
193 </dd> 249 </dd>
194 </dl><a NAME="RefactoringRopePlugin.__disconnectEditor" ID="RefactoringRopePlugin.__disconnectEditor"></a> 250 </dl>
251 <a NAME="RefactoringRopePlugin.__disconnectEditor" ID="RefactoringRopePlugin.__disconnectEditor"></a>
195 <h4>RefactoringRopePlugin.__disconnectEditor</h4> 252 <h4>RefactoringRopePlugin.__disconnectEditor</h4>
196 <b>__disconnectEditor</b>(<i>editor</i>) 253 <b>__disconnectEditor</b>(<i>editor</i>)
254
197 <p> 255 <p>
198 Private method to disconnect an editor. 256 Private method to disconnect an editor.
199 </p><dl> 257 </p>
258 <dl>
259
200 <dt><i>editor</i> (QScintilla.Editor.Editor)</dt> 260 <dt><i>editor</i> (QScintilla.Editor.Editor)</dt>
201 <dd> 261 <dd>
202 reference to the editor 262 reference to the editor
203 </dd> 263 </dd>
204 </dl><a NAME="RefactoringRopePlugin.__disconnectMouseClickHandler" ID="RefactoringRopePlugin.__disconnectMouseClickHandler"></a> 264 </dl>
265 <a NAME="RefactoringRopePlugin.__disconnectMouseClickHandler" ID="RefactoringRopePlugin.__disconnectMouseClickHandler"></a>
205 <h4>RefactoringRopePlugin.__disconnectMouseClickHandler</h4> 266 <h4>RefactoringRopePlugin.__disconnectMouseClickHandler</h4>
206 <b>__disconnectMouseClickHandler</b>(<i>editor</i>) 267 <b>__disconnectMouseClickHandler</b>(<i>editor</i>)
268
207 <p> 269 <p>
208 Private method to disconnect the mouse click handler from an editor. 270 Private method to disconnect the mouse click handler from an editor.
209 </p><dl> 271 </p>
272 <dl>
273
210 <dt><i>editor</i> (QScintilla.Editor)</dt> 274 <dt><i>editor</i> (QScintilla.Editor)</dt>
211 <dd> 275 <dd>
212 reference to the editor 276 reference to the editor
213 </dd> 277 </dd>
214 </dl><a NAME="RefactoringRopePlugin.__editorAboutToBeSaved" ID="RefactoringRopePlugin.__editorAboutToBeSaved"></a> 278 </dl>
279 <a NAME="RefactoringRopePlugin.__editorAboutToBeSaved" ID="RefactoringRopePlugin.__editorAboutToBeSaved"></a>
215 <h4>RefactoringRopePlugin.__editorAboutToBeSaved</h4> 280 <h4>RefactoringRopePlugin.__editorAboutToBeSaved</h4>
216 <b>__editorAboutToBeSaved</b>(<i>filename</i>) 281 <b>__editorAboutToBeSaved</b>(<i>filename</i>)
282
217 <p> 283 <p>
218 Private slot to get the old contents of the named file. 284 Private slot to get the old contents of the named file.
219 </p><dl> 285 </p>
286 <dl>
287
220 <dt><i>filename</i> (str)</dt> 288 <dt><i>filename</i> (str)</dt>
221 <dd> 289 <dd>
222 name of the file about to be saved 290 name of the file about to be saved
223 </dd> 291 </dd>
224 </dl><a NAME="RefactoringRopePlugin.__editorClosed" ID="RefactoringRopePlugin.__editorClosed"></a> 292 </dl>
293 <a NAME="RefactoringRopePlugin.__editorClosed" ID="RefactoringRopePlugin.__editorClosed"></a>
225 <h4>RefactoringRopePlugin.__editorClosed</h4> 294 <h4>RefactoringRopePlugin.__editorClosed</h4>
226 <b>__editorClosed</b>(<i>editor</i>) 295 <b>__editorClosed</b>(<i>editor</i>)
296
227 <p> 297 <p>
228 Private slot called, when an editor was closed. 298 Private slot called, when an editor was closed.
229 </p><dl> 299 </p>
300 <dl>
301
230 <dt><i>editor</i> (QScintilla.Editor.Editor)</dt> 302 <dt><i>editor</i> (QScintilla.Editor.Editor)</dt>
231 <dd> 303 <dd>
232 reference to the editor 304 reference to the editor
233 </dd> 305 </dd>
234 </dl><a NAME="RefactoringRopePlugin.__editorLanguageChanged" ID="RefactoringRopePlugin.__editorLanguageChanged"></a> 306 </dl>
307 <a NAME="RefactoringRopePlugin.__editorLanguageChanged" ID="RefactoringRopePlugin.__editorLanguageChanged"></a>
235 <h4>RefactoringRopePlugin.__editorLanguageChanged</h4> 308 <h4>RefactoringRopePlugin.__editorLanguageChanged</h4>
236 <b>__editorLanguageChanged</b>(<i>language</i>) 309 <b>__editorLanguageChanged</b>(<i>language</i>)
310
237 <p> 311 <p>
238 Private slot to handle the language change of an editor. 312 Private slot to handle the language change of an editor.
239 </p><dl> 313 </p>
314 <dl>
315
240 <dt><i>language</i> (str)</dt> 316 <dt><i>language</i> (str)</dt>
241 <dd> 317 <dd>
242 programming language of the editor 318 programming language of the editor
243 </dd> 319 </dd>
244 </dl><a NAME="RefactoringRopePlugin.__editorOpened" ID="RefactoringRopePlugin.__editorOpened"></a> 320 </dl>
321 <a NAME="RefactoringRopePlugin.__editorOpened" ID="RefactoringRopePlugin.__editorOpened"></a>
245 <h4>RefactoringRopePlugin.__editorOpened</h4> 322 <h4>RefactoringRopePlugin.__editorOpened</h4>
246 <b>__editorOpened</b>(<i>editor</i>) 323 <b>__editorOpened</b>(<i>editor</i>)
324
247 <p> 325 <p>
248 Private slot called, when a new editor was opened. 326 Private slot called, when a new editor was opened.
249 </p><dl> 327 </p>
328 <dl>
329
250 <dt><i>editor</i> (QScintilla.Editor.Editor)</dt> 330 <dt><i>editor</i> (QScintilla.Editor.Editor)</dt>
251 <dd> 331 <dd>
252 reference to the new editor 332 reference to the new editor
253 </dd> 333 </dd>
254 </dl><a NAME="RefactoringRopePlugin.__editorSaved" ID="RefactoringRopePlugin.__editorSaved"></a> 334 </dl>
335 <a NAME="RefactoringRopePlugin.__editorSaved" ID="RefactoringRopePlugin.__editorSaved"></a>
255 <h4>RefactoringRopePlugin.__editorSaved</h4> 336 <h4>RefactoringRopePlugin.__editorSaved</h4>
256 <b>__editorSaved</b>(<i>filename</i>) 337 <b>__editorSaved</b>(<i>filename</i>)
338
257 <p> 339 <p>
258 Private slot to activate SOA. 340 Private slot to activate SOA.
259 </p><dl> 341 </p>
342 <dl>
343
260 <dt><i>filename</i> (str)</dt> 344 <dt><i>filename</i> (str)</dt>
261 <dd> 345 <dd>
262 name of the file that was saved 346 name of the file that was saved
263 </dd> 347 </dd>
264 </dl><a NAME="RefactoringRopePlugin.__initialize" ID="RefactoringRopePlugin.__initialize"></a> 348 </dl>
349 <a NAME="RefactoringRopePlugin.__initialize" ID="RefactoringRopePlugin.__initialize"></a>
265 <h4>RefactoringRopePlugin.__initialize</h4> 350 <h4>RefactoringRopePlugin.__initialize</h4>
266 <b>__initialize</b>(<i></i>) 351 <b>__initialize</b>(<i></i>)
352
267 <p> 353 <p>
268 Private slot to (re)initialize the plugin. 354 Private slot to (re)initialize the plugin.
269 </p><a NAME="RefactoringRopePlugin.__loadTranslator" ID="RefactoringRopePlugin.__loadTranslator"></a> 355 </p>
356 <a NAME="RefactoringRopePlugin.__loadTranslator" ID="RefactoringRopePlugin.__loadTranslator"></a>
270 <h4>RefactoringRopePlugin.__loadTranslator</h4> 357 <h4>RefactoringRopePlugin.__loadTranslator</h4>
271 <b>__loadTranslator</b>(<i></i>) 358 <b>__loadTranslator</b>(<i></i>)
359
272 <p> 360 <p>
273 Private method to load the translation file. 361 Private method to load the translation file.
274 </p><a NAME="RefactoringRopePlugin.__setAutoCompletionHook" ID="RefactoringRopePlugin.__setAutoCompletionHook"></a> 362 </p>
363 <a NAME="RefactoringRopePlugin.__setAutoCompletionHook" ID="RefactoringRopePlugin.__setAutoCompletionHook"></a>
275 <h4>RefactoringRopePlugin.__setAutoCompletionHook</h4> 364 <h4>RefactoringRopePlugin.__setAutoCompletionHook</h4>
276 <b>__setAutoCompletionHook</b>(<i>editor</i>) 365 <b>__setAutoCompletionHook</b>(<i>editor</i>)
366
277 <p> 367 <p>
278 Private method to set the autocompletion hook. 368 Private method to set the autocompletion hook.
279 </p><dl> 369 </p>
370 <dl>
371
280 <dt><i>editor</i> (QScintilla.Editor)</dt> 372 <dt><i>editor</i> (QScintilla.Editor)</dt>
281 <dd> 373 <dd>
282 reference to the editor 374 reference to the editor
283 </dd> 375 </dd>
284 </dl><a NAME="RefactoringRopePlugin.__setCalltipsHook" ID="RefactoringRopePlugin.__setCalltipsHook"></a> 376 </dl>
377 <a NAME="RefactoringRopePlugin.__setCalltipsHook" ID="RefactoringRopePlugin.__setCalltipsHook"></a>
285 <h4>RefactoringRopePlugin.__setCalltipsHook</h4> 378 <h4>RefactoringRopePlugin.__setCalltipsHook</h4>
286 <b>__setCalltipsHook</b>(<i>editor</i>) 379 <b>__setCalltipsHook</b>(<i>editor</i>)
380
287 <p> 381 <p>
288 Private method to set the calltip hook. 382 Private method to set the calltip hook.
289 </p><dl> 383 </p>
384 <dl>
385
290 <dt><i>editor</i> (QScintilla.Editor)</dt> 386 <dt><i>editor</i> (QScintilla.Editor)</dt>
291 <dd> 387 <dd>
292 reference to the editor 388 reference to the editor
293 </dd> 389 </dd>
294 </dl><a NAME="RefactoringRopePlugin.__shutdown" ID="RefactoringRopePlugin.__shutdown"></a> 390 </dl>
391 <a NAME="RefactoringRopePlugin.__shutdown" ID="RefactoringRopePlugin.__shutdown"></a>
295 <h4>RefactoringRopePlugin.__shutdown</h4> 392 <h4>RefactoringRopePlugin.__shutdown</h4>
296 <b>__shutdown</b>(<i></i>) 393 <b>__shutdown</b>(<i></i>)
394
297 <p> 395 <p>
298 Private slot handling the shutdown signal of the plug-in manager. 396 Private slot handling the shutdown signal of the plug-in manager.
299 </p><a NAME="RefactoringRopePlugin.__unsetAutoCompletionHook" ID="RefactoringRopePlugin.__unsetAutoCompletionHook"></a> 397 </p>
398 <a NAME="RefactoringRopePlugin.__unsetAutoCompletionHook" ID="RefactoringRopePlugin.__unsetAutoCompletionHook"></a>
300 <h4>RefactoringRopePlugin.__unsetAutoCompletionHook</h4> 399 <h4>RefactoringRopePlugin.__unsetAutoCompletionHook</h4>
301 <b>__unsetAutoCompletionHook</b>(<i>editor</i>) 400 <b>__unsetAutoCompletionHook</b>(<i>editor</i>)
401
302 <p> 402 <p>
303 Private method to unset the autocompletion hook. 403 Private method to unset the autocompletion hook.
304 </p><dl> 404 </p>
405 <dl>
406
305 <dt><i>editor</i> (QScintilla.Editor)</dt> 407 <dt><i>editor</i> (QScintilla.Editor)</dt>
306 <dd> 408 <dd>
307 reference to the editor 409 reference to the editor
308 </dd> 410 </dd>
309 </dl><a NAME="RefactoringRopePlugin.__unsetCalltipsHook" ID="RefactoringRopePlugin.__unsetCalltipsHook"></a> 411 </dl>
412 <a NAME="RefactoringRopePlugin.__unsetCalltipsHook" ID="RefactoringRopePlugin.__unsetCalltipsHook"></a>
310 <h4>RefactoringRopePlugin.__unsetCalltipsHook</h4> 413 <h4>RefactoringRopePlugin.__unsetCalltipsHook</h4>
311 <b>__unsetCalltipsHook</b>(<i>editor</i>) 414 <b>__unsetCalltipsHook</b>(<i>editor</i>)
415
312 <p> 416 <p>
313 Private method to unset the calltip hook. 417 Private method to unset the calltip hook.
314 </p><dl> 418 </p>
419 <dl>
420
315 <dt><i>editor</i> (QScintilla.Editor)</dt> 421 <dt><i>editor</i> (QScintilla.Editor)</dt>
316 <dd> 422 <dd>
317 reference to the editor 423 reference to the editor
318 </dd> 424 </dd>
319 </dl><a NAME="RefactoringRopePlugin.activate" ID="RefactoringRopePlugin.activate"></a> 425 </dl>
426 <a NAME="RefactoringRopePlugin.activate" ID="RefactoringRopePlugin.activate"></a>
320 <h4>RefactoringRopePlugin.activate</h4> 427 <h4>RefactoringRopePlugin.activate</h4>
321 <b>activate</b>(<i></i>) 428 <b>activate</b>(<i></i>)
429
322 <p> 430 <p>
323 Public method to activate this plugin. 431 Public method to activate this plugin.
324 </p><dl> 432 </p>
433 <dl>
325 <dt>Returns:</dt> 434 <dt>Returns:</dt>
326 <dd> 435 <dd>
327 tuple of None and activation status 436 tuple of None and activation status
328 </dd> 437 </dd>
329 </dl><dl> 438 </dl>
439 <dl>
330 <dt>Return Type:</dt> 440 <dt>Return Type:</dt>
331 <dd> 441 <dd>
332 tuple of (None, bool) 442 tuple of (None, bool)
333 </dd> 443 </dd>
334 </dl><a NAME="RefactoringRopePlugin.deactivate" ID="RefactoringRopePlugin.deactivate"></a> 444 </dl>
445 <a NAME="RefactoringRopePlugin.deactivate" ID="RefactoringRopePlugin.deactivate"></a>
335 <h4>RefactoringRopePlugin.deactivate</h4> 446 <h4>RefactoringRopePlugin.deactivate</h4>
336 <b>deactivate</b>(<i></i>) 447 <b>deactivate</b>(<i></i>)
448
337 <p> 449 <p>
338 Public method to deactivate this plugin. 450 Public method to deactivate this plugin.
339 </p><a NAME="RefactoringRopePlugin.getCodeAssistServer" ID="RefactoringRopePlugin.getCodeAssistServer"></a> 451 </p>
452 <a NAME="RefactoringRopePlugin.getCodeAssistServer" ID="RefactoringRopePlugin.getCodeAssistServer"></a>
340 <h4>RefactoringRopePlugin.getCodeAssistServer</h4> 453 <h4>RefactoringRopePlugin.getCodeAssistServer</h4>
341 <b>getCodeAssistServer</b>(<i></i>) 454 <b>getCodeAssistServer</b>(<i></i>)
455
342 <p> 456 <p>
343 Public method to get a reference to the code assist server. 457 Public method to get a reference to the code assist server.
344 </p><dl> 458 </p>
459 <dl>
345 <dt>Returns:</dt> 460 <dt>Returns:</dt>
346 <dd> 461 <dd>
347 reference to the code assist server 462 reference to the code assist server
348 </dd> 463 </dd>
349 </dl><dl> 464 </dl>
465 <dl>
350 <dt>Return Type:</dt> 466 <dt>Return Type:</dt>
351 <dd> 467 <dd>
352 CodeAssistServer 468 CodeAssistServer
353 </dd> 469 </dd>
354 </dl><a NAME="RefactoringRopePlugin.getPreferences" ID="RefactoringRopePlugin.getPreferences"></a> 470 </dl>
471 <a NAME="RefactoringRopePlugin.getPreferences" ID="RefactoringRopePlugin.getPreferences"></a>
355 <h4>RefactoringRopePlugin.getPreferences</h4> 472 <h4>RefactoringRopePlugin.getPreferences</h4>
356 <b>getPreferences</b>(<i>key</i>) 473 <b>getPreferences</b>(<i>key</i>)
474
357 <p> 475 <p>
358 Public method to retrieve the various refactoring settings. 476 Public method to retrieve the various refactoring settings.
359 </p><dl> 477 </p>
478 <dl>
479
360 <dt><i>key</i> (str)</dt> 480 <dt><i>key</i> (str)</dt>
361 <dd> 481 <dd>
362 the key of the value to get 482 the key of the value to get
363 </dd> 483 </dd>
364 </dl><dl> 484 </dl>
485 <dl>
365 <dt>Returns:</dt> 486 <dt>Returns:</dt>
366 <dd> 487 <dd>
367 the requested refactoring setting 488 the requested refactoring setting
368 </dd> 489 </dd>
369 </dl><a NAME="RefactoringRopePlugin.setPreferences" ID="RefactoringRopePlugin.setPreferences"></a> 490 </dl>
491 <a NAME="RefactoringRopePlugin.setPreferences" ID="RefactoringRopePlugin.setPreferences"></a>
370 <h4>RefactoringRopePlugin.setPreferences</h4> 492 <h4>RefactoringRopePlugin.setPreferences</h4>
371 <b>setPreferences</b>(<i>key, value</i>) 493 <b>setPreferences</b>(<i>key, value</i>)
494
372 <p> 495 <p>
373 Public method to store the various refactoring settings. 496 Public method to store the various refactoring settings.
374 </p><dl> 497 </p>
498 <dl>
499
375 <dt><i>key</i> (str)</dt> 500 <dt><i>key</i> (str)</dt>
376 <dd> 501 <dd>
377 the key of the setting to be set 502 the key of the setting to be set
378 </dd><dt><i>value</i></dt> 503 </dd>
504 <dt><i>value</i></dt>
379 <dd> 505 <dd>
380 the value to be set 506 the value to be set
381 </dd> 507 </dd>
382 </dl> 508 </dl>
383 <div align="right"><a href="#top">Up</a></div> 509 <div align="right"><a href="#top">Up</a></div>
384 <hr /><hr /> 510 <hr />
511 <hr />
385 <a NAME="createAutoCompletionPage" ID="createAutoCompletionPage"></a> 512 <a NAME="createAutoCompletionPage" ID="createAutoCompletionPage"></a>
386 <h2>createAutoCompletionPage</h2> 513 <h2>createAutoCompletionPage</h2>
387 <b>createAutoCompletionPage</b>(<i>configDlg</i>) 514 <b>createAutoCompletionPage</b>(<i>configDlg</i>)
515
388 <p> 516 <p>
389 Module function to create the autocompletion configuration page. 517 Module function to create the autocompletion configuration page.
390 </p><dl> 518 </p>
519 <dl>
520
391 <dt><i>configDlg</i></dt> 521 <dt><i>configDlg</i></dt>
392 <dd> 522 <dd>
393 reference to the configuration dialog 523 reference to the configuration dialog
394 </dd> 524 </dd>
395 </dl><dl> 525 </dl>
526 <dl>
396 <dt>Returns:</dt> 527 <dt>Returns:</dt>
397 <dd> 528 <dd>
398 reference to the configuration page 529 reference to the configuration page
399 </dd> 530 </dd>
400 </dl> 531 </dl>
401 <div align="right"><a href="#top">Up</a></div> 532 <div align="right"><a href="#top">Up</a></div>
402 <hr /><hr /> 533 <hr />
534 <hr />
403 <a NAME="createCallTipsPage" ID="createCallTipsPage"></a> 535 <a NAME="createCallTipsPage" ID="createCallTipsPage"></a>
404 <h2>createCallTipsPage</h2> 536 <h2>createCallTipsPage</h2>
405 <b>createCallTipsPage</b>(<i>configDlg</i>) 537 <b>createCallTipsPage</b>(<i>configDlg</i>)
538
406 <p> 539 <p>
407 Module function to create the calltips configuration page. 540 Module function to create the calltips configuration page.
408 </p><dl> 541 </p>
542 <dl>
543
409 <dt><i>configDlg</i></dt> 544 <dt><i>configDlg</i></dt>
410 <dd> 545 <dd>
411 reference to the configuration dialog 546 reference to the configuration dialog
412 </dd> 547 </dd>
413 </dl><dl> 548 </dl>
549 <dl>
414 <dt>Returns:</dt> 550 <dt>Returns:</dt>
415 <dd> 551 <dd>
416 reference to the configuration page 552 reference to the configuration page
417 </dd> 553 </dd>
418 </dl> 554 </dl>
419 <div align="right"><a href="#top">Up</a></div> 555 <div align="right"><a href="#top">Up</a></div>
420 <hr /><hr /> 556 <hr />
557 <hr />
421 <a NAME="createMouseClickHandlerPage" ID="createMouseClickHandlerPage"></a> 558 <a NAME="createMouseClickHandlerPage" ID="createMouseClickHandlerPage"></a>
422 <h2>createMouseClickHandlerPage</h2> 559 <h2>createMouseClickHandlerPage</h2>
423 <b>createMouseClickHandlerPage</b>(<i>configDlg</i>) 560 <b>createMouseClickHandlerPage</b>(<i>configDlg</i>)
561
424 <p> 562 <p>
425 Module function to create the mouse click handler configuration page. 563 Module function to create the mouse click handler configuration page.
426 </p><dl> 564 </p>
565 <dl>
566
427 <dt><i>configDlg</i></dt> 567 <dt><i>configDlg</i></dt>
428 <dd> 568 <dd>
429 reference to the configuration dialog 569 reference to the configuration dialog
430 </dd> 570 </dd>
431 </dl><dl> 571 </dl>
572 <dl>
432 <dt>Returns:</dt> 573 <dt>Returns:</dt>
433 <dd> 574 <dd>
434 reference to the configuration page 575 reference to the configuration page
435 </dd> 576 </dd>
436 </dl> 577 </dl>
437 <div align="right"><a href="#top">Up</a></div> 578 <div align="right"><a href="#top">Up</a></div>
438 <hr /><hr /> 579 <hr />
580 <hr />
439 <a NAME="getConfigData" ID="getConfigData"></a> 581 <a NAME="getConfigData" ID="getConfigData"></a>
440 <h2>getConfigData</h2> 582 <h2>getConfigData</h2>
441 <b>getConfigData</b>(<i></i>) 583 <b>getConfigData</b>(<i></i>)
584
442 <p> 585 <p>
443 Module function returning data as required by the configuration dialog. 586 Module function returning data as required by the configuration dialog.
444 </p><dl> 587 </p>
588 <dl>
445 <dt>Returns:</dt> 589 <dt>Returns:</dt>
446 <dd> 590 <dd>
447 dictionary containing the relevant data 591 dictionary containing the relevant data
448 </dd> 592 </dd>
449 </dl><dl> 593 </dl>
594 <dl>
450 <dt>Return Type:</dt> 595 <dt>Return Type:</dt>
451 <dd> 596 <dd>
452 dict 597 dict
453 </dd> 598 </dd>
454 </dl> 599 </dl>
455 <div align="right"><a href="#top">Up</a></div> 600 <div align="right"><a href="#top">Up</a></div>
456 <hr /><hr /> 601 <hr />
602 <hr />
457 <a NAME="prepareUninstall" ID="prepareUninstall"></a> 603 <a NAME="prepareUninstall" ID="prepareUninstall"></a>
458 <h2>prepareUninstall</h2> 604 <h2>prepareUninstall</h2>
459 <b>prepareUninstall</b>(<i></i>) 605 <b>prepareUninstall</b>(<i></i>)
606
460 <p> 607 <p>
461 Module function to prepare for an uninstallation. 608 Module function to prepare for an uninstallation.
462 </p> 609 </p>
463 <div align="right"><a href="#top">Up</a></div> 610 <div align="right"><a href="#top">Up</a></div>
464 <hr /> 611 <hr />

Mercurial Repository: Rope Refactoring

eric ide

mercurial