eric6/Documentation/Source/eric6.QScintilla.SpellChecker.html

branch
maintenance
changeset 8043
0acf98cd089a
parent 7989
a21d673a8f99
equal deleted inserted replaced
7991:866adc8c315b 8043:0acf98cd089a
218 <dt><i>lang</i></dt> 218 <dt><i>lang</i></dt>
219 <dd> 219 <dd>
220 the language to be used as the default (string). 220 the language to be used as the default (string).
221 The string should be in language locale format (e.g. en_US, de). 221 The string should be in language locale format (e.g. en_US, de).
222 </dd> 222 </dd>
223 <dt><i>pwl=</i></dt> 223 <dt><i>pwl</i></dt>
224 <dd> 224 <dd>
225 name of the personal/project word list (string) 225 name of the personal/project word list (string)
226 </dd> 226 </dd>
227 <dt><i>pel=</i></dt> 227 <dt><i>pel</i></dt>
228 <dd> 228 <dd>
229 name of the personal/project exclude list (string) 229 name of the personal/project exclude list (string)
230 </dd> 230 </dd>
231 </dl> 231 </dl>
232 <dl> 232 <dl>
233 <dt>Returns:</dt> 233 <dt>Return:</dt>
234 <dd> 234 <dd>
235 reference to the dictionary (enchant.Dict) 235 reference to the dictionary (enchant.Dict)
236 </dd> 236 </dd>
237 </dl> 237 </dl>
238 <a NAME="SpellChecker.getAvailableLanguages" ID="SpellChecker.getAvailableLanguages"></a> 238 <a NAME="SpellChecker.getAvailableLanguages" ID="SpellChecker.getAvailableLanguages"></a>
241 241
242 <p> 242 <p>
243 Class method to get all available languages. 243 Class method to get all available languages.
244 </p> 244 </p>
245 <dl> 245 <dl>
246 <dt>Returns:</dt> 246 <dt>Return:</dt>
247 <dd> 247 <dd>
248 list of available languages (list of strings) 248 list of available languages (list of strings)
249 </dd> 249 </dd>
250 </dl> 250 </dl>
251 <a NAME="SpellChecker.getDefaultPath" ID="SpellChecker.getDefaultPath"></a> 251 <a NAME="SpellChecker.getDefaultPath" ID="SpellChecker.getDefaultPath"></a>
262 flag indicating to return the name of the default 262 flag indicating to return the name of the default
263 exception dictionary (boolean) 263 exception dictionary (boolean)
264 </dd> 264 </dd>
265 </dl> 265 </dl>
266 <dl> 266 <dl>
267 <dt>Returns:</dt> 267 <dt>Return:</dt>
268 <dd> 268 <dd>
269 file name of the default user dictionary or the default user 269 file name of the default user dictionary or the default user
270 exception dictionary (string) 270 exception dictionary (string)
271 </dd> 271 </dd>
272 </dl> 272 </dl>
284 flag indicating to return the name of the user 284 flag indicating to return the name of the user
285 exception dictionary (boolean) 285 exception dictionary (boolean)
286 </dd> 286 </dd>
287 </dl> 287 </dl>
288 <dl> 288 <dl>
289 <dt>Returns:</dt> 289 <dt>Return:</dt>
290 <dd> 290 <dd>
291 file name of the user dictionary or the user exception 291 file name of the user dictionary or the user exception
292 dictionary (string) 292 dictionary (string)
293 </dd> 293 </dd>
294 </dl> 294 </dl>
298 298
299 <p> 299 <p>
300 Class method to check, if spellchecking is available. 300 Class method to check, if spellchecking is available.
301 </p> 301 </p>
302 <dl> 302 <dl>
303 <dt>Returns:</dt> 303 <dt>Return:</dt>
304 <dd> 304 <dd>
305 flag indicating availability (boolean) 305 flag indicating availability (boolean)
306 </dd> 306 </dd>
307 </dl> 307 </dl>
308 <a NAME="SpellChecker.setDefaultLanguage" ID="SpellChecker.setDefaultLanguage"></a> 308 <a NAME="SpellChecker.setDefaultLanguage" ID="SpellChecker.setDefaultLanguage"></a>
335 </dd> 335 </dd>
336 <dt><i>indicator</i></dt> 336 <dt><i>indicator</i></dt>
337 <dd> 337 <dd>
338 spell checking indicator 338 spell checking indicator
339 </dd> 339 </dd>
340 <dt><i>defaultLanguage=</i></dt> 340 <dt><i>defaultLanguage</i></dt>
341 <dd> 341 <dd>
342 the language to be used as the default 342 the language to be used as the default
343 (string). The string should be in language locale format 343 (string). The string should be in language locale format
344 (e.g. en_US, de). 344 (e.g. en_US, de).
345 </dd> 345 </dd>
346 <dt><i>checkRegion=</i></dt> 346 <dt><i>checkRegion</i></dt>
347 <dd> 347 <dd>
348 reference to a function to check for a valid 348 reference to a function to check for a valid
349 region 349 region
350 </dd> 350 </dd>
351 </dl> 351 </dl>
385 <dd> 385 <dd>
386 position to stop word extraction (integer) 386 position to stop word extraction (integer)
387 </dd> 387 </dd>
388 </dl> 388 </dl>
389 <dl> 389 <dl>
390 <dt>Returns:</dt> 390 <dt>Return:</dt>
391 <dd> 391 <dd>
392 tuple of three values (the extracted word (string), 392 tuple of three values (the extracted word (string),
393 start position (integer), end position (integer)) 393 start position (integer), end position (integer))
394 </dd> 394 </dd>
395 </dl> 395 </dl>
406 406
407 <p> 407 <p>
408 Special method to create an iterator. 408 Special method to create an iterator.
409 </p> 409 </p>
410 <dl> 410 <dl>
411 <dt>Returns:</dt> 411 <dt>Return:</dt>
412 <dd> 412 <dd>
413 self 413 self
414 </dd> 414 </dd>
415 </dl> 415 </dl>
416 <a NAME="SpellChecker.__next__" ID="SpellChecker.__next__"></a> 416 <a NAME="SpellChecker.__next__" ID="SpellChecker.__next__"></a>
419 419
420 <p> 420 <p>
421 Special method to advance to the next error. 421 Special method to advance to the next error.
422 </p> 422 </p>
423 <dl> 423 <dl>
424 <dt>Returns:</dt> 424 <dt>Return:</dt>
425 <dd> 425 <dd>
426 self 426 self
427 </dd> 427 </dd>
428 </dl> 428 </dl>
429 <dl> 429 <dl>
504 504
505 <dt><i>pos</i></dt> 505 <dt><i>pos</i></dt>
506 <dd> 506 <dd>
507 position to check at (integer) 507 position to check at (integer)
508 </dd> 508 </dd>
509 <dt><i>atEnd=</i></dt> 509 <dt><i>atEnd</i></dt>
510 <dd> 510 <dd>
511 flag indicating the position is at the end of the word 511 flag indicating the position is at the end of the word
512 to check (boolean) 512 to check (boolean)
513 </dd> 513 </dd>
514 </dl> 514 </dl>
536 <dd> 536 <dd>
537 the ending position of the word (integer) 537 the ending position of the word (integer)
538 </dd> 538 </dd>
539 </dl> 539 </dl>
540 <dl> 540 <dl>
541 <dt>Returns:</dt> 541 <dt>Return:</dt>
542 <dd> 542 <dd>
543 tuple of the leading and trailing context (string, string) 543 tuple of the leading and trailing context (string, string)
544 </dd> 544 </dd>
545 </dl> 545 </dl>
546 <a NAME="SpellChecker.getError" ID="SpellChecker.getError"></a> 546 <a NAME="SpellChecker.getError" ID="SpellChecker.getError"></a>
549 549
550 <p> 550 <p>
551 Public method to get information about the last error found. 551 Public method to get information about the last error found.
552 </p> 552 </p>
553 <dl> 553 <dl>
554 <dt>Returns:</dt> 554 <dt>Return:</dt>
555 <dd> 555 <dd>
556 tuple of last faulty word (string), starting position of the 556 tuple of last faulty word (string), starting position of the
557 faulty word (integer) and ending position of the faulty word 557 faulty word (integer) and ending position of the faulty word
558 (integer) 558 (integer)
559 </dd> 559 </dd>
564 564
565 <p> 565 <p>
566 Public method to get the current language. 566 Public method to get the current language.
567 </p> 567 </p>
568 <dl> 568 <dl>
569 <dt>Returns:</dt> 569 <dt>Return:</dt>
570 <dd> 570 <dd>
571 current language in language locale format (string) 571 current language in language locale format (string)
572 </dd> 572 </dd>
573 </dl> 573 </dl>
574 <a NAME="SpellChecker.getSuggestions" ID="SpellChecker.getSuggestions"></a> 574 <a NAME="SpellChecker.getSuggestions" ID="SpellChecker.getSuggestions"></a>
584 <dd> 584 <dd>
585 word to get suggestions for (string) 585 word to get suggestions for (string)
586 </dd> 586 </dd>
587 </dl> 587 </dl>
588 <dl> 588 <dl>
589 <dt>Returns:</dt> 589 <dt>Return:</dt>
590 <dd> 590 <dd>
591 list of suggestions (list of strings) 591 list of suggestions (list of strings)
592 </dd> 592 </dd>
593 </dl> 593 </dl>
594 <a NAME="SpellChecker.ignoreAlways" ID="SpellChecker.ignoreAlways"></a> 594 <a NAME="SpellChecker.ignoreAlways" ID="SpellChecker.ignoreAlways"></a>
623 <dd> 623 <dd>
624 position to end at (integer) 624 position to end at (integer)
625 </dd> 625 </dd>
626 </dl> 626 </dl>
627 <dl> 627 <dl>
628 <dt>Returns:</dt> 628 <dt>Return:</dt>
629 <dd> 629 <dd>
630 flag indicating successful initialization (boolean) 630 flag indicating successful initialization (boolean)
631 </dd> 631 </dd>
632 </dl> 632 </dl>
633 <a NAME="SpellChecker.remove" ID="SpellChecker.remove"></a> 633 <a NAME="SpellChecker.remove" ID="SpellChecker.remove"></a>
686 <dt><i>language</i></dt> 686 <dt><i>language</i></dt>
687 <dd> 687 <dd>
688 the language to be used as the default (string). 688 the language to be used as the default (string).
689 The string should be in language locale format (e.g. en_US, de). 689 The string should be in language locale format (e.g. en_US, de).
690 </dd> 690 </dd>
691 <dt><i>pwl=</i></dt> 691 <dt><i>pwl</i></dt>
692 <dd> 692 <dd>
693 name of the personal/project word list (string) 693 name of the personal/project word list (string)
694 </dd> 694 </dd>
695 <dt><i>pel=</i></dt> 695 <dt><i>pel</i></dt>
696 <dd> 696 <dd>
697 name of the personal/project exclude list (string) 697 name of the personal/project exclude list (string)
698 </dd> 698 </dd>
699 </dl> 699 </dl>
700 <a NAME="SpellChecker.setMinimumWordSize" ID="SpellChecker.setMinimumWordSize"></a> 700 <a NAME="SpellChecker.setMinimumWordSize" ID="SpellChecker.setMinimumWordSize"></a>

eric ide

mercurial