Mercurial Repositories > Rope Refactoring / file comparison

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

RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.CodeAssistClient.html

branch
eric7
changeset 416
45159308166f
parent 375
c61a2f18ed78
equal deleted inserted replaced
415:78af27bb8201 416:45159308166f
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>Plugin_Refactoring_Rope.RefactoringRope.CodeAssistClient</h1> 9 <h1>Plugin_Refactoring_Rope.RefactoringRope.CodeAssistClient</h1>
10
11 <p> 10 <p>
12 Module implementing the code assist client interface to rope. 11 Module implementing the code assist client interface to rope.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15 15 <table>
16 <table> 16 <tr><td>QCoreApplication</td></tr>
17 <tr><td>app</td></tr>
18 <tr><td>client</td></tr>
17 <tr><td>modulePath</td></tr> 19 <tr><td>modulePath</td></tr>
18 </table> 20 </table>
21
19 <h3>Classes</h3> 22 <h3>Classes</h3>
20 23 <table>
21 <table>
22
23 <tr> 24 <tr>
24 <td><a href="#CodeAssistClient">CodeAssistClient</a></td> 25 <td><a href="#CodeAssistClient">CodeAssistClient</a></td>
25 <td>Class implementing the code assist client interface to rope.</td> 26 <td>Class implementing the code assist client interface to rope.</td>
26 </tr> 27 </tr>
27 </table> 28 </table>
29
28 <h3>Functions</h3> 30 <h3>Functions</h3>
29
30 <table> 31 <table>
31 <tr><td>None</td></tr> 32 <tr><td>None</td></tr>
32 </table> 33 </table>
34
33 <hr /> 35 <hr />
34 <hr /> 36 <hr />
35 <a NAME="CodeAssistClient" ID="CodeAssistClient"></a> 37 <a NAME="CodeAssistClient" ID="CodeAssistClient"></a>
36 <h2>CodeAssistClient</h2> 38 <h2>CodeAssistClient</h2>
37
38 <p> 39 <p>
39 Class implementing the code assist client interface to rope. 40 Class implementing the code assist client interface to rope.
40 </p> 41 </p>
42
41 <h3>Derived from</h3> 43 <h3>Derived from</h3>
42 EricJsonClient 44 EricJsonClient
43 <h3>Class Attributes</h3> 45 <h3>Class Attributes</h3>
44
45 <table> 46 <table>
46 <tr><td>IdProject</td></tr> 47 <tr><td>IdProject</td></tr>
47 </table> 48 </table>
49
48 <h3>Class Methods</h3> 50 <h3>Class Methods</h3>
49
50 <table> 51 <table>
51 <tr><td>None</td></tr> 52 <tr><td>None</td></tr>
52 </table> 53 </table>
54
53 <h3>Methods</h3> 55 <h3>Methods</h3>
54 56 <table>
55 <table>
56
57 <tr> 57 <tr>
58 <td><a href="#CodeAssistClient.__init__">CodeAssistClient</a></td> 58 <td><a href="#CodeAssistClient.__init__">CodeAssistClient</a></td>
59 <td>Constructor</td> 59 <td>Constructor</td>
60 </tr> 60 </tr>
61 <tr> 61 <tr>
109 <tr> 109 <tr>
110 <td><a href="#CodeAssistClient.handleCall">handleCall</a></td> 110 <td><a href="#CodeAssistClient.handleCall">handleCall</a></td>
111 <td>Public method to handle a method call from the server.</td> 111 <td>Public method to handle a method call from the server.</td>
112 </tr> 112 </tr>
113 </table> 113 </table>
114
114 <h3>Static Methods</h3> 115 <h3>Static Methods</h3>
115
116 <table> 116 <table>
117 <tr><td>None</td></tr> 117 <tr><td>None</td></tr>
118 </table> 118 </table>
119
119 120
120 <a NAME="CodeAssistClient.__init__" ID="CodeAssistClient.__init__"></a> 121 <a NAME="CodeAssistClient.__init__" ID="CodeAssistClient.__init__"></a>
121 <h4>CodeAssistClient (Constructor)</h4> 122 <h4>CodeAssistClient (Constructor)</h4>
122 <b>CodeAssistClient</b>(<i>host, port, idString, projectPath</i>) 123 <b>CodeAssistClient</b>(<i>host, port, idString, projectPath</i>)
123
124 <p> 124 <p>
125 Constructor 125 Constructor
126 </p> 126 </p>
127
127 <dl> 128 <dl>
128 129
129 <dt><i>host</i> (str)</dt> 130 <dt><i>host</i> (str)</dt>
130 <dd> 131 <dd>
131 ip address the background service is listening 132 ip address the background service is listening
145 </dd> 146 </dd>
146 </dl> 147 </dl>
147 <a NAME="CodeAssistClient.__closeProject" ID="CodeAssistClient.__closeProject"></a> 148 <a NAME="CodeAssistClient.__closeProject" ID="CodeAssistClient.__closeProject"></a>
148 <h4>CodeAssistClient.__closeProject</h4> 149 <h4>CodeAssistClient.__closeProject</h4>
149 <b>__closeProject</b>(<i>params</i>) 150 <b>__closeProject</b>(<i>params</i>)
150
151 <p> 151 <p>
152 Private slot to validate the project. 152 Private slot to validate the project.
153 </p> 153 </p>
154
154 <dl> 155 <dl>
155 156
156 <dt><i>params</i> (dict)</dt> 157 <dt><i>params</i> (dict)</dt>
157 <dd> 158 <dd>
158 dictionary containing the method parameters sent by 159 dictionary containing the method parameters sent by
160 </dd> 161 </dd>
161 </dl> 162 </dl>
162 <a NAME="CodeAssistClient.__configChanged" ID="CodeAssistClient.__configChanged"></a> 163 <a NAME="CodeAssistClient.__configChanged" ID="CodeAssistClient.__configChanged"></a>
163 <h4>CodeAssistClient.__configChanged</h4> 164 <h4>CodeAssistClient.__configChanged</h4>
164 <b>__configChanged</b>(<i>params</i>) 165 <b>__configChanged</b>(<i>params</i>)
165
166 <p> 166 <p>
167 Private method to handle a change of the configuration file. 167 Private method to handle a change of the configuration file.
168 </p> 168 </p>
169
169 <dl> 170 <dl>
170 171
171 <dt><i>params</i> (dict)</dt> 172 <dt><i>params</i> (dict)</dt>
172 <dd> 173 <dd>
173 dictionary containing the method parameters sent by 174 dictionary containing the method parameters sent by
175 </dd> 176 </dd>
176 </dl> 177 </dl>
177 <a NAME="CodeAssistClient.__getCallTips" ID="CodeAssistClient.__getCallTips"></a> 178 <a NAME="CodeAssistClient.__getCallTips" ID="CodeAssistClient.__getCallTips"></a>
178 <h4>CodeAssistClient.__getCallTips</h4> 179 <h4>CodeAssistClient.__getCallTips</h4>
179 <b>__getCallTips</b>(<i>params</i>) 180 <b>__getCallTips</b>(<i>params</i>)
180
181 <p> 181 <p>
182 Private method to calculate possible calltips. 182 Private method to calculate possible calltips.
183 </p> 183 </p>
184
184 <dl> 185 <dl>
185 186
186 <dt><i>params</i> (dict)</dt> 187 <dt><i>params</i> (dict)</dt>
187 <dd> 188 <dd>
188 dictionary containing the method parameters 189 dictionary containing the method parameters
189 </dd> 190 </dd>
190 </dl> 191 </dl>
191 <a NAME="CodeAssistClient.__getCompletions" ID="CodeAssistClient.__getCompletions"></a> 192 <a NAME="CodeAssistClient.__getCompletions" ID="CodeAssistClient.__getCompletions"></a>
192 <h4>CodeAssistClient.__getCompletions</h4> 193 <h4>CodeAssistClient.__getCompletions</h4>
193 <b>__getCompletions</b>(<i>params</i>) 194 <b>__getCompletions</b>(<i>params</i>)
194
195 <p> 195 <p>
196 Private method to calculate possible completions. 196 Private method to calculate possible completions.
197 </p> 197 </p>
198
198 <dl> 199 <dl>
199 200
200 <dt><i>params</i> (dict)</dt> 201 <dt><i>params</i> (dict)</dt>
201 <dd> 202 <dd>
202 dictionary containing the method parameters 203 dictionary containing the method parameters
203 </dd> 204 </dd>
204 </dl> 205 </dl>
205 <a NAME="CodeAssistClient.__getConfig" ID="CodeAssistClient.__getConfig"></a> 206 <a NAME="CodeAssistClient.__getConfig" ID="CodeAssistClient.__getConfig"></a>
206 <h4>CodeAssistClient.__getConfig</h4> 207 <h4>CodeAssistClient.__getConfig</h4>
207 <b>__getConfig</b>(<i>params</i>) 208 <b>__getConfig</b>(<i>params</i>)
208
209 <p> 209 <p>
210 Private method to send some configuration data to the server. 210 Private method to send some configuration data to the server.
211 </p> 211 </p>
212
212 <dl> 213 <dl>
213 214
214 <dt><i>params</i> (dict)</dt> 215 <dt><i>params</i> (dict)</dt>
215 <dd> 216 <dd>
216 dictionary containing the method parameters sent by 217 dictionary containing the method parameters sent by
218 </dd> 219 </dd>
219 </dl> 220 </dl>
220 <a NAME="CodeAssistClient.__getDocumentation" ID="CodeAssistClient.__getDocumentation"></a> 221 <a NAME="CodeAssistClient.__getDocumentation" ID="CodeAssistClient.__getDocumentation"></a>
221 <h4>CodeAssistClient.__getDocumentation</h4> 222 <h4>CodeAssistClient.__getDocumentation</h4>
222 <b>__getDocumentation</b>(<i>params</i>) 223 <b>__getDocumentation</b>(<i>params</i>)
223
224 <p> 224 <p>
225 Private method to get some source code documentation. 225 Private method to get some source code documentation.
226 </p> 226 </p>
227
227 <dl> 228 <dl>
228 229
229 <dt><i>params</i> (dict)</dt> 230 <dt><i>params</i> (dict)</dt>
230 <dd> 231 <dd>
231 dictionary containing the method parameters 232 dictionary containing the method parameters
232 </dd> 233 </dd>
233 </dl> 234 </dl>
234 <a NAME="CodeAssistClient.__getObjectTypeAndName" ID="CodeAssistClient.__getObjectTypeAndName"></a> 235 <a NAME="CodeAssistClient.__getObjectTypeAndName" ID="CodeAssistClient.__getObjectTypeAndName"></a>
235 <h4>CodeAssistClient.__getObjectTypeAndName</h4> 236 <h4>CodeAssistClient.__getObjectTypeAndName</h4>
236 <b>__getObjectTypeAndName</b>(<i>project, sourceCode, offset, resource=None, maxfixes=1</i>) 237 <b>__getObjectTypeAndName</b>(<i>project, sourceCode, offset, resource=None, maxfixes=1</i>)
237
238 <p> 238 <p>
239 Private method to determine an object type and name for the given 239 Private method to determine an object type and name for the given
240 location. 240 location.
241 </p> 241 </p>
242
242 <dl> 243 <dl>
243 244
244 <dt><i>project</i> (rope.base.project.Project)</dt> 245 <dt><i>project</i> (rope.base.project.Project)</dt>
245 <dd> 246 <dd>
246 reference to the rope project object 247 reference to the rope project object
275 </dd> 276 </dd>
276 </dl> 277 </dl>
277 <a NAME="CodeAssistClient.__getReferences" ID="CodeAssistClient.__getReferences"></a> 278 <a NAME="CodeAssistClient.__getReferences" ID="CodeAssistClient.__getReferences"></a>
278 <h4>CodeAssistClient.__getReferences</h4> 279 <h4>CodeAssistClient.__getReferences</h4>
279 <b>__getReferences</b>(<i>params</i>) 280 <b>__getReferences</b>(<i>params</i>)
280
281 <p> 281 <p>
282 Private method to get the places a parameter is referenced. 282 Private method to get the places a parameter is referenced.
283 </p> 283 </p>
284
284 <dl> 285 <dl>
285 286
286 <dt><i>params</i> (dict)</dt> 287 <dt><i>params</i> (dict)</dt>
287 <dd> 288 <dd>
288 dictionary containing the method parameters sent by 289 dictionary containing the method parameters sent by
290 </dd> 291 </dd>
291 </dl> 292 </dl>
292 <a NAME="CodeAssistClient.__gotoDefinition" ID="CodeAssistClient.__gotoDefinition"></a> 293 <a NAME="CodeAssistClient.__gotoDefinition" ID="CodeAssistClient.__gotoDefinition"></a>
293 <h4>CodeAssistClient.__gotoDefinition</h4> 294 <h4>CodeAssistClient.__gotoDefinition</h4>
294 <b>__gotoDefinition</b>(<i>params</i>) 295 <b>__gotoDefinition</b>(<i>params</i>)
295
296 <p> 296 <p>
297 Private method to handle the Goto Definition action. 297 Private method to handle the Goto Definition action.
298 </p> 298 </p>
299
299 <dl> 300 <dl>
300 301
301 <dt><i>params</i> (dict)</dt> 302 <dt><i>params</i> (dict)</dt>
302 <dd> 303 <dd>
303 dictionary containing the method parameters sent by 304 dictionary containing the method parameters sent by
305 </dd> 306 </dd>
306 </dl> 307 </dl>
307 <a NAME="CodeAssistClient.__handleRopeError" ID="CodeAssistClient.__handleRopeError"></a> 308 <a NAME="CodeAssistClient.__handleRopeError" ID="CodeAssistClient.__handleRopeError"></a>
308 <h4>CodeAssistClient.__handleRopeError</h4> 309 <h4>CodeAssistClient.__handleRopeError</h4>
309 <b>__handleRopeError</b>(<i>err</i>) 310 <b>__handleRopeError</b>(<i>err</i>)
310
311 <p> 311 <p>
312 Private method to process a rope error. 312 Private method to process a rope error.
313 </p> 313 </p>
314
314 <dl> 315 <dl>
315 316
316 <dt><i>err</i> (Exception)</dt> 317 <dt><i>err</i> (Exception)</dt>
317 <dd> 318 <dd>
318 rope exception object 319 rope exception object
331 </dd> 332 </dd>
332 </dl> 333 </dl>
333 <a NAME="CodeAssistClient.__processDocumentation" ID="CodeAssistClient.__processDocumentation"></a> 334 <a NAME="CodeAssistClient.__processDocumentation" ID="CodeAssistClient.__processDocumentation"></a>
334 <h4>CodeAssistClient.__processDocumentation</h4> 335 <h4>CodeAssistClient.__processDocumentation</h4>
335 <b>__processDocumentation</b>(<i>cts, documentation, typeName</i>) 336 <b>__processDocumentation</b>(<i>cts, documentation, typeName</i>)
336
337 <p> 337 <p>
338 Private method to process the call-tips and documentation. 338 Private method to process the call-tips and documentation.
339 </p> 339 </p>
340
340 <dl> 341 <dl>
341 342
342 <dt><i>cts</i> (str)</dt> 343 <dt><i>cts</i> (str)</dt>
343 <dd> 344 <dd>
344 call-tips 345 call-tips
366 </dd> 367 </dd>
367 </dl> 368 </dl>
368 <a NAME="CodeAssistClient.__reportChanged" ID="CodeAssistClient.__reportChanged"></a> 369 <a NAME="CodeAssistClient.__reportChanged" ID="CodeAssistClient.__reportChanged"></a>
369 <h4>CodeAssistClient.__reportChanged</h4> 370 <h4>CodeAssistClient.__reportChanged</h4>
370 <b>__reportChanged</b>(<i>params</i>) 371 <b>__reportChanged</b>(<i>params</i>)
371
372 <p> 372 <p>
373 Private method to register some changed sources. 373 Private method to register some changed sources.
374 </p> 374 </p>
375
375 <dl> 376 <dl>
376 377
377 <dt><i>params</i> (dict)</dt> 378 <dt><i>params</i> (dict)</dt>
378 <dd> 379 <dd>
379 dictionary containing the method parameters sent by 380 dictionary containing the method parameters sent by
381 </dd> 382 </dd>
382 </dl> 383 </dl>
383 <a NAME="CodeAssistClient.handleCall" ID="CodeAssistClient.handleCall"></a> 384 <a NAME="CodeAssistClient.handleCall" ID="CodeAssistClient.handleCall"></a>
384 <h4>CodeAssistClient.handleCall</h4> 385 <h4>CodeAssistClient.handleCall</h4>
385 <b>handleCall</b>(<i>method, params</i>) 386 <b>handleCall</b>(<i>method, params</i>)
386
387 <p> 387 <p>
388 Public method to handle a method call from the server. 388 Public method to handle a method call from the server.
389 </p> 389 </p>
390
390 <dl> 391 <dl>
391 392
392 <dt><i>method</i> (str)</dt> 393 <dt><i>method</i> (str)</dt>
393 <dd> 394 <dd>
394 requested method name 395 requested method name

Mercurial Repository: Rope Refactoring

eric ide

mercurial