Mercurial Repositories > eric / file comparison

comparison: src/eric7/Documentation/Source/eric7.QScintilla.TypingCompleters.CompleterPython.html

src/eric7/Documentation/Source/eric7.QScintilla.TypingCompleters.CompleterPython.html

branch
eric7
changeset 10479
856476537696
parent 10431
64157aeb0312
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
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>eric7.QScintilla.TypingCompleters.CompleterPython</h1> 9 <h1>eric7.QScintilla.TypingCompleters.CompleterPython</h1>
10
11 <p> 10 <p>
12 Module implementing a typing completer for Python. 11 Module implementing a typing completer for Python.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15
16 <table> 15 <table>
17 <tr><td>None</td></tr> 16 <tr><td>None</td></tr>
18 </table> 17 </table>
18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#CompleterPython">CompleterPython</a></td> 22 <td><a href="#CompleterPython">CompleterPython</a></td>
25 <td>Class implementing typing completer for Python.</td> 23 <td>Class implementing typing completer for Python.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29 28 <table>
30 <table>
31
32 <tr> 29 <tr>
33 <td><a href="#createCompleter">createCompleter</a></td> 30 <td><a href="#createCompleter">createCompleter</a></td>
34 <td>Function to instantiate a typing completer object.</td> 31 <td>Function to instantiate a typing completer object.</td>
35 </tr> 32 </tr>
36 </table> 33 </table>
34
37 <hr /> 35 <hr />
38 <hr /> 36 <hr />
39 <a NAME="CompleterPython" ID="CompleterPython"></a> 37 <a NAME="CompleterPython" ID="CompleterPython"></a>
40 <h2>CompleterPython</h2> 38 <h2>CompleterPython</h2>
41
42 <p> 39 <p>
43 Class implementing typing completer for Python. 40 Class implementing typing completer for Python.
44 </p> 41 </p>
42
45 <h3>Derived from</h3> 43 <h3>Derived from</h3>
46 CompleterBase 44 CompleterBase
47 <h3>Class Attributes</h3> 45 <h3>Class Attributes</h3>
48
49 <table> 46 <table>
50 <tr><td>None</td></tr> 47 <tr><td>None</td></tr>
51 </table> 48 </table>
49
52 <h3>Class Methods</h3> 50 <h3>Class Methods</h3>
53
54 <table> 51 <table>
55 <tr><td>None</td></tr> 52 <tr><td>None</td></tr>
56 </table> 53 </table>
54
57 <h3>Methods</h3> 55 <h3>Methods</h3>
58 56 <table>
59 <table>
60
61 <tr> 57 <tr>
62 <td><a href="#CompleterPython.__init__">CompleterPython</a></td> 58 <td><a href="#CompleterPython.__init__">CompleterPython</a></td>
63 <td>Constructor</td> 59 <td>Constructor</td>
64 </tr> 60 </tr>
65 <tr> 61 <tr>
121 <tr> 117 <tr>
122 <td><a href="#CompleterPython.readSettings">readSettings</a></td> 118 <td><a href="#CompleterPython.readSettings">readSettings</a></td>
123 <td>Public slot called to reread the configuration parameters.</td> 119 <td>Public slot called to reread the configuration parameters.</td>
124 </tr> 120 </tr>
125 </table> 121 </table>
122
126 <h3>Static Methods</h3> 123 <h3>Static Methods</h3>
127
128 <table> 124 <table>
129 <tr><td>None</td></tr> 125 <tr><td>None</td></tr>
130 </table> 126 </table>
127
131 128
132 <a NAME="CompleterPython.__init__" ID="CompleterPython.__init__"></a> 129 <a NAME="CompleterPython.__init__" ID="CompleterPython.__init__"></a>
133 <h4>CompleterPython (Constructor)</h4> 130 <h4>CompleterPython (Constructor)</h4>
134 <b>CompleterPython</b>(<i>editor, parent=None</i>) 131 <b>CompleterPython</b>(<i>editor, parent=None</i>)
135
136 <p> 132 <p>
137 Constructor 133 Constructor
138 </p> 134 </p>
135
139 <dl> 136 <dl>
140 137
141 <dt><i>editor</i> (QScintilla.Editor)</dt> 138 <dt><i>editor</i> (QScintilla.Editor)</dt>
142 <dd> 139 <dd>
143 reference to the editor object 140 reference to the editor object
148 </dd> 145 </dd>
149 </dl> 146 </dl>
150 <a NAME="CompleterPython.__dedentDefStatement" ID="CompleterPython.__dedentDefStatement"></a> 147 <a NAME="CompleterPython.__dedentDefStatement" ID="CompleterPython.__dedentDefStatement"></a>
151 <h4>CompleterPython.__dedentDefStatement</h4> 148 <h4>CompleterPython.__dedentDefStatement</h4>
152 <b>__dedentDefStatement</b>(<i></i>) 149 <b>__dedentDefStatement</b>(<i></i>)
153
154 <p> 150 <p>
155 Private method to dedent the line of the def statement to a previous 151 Private method to dedent the line of the def statement to a previous
156 def statement or class statement. 152 def statement or class statement.
157 </p> 153 </p>
154
158 <a NAME="CompleterPython.__dedentElseToIfWhileForTry" ID="CompleterPython.__dedentElseToIfWhileForTry"></a> 155 <a NAME="CompleterPython.__dedentElseToIfWhileForTry" ID="CompleterPython.__dedentElseToIfWhileForTry"></a>
159 <h4>CompleterPython.__dedentElseToIfWhileForTry</h4> 156 <h4>CompleterPython.__dedentElseToIfWhileForTry</h4>
160 <b>__dedentElseToIfWhileForTry</b>(<i></i>) 157 <b>__dedentElseToIfWhileForTry</b>(<i></i>)
161
162 <p> 158 <p>
163 Private method to dedent the line of the else statement to the last 159 Private method to dedent the line of the else statement to the last
164 if, while, for or try statement with less (or equal) indentation. 160 if, while, for or try statement with less (or equal) indentation.
165 </p> 161 </p>
162
166 <a NAME="CompleterPython.__dedentExceptToTry" ID="CompleterPython.__dedentExceptToTry"></a> 163 <a NAME="CompleterPython.__dedentExceptToTry" ID="CompleterPython.__dedentExceptToTry"></a>
167 <h4>CompleterPython.__dedentExceptToTry</h4> 164 <h4>CompleterPython.__dedentExceptToTry</h4>
168 <b>__dedentExceptToTry</b>(<i></i>) 165 <b>__dedentExceptToTry</b>(<i></i>)
169
170 <p> 166 <p>
171 Private method to dedent the line of the except statement to the last 167 Private method to dedent the line of the except statement to the last
172 try statement with less (or equal) indentation. 168 try statement with less (or equal) indentation.
173 </p> 169 </p>
170
174 <a NAME="CompleterPython.__dedentFinallyToTry" ID="CompleterPython.__dedentFinallyToTry"></a> 171 <a NAME="CompleterPython.__dedentFinallyToTry" ID="CompleterPython.__dedentFinallyToTry"></a>
175 <h4>CompleterPython.__dedentFinallyToTry</h4> 172 <h4>CompleterPython.__dedentFinallyToTry</h4>
176 <b>__dedentFinallyToTry</b>(<i></i>) 173 <b>__dedentFinallyToTry</b>(<i></i>)
177
178 <p> 174 <p>
179 Private method to dedent the line of the except statement to the last 175 Private method to dedent the line of the except statement to the last
180 try statement with less (or equal) indentation. 176 try statement with less (or equal) indentation.
181 </p> 177 </p>
178
182 <a NAME="CompleterPython.__dedentToIf" ID="CompleterPython.__dedentToIf"></a> 179 <a NAME="CompleterPython.__dedentToIf" ID="CompleterPython.__dedentToIf"></a>
183 <h4>CompleterPython.__dedentToIf</h4> 180 <h4>CompleterPython.__dedentToIf</h4>
184 <b>__dedentToIf</b>(<i></i>) 181 <b>__dedentToIf</b>(<i></i>)
185
186 <p> 182 <p>
187 Private method to dedent the last line to the last if statement with 183 Private method to dedent the last line to the last if statement with
188 less (or equal) indentation. 184 less (or equal) indentation.
189 </p> 185 </p>
186
190 <a NAME="CompleterPython.__inComment" ID="CompleterPython.__inComment"></a> 187 <a NAME="CompleterPython.__inComment" ID="CompleterPython.__inComment"></a>
191 <h4>CompleterPython.__inComment</h4> 188 <h4>CompleterPython.__inComment</h4>
192 <b>__inComment</b>(<i>line, col</i>) 189 <b>__inComment</b>(<i>line, col</i>)
193
194 <p> 190 <p>
195 Private method to check, if the cursor is inside a comment. 191 Private method to check, if the cursor is inside a comment.
196 </p> 192 </p>
193
197 <dl> 194 <dl>
198 195
199 <dt><i>line</i> (int)</dt> 196 <dt><i>line</i> (int)</dt>
200 <dd> 197 <dd>
201 current line 198 current line
218 </dd> 215 </dd>
219 </dl> 216 </dl>
220 <a NAME="CompleterPython.__inDoubleQuotedString" ID="CompleterPython.__inDoubleQuotedString"></a> 217 <a NAME="CompleterPython.__inDoubleQuotedString" ID="CompleterPython.__inDoubleQuotedString"></a>
221 <h4>CompleterPython.__inDoubleQuotedString</h4> 218 <h4>CompleterPython.__inDoubleQuotedString</h4>
222 <b>__inDoubleQuotedString</b>(<i></i>) 219 <b>__inDoubleQuotedString</b>(<i></i>)
223
224 <p> 220 <p>
225 Private method to check, if the cursor is within a double quoted 221 Private method to check, if the cursor is within a double quoted
226 string. 222 string.
227 </p> 223 </p>
224
228 <dl> 225 <dl>
229 <dt>Return:</dt> 226 <dt>Return:</dt>
230 <dd> 227 <dd>
231 flag indicating, if the cursor is inside a double 228 flag indicating, if the cursor is inside a double
232 quoted string 229 quoted string
239 </dd> 236 </dd>
240 </dl> 237 </dl>
241 <a NAME="CompleterPython.__inSingleQuotedString" ID="CompleterPython.__inSingleQuotedString"></a> 238 <a NAME="CompleterPython.__inSingleQuotedString" ID="CompleterPython.__inSingleQuotedString"></a>
242 <h4>CompleterPython.__inSingleQuotedString</h4> 239 <h4>CompleterPython.__inSingleQuotedString</h4>
243 <b>__inSingleQuotedString</b>(<i></i>) 240 <b>__inSingleQuotedString</b>(<i></i>)
244
245 <p> 241 <p>
246 Private method to check, if the cursor is within a single quoted 242 Private method to check, if the cursor is within a single quoted
247 string. 243 string.
248 </p> 244 </p>
245
249 <dl> 246 <dl>
250 <dt>Return:</dt> 247 <dt>Return:</dt>
251 <dd> 248 <dd>
252 flag indicating, if the cursor is inside a single 249 flag indicating, if the cursor is inside a single
253 quoted string 250 quoted string
260 </dd> 257 </dd>
261 </dl> 258 </dl>
262 <a NAME="CompleterPython.__inTripleDoubleQuotedString" ID="CompleterPython.__inTripleDoubleQuotedString"></a> 259 <a NAME="CompleterPython.__inTripleDoubleQuotedString" ID="CompleterPython.__inTripleDoubleQuotedString"></a>
263 <h4>CompleterPython.__inTripleDoubleQuotedString</h4> 260 <h4>CompleterPython.__inTripleDoubleQuotedString</h4>
264 <b>__inTripleDoubleQuotedString</b>(<i></i>) 261 <b>__inTripleDoubleQuotedString</b>(<i></i>)
265
266 <p> 262 <p>
267 Private method to check, if the cursor is within a triple double 263 Private method to check, if the cursor is within a triple double
268 quoted string. 264 quoted string.
269 </p> 265 </p>
266
270 <dl> 267 <dl>
271 <dt>Return:</dt> 268 <dt>Return:</dt>
272 <dd> 269 <dd>
273 flag indicating, if the cursor is inside a triple double 270 flag indicating, if the cursor is inside a triple double
274 quoted string 271 quoted string
281 </dd> 278 </dd>
282 </dl> 279 </dl>
283 <a NAME="CompleterPython.__inTripleSingleQuotedString" ID="CompleterPython.__inTripleSingleQuotedString"></a> 280 <a NAME="CompleterPython.__inTripleSingleQuotedString" ID="CompleterPython.__inTripleSingleQuotedString"></a>
284 <h4>CompleterPython.__inTripleSingleQuotedString</h4> 281 <h4>CompleterPython.__inTripleSingleQuotedString</h4>
285 <b>__inTripleSingleQuotedString</b>(<i></i>) 282 <b>__inTripleSingleQuotedString</b>(<i></i>)
286
287 <p> 283 <p>
288 Private method to check, if the cursor is within a triple single 284 Private method to check, if the cursor is within a triple single
289 quoted string. 285 quoted string.
290 </p> 286 </p>
287
291 <dl> 288 <dl>
292 <dt>Return:</dt> 289 <dt>Return:</dt>
293 <dd> 290 <dd>
294 flag indicating, if the cursor is inside a triple single 291 flag indicating, if the cursor is inside a triple single
295 quoted string 292 quoted string
302 </dd> 299 </dd>
303 </dl> 300 </dl>
304 <a NAME="CompleterPython.__isClassMethod" ID="CompleterPython.__isClassMethod"></a> 301 <a NAME="CompleterPython.__isClassMethod" ID="CompleterPython.__isClassMethod"></a>
305 <h4>CompleterPython.__isClassMethod</h4> 302 <h4>CompleterPython.__isClassMethod</h4>
306 <b>__isClassMethod</b>(<i></i>) 303 <b>__isClassMethod</b>(<i></i>)
307
308 <p> 304 <p>
309 Private method to check, if the user is defining a class method. 305 Private method to check, if the user is defining a class method.
310 </p> 306 </p>
307
311 <dl> 308 <dl>
312 <dt>Return:</dt> 309 <dt>Return:</dt>
313 <dd> 310 <dd>
314 flag indicating the definition of a class method 311 flag indicating the definition of a class method
315 </dd> 312 </dd>
321 </dd> 318 </dd>
322 </dl> 319 </dl>
323 <a NAME="CompleterPython.__isClassMethodDef" ID="CompleterPython.__isClassMethodDef"></a> 320 <a NAME="CompleterPython.__isClassMethodDef" ID="CompleterPython.__isClassMethodDef"></a>
324 <h4>CompleterPython.__isClassMethodDef</h4> 321 <h4>CompleterPython.__isClassMethodDef</h4>
325 <b>__isClassMethodDef</b>(<i></i>) 322 <b>__isClassMethodDef</b>(<i></i>)
326
327 <p> 323 <p>
328 Private method to check, if the user is defing a class method 324 Private method to check, if the user is defing a class method
329 (@classmethod). 325 (@classmethod).
330 </p> 326 </p>
327
331 <dl> 328 <dl>
332 <dt>Return:</dt> 329 <dt>Return:</dt>
333 <dd> 330 <dd>
334 flag indicating the definition of a class method 331 flag indicating the definition of a class method
335 </dd> 332 </dd>
341 </dd> 338 </dd>
342 </dl> 339 </dl>
343 <a NAME="CompleterPython.__isStaticMethodDef" ID="CompleterPython.__isStaticMethodDef"></a> 340 <a NAME="CompleterPython.__isStaticMethodDef" ID="CompleterPython.__isStaticMethodDef"></a>
344 <h4>CompleterPython.__isStaticMethodDef</h4> 341 <h4>CompleterPython.__isStaticMethodDef</h4>
345 <b>__isStaticMethodDef</b>(<i></i>) 342 <b>__isStaticMethodDef</b>(<i></i>)
346
347 <p> 343 <p>
348 Private method to check, if the user is defing a static method 344 Private method to check, if the user is defing a static method
349 (@staticmethod) method. 345 (@staticmethod) method.
350 </p> 346 </p>
347
351 <dl> 348 <dl>
352 <dt>Return:</dt> 349 <dt>Return:</dt>
353 <dd> 350 <dd>
354 flag indicating the definition of a static method 351 flag indicating the definition of a static method
355 </dd> 352 </dd>
361 </dd> 358 </dd>
362 </dl> 359 </dl>
363 <a NAME="CompleterPython.charAdded" ID="CompleterPython.charAdded"></a> 360 <a NAME="CompleterPython.charAdded" ID="CompleterPython.charAdded"></a>
364 <h4>CompleterPython.charAdded</h4> 361 <h4>CompleterPython.charAdded</h4>
365 <b>charAdded</b>(<i>charNumber</i>) 362 <b>charAdded</b>(<i>charNumber</i>)
366
367 <p> 363 <p>
368 Public slot called to handle the user entering a character. 364 Public slot called to handle the user entering a character.
369 </p> 365 </p>
366
370 <dl> 367 <dl>
371 368
372 <dt><i>charNumber</i> (int)</dt> 369 <dt><i>charNumber</i> (int)</dt>
373 <dd> 370 <dd>
374 value of the character entered 371 value of the character entered
375 </dd> 372 </dd>
376 </dl> 373 </dl>
377 <a NAME="CompleterPython.readSettings" ID="CompleterPython.readSettings"></a> 374 <a NAME="CompleterPython.readSettings" ID="CompleterPython.readSettings"></a>
378 <h4>CompleterPython.readSettings</h4> 375 <h4>CompleterPython.readSettings</h4>
379 <b>readSettings</b>(<i></i>) 376 <b>readSettings</b>(<i></i>)
380
381 <p> 377 <p>
382 Public slot called to reread the configuration parameters. 378 Public slot called to reread the configuration parameters.
383 </p> 379 </p>
380
384 <div align="right"><a href="#top">Up</a></div> 381 <div align="right"><a href="#top">Up</a></div>
385 <hr /> 382 <hr />
386 <hr /> 383 <hr />
387 <a NAME="createCompleter" ID="createCompleter"></a> 384 <a NAME="createCompleter" ID="createCompleter"></a>
388 <h2>createCompleter</h2> 385 <h2>createCompleter</h2>
389 <b>createCompleter</b>(<i>editor, parent=None</i>) 386 <b>createCompleter</b>(<i>editor, parent=None</i>)
390
391 <p> 387 <p>
392 Function to instantiate a typing completer object. 388 Function to instantiate a typing completer object.
393 </p> 389 </p>
390
394 <dl> 391 <dl>
395 392
396 <dt><i>editor</i> (QScintilla.Editor)</dt> 393 <dt><i>editor</i> (QScintilla.Editor)</dt>
397 <dd> 394 <dd>
398 reference to the editor object 395 reference to the editor object

Mercurial Repository: eric

eric ide

mercurial