\section{KDict\-Spelling\-Highlighter Class Reference}
\label{classKDictSpellingHighlighter}\index{KDictSpellingHighlighter@{KDictSpellingHighlighter}}
Dictionary sensitive text highlighter.  


{\tt \#include $<$ksyntaxhighlighter.h$>$}

Inheritance diagram for KDict\-Spelling\-Highlighter:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=79pt]{classKDictSpellingHighlighter__inherit__graph}
\end{center}
\end{figure}
Collaboration diagram for KDict\-Spelling\-Highlighter:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=79pt]{classKDictSpellingHighlighter__coll__graph}
\end{center}
\end{figure}
\subsection*{Signals}
\begin{CompactItemize}
\item 
void {\bf active\-Changed} (const {\bf QString} \&)\label{classKDictSpellingHighlighter_l0}

\item 
void {\bf new\-Suggestions} (const {\bf QString} \&originalword, const {\bf QString\-List} \&suggestions, unsigned int pos)\label{classKDictSpellingHighlighter_l1}

\end{CompactItemize}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf KDict\-Spelling\-Highlighter} ({\bf QText\-Edit} $\ast${\bf text\-Edit}, bool spell\-Checking\-Active=true, bool auto\-Enable=true, const {\bf QColor} \&spell\-Color=red, bool color\-Quoting=false, const {\bf QColor} \&Quote\-Color0=black, const {\bf QColor} \&Quote\-Color1={\bf QColor}(0x00, 0x80, 0x00), const {\bf QColor} \&Quote\-Color2={\bf QColor}(0x00, 0x70, 0x00), const {\bf QColor} \&Quote\-Color3={\bf QColor}(0x00, 0x60, 0x00), {\bf KSpell\-Config} $\ast$spell\-Config=0)\label{classKDictSpellingHighlighter_a0}

\item 
virtual bool {\bf is\-Misspelled} (const {\bf QString} \&word)\label{classKDictSpellingHighlighter_a2}

\item 
void {\bf restart\-Background\-Spell\-Check} ()\label{classKDictSpellingHighlighter_a3}

\item 
void {\bf set\-Active} (bool active)
\item 
bool {\bf is\-Active} () const 
\item 
void {\bf set\-Automatic} (bool automatic)
\item 
bool {\bf automatic} () const 
\end{CompactItemize}
\subsection*{Static Public Member Functions}
\begin{CompactItemize}
\item 
static void {\bf dictionary\-Changed} ()\label{classKDictSpellingHighlighter_e0}

\end{CompactItemize}
\subsection*{Protected Slots}
\begin{CompactItemize}
\item 
void {\bf slot\-Misspelling} (const {\bf QString} \&original\-Word, const {\bf QString\-List} \&suggestions, unsigned int pos)\label{classKDictSpellingHighlighter_j0}

\item 
void {\bf slot\-Corrected} (const {\bf QString} \&original\-Word, const {\bf QString} \&, unsigned int)\label{classKDictSpellingHighlighter_j1}

\item 
void {\bf slot\-Rehighlight} ()\label{classKDictSpellingHighlighter_j2}

\item 
void {\bf slot\-Dictionary\-Changed} ()\label{classKDictSpellingHighlighter_j3}

\item 
void {\bf slot\-Spell\-Ready} ({\bf KSpell} $\ast$spell)\label{classKDictSpellingHighlighter_j4}

\item 
void {\bf slot\-Auto\-Detection} ()\label{classKDictSpellingHighlighter_j5}

\item 
void {\bf slot\-Local\-Spell\-Config\-Changed} ()\label{classKDictSpellingHighlighter_j6}

\item 
void {\bf slot\-KSpell\-Not\-Responding} ()\label{classKDictSpellingHighlighter_j7}

\end{CompactItemize}
\subsection*{Protected Member Functions}
\begin{CompactItemize}
\item 
{\bf QString} {\bf spell\-Key} ()\label{classKDictSpellingHighlighter_b0}

\item 
bool {\bf event\-Filter} ({\bf QObject} $\ast$o, {\bf QEvent} $\ast$e)\label{classKDictSpellingHighlighter_b1}

\end{CompactItemize}


\subsection{Detailed Description}
Dictionary sensitive text highlighter. 



Definition at line 94 of file ksyntaxhighlighter.h.

\subsection{Member Function Documentation}
\index{KDictSpellingHighlighter@{KDict\-Spelling\-Highlighter}!setActive@{setActive}}
\index{setActive@{setActive}!KDictSpellingHighlighter@{KDict\-Spelling\-Highlighter}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDict\-Spelling\-Highlighter::set\-Active (bool {\em active})}\label{classKDictSpellingHighlighter_a4}


Enable/Disable spell checking. 

If {\tt active} is true then spell checking is enabled; otherwise it is disabled. Note that you have to disable automatic (de)activation with {\bf set\-Automatic()}{\rm (p.\,\pageref{classKDictSpellingHighlighter_a6})} before you change the state of spell checking if you want to persistently enable/disable spell checking.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em active}]if true, then spell checking is enabled\end{description}
\end{Desc}
\begin{Desc}
\item[See also:]{\bf is\-Active()}{\rm (p.\,\pageref{classKDictSpellingHighlighter_a5})}, {\bf set\-Automatic()}{\rm (p.\,\pageref{classKDictSpellingHighlighter_a6})} \end{Desc}


Definition at line 463 of file ksyntaxhighlighter.cpp.

References QSyntax\-Highlighter::rehighlight().\index{KDictSpellingHighlighter@{KDict\-Spelling\-Highlighter}!isActive@{isActive}}
\index{isActive@{isActive}!KDictSpellingHighlighter@{KDict\-Spelling\-Highlighter}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool KDict\-Spelling\-Highlighter::is\-Active () const}\label{classKDictSpellingHighlighter_a5}


Returns the state of spell checking. 

\begin{Desc}
\item[Returns:]true if spell checking is active\end{Desc}
\begin{Desc}
\item[See also:]{\bf set\-Active()}{\rm (p.\,\pageref{classKDictSpellingHighlighter_a4})} \end{Desc}


Definition at line 476 of file ksyntaxhighlighter.cpp.\index{KDictSpellingHighlighter@{KDict\-Spelling\-Highlighter}!setAutomatic@{setAutomatic}}
\index{setAutomatic@{setAutomatic}!KDictSpellingHighlighter@{KDict\-Spelling\-Highlighter}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KDict\-Spelling\-Highlighter::set\-Automatic (bool {\em automatic})}\label{classKDictSpellingHighlighter_a6}


En-/Disable automatic (de)activation in case of too many errors. 

If {\tt automatic} 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.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em automatic}]if true, then automatic (de)activation is enabled\end{description}
\end{Desc}
\begin{Desc}
\item[See also:]{\bf automatic()}{\rm (p.\,\pageref{classKDictSpellingHighlighter_a7})} \end{Desc}


Definition at line 481 of file ksyntaxhighlighter.cpp.\index{KDictSpellingHighlighter@{KDict\-Spelling\-Highlighter}!automatic@{automatic}}
\index{automatic@{automatic}!KDictSpellingHighlighter@{KDict\-Spelling\-Highlighter}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool KDict\-Spelling\-Highlighter::automatic () const}\label{classKDictSpellingHighlighter_a7}


Returns the state of automatic (de)activation. 

\begin{Desc}
\item[Returns:]true if automatic (de)activation is enabled\end{Desc}
\begin{Desc}
\item[See also:]{\bf set\-Automatic()}{\rm (p.\,\pageref{classKDictSpellingHighlighter_a6})} \end{Desc}


Definition at line 491 of file ksyntaxhighlighter.cpp.

The documentation for this class was generated from the following files:\begin{CompactItemize}
\item 
ksyntaxhighlighter.h\item 
ksyntaxhighlighter.cpp\end{CompactItemize}
