53 </table> |
53 </table> |
54 <h3>Methods</h3> |
54 <h3>Methods</h3> |
55 <table> |
55 <table> |
56 <tr> |
56 <tr> |
57 <td><a href="#CompleterPython.__init__">CompleterPython</a></td> |
57 <td><a href="#CompleterPython.__init__">CompleterPython</a></td> |
58 <td>Constructor</td> |
58 <td>Constructor</td> |
59 </tr><tr> |
59 </tr><tr> |
60 <td><a href="#CompleterPython.__dedentDefStatement">__dedentDefStatement</a></td> |
60 <td><a href="#CompleterPython.__dedentDefStatement">__dedentDefStatement</a></td> |
61 <td>Private method to dedent the line of the def statement to a previous def statement or class statement.</td> |
61 <td>Private method to dedent the line of the def statement to a previous def statement or class statement.</td> |
62 </tr><tr> |
62 </tr><tr> |
63 <td><a href="#CompleterPython.__dedentElseToIfWhileForTry">__dedentElseToIfWhileForTry</a></td> |
63 <td><a href="#CompleterPython.__dedentElseToIfWhileForTry">__dedentElseToIfWhileForTry</a></td> |
64 <td>Private method to dedent the line of the else statement to the last if, while, for or try statement with less (or equal) indentation.</td> |
64 <td>Private method to dedent the line of the else statement to the last if, while, for or try statement with less (or equal) indentation.</td> |
65 </tr><tr> |
65 </tr><tr> |
66 <td><a href="#CompleterPython.__dedentExceptToTry">__dedentExceptToTry</a></td> |
66 <td><a href="#CompleterPython.__dedentExceptToTry">__dedentExceptToTry</a></td> |
67 <td>Private method to dedent the line of the except statement to the last try statement with less (or equal) indentation.</td> |
67 <td>Private method to dedent the line of the except statement to the last try statement with less (or equal) indentation.</td> |
68 </tr><tr> |
68 </tr><tr> |
69 <td><a href="#CompleterPython.__dedentFinallyToTry">__dedentFinallyToTry</a></td> |
69 <td><a href="#CompleterPython.__dedentFinallyToTry">__dedentFinallyToTry</a></td> |
70 <td>Private method to dedent the line of the except statement to the last try statement with less (or equal) indentation.</td> |
70 <td>Private method to dedent the line of the except statement to the last try statement with less (or equal) indentation.</td> |
71 </tr><tr> |
71 </tr><tr> |
72 <td><a href="#CompleterPython.__dedentToIf">__dedentToIf</a></td> |
72 <td><a href="#CompleterPython.__dedentToIf">__dedentToIf</a></td> |
73 <td>Private method to dedent the last line to the last if statement with less (or equal) indentation.</td> |
73 <td>Private method to dedent the last line to the last if statement with less (or equal) indentation.</td> |
74 </tr><tr> |
74 </tr><tr> |
75 <td><a href="#CompleterPython.__inComment">__inComment</a></td> |
75 <td><a href="#CompleterPython.__inComment">__inComment</a></td> |
76 <td>Private method to check, if the cursor is inside a comment</td> |
76 <td>Private method to check, if the cursor is inside a comment</td> |
77 </tr><tr> |
77 </tr><tr> |
78 <td><a href="#CompleterPython.__inDoubleQuotedString">__inDoubleQuotedString</a></td> |
78 <td><a href="#CompleterPython.__inDoubleQuotedString">__inDoubleQuotedString</a></td> |
79 <td>Private method to check, if the cursor is within a double quoted string.</td> |
79 <td>Private method to check, if the cursor is within a double quoted string.</td> |
80 </tr><tr> |
80 </tr><tr> |
81 <td><a href="#CompleterPython.__inSingleQuotedString">__inSingleQuotedString</a></td> |
81 <td><a href="#CompleterPython.__inSingleQuotedString">__inSingleQuotedString</a></td> |
82 <td>Private method to check, if the cursor is within a single quoted string.</td> |
82 <td>Private method to check, if the cursor is within a single quoted string.</td> |
83 </tr><tr> |
83 </tr><tr> |
84 <td><a href="#CompleterPython.__inTripleDoubleQuotedString">__inTripleDoubleQuotedString</a></td> |
84 <td><a href="#CompleterPython.__inTripleDoubleQuotedString">__inTripleDoubleQuotedString</a></td> |
85 <td>Private method to check, if the cursor is within a triple double quoted string.</td> |
85 <td>Private method to check, if the cursor is within a triple double quoted string.</td> |
86 </tr><tr> |
86 </tr><tr> |
87 <td><a href="#CompleterPython.__inTripleSingleQuotedString">__inTripleSingleQuotedString</a></td> |
87 <td><a href="#CompleterPython.__inTripleSingleQuotedString">__inTripleSingleQuotedString</a></td> |
88 <td>Private method to check, if the cursor is within a triple single quoted string.</td> |
88 <td>Private method to check, if the cursor is within a triple single quoted string.</td> |
89 </tr><tr> |
89 </tr><tr> |
90 <td><a href="#CompleterPython.__isClassMethod">__isClassMethod</a></td> |
90 <td><a href="#CompleterPython.__isClassMethod">__isClassMethod</a></td> |
91 <td>Private method to check, if the user is defining a class method.</td> |
91 <td>Private method to check, if the user is defining a class method.</td> |
92 </tr><tr> |
92 </tr><tr> |
93 <td><a href="#CompleterPython.__isClassmethodDef">__isClassmethodDef</a></td> |
93 <td><a href="#CompleterPython.__isClassmethodDef">__isClassmethodDef</a></td> |
94 <td>Private method to check, if the user is defing a classmethod (@classmethod) method.</td> |
94 <td>Private method to check, if the user is defing a classmethod (@classmethod) method.</td> |
95 </tr><tr> |
95 </tr><tr> |
96 <td><a href="#CompleterPython.charAdded">charAdded</a></td> |
96 <td><a href="#CompleterPython.charAdded">charAdded</a></td> |
97 <td>Public slot called to handle the user entering a character.</td> |
97 <td>Public slot called to handle the user entering a character.</td> |
98 </tr><tr> |
98 </tr><tr> |
99 <td><a href="#CompleterPython.readSettings">readSettings</a></td> |
99 <td><a href="#CompleterPython.readSettings">readSettings</a></td> |
100 <td>Public slot called to reread the configuration parameters.</td> |
100 <td>Public slot called to reread the configuration parameters.</td> |
101 </tr> |
101 </tr> |
102 </table> |
102 </table> |
103 <a NAME="CompleterPython.__init__" ID="CompleterPython.__init__"></a> |
103 <a NAME="CompleterPython.__init__" ID="CompleterPython.__init__"></a> |
104 <h4>CompleterPython (Constructor)</h4> |
104 <h4>CompleterPython (Constructor)</h4> |
105 <b>CompleterPython</b>(<i>editor, parent = None</i>) |
105 <b>CompleterPython</b>(<i>editor, parent = None</i>) |
106 <p> |
106 <p> |
107 Constructor |
107 Constructor |
108 </p><dl> |
108 </p><dl> |
109 <dt><i>editor</i></dt> |
109 <dt><i>editor</i></dt> |
110 <dd> |
110 <dd> |
111 reference to the editor object (QScintilla.Editor) |
111 reference to the editor object (QScintilla.Editor) |
112 </dd><dt><i>parent</i></dt> |
112 </dd><dt><i>parent</i></dt> |
113 <dd> |
113 <dd> |
114 reference to the parent object (QObject) |
114 reference to the parent object (QObject) |
115 </dd> |
115 </dd> |
116 </dl><a NAME="CompleterPython.__dedentDefStatement" ID="CompleterPython.__dedentDefStatement"></a> |
116 </dl><a NAME="CompleterPython.__dedentDefStatement" ID="CompleterPython.__dedentDefStatement"></a> |
117 <h4>CompleterPython.__dedentDefStatement</h4> |
117 <h4>CompleterPython.__dedentDefStatement</h4> |
118 <b>__dedentDefStatement</b>(<i></i>) |
118 <b>__dedentDefStatement</b>(<i></i>) |
119 <p> |
119 <p> |
120 Private method to dedent the line of the def statement to a previous def |
120 Private method to dedent the line of the def statement to a previous def |
121 statement or class statement. |
121 statement or class statement. |
122 </p><a NAME="CompleterPython.__dedentElseToIfWhileForTry" ID="CompleterPython.__dedentElseToIfWhileForTry"></a> |
122 </p><a NAME="CompleterPython.__dedentElseToIfWhileForTry" ID="CompleterPython.__dedentElseToIfWhileForTry"></a> |
123 <h4>CompleterPython.__dedentElseToIfWhileForTry</h4> |
123 <h4>CompleterPython.__dedentElseToIfWhileForTry</h4> |
124 <b>__dedentElseToIfWhileForTry</b>(<i></i>) |
124 <b>__dedentElseToIfWhileForTry</b>(<i></i>) |
125 <p> |
125 <p> |
126 Private method to dedent the line of the else statement to the last |
126 Private method to dedent the line of the else statement to the last |
127 if, while, for or try statement with less (or equal) indentation. |
127 if, while, for or try statement with less (or equal) indentation. |
128 </p><a NAME="CompleterPython.__dedentExceptToTry" ID="CompleterPython.__dedentExceptToTry"></a> |
128 </p><a NAME="CompleterPython.__dedentExceptToTry" ID="CompleterPython.__dedentExceptToTry"></a> |
129 <h4>CompleterPython.__dedentExceptToTry</h4> |
129 <h4>CompleterPython.__dedentExceptToTry</h4> |
130 <b>__dedentExceptToTry</b>(<i>hasColon</i>) |
130 <b>__dedentExceptToTry</b>(<i>hasColon</i>) |
131 <p> |
131 <p> |
132 Private method to dedent the line of the except statement to the last |
132 Private method to dedent the line of the except statement to the last |
133 try statement with less (or equal) indentation. |
133 try statement with less (or equal) indentation. |
134 </p><dl> |
134 </p><dl> |
135 <dt><i>hasColon</i></dt> |
135 <dt><i>hasColon</i></dt> |
136 <dd> |
136 <dd> |
137 flag indicating the except type (boolean) |
137 flag indicating the except type (boolean) |
138 </dd> |
138 </dd> |
139 </dl><a NAME="CompleterPython.__dedentFinallyToTry" ID="CompleterPython.__dedentFinallyToTry"></a> |
139 </dl><a NAME="CompleterPython.__dedentFinallyToTry" ID="CompleterPython.__dedentFinallyToTry"></a> |
140 <h4>CompleterPython.__dedentFinallyToTry</h4> |
140 <h4>CompleterPython.__dedentFinallyToTry</h4> |
141 <b>__dedentFinallyToTry</b>(<i></i>) |
141 <b>__dedentFinallyToTry</b>(<i></i>) |
142 <p> |
142 <p> |
143 Private method to dedent the line of the except statement to the last |
143 Private method to dedent the line of the except statement to the last |
144 try statement with less (or equal) indentation. |
144 try statement with less (or equal) indentation. |
145 </p><a NAME="CompleterPython.__dedentToIf" ID="CompleterPython.__dedentToIf"></a> |
145 </p><a NAME="CompleterPython.__dedentToIf" ID="CompleterPython.__dedentToIf"></a> |
146 <h4>CompleterPython.__dedentToIf</h4> |
146 <h4>CompleterPython.__dedentToIf</h4> |
147 <b>__dedentToIf</b>(<i></i>) |
147 <b>__dedentToIf</b>(<i></i>) |
148 <p> |
148 <p> |
149 Private method to dedent the last line to the last if statement with |
149 Private method to dedent the last line to the last if statement with |
150 less (or equal) indentation. |
150 less (or equal) indentation. |
151 </p><a NAME="CompleterPython.__inComment" ID="CompleterPython.__inComment"></a> |
151 </p><a NAME="CompleterPython.__inComment" ID="CompleterPython.__inComment"></a> |
152 <h4>CompleterPython.__inComment</h4> |
152 <h4>CompleterPython.__inComment</h4> |
153 <b>__inComment</b>(<i>line, col</i>) |
153 <b>__inComment</b>(<i>line, col</i>) |
154 <p> |
154 <p> |
155 Private method to check, if the cursor is inside a comment |
155 Private method to check, if the cursor is inside a comment |
156 </p><dl> |
156 </p><dl> |
157 <dt><i>line</i></dt> |
157 <dt><i>line</i></dt> |
158 <dd> |
158 <dd> |
159 current line (integer) |
159 current line (integer) |
160 </dd><dt><i>col</i></dt> |
160 </dd><dt><i>col</i></dt> |
161 <dd> |
161 <dd> |
162 current position within line (integer) |
162 current position within line (integer) |
163 </dd> |
163 </dd> |
164 </dl><dl> |
164 </dl><dl> |
165 <dt>Returns:</dt> |
165 <dt>Returns:</dt> |
166 <dd> |
166 <dd> |
167 flag indicating, if the cursor is inside a comment (boolean) |
167 flag indicating, if the cursor is inside a comment (boolean) |
168 </dd> |
168 </dd> |
169 </dl><a NAME="CompleterPython.__inDoubleQuotedString" ID="CompleterPython.__inDoubleQuotedString"></a> |
169 </dl><a NAME="CompleterPython.__inDoubleQuotedString" ID="CompleterPython.__inDoubleQuotedString"></a> |
170 <h4>CompleterPython.__inDoubleQuotedString</h4> |
170 <h4>CompleterPython.__inDoubleQuotedString</h4> |
171 <b>__inDoubleQuotedString</b>(<i></i>) |
171 <b>__inDoubleQuotedString</b>(<i></i>) |
172 <p> |
172 <p> |
173 Private method to check, if the cursor is within a double quoted string. |
173 Private method to check, if the cursor is within a double quoted string. |
174 </p><dl> |
174 </p><dl> |
175 <dt>Returns:</dt> |
175 <dt>Returns:</dt> |
176 <dd> |
176 <dd> |
177 flag indicating, if the cursor is inside a double |
177 flag indicating, if the cursor is inside a double |
178 quoted string (boolean) |
178 quoted string (boolean) |
179 </dd> |
179 </dd> |
180 </dl><a NAME="CompleterPython.__inSingleQuotedString" ID="CompleterPython.__inSingleQuotedString"></a> |
180 </dl><a NAME="CompleterPython.__inSingleQuotedString" ID="CompleterPython.__inSingleQuotedString"></a> |
181 <h4>CompleterPython.__inSingleQuotedString</h4> |
181 <h4>CompleterPython.__inSingleQuotedString</h4> |
182 <b>__inSingleQuotedString</b>(<i></i>) |
182 <b>__inSingleQuotedString</b>(<i></i>) |
183 <p> |
183 <p> |
184 Private method to check, if the cursor is within a single quoted string. |
184 Private method to check, if the cursor is within a single quoted string. |
185 </p><dl> |
185 </p><dl> |
186 <dt>Returns:</dt> |
186 <dt>Returns:</dt> |
187 <dd> |
187 <dd> |
188 flag indicating, if the cursor is inside a single |
188 flag indicating, if the cursor is inside a single |
189 quoted string (boolean) |
189 quoted string (boolean) |
190 </dd> |
190 </dd> |
191 </dl><a NAME="CompleterPython.__inTripleDoubleQuotedString" ID="CompleterPython.__inTripleDoubleQuotedString"></a> |
191 </dl><a NAME="CompleterPython.__inTripleDoubleQuotedString" ID="CompleterPython.__inTripleDoubleQuotedString"></a> |
192 <h4>CompleterPython.__inTripleDoubleQuotedString</h4> |
192 <h4>CompleterPython.__inTripleDoubleQuotedString</h4> |
193 <b>__inTripleDoubleQuotedString</b>(<i></i>) |
193 <b>__inTripleDoubleQuotedString</b>(<i></i>) |
194 <p> |
194 <p> |
195 Private method to check, if the cursor is within a triple double quoted string. |
195 Private method to check, if the cursor is within a triple double quoted string. |
196 </p><dl> |
196 </p><dl> |
197 <dt>Returns:</dt> |
197 <dt>Returns:</dt> |
198 <dd> |
198 <dd> |
199 flag indicating, if the cursor is inside a triple double |
199 flag indicating, if the cursor is inside a triple double |
200 quoted string (boolean) |
200 quoted string (boolean) |
201 </dd> |
201 </dd> |
202 </dl><a NAME="CompleterPython.__inTripleSingleQuotedString" ID="CompleterPython.__inTripleSingleQuotedString"></a> |
202 </dl><a NAME="CompleterPython.__inTripleSingleQuotedString" ID="CompleterPython.__inTripleSingleQuotedString"></a> |
203 <h4>CompleterPython.__inTripleSingleQuotedString</h4> |
203 <h4>CompleterPython.__inTripleSingleQuotedString</h4> |
204 <b>__inTripleSingleQuotedString</b>(<i></i>) |
204 <b>__inTripleSingleQuotedString</b>(<i></i>) |
205 <p> |
205 <p> |
206 Private method to check, if the cursor is within a triple single quoted string. |
206 Private method to check, if the cursor is within a triple single quoted string. |
207 </p><dl> |
207 </p><dl> |
208 <dt>Returns:</dt> |
208 <dt>Returns:</dt> |
209 <dd> |
209 <dd> |
210 flag indicating, if the cursor is inside a triple single |
210 flag indicating, if the cursor is inside a triple single |
211 quoted string (boolean) |
211 quoted string (boolean) |
212 </dd> |
212 </dd> |
213 </dl><a NAME="CompleterPython.__isClassMethod" ID="CompleterPython.__isClassMethod"></a> |
213 </dl><a NAME="CompleterPython.__isClassMethod" ID="CompleterPython.__isClassMethod"></a> |
214 <h4>CompleterPython.__isClassMethod</h4> |
214 <h4>CompleterPython.__isClassMethod</h4> |
215 <b>__isClassMethod</b>(<i></i>) |
215 <b>__isClassMethod</b>(<i></i>) |
216 <p> |
216 <p> |
217 Private method to check, if the user is defining a class method. |
217 Private method to check, if the user is defining a class method. |
218 </p><dl> |
218 </p><dl> |
219 <dt>Returns:</dt> |
219 <dt>Returns:</dt> |
220 <dd> |
220 <dd> |
221 flag indicating the definition of a class method (boolean) |
221 flag indicating the definition of a class method (boolean) |
222 </dd> |
222 </dd> |
223 </dl><a NAME="CompleterPython.__isClassmethodDef" ID="CompleterPython.__isClassmethodDef"></a> |
223 </dl><a NAME="CompleterPython.__isClassmethodDef" ID="CompleterPython.__isClassmethodDef"></a> |
224 <h4>CompleterPython.__isClassmethodDef</h4> |
224 <h4>CompleterPython.__isClassmethodDef</h4> |
225 <b>__isClassmethodDef</b>(<i></i>) |
225 <b>__isClassmethodDef</b>(<i></i>) |
226 <p> |
226 <p> |
227 Private method to check, if the user is defing a classmethod |
227 Private method to check, if the user is defing a classmethod |
228 (@classmethod) method. |
228 (@classmethod) method. |
229 </p><dl> |
229 </p><dl> |
230 <dt>Returns:</dt> |
230 <dt>Returns:</dt> |
231 <dd> |
231 <dd> |
232 flag indicating the definition of a classmethod method (boolean) |
232 flag indicating the definition of a classmethod method (boolean) |
233 </dd> |
233 </dd> |
234 </dl><a NAME="CompleterPython.charAdded" ID="CompleterPython.charAdded"></a> |
234 </dl><a NAME="CompleterPython.charAdded" ID="CompleterPython.charAdded"></a> |
235 <h4>CompleterPython.charAdded</h4> |
235 <h4>CompleterPython.charAdded</h4> |
236 <b>charAdded</b>(<i>charNumber</i>) |
236 <b>charAdded</b>(<i>charNumber</i>) |
237 <p> |
237 <p> |
238 Public slot called to handle the user entering a character. |
238 Public slot called to handle the user entering a character. |
239 </p><dl> |
239 </p><dl> |
240 <dt><i>charNumber</i></dt> |
240 <dt><i>charNumber</i></dt> |
241 <dd> |
241 <dd> |
242 value of the character entered (integer) |
242 value of the character entered (integer) |
243 </dd> |
243 </dd> |
244 </dl><a NAME="CompleterPython.readSettings" ID="CompleterPython.readSettings"></a> |
244 </dl><a NAME="CompleterPython.readSettings" ID="CompleterPython.readSettings"></a> |
245 <h4>CompleterPython.readSettings</h4> |
245 <h4>CompleterPython.readSettings</h4> |
246 <b>readSettings</b>(<i></i>) |
246 <b>readSettings</b>(<i></i>) |
247 <p> |
247 <p> |
248 Public slot called to reread the configuration parameters. |
248 Public slot called to reread the configuration parameters. |
249 </p> |
249 </p> |
250 <div align="right"><a href="#top">Up</a></div> |
250 <div align="right"><a href="#top">Up</a></div> |
251 <hr /> |
251 <hr /> |
252 </body></html> |
252 </body></html> |