--- a/eric7/Documentation/Source/eric7.EricWidgets.EricSpellCheckedTextEdit.html Thu Jun 17 18:56:21 2021 +0200 +++ b/eric7/Documentation/Source/eric7.EricWidgets.EricSpellCheckedTextEdit.html Sat Jun 19 12:17:17 2021 +0200 @@ -339,7 +339,7 @@ <h3>Class Attributes</h3> <table> -<tr><td>DefaultLanguage</td></tr><tr><td>MaxSuggestions</td></tr> +<tr><td>DefaultLanguage</td></tr><tr><td>DefaultUserExceptionList</td></tr><tr><td>DefaultUserWordList</td></tr><tr><td>MaxSuggestions</td></tr> </table> <h3>Class Methods</h3> @@ -359,8 +359,16 @@ <td>Constructor</td> </tr> <tr> +<td><a href="#SpellCheckMixin.__addRemoveEntry">__addRemoveEntry</a></td> +<td>Private method to create a menu entry to remove the word at the menu position.</td> +</tr> +<tr> +<td><a href="#SpellCheckMixin.__addToUserDict">__addToUserDict</a></td> +<td>Private method to add a word to the user word or exclude list.</td> +</tr> +<tr> <td><a href="#SpellCheckMixin.__correctWord">__correctWord</a></td> -<td>Private slot to correct the misspelled word with the selected correction.</td> +<td>Private method to replace some misspelled text.</td> </tr> <tr> <td><a href="#SpellCheckMixin.__createCorrectionsMenu">__createCorrectionsMenu</a></td> @@ -383,6 +391,10 @@ <td>Private method to create a text cursor selecting the misspelled word.</td> </tr> <tr> +<td><a href="#SpellCheckMixin.__cursorForPosition">__cursorForPosition</a></td> +<td>Private method to create a text cursor selecting the word at the given position.</td> +</tr> +<tr> <td><a href="#SpellCheckMixin.__setFormat">__setFormat</a></td> <td>Private slot to set the selected document format.</td> </tr> @@ -391,6 +403,10 @@ <td>Private slot to set the selected language.</td> </tr> <tr> +<td><a href="#SpellCheckMixin.__spellMenuTriggered">__spellMenuTriggered</a></td> +<td>Private slot to handle a selection of the spell menu.</td> +</tr> +<tr> <td><a href="#SpellCheckMixin.contextMenuEvent">contextMenuEvent</a></td> <td>Protected method to handle context menu events to add a spelling suggestions submenu.</td> </tr> @@ -415,7 +431,7 @@ <a NAME="SpellCheckMixin.setDefaultLanguage" ID="SpellCheckMixin.setDefaultLanguage"></a> <h4>SpellCheckMixin.setDefaultLanguage (class method)</h4> -<b>setDefaultLanguage</b>(<i>language</i>) +<b>setDefaultLanguage</b>(<i>language, pwl=None, pel=None</i>) <p> Class method to set the default spell-check language. @@ -426,6 +442,14 @@ <dd> language to be set as default </dd> +<dt><i>pwl</i> (str)</dt> +<dd> +file name of the personal word list +</dd> +<dt><i>pel</i> (str)</dt> +<dd> +file name of the personal exclude list +</dd> </dl> <a NAME="SpellCheckMixin.__init__" ID="SpellCheckMixin.__init__"></a> <h4>SpellCheckMixin (Constructor)</h4> @@ -434,19 +458,59 @@ <p> Constructor </p> -<a NAME="SpellCheckMixin.__correctWord" ID="SpellCheckMixin.__correctWord"></a> -<h4>SpellCheckMixin.__correctWord</h4> -<b>__correctWord</b>(<i>act</i>) +<a NAME="SpellCheckMixin.__addRemoveEntry" ID="SpellCheckMixin.__addRemoveEntry"></a> +<h4>SpellCheckMixin.__addRemoveEntry</h4> +<b>__addRemoveEntry</b>(<i>cursor, menu</i>) <p> - Private slot to correct the misspelled word with the selected - correction. + Private method to create a menu entry to remove the word at the + menu position. </p> <dl> -<dt><i>act</i> (QAction)</dt> +<dt><i>cursor</i> (QTextCursor)</dt> +<dd> +reference to the text cursor for the misspelled word +</dd> +<dt><i>menu</i> (QMenu)</dt> +<dd> +reference to the context menu +</dd> +</dl> +<a NAME="SpellCheckMixin.__addToUserDict" ID="SpellCheckMixin.__addToUserDict"></a> +<h4>SpellCheckMixin.__addToUserDict</h4> +<b>__addToUserDict</b>(<i>word, command</i>) + +<p> + Private method to add a word to the user word or exclude list. +</p> +<dl> + +<dt><i>word</i> (str)</dt> <dd> -reference to the selected action +text to be added +</dd> +<dt><i>command</i> (str)</dt> +<dd> +command indicating the user dictionary type +</dd> +</dl> +<a NAME="SpellCheckMixin.__correctWord" ID="SpellCheckMixin.__correctWord"></a> +<h4>SpellCheckMixin.__correctWord</h4> +<b>__correctWord</b>(<i>cursor, word</i>) + +<p> + Private method to replace some misspelled text. +</p> +<dl> + +<dt><i>cursor</i> (QTextCursor)</dt> +<dd> +reference to the text cursor for the misspelled word +</dd> +<dt><i>word</i> (str)</dt> +<dd> +replacement text </dd> </dl> <a NAME="SpellCheckMixin.__createCorrectionsMenu" ID="SpellCheckMixin.__createCorrectionsMenu"></a> @@ -586,6 +650,33 @@ QTextCursor </dd> </dl> +<a NAME="SpellCheckMixin.__cursorForPosition" ID="SpellCheckMixin.__cursorForPosition"></a> +<h4>SpellCheckMixin.__cursorForPosition</h4> +<b>__cursorForPosition</b>(<i>pos</i>) + +<p> + Private method to create a text cursor selecting the word at the + given position. +</p> +<dl> + +<dt><i>pos</i> (QPoint)</dt> +<dd> +position of the misspelled word +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +text cursor for the word +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QTextCursor +</dd> +</dl> <a NAME="SpellCheckMixin.__setFormat" ID="SpellCheckMixin.__setFormat"></a> <h4>SpellCheckMixin.__setFormat</h4> <b>__setFormat</b>(<i>act</i>) @@ -614,6 +705,20 @@ reference to the selected action </dd> </dl> +<a NAME="SpellCheckMixin.__spellMenuTriggered" ID="SpellCheckMixin.__spellMenuTriggered"></a> +<h4>SpellCheckMixin.__spellMenuTriggered</h4> +<b>__spellMenuTriggered</b>(<i>act</i>) + +<p> + Private slot to handle a selection of the spell menu. +</p> +<dl> + +<dt><i>act</i> (QAction)</dt> +<dd> +reference to the selected action +</dd> +</dl> <a NAME="SpellCheckMixin.contextMenuEvent" ID="SpellCheckMixin.contextMenuEvent"></a> <h4>SpellCheckMixin.contextMenuEvent</h4> <b>contextMenuEvent</b>(<i>evt</i>)