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

changeset 283
d98e971d9e4c
parent 232
65d7d745543d
child 285
247d62c682dc
equal deleted inserted replaced
282:ccb5c268df65 283:d98e971d9e4c
46 </p> 46 </p>
47 <h3>Derived from</h3> 47 <h3>Derived from</h3>
48 JsonServer 48 JsonServer
49 <h3>Class Attributes</h3> 49 <h3>Class Attributes</h3>
50 <table> 50 <table>
51 <tr><td>None</td></tr> 51 <tr><td>IdProject</td></tr>
52 </table> 52 </table>
53 <h3>Class Methods</h3> 53 <h3>Class Methods</h3>
54 <table> 54 <table>
55 <tr><td>None</td></tr> 55 <tr><td>None</td></tr>
56 </table> 56 </table>
67 <td>Private method to ensure, that the requested client is active.</td> 67 <td>Private method to ensure, that the requested client is active.</td>
68 </tr><tr> 68 </tr><tr>
69 <td><a href="#CodeAssistServer.__getConfigs">__getConfigs</a></td> 69 <td><a href="#CodeAssistServer.__getConfigs">__getConfigs</a></td>
70 <td>Private method to get the configurations of all connected clients.</td> 70 <td>Private method to get the configurations of all connected clients.</td>
71 </tr><tr> 71 </tr><tr>
72 <td><a href="#CodeAssistServer.__idString">__idString</a></td>
73 <td>Private method to determine the ID string for the back-end.</td>
74 </tr><tr>
75 <td><a href="#CodeAssistServer.__interpreterForProject">__interpreterForProject</a></td>
76 <td>Private method to determine the interpreter for the current project.</td>
77 </tr><tr>
72 <td><a href="#CodeAssistServer.__processCallTipsResult">__processCallTipsResult</a></td> 78 <td><a href="#CodeAssistServer.__processCallTipsResult">__processCallTipsResult</a></td>
73 <td>Private method to process the calltips sent by the client.</td> 79 <td>Private method to process the calltips sent by the client.</td>
74 </tr><tr> 80 </tr><tr>
75 <td><a href="#CodeAssistServer.__processClientException">__processClientException</a></td> 81 <td><a href="#CodeAssistServer.__processClientException">__processClientException</a></td>
76 <td>Private method to handle exceptions of the refactoring client.</td> 82 <td>Private method to handle exceptions of the refactoring client.</td>
78 <td><a href="#CodeAssistServer.__processCompletionsResult">__processCompletionsResult</a></td> 84 <td><a href="#CodeAssistServer.__processCompletionsResult">__processCompletionsResult</a></td>
79 <td>Private method to process the completions sent by the client.</td> 85 <td>Private method to process the completions sent by the client.</td>
80 </tr><tr> 86 </tr><tr>
81 <td><a href="#CodeAssistServer.__processDocumentationResult">__processDocumentationResult</a></td> 87 <td><a href="#CodeAssistServer.__processDocumentationResult">__processDocumentationResult</a></td>
82 <td>Private method to process the documentation sent by the client.</td> 88 <td>Private method to process the documentation sent by the client.</td>
89 </tr><tr>
90 <td><a href="#CodeAssistServer.__projectClosed">__projectClosed</a></td>
91 <td>Private slot to handle the projectClosed signal.</td>
83 </tr><tr> 92 </tr><tr>
84 <td><a href="#CodeAssistServer.__ropeConfigFile">__ropeConfigFile</a></td> 93 <td><a href="#CodeAssistServer.__ropeConfigFile">__ropeConfigFile</a></td>
85 <td>Private method to get the name of the rope configuration file.</td> 94 <td>Private method to get the name of the rope configuration file.</td>
86 </tr><tr> 95 </tr><tr>
87 <td><a href="#CodeAssistServer.__setAutoCompletionHook">__setAutoCompletionHook</a></td> 96 <td><a href="#CodeAssistServer.__setAutoCompletionHook">__setAutoCompletionHook</a></td>
197 </dl><a NAME="CodeAssistServer.__getConfigs" ID="CodeAssistServer.__getConfigs"></a> 206 </dl><a NAME="CodeAssistServer.__getConfigs" ID="CodeAssistServer.__getConfigs"></a>
198 <h4>CodeAssistServer.__getConfigs</h4> 207 <h4>CodeAssistServer.__getConfigs</h4>
199 <b>__getConfigs</b>(<i></i>) 208 <b>__getConfigs</b>(<i></i>)
200 <p> 209 <p>
201 Private method to get the configurations of all connected clients. 210 Private method to get the configurations of all connected clients.
202 </p><a NAME="CodeAssistServer.__processCallTipsResult" ID="CodeAssistServer.__processCallTipsResult"></a> 211 </p><a NAME="CodeAssistServer.__idString" ID="CodeAssistServer.__idString"></a>
212 <h4>CodeAssistServer.__idString</h4>
213 <b>__idString</b>(<i>editor</i>)
214 <p>
215 Private method to determine the ID string for the back-end.
216 </p><dl>
217 <dt><i>editor</i> (QScintilla.Editor)</dt>
218 <dd>
219 reference to the editor to determine the ID string for
220 </dd>
221 </dl><dl>
222 <dt>Returns:</dt>
223 <dd>
224 ID string
225 </dd>
226 </dl><dl>
227 <dt>Return Type:</dt>
228 <dd>
229 str
230 </dd>
231 </dl><a NAME="CodeAssistServer.__interpreterForProject" ID="CodeAssistServer.__interpreterForProject"></a>
232 <h4>CodeAssistServer.__interpreterForProject</h4>
233 <b>__interpreterForProject</b>(<i></i>)
234 <p>
235 Private method to determine the interpreter for the current project.
236 </p><dl>
237 <dt>Returns:</dt>
238 <dd>
239 interpreter of the current project
240 </dd>
241 </dl><dl>
242 <dt>Return Type:</dt>
243 <dd>
244 str
245 </dd>
246 </dl><a NAME="CodeAssistServer.__processCallTipsResult" ID="CodeAssistServer.__processCallTipsResult"></a>
203 <h4>CodeAssistServer.__processCallTipsResult</h4> 247 <h4>CodeAssistServer.__processCallTipsResult</h4>
204 <b>__processCallTipsResult</b>(<i>result</i>) 248 <b>__processCallTipsResult</b>(<i>result</i>)
205 <p> 249 <p>
206 Private method to process the calltips sent by the client. 250 Private method to process the calltips sent by the client.
207 </p><dl> 251 </p><dl>
237 </p><dl> 281 </p><dl>
238 <dt><i>result</i> (dict with keys 'name', 'argspec', 'note', 'docstring', 'typ')</dt> 282 <dt><i>result</i> (dict with keys 'name', 'argspec', 'note', 'docstring', 'typ')</dt>
239 <dd> 283 <dd>
240 dictionary containing the result sent by the client 284 dictionary containing the result sent by the client
241 </dd> 285 </dd>
242 </dl><a NAME="CodeAssistServer.__ropeConfigFile" ID="CodeAssistServer.__ropeConfigFile"></a> 286 </dl><a NAME="CodeAssistServer.__projectClosed" ID="CodeAssistServer.__projectClosed"></a>
287 <h4>CodeAssistServer.__projectClosed</h4>
288 <b>__projectClosed</b>(<i></i>)
289 <p>
290 Private slot to handle the projectClosed signal.
291 </p><a NAME="CodeAssistServer.__ropeConfigFile" ID="CodeAssistServer.__ropeConfigFile"></a>
243 <h4>CodeAssistServer.__ropeConfigFile</h4> 292 <h4>CodeAssistServer.__ropeConfigFile</h4>
244 <b>__ropeConfigFile</b>(<i>idString</i>) 293 <b>__ropeConfigFile</b>(<i>idString</i>)
245 <p> 294 <p>
246 Private method to get the name of the rope configuration file. 295 Private method to get the name of the rope configuration file.
247 </p><dl> 296 </p><dl>

eric ide

mercurial