eric6/Documentation/Source/eric6.QScintilla.SpellCheckingDialog.html

<!DOCTYPE html>
<html><head>
<title>eric6.QScintilla.SpellCheckingDialog</title>
<meta charset="UTF-8">
<style>
body {
    background: #EDECE6;
    margin: 0em 1em 10em 1em;
    color: black;
}

h1 { color: white; background: #85774A; }
h2 { color: white; background: #85774A; }
h3 { color: white; background: #9D936E; }
h4 { color: white; background: #9D936E; }
    
a { color: #BA6D36; }

</style>
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric6.QScintilla.SpellCheckingDialog</h1>

<p>
Module implementing the spell checking dialog.
</p>
<h3>Global Attributes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>

<table>

<tr>
<td><a href="#SpellCheckingDialog">SpellCheckingDialog</a></td>
<td>Class implementing the spell checking dialog.</td>
</tr>
</table>
<h3>Functions</h3>

<table>
<tr><td>None</td></tr>
</table>
<hr />
<hr />
<a NAME="SpellCheckingDialog" ID="SpellCheckingDialog"></a>
<h2>SpellCheckingDialog</h2>

<p>
    Class implementing the spell checking dialog.
</p>
<h3>Derived from</h3>
QDialog, Ui_SpellCheckingDialog
<h3>Class Attributes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Class Methods</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>

<table>

<tr>
<td><a href="#SpellCheckingDialog.__init__">SpellCheckingDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#SpellCheckingDialog.__advance">__advance</a></td>
<td>Private method to advance to the next error.</td>
</tr>
<tr>
<td><a href="#SpellCheckingDialog.__enableButtons">__enableButtons</a></td>
<td>Private method to set the buttons enabled state.</td>
</tr>
<tr>
<td><a href="#SpellCheckingDialog.on_addButton_clicked">on_addButton_clicked</a></td>
<td>Private slot to add the current word to the personal word list.</td>
</tr>
<tr>
<td><a href="#SpellCheckingDialog.on_changeEdit_textChanged">on_changeEdit_textChanged</a></td>
<td>Private method to handle a change of the replacement text.</td>
</tr>
<tr>
<td><a href="#SpellCheckingDialog.on_ignoreAllButton_clicked">on_ignoreAllButton_clicked</a></td>
<td>Private slot to always ignore the found error.</td>
</tr>
<tr>
<td><a href="#SpellCheckingDialog.on_ignoreButton_clicked">on_ignoreButton_clicked</a></td>
<td>Private slot to ignore the found error.</td>
</tr>
<tr>
<td><a href="#SpellCheckingDialog.on_replaceAllButton_clicked">on_replaceAllButton_clicked</a></td>
<td>Private slot to replace the current word with the given replacement.</td>
</tr>
<tr>
<td><a href="#SpellCheckingDialog.on_replaceButton_clicked">on_replaceButton_clicked</a></td>
<td>Private slot to replace the current word with the given replacement.</td>
</tr>
<tr>
<td><a href="#SpellCheckingDialog.on_suggestionsList_currentTextChanged">on_suggestionsList_currentTextChanged</a></td>
<td>Private method to handle the selection of a suggestion.</td>
</tr>
</table>
<h3>Static Methods</h3>

<table>
<tr><td>None</td></tr>
</table>

<a NAME="SpellCheckingDialog.__init__" ID="SpellCheckingDialog.__init__"></a>
<h4>SpellCheckingDialog (Constructor)</h4>
<b>SpellCheckingDialog</b>(<i>spellChecker, startPos, endPos, parent=None</i>)

<p>
        Constructor
</p>
<dl>

<dt><i>spellChecker</i></dt>
<dd>
reference to the spell checker (SpellChecker)
</dd>
<dt><i>startPos</i></dt>
<dd>
position to start spell checking (integer)
</dd>
<dt><i>endPos</i></dt>
<dd>
end position for spell checking (integer)
</dd>
<dt><i>parent</i></dt>
<dd>
reference to the parent widget (QWidget)
</dd>
</dl>
<a NAME="SpellCheckingDialog.__advance" ID="SpellCheckingDialog.__advance"></a>
<h4>SpellCheckingDialog.__advance</h4>
<b>__advance</b>(<i></i>)

<p>
        Private method to advance to the next error.
</p>
<a NAME="SpellCheckingDialog.__enableButtons" ID="SpellCheckingDialog.__enableButtons"></a>
<h4>SpellCheckingDialog.__enableButtons</h4>
<b>__enableButtons</b>(<i>enable</i>)

<p>
        Private method to set the buttons enabled state.
</p>
<dl>

<dt><i>enable</i></dt>
<dd>
enable state (boolean)
</dd>
</dl>
<a NAME="SpellCheckingDialog.on_addButton_clicked" ID="SpellCheckingDialog.on_addButton_clicked"></a>
<h4>SpellCheckingDialog.on_addButton_clicked</h4>
<b>on_addButton_clicked</b>(<i></i>)

<p>
        Private slot to add the current word to the personal word list.
</p>
<a NAME="SpellCheckingDialog.on_changeEdit_textChanged" ID="SpellCheckingDialog.on_changeEdit_textChanged"></a>
<h4>SpellCheckingDialog.on_changeEdit_textChanged</h4>
<b>on_changeEdit_textChanged</b>(<i>text</i>)

<p>
        Private method to handle a change of the replacement text.
</p>
<dl>

<dt><i>text</i></dt>
<dd>
contents of the line edit (string)
</dd>
</dl>
<a NAME="SpellCheckingDialog.on_ignoreAllButton_clicked" ID="SpellCheckingDialog.on_ignoreAllButton_clicked"></a>
<h4>SpellCheckingDialog.on_ignoreAllButton_clicked</h4>
<b>on_ignoreAllButton_clicked</b>(<i></i>)

<p>
        Private slot to always ignore the found error.
</p>
<a NAME="SpellCheckingDialog.on_ignoreButton_clicked" ID="SpellCheckingDialog.on_ignoreButton_clicked"></a>
<h4>SpellCheckingDialog.on_ignoreButton_clicked</h4>
<b>on_ignoreButton_clicked</b>(<i></i>)

<p>
        Private slot to ignore the found error.
</p>
<a NAME="SpellCheckingDialog.on_replaceAllButton_clicked" ID="SpellCheckingDialog.on_replaceAllButton_clicked"></a>
<h4>SpellCheckingDialog.on_replaceAllButton_clicked</h4>
<b>on_replaceAllButton_clicked</b>(<i></i>)

<p>
        Private slot to replace the current word with the given replacement.
</p>
<a NAME="SpellCheckingDialog.on_replaceButton_clicked" ID="SpellCheckingDialog.on_replaceButton_clicked"></a>
<h4>SpellCheckingDialog.on_replaceButton_clicked</h4>
<b>on_replaceButton_clicked</b>(<i></i>)

<p>
        Private slot to replace the current word with the given replacement.
</p>
<a NAME="SpellCheckingDialog.on_suggestionsList_currentTextChanged" ID="SpellCheckingDialog.on_suggestionsList_currentTextChanged"></a>
<h4>SpellCheckingDialog.on_suggestionsList_currentTextChanged</h4>
<b>on_suggestionsList_currentTextChanged</b>(<i>currentText</i>)

<p>
        Private method to handle the selection of a suggestion.
</p>
<dl>

<dt><i>currentText</i></dt>
<dd>
the currently selected text (string)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>