.TH "KDictSpellingHighlighter" kde3 "11 Jun 2005" "Version Version 3.4.1" "kdeui Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KDictSpellingHighlighter \- Dictionary sensitive text highlighter.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <ksyntaxhighlighter.h>\fP
.PP
Inherits \fBQObject\fP, and KSpellingHighlighter.
.PP
.SS "Signals"

.in +1c
.ti -1c
.RI "void \fBactiveChanged\fP (const \fBQString\fP &)"
.br
.ti -1c
.RI "void \fBnewSuggestions\fP (const \fBQString\fP &originalword, const \fBQStringList\fP &suggestions, unsigned int pos)"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKDictSpellingHighlighter\fP (\fBQTextEdit\fP *\fBtextEdit\fP, bool spellCheckingActive=true, bool autoEnable=true, const \fBQColor\fP &spellColor=red, bool colorQuoting=false, const \fBQColor\fP &QuoteColor0=black, const \fBQColor\fP &QuoteColor1=\fBQColor\fP(0x00, 0x80, 0x00), const \fBQColor\fP &QuoteColor2=\fBQColor\fP(0x00, 0x70, 0x00), const \fBQColor\fP &QuoteColor3=\fBQColor\fP(0x00, 0x60, 0x00), \fBKSpellConfig\fP *spellConfig=0)"
.br
.ti -1c
.RI "virtual bool \fBisMisspelled\fP (const \fBQString\fP &word)"
.br
.ti -1c
.RI "void \fBrestartBackgroundSpellCheck\fP ()"
.br
.ti -1c
.RI "void \fBsetActive\fP (bool active)"
.br
.ti -1c
.RI "bool \fBisActive\fP () const "
.br
.ti -1c
.RI "void \fBsetAutomatic\fP (bool automatic)"
.br
.ti -1c
.RI "bool \fBautomatic\fP () const "
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "static void \fBdictionaryChanged\fP ()"
.br
.in -1c
.SS "Protected Slots"

.in +1c
.ti -1c
.RI "void \fBslotMisspelling\fP (const \fBQString\fP &originalWord, const \fBQStringList\fP &suggestions, unsigned int pos)"
.br
.ti -1c
.RI "void \fBslotCorrected\fP (const \fBQString\fP &originalWord, const \fBQString\fP &, unsigned int)"
.br
.ti -1c
.RI "void \fBslotRehighlight\fP ()"
.br
.ti -1c
.RI "void \fBslotDictionaryChanged\fP ()"
.br
.ti -1c
.RI "void \fBslotSpellReady\fP (\fBKSpell\fP *spell)"
.br
.ti -1c
.RI "void \fBslotAutoDetection\fP ()"
.br
.ti -1c
.RI "void \fBslotLocalSpellConfigChanged\fP ()"
.br
.ti -1c
.RI "void \fBslotKSpellNotResponding\fP ()"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "\fBQString\fP \fBspellKey\fP ()"
.br
.ti -1c
.RI "bool \fBeventFilter\fP (\fBQObject\fP *o, \fBQEvent\fP *e)"
.br
.in -1c
.SH "Detailed Description"
.PP 
Dictionary sensitive text highlighter. 
.PP
Definition at line 94 of file ksyntaxhighlighter.h.
.SH "Member Function Documentation"
.PP 
.SS "void KDictSpellingHighlighter::setActive (bool active)"
.PP
Enable/Disable spell checking. 
.PP
If \fCactive\fP is true then spell checking is enabled; otherwise it is disabled. Note that you have to disable automatic (de)activation with \fBsetAutomatic()\fP before you change the state of spell checking if you want to persistently enable/disable spell checking.
.PP
\fBParameters:\fP
.RS 4
\fIactive\fP if true, then spell checking is enabled
.RE
.PP
\fBSee also:\fP
.RS 4
\fBisActive()\fP, \fBsetAutomatic()\fP 
.RE
.PP

.PP
Definition at line 463 of file ksyntaxhighlighter.cpp.
.PP
References QSyntaxHighlighter::rehighlight().
.SS "bool KDictSpellingHighlighter::isActive () const"
.PP
Returns the state of spell checking. 
.PP
\fBReturns:\fP
.RS 4
true if spell checking is active
.RE
.PP
\fBSee also:\fP
.RS 4
\fBsetActive()\fP 
.RE
.PP

.PP
Definition at line 476 of file ksyntaxhighlighter.cpp.
.SS "void KDictSpellingHighlighter::setAutomatic (bool automatic)"
.PP
En-/Disable automatic (de)activation in case of too many errors. 
.PP
If \fCautomatic\fP is true then spell checking will be deactivated if too many words were mispelled and spell checking will be activated again if the amount of mispelled words drop below a certain threshold.
.PP
\fBParameters:\fP
.RS 4
\fIautomatic\fP if true, then automatic (de)activation is enabled
.RE
.PP
\fBSee also:\fP
.RS 4
\fBautomatic()\fP 
.RE
.PP

.PP
Definition at line 481 of file ksyntaxhighlighter.cpp.
.SS "bool KDictSpellingHighlighter::automatic () const"
.PP
Returns the state of automatic (de)activation. 
.PP
\fBReturns:\fP
.RS 4
true if automatic (de)activation is enabled
.RE
.PP
\fBSee also:\fP
.RS 4
\fBsetAutomatic()\fP 
.RE
.PP

.PP
Definition at line 491 of file ksyntaxhighlighter.cpp.

.SH "Author"
.PP 
Generated automatically by Doxygen for kdeui Library from the source code.
