Mercurial Repositories > Rope Refactoring / file comparison

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

RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.PluginRefactoringRope.html

branch
server_client_variant
changeset 214
ccc3918ac38c
parent 204
b4bf79b956bc
child 217
874115c79ca7
equal deleted inserted replaced
213:2547dd1627b3 214:ccc3918ac38c
76 <td>Constructor</td> 76 <td>Constructor</td>
77 </tr><tr> 77 </tr><tr>
78 <td><a href="#RefactoringRopePlugin.__connectEditor">__connectEditor</a></td> 78 <td><a href="#RefactoringRopePlugin.__connectEditor">__connectEditor</a></td>
79 <td>Private method to connect an editor.</td> 79 <td>Private method to connect an editor.</td>
80 </tr><tr> 80 </tr><tr>
81 <td><a href="#RefactoringRopePlugin.__connectMouseClickHandler">__connectMouseClickHandler</a></td>
82 <td>Private method to connect the mouse click handler to an editor.</td>
83 </tr><tr>
84 <td><a href="#RefactoringRopePlugin.__disconnectEditor">__disconnectEditor</a></td> 81 <td><a href="#RefactoringRopePlugin.__disconnectEditor">__disconnectEditor</a></td>
85 <td>Private method to disconnect an editor.</td> 82 <td>Private method to disconnect an editor.</td>
86 </tr><tr> 83 </tr><tr>
87 <td><a href="#RefactoringRopePlugin.__disconnectMouseClickHandler">__disconnectMouseClickHandler</a></td>
88 <td>Private method to disconnect the mouse click handler from an editor.</td>
89 </tr><tr>
90 <td><a href="#RefactoringRopePlugin.__editorAboutToBeSaved">__editorAboutToBeSaved</a></td> 84 <td><a href="#RefactoringRopePlugin.__editorAboutToBeSaved">__editorAboutToBeSaved</a></td>
91 <td>Private slot to get the old contents of the named file.</td> 85 <td>Private slot to get the old contents of the named file.</td>
92 </tr><tr> 86 </tr><tr>
93 <td><a href="#RefactoringRopePlugin.__editorClosed">__editorClosed</a></td> 87 <td><a href="#RefactoringRopePlugin.__editorClosed">__editorClosed</a></td>
94 <td>Private slot called, when an editor was closed.</td> 88 <td>Private slot called, when an editor was closed.</td>
106 <td>Private slot to (re)initialize the plugin.</td> 100 <td>Private slot to (re)initialize the plugin.</td>
107 </tr><tr> 101 </tr><tr>
108 <td><a href="#RefactoringRopePlugin.__loadTranslator">__loadTranslator</a></td> 102 <td><a href="#RefactoringRopePlugin.__loadTranslator">__loadTranslator</a></td>
109 <td>Private method to load the translation file.</td> 103 <td>Private method to load the translation file.</td>
110 </tr><tr> 104 </tr><tr>
111 <td><a href="#RefactoringRopePlugin.__setAutoCompletionHook">__setAutoCompletionHook</a></td>
112 <td>Private method to set the autocompletion hook.</td>
113 </tr><tr>
114 <td><a href="#RefactoringRopePlugin.__setCalltipsHook">__setCalltipsHook</a></td>
115 <td>Private method to set the calltip hook.</td>
116 </tr><tr>
117 <td><a href="#RefactoringRopePlugin.__shutdown">__shutdown</a></td> 105 <td><a href="#RefactoringRopePlugin.__shutdown">__shutdown</a></td>
118 <td>Private slot handling the shutdown signal of the plug-in manager.</td> 106 <td>Private slot handling the shutdown signal of the plug-in manager.</td>
119 </tr><tr> 107 </tr><tr>
120 <td><a href="#RefactoringRopePlugin.__unsetAutoCompletionHook">__unsetAutoCompletionHook</a></td>
121 <td>Private method to unset the autocompletion hook.</td>
122 </tr><tr>
123 <td><a href="#RefactoringRopePlugin.__unsetCalltipsHook">__unsetCalltipsHook</a></td>
124 <td>Private method to unset the calltip hook.</td>
125 </tr><tr>
126 <td><a href="#RefactoringRopePlugin.activate">activate</a></td> 108 <td><a href="#RefactoringRopePlugin.activate">activate</a></td>
127 <td>Public method to activate this plugin.</td> 109 <td>Public method to activate this plugin.</td>
128 </tr><tr> 110 </tr><tr>
129 <td><a href="#RefactoringRopePlugin.codeAssistCallTip">codeAssistCallTip</a></td>
130 <td>Public method to return a list of calltips.</td>
131 </tr><tr>
132 <td><a href="#RefactoringRopePlugin.deactivate">deactivate</a></td> 111 <td><a href="#RefactoringRopePlugin.deactivate">deactivate</a></td>
133 <td>Public method to deactivate this plugin.</td> 112 <td>Public method to deactivate this plugin.</td>
134 </tr><tr> 113 </tr><tr>
135 <td><a href="#RefactoringRopePlugin.getCompletionsList">getCompletionsList</a></td> 114 <td><a href="#RefactoringRopePlugin.getCodeAssistServer">getCodeAssistServer</a></td>
136 <td>Public method to get a list of possible completions.</td> 115 <td>Public method to get a reference to the code assist server.</td>
137 </tr><tr> 116 </tr><tr>
138 <td><a href="#RefactoringRopePlugin.getPreferences">getPreferences</a></td> 117 <td><a href="#RefactoringRopePlugin.getPreferences">getPreferences</a></td>
139 <td>Public method to retrieve the various refactoring settings.</td> 118 <td>Public method to retrieve the various refactoring settings.</td>
140 </tr><tr> 119 </tr><tr>
141 <td><a href="#RefactoringRopePlugin.setPreferences">setPreferences</a></td> 120 <td><a href="#RefactoringRopePlugin.setPreferences">setPreferences</a></td>
164 </p><dl> 143 </p><dl>
165 <dt><i>editor</i> (QScintilla.Editor)</dt> 144 <dt><i>editor</i> (QScintilla.Editor)</dt>
166 <dd> 145 <dd>
167 reference to the editor 146 reference to the editor
168 </dd> 147 </dd>
169 </dl><a NAME="RefactoringRopePlugin.__connectMouseClickHandler" ID="RefactoringRopePlugin.__connectMouseClickHandler"></a>
170 <h4>RefactoringRopePlugin.__connectMouseClickHandler</h4>
171 <b>__connectMouseClickHandler</b>(<i>editor</i>)
172 <p>
173 Private method to connect the mouse click handler to an editor.
174 </p><dl>
175 <dt><i>editor</i> (QScintilla.Editor)</dt>
176 <dd>
177 reference to the editor
178 </dd>
179 </dl><a NAME="RefactoringRopePlugin.__disconnectEditor" ID="RefactoringRopePlugin.__disconnectEditor"></a> 148 </dl><a NAME="RefactoringRopePlugin.__disconnectEditor" ID="RefactoringRopePlugin.__disconnectEditor"></a>
180 <h4>RefactoringRopePlugin.__disconnectEditor</h4> 149 <h4>RefactoringRopePlugin.__disconnectEditor</h4>
181 <b>__disconnectEditor</b>(<i>editor</i>) 150 <b>__disconnectEditor</b>(<i>editor</i>)
182 <p> 151 <p>
183 Private method to disconnect an editor. 152 Private method to disconnect an editor.
184 </p><dl>
185 <dt><i>editor</i> (QScintilla.Editor)</dt>
186 <dd>
187 reference to the editor
188 </dd>
189 </dl><a NAME="RefactoringRopePlugin.__disconnectMouseClickHandler" ID="RefactoringRopePlugin.__disconnectMouseClickHandler"></a>
190 <h4>RefactoringRopePlugin.__disconnectMouseClickHandler</h4>
191 <b>__disconnectMouseClickHandler</b>(<i>editor</i>)
192 <p>
193 Private method to disconnect the mouse click handler from an editor.
194 </p><dl> 153 </p><dl>
195 <dt><i>editor</i> (QScintilla.Editor)</dt> 154 <dt><i>editor</i> (QScintilla.Editor)</dt>
196 <dd> 155 <dd>
197 reference to the editor 156 reference to the editor
198 </dd> 157 </dd>
254 </p><a NAME="RefactoringRopePlugin.__loadTranslator" ID="RefactoringRopePlugin.__loadTranslator"></a> 213 </p><a NAME="RefactoringRopePlugin.__loadTranslator" ID="RefactoringRopePlugin.__loadTranslator"></a>
255 <h4>RefactoringRopePlugin.__loadTranslator</h4> 214 <h4>RefactoringRopePlugin.__loadTranslator</h4>
256 <b>__loadTranslator</b>(<i></i>) 215 <b>__loadTranslator</b>(<i></i>)
257 <p> 216 <p>
258 Private method to load the translation file. 217 Private method to load the translation file.
259 </p><a NAME="RefactoringRopePlugin.__setAutoCompletionHook" ID="RefactoringRopePlugin.__setAutoCompletionHook"></a> 218 </p><a NAME="RefactoringRopePlugin.__shutdown" ID="RefactoringRopePlugin.__shutdown"></a>
260 <h4>RefactoringRopePlugin.__setAutoCompletionHook</h4>
261 <b>__setAutoCompletionHook</b>(<i>editor</i>)
262 <p>
263 Private method to set the autocompletion hook.
264 </p><dl>
265 <dt><i>editor</i> (QScintilla.Editor)</dt>
266 <dd>
267 reference to the editor
268 </dd>
269 </dl><a NAME="RefactoringRopePlugin.__setCalltipsHook" ID="RefactoringRopePlugin.__setCalltipsHook"></a>
270 <h4>RefactoringRopePlugin.__setCalltipsHook</h4>
271 <b>__setCalltipsHook</b>(<i>editor</i>)
272 <p>
273 Private method to set the calltip hook.
274 </p><dl>
275 <dt><i>editor</i> (QScintilla.Editor)</dt>
276 <dd>
277 reference to the editor
278 </dd>
279 </dl><a NAME="RefactoringRopePlugin.__shutdown" ID="RefactoringRopePlugin.__shutdown"></a>
280 <h4>RefactoringRopePlugin.__shutdown</h4> 219 <h4>RefactoringRopePlugin.__shutdown</h4>
281 <b>__shutdown</b>(<i></i>) 220 <b>__shutdown</b>(<i></i>)
282 <p> 221 <p>
283 Private slot handling the shutdown signal of the plug-in manager. 222 Private slot handling the shutdown signal of the plug-in manager.
284 </p><a NAME="RefactoringRopePlugin.__unsetAutoCompletionHook" ID="RefactoringRopePlugin.__unsetAutoCompletionHook"></a> 223 </p><a NAME="RefactoringRopePlugin.activate" ID="RefactoringRopePlugin.activate"></a>
285 <h4>RefactoringRopePlugin.__unsetAutoCompletionHook</h4>
286 <b>__unsetAutoCompletionHook</b>(<i>editor</i>)
287 <p>
288 Private method to unset the autocompletion hook.
289 </p><dl>
290 <dt><i>editor</i> (QScintilla.Editor)</dt>
291 <dd>
292 reference to the editor
293 </dd>
294 </dl><a NAME="RefactoringRopePlugin.__unsetCalltipsHook" ID="RefactoringRopePlugin.__unsetCalltipsHook"></a>
295 <h4>RefactoringRopePlugin.__unsetCalltipsHook</h4>
296 <b>__unsetCalltipsHook</b>(<i>editor</i>)
297 <p>
298 Private method to unset the calltip hook.
299 </p><dl>
300 <dt><i>editor</i> (QScintilla.Editor)</dt>
301 <dd>
302 reference to the editor
303 </dd>
304 </dl><a NAME="RefactoringRopePlugin.activate" ID="RefactoringRopePlugin.activate"></a>
305 <h4>RefactoringRopePlugin.activate</h4> 224 <h4>RefactoringRopePlugin.activate</h4>
306 <b>activate</b>(<i></i>) 225 <b>activate</b>(<i></i>)
307 <p> 226 <p>
308 Public method to activate this plugin. 227 Public method to activate this plugin.
309 </p><dl> 228 </p><dl>
313 </dd> 232 </dd>
314 </dl><dl> 233 </dl><dl>
315 <dt>Return Type:</dt> 234 <dt>Return Type:</dt>
316 <dd> 235 <dd>
317 tuple of (None, bool) 236 tuple of (None, bool)
318 </dd>
319 </dl><a NAME="RefactoringRopePlugin.codeAssistCallTip" ID="RefactoringRopePlugin.codeAssistCallTip"></a>
320 <h4>RefactoringRopePlugin.codeAssistCallTip</h4>
321 <b>codeAssistCallTip</b>(<i>editor, pos, commas</i>)
322 <p>
323 Public method to return a list of calltips.
324 </p><dl>
325 <dt><i>editor</i> (QScintilla.Editor)</dt>
326 <dd>
327 reference to the editor
328 </dd><dt><i>pos</i> (int)</dt>
329 <dd>
330 position in the text for the calltip
331 </dd><dt><i>commas</i> (int)</dt>
332 <dd>
333 minimum number of commas contained in the calltip
334 </dd>
335 </dl><dl>
336 <dt>Returns:</dt>
337 <dd>
338 list of possible calltips
339 </dd>
340 </dl><dl>
341 <dt>Return Type:</dt>
342 <dd>
343 list of str
344 </dd> 237 </dd>
345 </dl><a NAME="RefactoringRopePlugin.deactivate" ID="RefactoringRopePlugin.deactivate"></a> 238 </dl><a NAME="RefactoringRopePlugin.deactivate" ID="RefactoringRopePlugin.deactivate"></a>
346 <h4>RefactoringRopePlugin.deactivate</h4> 239 <h4>RefactoringRopePlugin.deactivate</h4>
347 <b>deactivate</b>(<i></i>) 240 <b>deactivate</b>(<i></i>)
348 <p> 241 <p>
349 Public method to deactivate this plugin. 242 Public method to deactivate this plugin.
350 </p><a NAME="RefactoringRopePlugin.getCompletionsList" ID="RefactoringRopePlugin.getCompletionsList"></a> 243 </p><a NAME="RefactoringRopePlugin.getCodeAssistServer" ID="RefactoringRopePlugin.getCodeAssistServer"></a>
351 <h4>RefactoringRopePlugin.getCompletionsList</h4> 244 <h4>RefactoringRopePlugin.getCodeAssistServer</h4>
352 <b>getCompletionsList</b>(<i>editor, context</i>) 245 <b>getCodeAssistServer</b>(<i></i>)
353 <p> 246 <p>
354 Public method to get a list of possible completions. 247 Public method to get a reference to the code assist server.
355 </p><dl> 248 </p><dl>
356 <dt><i>editor</i> (QScintilla.Editor)</dt> 249 <dt>Returns:</dt>
357 <dd> 250 <dd>
358 reference to the editor object, that called this method 251 reference to the code assist server
359 </dd><dt><i>context</i> (bool)</dt>
360 <dd>
361 flag indicating to autocomplete a context
362 </dd>
363 </dl><dl>
364 <dt>Returns:</dt>
365 <dd>
366 list of possible completions
367 </dd> 252 </dd>
368 </dl><dl> 253 </dl><dl>
369 <dt>Return Type:</dt> 254 <dt>Return Type:</dt>
370 <dd> 255 <dd>
371 list of str 256 CodeAssistServer
372 </dd> 257 </dd>
373 </dl><a NAME="RefactoringRopePlugin.getPreferences" ID="RefactoringRopePlugin.getPreferences"></a> 258 </dl><a NAME="RefactoringRopePlugin.getPreferences" ID="RefactoringRopePlugin.getPreferences"></a>
374 <h4>RefactoringRopePlugin.getPreferences</h4> 259 <h4>RefactoringRopePlugin.getPreferences</h4>
375 <b>getPreferences</b>(<i>key</i>) 260 <b>getPreferences</b>(<i>key</i>)
376 <p> 261 <p>

Mercurial Repository: Rope Refactoring

eric ide

mercurial