Mercurial Repositories > Rope Refactoring / file comparison

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

RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.CodeAssistServer.html

branch
server_client_variant
changeset 217
874115c79ca7
parent 214
ccc3918ac38c
child 232
65d7d745543d
equal deleted inserted replaced
216:47fb0119f0be 217:874115c79ca7
76 <td>Private method to handle exceptions of the refactoring client.</td> 76 <td>Private method to handle exceptions of the refactoring client.</td>
77 </tr><tr> 77 </tr><tr>
78 <td><a href="#CodeAssistServer.__processCompletionsResult">__processCompletionsResult</a></td> 78 <td><a href="#CodeAssistServer.__processCompletionsResult">__processCompletionsResult</a></td>
79 <td>Private method to process the completions sent by the client.</td> 79 <td>Private method to process the completions sent by the client.</td>
80 </tr><tr> 80 </tr><tr>
81 <td><a href="#CodeAssistServer.__processDocumentationResult">__processDocumentationResult</a></td>
82 <td>Private method to process the documentation sent by the client.</td>
83 </tr><tr>
81 <td><a href="#CodeAssistServer.__ropeConfigFile">__ropeConfigFile</a></td> 84 <td><a href="#CodeAssistServer.__ropeConfigFile">__ropeConfigFile</a></td>
82 <td>Private method to get the name of the rope configuration file.</td> 85 <td>Private method to get the name of the rope configuration file.</td>
83 </tr><tr> 86 </tr><tr>
84 <td><a href="#CodeAssistServer.__setAutoCompletionHook">__setAutoCompletionHook</a></td> 87 <td><a href="#CodeAssistServer.__setAutoCompletionHook">__setAutoCompletionHook</a></td>
85 <td>Private method to set the auto-completion hook.</td> 88 <td>Private method to set the auto-completion hook.</td>
132 <td><a href="#CodeAssistServer.isSupportedLanguage">isSupportedLanguage</a></td> 135 <td><a href="#CodeAssistServer.isSupportedLanguage">isSupportedLanguage</a></td>
133 <td>Public method to check, if the given language is supported.</td> 136 <td>Public method to check, if the given language is supported.</td>
134 </tr><tr> 137 </tr><tr>
135 <td><a href="#CodeAssistServer.reportChanged">reportChanged</a></td> 138 <td><a href="#CodeAssistServer.reportChanged">reportChanged</a></td>
136 <td>Public slot to report some changed sources.</td> 139 <td>Public slot to report some changed sources.</td>
140 </tr><tr>
141 <td><a href="#CodeAssistServer.requestCodeDocumentation">requestCodeDocumentation</a></td>
142 <td>Public method to request source code documentation for the given editor.</td>
137 </tr><tr> 143 </tr><tr>
138 <td><a href="#CodeAssistServer.requestCompletions">requestCompletions</a></td> 144 <td><a href="#CodeAssistServer.requestCompletions">requestCompletions</a></td>
139 <td>Public method to request a list of possible completions.</td> 145 <td>Public method to request a list of possible completions.</td>
140 </tr> 146 </tr>
141 </table> 147 </table>
172 <p> 178 <p>
173 Private method to ensure, that the requested client is active. 179 Private method to ensure, that the requested client is active.
174 </p><p> 180 </p><p>
175 A non-active client will be started. 181 A non-active client will be started.
176 </p><dl> 182 </p><dl>
183 <dt><i>idString</i> (str)</dt>
184 <dd>
185 id of the client to be checked
186 </dd>
187 </dl><dl>
177 <dt>Returns:</dt> 188 <dt>Returns:</dt>
178 <dd> 189 <dd>
179 flag indicating an active client 190 flag indicating an active client
180 </dd> 191 </dd>
181 </dl><dl> 192 </dl><dl>
216 </p><dl> 227 </p><dl>
217 <dt><i>result</i> (dict)</dt> 228 <dt><i>result</i> (dict)</dt>
218 <dd> 229 <dd>
219 dictionary containing the result sent by the client 230 dictionary containing the result sent by the client
220 </dd> 231 </dd>
232 </dl><a NAME="CodeAssistServer.__processDocumentationResult" ID="CodeAssistServer.__processDocumentationResult"></a>
233 <h4>CodeAssistServer.__processDocumentationResult</h4>
234 <b>__processDocumentationResult</b>(<i>result</i>)
235 <p>
236 Private method to process the documentation sent by the client.
237 </p><dl>
238 <dt><i>result</i> (dict)</dt>
239 <dd>
240 dictionary containing the result sent by the client
241 </dd>
221 </dl><a NAME="CodeAssistServer.__ropeConfigFile" ID="CodeAssistServer.__ropeConfigFile"></a> 242 </dl><a NAME="CodeAssistServer.__ropeConfigFile" ID="CodeAssistServer.__ropeConfigFile"></a>
222 <h4>CodeAssistServer.__ropeConfigFile</h4> 243 <h4>CodeAssistServer.__ropeConfigFile</h4>
223 <b>__ropeConfigFile</b>(<i>idString</i>) 244 <b>__ropeConfigFile</b>(<i>idString</i>)
224 <p> 245 <p>
225 Private method to get the name of the rope configuration file. 246 Private method to get the name of the rope configuration file.
242 <h4>CodeAssistServer.__setAutoCompletionHook</h4> 263 <h4>CodeAssistServer.__setAutoCompletionHook</h4>
243 <b>__setAutoCompletionHook</b>(<i>editor</i>) 264 <b>__setAutoCompletionHook</b>(<i>editor</i>)
244 <p> 265 <p>
245 Private method to set the auto-completion hook. 266 Private method to set the auto-completion hook.
246 </p><dl> 267 </p><dl>
247 <dt><i>editor</i> (QScintilla.Editor)</dt> 268 <dt><i>editor</i> (QScintilla.Editor.Editor)</dt>
248 <dd> 269 <dd>
249 reference to the editor 270 reference to the editor
250 </dd> 271 </dd>
251 </dl><a NAME="CodeAssistServer.__setCalltipsHook" ID="CodeAssistServer.__setCalltipsHook"></a> 272 </dl><a NAME="CodeAssistServer.__setCalltipsHook" ID="CodeAssistServer.__setCalltipsHook"></a>
252 <h4>CodeAssistServer.__setCalltipsHook</h4> 273 <h4>CodeAssistServer.__setCalltipsHook</h4>
253 <b>__setCalltipsHook</b>(<i>editor</i>) 274 <b>__setCalltipsHook</b>(<i>editor</i>)
254 <p> 275 <p>
255 Private method to set the calltip hook. 276 Private method to set the calltip hook.
256 </p><dl> 277 </p><dl>
257 <dt><i>editor</i> (QScintilla.Editor)</dt> 278 <dt><i>editor</i> (QScintilla.Editor.Editor)</dt>
258 <dd> 279 <dd>
259 reference to the editor 280 reference to the editor
260 </dd> 281 </dd>
261 </dl><a NAME="CodeAssistServer.__setConfig" ID="CodeAssistServer.__setConfig"></a> 282 </dl><a NAME="CodeAssistServer.__setConfig" ID="CodeAssistServer.__setConfig"></a>
262 <h4>CodeAssistServer.__setConfig</h4> 283 <h4>CodeAssistServer.__setConfig</h4>
296 <h4>CodeAssistServer.__unsetAutoCompletionHook</h4> 317 <h4>CodeAssistServer.__unsetAutoCompletionHook</h4>
297 <b>__unsetAutoCompletionHook</b>(<i>editor</i>) 318 <b>__unsetAutoCompletionHook</b>(<i>editor</i>)
298 <p> 319 <p>
299 Private method to unset the auto-completion hook. 320 Private method to unset the auto-completion hook.
300 </p><dl> 321 </p><dl>
301 <dt><i>editor</i> (QScintilla.Editor)</dt> 322 <dt><i>editor</i> (QScintilla.Editor.Editor)</dt>
302 <dd> 323 <dd>
303 reference to the editor 324 reference to the editor
304 </dd> 325 </dd>
305 </dl><a NAME="CodeAssistServer.__unsetCalltipsHook" ID="CodeAssistServer.__unsetCalltipsHook"></a> 326 </dl><a NAME="CodeAssistServer.__unsetCalltipsHook" ID="CodeAssistServer.__unsetCalltipsHook"></a>
306 <h4>CodeAssistServer.__unsetCalltipsHook</h4> 327 <h4>CodeAssistServer.__unsetCalltipsHook</h4>
307 <b>__unsetCalltipsHook</b>(<i>editor</i>) 328 <b>__unsetCalltipsHook</b>(<i>editor</i>)
308 <p> 329 <p>
309 Private method to unset the calltip hook. 330 Private method to unset the calltip hook.
310 </p><dl> 331 </p><dl>
311 <dt><i>editor</i> (QScintilla.Editor)</dt> 332 <dt><i>editor</i> (QScintilla.Editor.Editor)</dt>
312 <dd> 333 <dd>
313 reference to the editor 334 reference to the editor
314 </dd> 335 </dd>
315 </dl><a NAME="CodeAssistServer.__updateEditorLanguageMapping" ID="CodeAssistServer.__updateEditorLanguageMapping"></a> 336 </dl><a NAME="CodeAssistServer.__updateEditorLanguageMapping" ID="CodeAssistServer.__updateEditorLanguageMapping"></a>
316 <h4>CodeAssistServer.__updateEditorLanguageMapping</h4> 337 <h4>CodeAssistServer.__updateEditorLanguageMapping</h4>
320 </p><a NAME="CodeAssistServer.activate" ID="CodeAssistServer.activate"></a> 341 </p><a NAME="CodeAssistServer.activate" ID="CodeAssistServer.activate"></a>
321 <h4>CodeAssistServer.activate</h4> 342 <h4>CodeAssistServer.activate</h4>
322 <b>activate</b>(<i></i>) 343 <b>activate</b>(<i></i>)
323 <p> 344 <p>
324 Public method to activate the code assist server. 345 Public method to activate the code assist server.
325 </p><p>
326 Note: This method provides for some growth potential.
327 Currently it is empty.
328 </p><a NAME="CodeAssistServer.connectEditor" ID="CodeAssistServer.connectEditor"></a> 346 </p><a NAME="CodeAssistServer.connectEditor" ID="CodeAssistServer.connectEditor"></a>
329 <h4>CodeAssistServer.connectEditor</h4> 347 <h4>CodeAssistServer.connectEditor</h4>
330 <b>connectEditor</b>(<i>editor</i>) 348 <b>connectEditor</b>(<i>editor</i>)
331 <p> 349 <p>
332 Public method to connect an editor. 350 Public method to connect an editor.
333 </p><dl> 351 </p><dl>
334 <dt><i>editor</i> (QScintilla.Editor)</dt> 352 <dt><i>editor</i> (QScintilla.Editor.Editor)</dt>
335 <dd> 353 <dd>
336 reference to the editor 354 reference to the editor
337 </dd> 355 </dd>
338 </dl><a NAME="CodeAssistServer.deactivate" ID="CodeAssistServer.deactivate"></a> 356 </dl><a NAME="CodeAssistServer.deactivate" ID="CodeAssistServer.deactivate"></a>
339 <h4>CodeAssistServer.deactivate</h4> 357 <h4>CodeAssistServer.deactivate</h4>
344 <h4>CodeAssistServer.disconnectEditor</h4> 362 <h4>CodeAssistServer.disconnectEditor</h4>
345 <b>disconnectEditor</b>(<i>editor</i>) 363 <b>disconnectEditor</b>(<i>editor</i>)
346 <p> 364 <p>
347 Public method to disconnect an editor. 365 Public method to disconnect an editor.
348 </p><dl> 366 </p><dl>
349 <dt><i>editor</i> (QScintilla.Editor)</dt> 367 <dt><i>editor</i> (QScintilla.Editor.Editor)</dt>
350 <dd> 368 <dd>
351 reference to the editor 369 reference to the editor
352 </dd> 370 </dd>
353 </dl><a NAME="CodeAssistServer.editConfig" ID="CodeAssistServer.editConfig"></a> 371 </dl><a NAME="CodeAssistServer.editConfig" ID="CodeAssistServer.editConfig"></a>
354 <h4>CodeAssistServer.editConfig</h4> 372 <h4>CodeAssistServer.editConfig</h4>
364 <h4>CodeAssistServer.getCallTips</h4> 382 <h4>CodeAssistServer.getCallTips</h4>
365 <b>getCallTips</b>(<i>editor, pos, commas</i>) 383 <b>getCallTips</b>(<i>editor, pos, commas</i>)
366 <p> 384 <p>
367 Public method to calculate calltips. 385 Public method to calculate calltips.
368 </p><dl> 386 </p><dl>
369 <dt><i>editor</i> (QScintilla.Editor)</dt> 387 <dt><i>editor</i> (QScintilla.Editor.Editor)</dt>
370 <dd> 388 <dd>
371 reference to the editor object, that called this method 389 reference to the editor object, that called this method
372 </dd><dt><i>pos</i> (int)</dt> 390 </dd><dt><i>pos</i> (int)</dt>
373 <dd> 391 <dd>
374 position in the text for the calltip 392 position in the text for the calltip
392 <p> 410 <p>
393 Public method to calculate the possible completions. 411 Public method to calculate the possible completions.
394 </p><p> 412 </p><p>
395 Note: This is the synchronous variant for eric6 before 17.11. 413 Note: This is the synchronous variant for eric6 before 17.11.
396 </p><dl> 414 </p><dl>
397 <dt><i>editor</i> (QScintilla.Editor)</dt> 415 <dt><i>editor</i> (QScintilla.Editor.Editor)</dt>
398 <dd> 416 <dd>
399 reference to the editor object, that called this method 417 reference to the editor object, that called this method
400 </dd><dt><i>context</i> (bool)</dt> 418 </dd><dt><i>context</i> (bool)</dt>
401 <dd> 419 <dd>
402 flag indicating to autocomplete a context 420 flag indicating to autocomplete a context
460 file name of the changed source 478 file name of the changed source
461 </dd><dt><i>oldSource</i> (str)</dt> 479 </dd><dt><i>oldSource</i> (str)</dt>
462 <dd> 480 <dd>
463 source code before the change 481 source code before the change
464 </dd> 482 </dd>
483 </dl><a NAME="CodeAssistServer.requestCodeDocumentation" ID="CodeAssistServer.requestCodeDocumentation"></a>
484 <h4>CodeAssistServer.requestCodeDocumentation</h4>
485 <b>requestCodeDocumentation</b>(<i>editor</i>)
486 <p>
487 Public method to request source code documentation for the given
488 editor.
489 </p><dl>
490 <dt><i>editor</i> (QScintilla.Editor.Editor)</dt>
491 <dd>
492 reference to the editor to get source code documentation
493 for
494 </dd>
465 </dl><a NAME="CodeAssistServer.requestCompletions" ID="CodeAssistServer.requestCompletions"></a> 495 </dl><a NAME="CodeAssistServer.requestCompletions" ID="CodeAssistServer.requestCompletions"></a>
466 <h4>CodeAssistServer.requestCompletions</h4> 496 <h4>CodeAssistServer.requestCompletions</h4>
467 <b>requestCompletions</b>(<i>editor, context, acText</i>) 497 <b>requestCompletions</b>(<i>editor, context, acText</i>)
468 <p> 498 <p>
469 Public method to request a list of possible completions. 499 Public method to request a list of possible completions.
470 </p><p> 500 </p><p>
471 Note: This is part of the asynchronous variant for eric6 17.11 and 501 Note: This is part of the asynchronous variant for eric6 17.11 and
472 later. 502 later.
473 </p><dl> 503 </p><dl>
474 <dt><i>editor</i> (QScintilla.Editor)</dt> 504 <dt><i>editor</i> (QScintilla.Editor.Editor)</dt>
475 <dd> 505 <dd>
476 reference to the editor object, that called this method 506 reference to the editor object, that called this method
477 </dd><dt><i>context</i> (bool)</dt> 507 </dd><dt><i>context</i> (bool)</dt>
478 <dd> 508 <dd>
479 flag indicating to autocomplete a context 509 flag indicating to autocomplete a context

Mercurial Repository: Rope Refactoring

eric ide

mercurial