src/eric7/Documentation/Source/eric7.DebugClients.Python.FlexCompleter.html

branch
eric7
changeset 10417
c6011e501282
parent 9209
b99e7fd55fd3
child 10479
856476537696
equal deleted inserted replaced
10416:5d807e997391 10417:c6011e501282
159 <p> 159 <p>
160 readline.set_completer(Completer(my_namespace).complete) 160 readline.set_completer(Completer(my_namespace).complete)
161 </p> 161 </p>
162 <dl> 162 <dl>
163 163
164 <dt><i>namespace</i></dt> 164 <dt><i>namespace</i> (dict)</dt>
165 <dd> 165 <dd>
166 The namespace for the completer. 166 namespace for the completer
167 </dd> 167 </dd>
168 </dl> 168 </dl>
169 <dl> 169 <dl>
170 170
171 <dt>Raises <b>TypeError</b>:</dt> 171 <dt>Raises <b>TypeError</b>:</dt>
181 <p> 181 <p>
182 Protected method to check for a callable. 182 Protected method to check for a callable.
183 </p> 183 </p>
184 <dl> 184 <dl>
185 185
186 <dt><i>val</i></dt> 186 <dt><i>val</i> (Any)</dt>
187 <dd> 187 <dd>
188 value to check (object) 188 value to check
189 </dd> 189 </dd>
190 <dt><i>word</i></dt> 190 <dt><i>word</i> (str)</dt>
191 <dd> 191 <dd>
192 word to ammend (string) 192 word to amend
193 </dd> 193 </dd>
194 </dl> 194 </dl>
195 <dl> 195 <dl>
196 <dt>Return:</dt> 196 <dt>Return:</dt>
197 <dd> 197 <dd>
198 ammended word (string) 198 amended word
199 </dd>
200 </dl>
201 <dl>
202 <dt>Return Type:</dt>
203 <dd>
204 str
199 </dd> 205 </dd>
200 </dl> 206 </dl>
201 <a NAME="Completer.attr_matches" ID="Completer.attr_matches"></a> 207 <a NAME="Completer.attr_matches" ID="Completer.attr_matches"></a>
202 <h4>Completer.attr_matches</h4> 208 <h4>Completer.attr_matches</h4>
203 <b>attr_matches</b>(<i>text</i>) 209 <b>attr_matches</b>(<i>text</i>)
215 <b>WARNING</b>: this can still invoke arbitrary C code, if an object 221 <b>WARNING</b>: this can still invoke arbitrary C code, if an object
216 with a __getattr__ hook is evaluated. 222 with a __getattr__ hook is evaluated.
217 </p> 223 </p>
218 <dl> 224 <dl>
219 225
220 <dt><i>text</i></dt> 226 <dt><i>text</i> (str)</dt>
221 <dd> 227 <dd>
222 The text to be completed. (string) 228 text to be completed
223 </dd> 229 </dd>
224 </dl> 230 </dl>
225 <dl> 231 <dl>
226 <dt>Return:</dt> 232 <dt>Return:</dt>
227 <dd> 233 <dd>
228 A list of all matches. 234 list of all matches
235 </dd>
236 </dl>
237 <dl>
238 <dt>Return Type:</dt>
239 <dd>
240 list of str
229 </dd> 241 </dd>
230 </dl> 242 </dl>
231 <a NAME="Completer.complete" ID="Completer.complete"></a> 243 <a NAME="Completer.complete" ID="Completer.complete"></a>
232 <h4>Completer.complete</h4> 244 <h4>Completer.complete</h4>
233 <b>complete</b>(<i>text, state</i>) 245 <b>complete</b>(<i>text, state</i>)
239 This is called successively with state == 0, 1, 2, ... until it 251 This is called successively with state == 0, 1, 2, ... until it
240 returns None. The completion should begin with 'text'. 252 returns None. The completion should begin with 'text'.
241 </p> 253 </p>
242 <dl> 254 <dl>
243 255
244 <dt><i>text</i></dt> 256 <dt><i>text</i> (str)</dt>
245 <dd> 257 <dd>
246 The text to be completed. (string) 258 text to be completed
247 </dd> 259 </dd>
248 <dt><i>state</i></dt> 260 <dt><i>state</i> (int)</dt>
249 <dd> 261 <dd>
250 The state of the completion. (integer) 262 state of the completion
251 </dd> 263 </dd>
252 </dl> 264 </dl>
253 <dl> 265 <dl>
254 <dt>Return:</dt> 266 <dt>Return:</dt>
255 <dd> 267 <dd>
256 The possible completions as a list of strings. 268 possible completions
269 </dd>
270 </dl>
271 <dl>
272 <dt>Return Type:</dt>
273 <dd>
274 list of str
257 </dd> 275 </dd>
258 </dl> 276 </dl>
259 <a NAME="Completer.global_matches" ID="Completer.global_matches"></a> 277 <a NAME="Completer.global_matches" ID="Completer.global_matches"></a>
260 <h4>Completer.global_matches</h4> 278 <h4>Completer.global_matches</h4>
261 <b>global_matches</b>(<i>text</i>) 279 <b>global_matches</b>(<i>text</i>)
263 <p> 281 <p>
264 Public method to compute matches when text is a simple name. 282 Public method to compute matches when text is a simple name.
265 </p> 283 </p>
266 <dl> 284 <dl>
267 285
268 <dt><i>text</i></dt> 286 <dt><i>text</i> (str)</dt>
269 <dd> 287 <dd>
270 The text to be completed. (string) 288 text to be completed
271 </dd> 289 </dd>
272 </dl> 290 </dl>
273 <dl> 291 <dl>
274 <dt>Return:</dt> 292 <dt>Return:</dt>
275 <dd> 293 <dd>
276 A list of all keywords, built-in functions and names currently 294 list of all keywords, built-in functions and names currently
277 defined in self.namespace that match. 295 defined in self.namespace that match
296 </dd>
297 </dl>
298 <dl>
299 <dt>Return Type:</dt>
300 <dd>
301 list of str
278 </dd> 302 </dd>
279 </dl> 303 </dl>
280 <div align="right"><a href="#top">Up</a></div> 304 <div align="right"><a href="#top">Up</a></div>
281 <hr /> 305 <hr />
282 <hr /> 306 <hr />
287 <p> 311 <p>
288 Module function to retrieve the class members. 312 Module function to retrieve the class members.
289 </p> 313 </p>
290 <dl> 314 <dl>
291 315
292 <dt><i>klass</i></dt> 316 <dt><i>klass</i> (Any)</dt>
293 <dd> 317 <dd>
294 The class object to be analysed. 318 class object to be analyzed
295 </dd> 319 </dd>
296 </dl> 320 </dl>
297 <dl> 321 <dl>
298 <dt>Return:</dt> 322 <dt>Return:</dt>
299 <dd> 323 <dd>
300 A list of all names defined in the class. 324 list of all names defined in the class
325 </dd>
326 </dl>
327 <dl>
328 <dt>Return Type:</dt>
329 <dd>
330 list of str
301 </dd> 331 </dd>
302 </dl> 332 </dl>
303 <div align="right"><a href="#top">Up</a></div> 333 <div align="right"><a href="#top">Up</a></div>
304 <hr /> 334 <hr />
305 </body></html> 335 </body></html>

eric ide

mercurial