eric7/Documentation/Source/eric7.EricWidgets.EricSpellCheckedTextEdit.html

branch
eric7
changeset 8432
074407b4c107
parent 8428
2deec2f8a9ab
child 8596
d64760b2da50
equal deleted inserted replaced
8431:bed315a45088 8432:074407b4c107
337 <h3>Derived from</h3> 337 <h3>Derived from</h3>
338 None 338 None
339 <h3>Class Attributes</h3> 339 <h3>Class Attributes</h3>
340 340
341 <table> 341 <table>
342 <tr><td>DefaultLanguage</td></tr><tr><td>MaxSuggestions</td></tr> 342 <tr><td>DefaultLanguage</td></tr><tr><td>DefaultUserExceptionList</td></tr><tr><td>DefaultUserWordList</td></tr><tr><td>MaxSuggestions</td></tr>
343 </table> 343 </table>
344 <h3>Class Methods</h3> 344 <h3>Class Methods</h3>
345 345
346 <table> 346 <table>
347 347
357 <tr> 357 <tr>
358 <td><a href="#SpellCheckMixin.__init__">SpellCheckMixin</a></td> 358 <td><a href="#SpellCheckMixin.__init__">SpellCheckMixin</a></td>
359 <td>Constructor</td> 359 <td>Constructor</td>
360 </tr> 360 </tr>
361 <tr> 361 <tr>
362 <td><a href="#SpellCheckMixin.__addRemoveEntry">__addRemoveEntry</a></td>
363 <td>Private method to create a menu entry to remove the word at the menu position.</td>
364 </tr>
365 <tr>
366 <td><a href="#SpellCheckMixin.__addToUserDict">__addToUserDict</a></td>
367 <td>Private method to add a word to the user word or exclude list.</td>
368 </tr>
369 <tr>
362 <td><a href="#SpellCheckMixin.__correctWord">__correctWord</a></td> 370 <td><a href="#SpellCheckMixin.__correctWord">__correctWord</a></td>
363 <td>Private slot to correct the misspelled word with the selected correction.</td> 371 <td>Private method to replace some misspelled text.</td>
364 </tr> 372 </tr>
365 <tr> 373 <tr>
366 <td><a href="#SpellCheckMixin.__createCorrectionsMenu">__createCorrectionsMenu</a></td> 374 <td><a href="#SpellCheckMixin.__createCorrectionsMenu">__createCorrectionsMenu</a></td>
367 <td>Private method to create a menu for corrections of the selected word.</td> 375 <td>Private method to create a menu for corrections of the selected word.</td>
368 </tr> 376 </tr>
381 <tr> 389 <tr>
382 <td><a href="#SpellCheckMixin.__cursorForMisspelling">__cursorForMisspelling</a></td> 390 <td><a href="#SpellCheckMixin.__cursorForMisspelling">__cursorForMisspelling</a></td>
383 <td>Private method to create a text cursor selecting the misspelled word.</td> 391 <td>Private method to create a text cursor selecting the misspelled word.</td>
384 </tr> 392 </tr>
385 <tr> 393 <tr>
394 <td><a href="#SpellCheckMixin.__cursorForPosition">__cursorForPosition</a></td>
395 <td>Private method to create a text cursor selecting the word at the given position.</td>
396 </tr>
397 <tr>
386 <td><a href="#SpellCheckMixin.__setFormat">__setFormat</a></td> 398 <td><a href="#SpellCheckMixin.__setFormat">__setFormat</a></td>
387 <td>Private slot to set the selected document format.</td> 399 <td>Private slot to set the selected document format.</td>
388 </tr> 400 </tr>
389 <tr> 401 <tr>
390 <td><a href="#SpellCheckMixin.__setLanguage">__setLanguage</a></td> 402 <td><a href="#SpellCheckMixin.__setLanguage">__setLanguage</a></td>
391 <td>Private slot to set the selected language.</td> 403 <td>Private slot to set the selected language.</td>
392 </tr> 404 </tr>
393 <tr> 405 <tr>
406 <td><a href="#SpellCheckMixin.__spellMenuTriggered">__spellMenuTriggered</a></td>
407 <td>Private slot to handle a selection of the spell menu.</td>
408 </tr>
409 <tr>
394 <td><a href="#SpellCheckMixin.contextMenuEvent">contextMenuEvent</a></td> 410 <td><a href="#SpellCheckMixin.contextMenuEvent">contextMenuEvent</a></td>
395 <td>Protected method to handle context menu events to add a spelling suggestions submenu.</td> 411 <td>Protected method to handle context menu events to add a spelling suggestions submenu.</td>
396 </tr> 412 </tr>
397 <tr> 413 <tr>
398 <td><a href="#SpellCheckMixin.dict">dict</a></td> 414 <td><a href="#SpellCheckMixin.dict">dict</a></td>
413 <tr><td>None</td></tr> 429 <tr><td>None</td></tr>
414 </table> 430 </table>
415 431
416 <a NAME="SpellCheckMixin.setDefaultLanguage" ID="SpellCheckMixin.setDefaultLanguage"></a> 432 <a NAME="SpellCheckMixin.setDefaultLanguage" ID="SpellCheckMixin.setDefaultLanguage"></a>
417 <h4>SpellCheckMixin.setDefaultLanguage (class method)</h4> 433 <h4>SpellCheckMixin.setDefaultLanguage (class method)</h4>
418 <b>setDefaultLanguage</b>(<i>language</i>) 434 <b>setDefaultLanguage</b>(<i>language, pwl=None, pel=None</i>)
419 435
420 <p> 436 <p>
421 Class method to set the default spell-check language. 437 Class method to set the default spell-check language.
422 </p> 438 </p>
423 <dl> 439 <dl>
424 440
425 <dt><i>language</i> (str)</dt> 441 <dt><i>language</i> (str)</dt>
426 <dd> 442 <dd>
427 language to be set as default 443 language to be set as default
444 </dd>
445 <dt><i>pwl</i> (str)</dt>
446 <dd>
447 file name of the personal word list
448 </dd>
449 <dt><i>pel</i> (str)</dt>
450 <dd>
451 file name of the personal exclude list
428 </dd> 452 </dd>
429 </dl> 453 </dl>
430 <a NAME="SpellCheckMixin.__init__" ID="SpellCheckMixin.__init__"></a> 454 <a NAME="SpellCheckMixin.__init__" ID="SpellCheckMixin.__init__"></a>
431 <h4>SpellCheckMixin (Constructor)</h4> 455 <h4>SpellCheckMixin (Constructor)</h4>
432 <b>SpellCheckMixin</b>(<i></i>) 456 <b>SpellCheckMixin</b>(<i></i>)
433 457
434 <p> 458 <p>
435 Constructor 459 Constructor
436 </p> 460 </p>
461 <a NAME="SpellCheckMixin.__addRemoveEntry" ID="SpellCheckMixin.__addRemoveEntry"></a>
462 <h4>SpellCheckMixin.__addRemoveEntry</h4>
463 <b>__addRemoveEntry</b>(<i>cursor, menu</i>)
464
465 <p>
466 Private method to create a menu entry to remove the word at the
467 menu position.
468 </p>
469 <dl>
470
471 <dt><i>cursor</i> (QTextCursor)</dt>
472 <dd>
473 reference to the text cursor for the misspelled word
474 </dd>
475 <dt><i>menu</i> (QMenu)</dt>
476 <dd>
477 reference to the context menu
478 </dd>
479 </dl>
480 <a NAME="SpellCheckMixin.__addToUserDict" ID="SpellCheckMixin.__addToUserDict"></a>
481 <h4>SpellCheckMixin.__addToUserDict</h4>
482 <b>__addToUserDict</b>(<i>word, command</i>)
483
484 <p>
485 Private method to add a word to the user word or exclude list.
486 </p>
487 <dl>
488
489 <dt><i>word</i> (str)</dt>
490 <dd>
491 text to be added
492 </dd>
493 <dt><i>command</i> (str)</dt>
494 <dd>
495 command indicating the user dictionary type
496 </dd>
497 </dl>
437 <a NAME="SpellCheckMixin.__correctWord" ID="SpellCheckMixin.__correctWord"></a> 498 <a NAME="SpellCheckMixin.__correctWord" ID="SpellCheckMixin.__correctWord"></a>
438 <h4>SpellCheckMixin.__correctWord</h4> 499 <h4>SpellCheckMixin.__correctWord</h4>
439 <b>__correctWord</b>(<i>act</i>) 500 <b>__correctWord</b>(<i>cursor, word</i>)
440 501
441 <p> 502 <p>
442 Private slot to correct the misspelled word with the selected 503 Private method to replace some misspelled text.
443 correction. 504 </p>
444 </p> 505 <dl>
445 <dl> 506
446 507 <dt><i>cursor</i> (QTextCursor)</dt>
447 <dt><i>act</i> (QAction)</dt> 508 <dd>
448 <dd> 509 reference to the text cursor for the misspelled word
449 reference to the selected action 510 </dd>
511 <dt><i>word</i> (str)</dt>
512 <dd>
513 replacement text
450 </dd> 514 </dd>
451 </dl> 515 </dl>
452 <a NAME="SpellCheckMixin.__createCorrectionsMenu" ID="SpellCheckMixin.__createCorrectionsMenu"></a> 516 <a NAME="SpellCheckMixin.__createCorrectionsMenu" ID="SpellCheckMixin.__createCorrectionsMenu"></a>
453 <h4>SpellCheckMixin.__createCorrectionsMenu</h4> 517 <h4>SpellCheckMixin.__createCorrectionsMenu</h4>
454 <b>__createCorrectionsMenu</b>(<i>cursor, parent=None</i>) 518 <b>__createCorrectionsMenu</b>(<i>cursor, parent=None</i>)
584 <dt>Return Type:</dt> 648 <dt>Return Type:</dt>
585 <dd> 649 <dd>
586 QTextCursor 650 QTextCursor
587 </dd> 651 </dd>
588 </dl> 652 </dl>
653 <a NAME="SpellCheckMixin.__cursorForPosition" ID="SpellCheckMixin.__cursorForPosition"></a>
654 <h4>SpellCheckMixin.__cursorForPosition</h4>
655 <b>__cursorForPosition</b>(<i>pos</i>)
656
657 <p>
658 Private method to create a text cursor selecting the word at the
659 given position.
660 </p>
661 <dl>
662
663 <dt><i>pos</i> (QPoint)</dt>
664 <dd>
665 position of the misspelled word
666 </dd>
667 </dl>
668 <dl>
669 <dt>Return:</dt>
670 <dd>
671 text cursor for the word
672 </dd>
673 </dl>
674 <dl>
675 <dt>Return Type:</dt>
676 <dd>
677 QTextCursor
678 </dd>
679 </dl>
589 <a NAME="SpellCheckMixin.__setFormat" ID="SpellCheckMixin.__setFormat"></a> 680 <a NAME="SpellCheckMixin.__setFormat" ID="SpellCheckMixin.__setFormat"></a>
590 <h4>SpellCheckMixin.__setFormat</h4> 681 <h4>SpellCheckMixin.__setFormat</h4>
591 <b>__setFormat</b>(<i>act</i>) 682 <b>__setFormat</b>(<i>act</i>)
592 683
593 <p> 684 <p>
612 <dt><i>act</i> (QAction)</dt> 703 <dt><i>act</i> (QAction)</dt>
613 <dd> 704 <dd>
614 reference to the selected action 705 reference to the selected action
615 </dd> 706 </dd>
616 </dl> 707 </dl>
708 <a NAME="SpellCheckMixin.__spellMenuTriggered" ID="SpellCheckMixin.__spellMenuTriggered"></a>
709 <h4>SpellCheckMixin.__spellMenuTriggered</h4>
710 <b>__spellMenuTriggered</b>(<i>act</i>)
711
712 <p>
713 Private slot to handle a selection of the spell menu.
714 </p>
715 <dl>
716
717 <dt><i>act</i> (QAction)</dt>
718 <dd>
719 reference to the selected action
720 </dd>
721 </dl>
617 <a NAME="SpellCheckMixin.contextMenuEvent" ID="SpellCheckMixin.contextMenuEvent"></a> 722 <a NAME="SpellCheckMixin.contextMenuEvent" ID="SpellCheckMixin.contextMenuEvent"></a>
618 <h4>SpellCheckMixin.contextMenuEvent</h4> 723 <h4>SpellCheckMixin.contextMenuEvent</h4>
619 <b>contextMenuEvent</b>(<i>evt</i>) 724 <b>contextMenuEvent</b>(<i>evt</i>)
620 725
621 <p> 726 <p>

eric ide

mercurial