\section{KSpell\-Config Class Reference}
\label{classKSpellConfig}\index{KSpellConfig@{KSpellConfig}}
A configuration class/dialog for {\bf KSpell}{\rm (p.\,\pageref{classKSpell})}.  


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

Inheritance diagram for KSpell\-Config:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=56pt]{classKSpellConfig__inherit__graph}
\end{center}
\end{figure}
Collaboration diagram for KSpell\-Config:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=301pt]{classKSpellConfig__coll__graph}
\end{center}
\end{figure}
\subsection*{Public Slots}
\begin{CompactItemize}
\item 
void {\bf activate\-Help} (void)
\begin{CompactList}\small\item\em Use this function to activate the help information for this widget. \item\end{CompactList}\end{CompactItemize}
\subsection*{Signals}
\begin{CompactItemize}
\item 
void {\bf config\-Changed} ()\label{classKSpellConfig_l0}

\end{CompactItemize}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf KSpell\-Config} ({\bf QWidget} $\ast$parent=0, const  char $\ast$name=0, {\bf KSpell\-Config} $\ast$spell\-Config=0, bool add\-Help\-Button=true)
\begin{CompactList}\small\item\em Constructs a KSpell\-Config with default or custom settings. \item\end{CompactList}\item 
{\bf KSpell\-Config} (const  {\bf KSpell\-Config} \&)\label{classKSpellConfig_a1}

\item 
void {\bf operator=} (const  {\bf KSpell\-Config} \&ksc)\label{classKSpellConfig_a3}

\item 
void {\bf set\-Ignore\-List} ({\bf QString\-List} \_\-ignorelist)
\begin{CompactList}\small\item\em The {\tt \_\-ignorelist} contains words you'd like {\bf KSpell}{\rm (p.\,\pageref{classKSpell})} to ignore when it is spellchecking. \item\end{CompactList}\item 
void {\bf set\-Replace\-All\-List} ({\bf QString\-List} \_\-replace\-All\-List)
\begin{CompactList}\small\item\em The {\tt \_\-replace\-All\-List} contains word you like that replace word. \item\end{CompactList}\item 
void {\bf set\-No\-Root\-Affix} (bool)
\begin{CompactList}\small\item\em Set an ISpell option. \item\end{CompactList}\item 
void {\bf set\-Run\-Together} (bool)
\begin{CompactList}\small\item\em Set an ISpell option. \item\end{CompactList}\item 
void {\bf set\-Dictionary} (const  {\bf QString} qs)
\begin{CompactList}\small\item\em Set the name of the dictionary to use. \item\end{CompactList}\item 
void {\bf set\-Dict\-From\-List} (bool dfl)\label{classKSpellConfig_a9}

\item 
void {\bf set\-Encoding} (int enctype)\label{classKSpellConfig_a10}

\item 
void {\bf set\-Client} (int client)\label{classKSpellConfig_a11}

\item 
bool {\bf no\-Root\-Affix} () const 
\begin{CompactList}\small\item\em Options reading routines. \item\end{CompactList}\item 
bool {\bf run\-Together} () const \label{classKSpellConfig_a13}

\item 
const  {\bf QString} {\bf dictionary} () const \label{classKSpellConfig_a14}

\item 
bool {\bf dict\-From\-List} () const \label{classKSpellConfig_a15}

\item 
int {\bf encoding} () const \label{classKSpellConfig_a16}

\item 
{\bf QString\-List} {\bf ignore\-List} () const \label{classKSpellConfig_a17}

\item 
{\bf QString\-List} {\bf replace\-All\-List} () const \label{classKSpellConfig_a18}

\item 
int {\bf client} () const \label{classKSpellConfig_a19}

\item 
bool {\bf write\-Global\-Settings} ()
\begin{CompactList}\small\item\em Call this method before this class is deleted if you want the settings you have (or the user has) chosen to become the global, default settings. \item\end{CompactList}\end{CompactItemize}
\subsection*{Protected Types}
\begin{CompactItemize}
\item 
enum \{ {\bf rdictlist} = 3, 
{\bf rencoding} = 4, 
{\bf rhelp} = 6
 \}
\end{CompactItemize}
\subsection*{Protected Slots}
\begin{CompactItemize}
\item 
void {\bf s\-Help} ()\label{classKSpellConfig_j0}

\item 
void {\bf s\-No\-Aff} (bool)\label{classKSpellConfig_j1}

\item 
void {\bf s\-Run\-Together} (bool)\label{classKSpellConfig_j2}

\item 
void {\bf s\-Dictionary} (bool)\label{classKSpellConfig_j3}

\item 
void {\bf s\-Path\-Dictionary} (bool)\label{classKSpellConfig_j4}

\item 
void {\bf s\-Set\-Dictionary} (int)\label{classKSpellConfig_j5}

\item 
void {\bf s\-Change\-Encoding} (int)\label{classKSpellConfig_j6}

\item 
void {\bf s\-Change\-Client} (int)\label{classKSpellConfig_j7}

\end{CompactItemize}
\subsection*{Protected Member Functions}
\begin{CompactItemize}
\item 
void {\bf fill\-In\-Dialog} ()\label{classKSpellConfig_b0}

\item 
bool {\bf read\-Global\-Settings} ()\label{classKSpellConfig_b1}

\item 
bool {\bf interpret} ({\bf QString} \&fname, {\bf QString} \&lname, {\bf QString} \&hname)
\begin{CompactList}\small\item\em This takes a dictionary file name (fname) and returns a language abbreviation (lname; like de for German), appropriate for the \$LANG variable, and a human-readble name (hname; like \char`\"{}Deutsch\char`\"{}). \item\end{CompactList}\end{CompactItemize}
\subsection*{Protected Attributes}
\begin{CompactItemize}
\item 
int {\bf enc}\label{classKSpellConfig_p0}

\item 
bool {\bf bnorootaffix}\label{classKSpellConfig_p1}

\item 
bool {\bf bruntogether}\label{classKSpellConfig_p2}

\item 
bool {\bf dictfromlist}\label{classKSpellConfig_p3}

\item 
bool {\bf nodialog}\label{classKSpellConfig_p4}

\item 
{\bf QString} {\bf qsdict}\label{classKSpellConfig_p5}

\item 
{\bf QString} {\bf qspdict}\label{classKSpellConfig_p6}

\item 
{\bf QString\-List} {\bf ignorelist}\label{classKSpellConfig_p7}

\item 
{\bf KConfig} $\ast$ {\bf kc}\label{classKSpellConfig_p8}

\item 
int {\bf iclient}\label{classKSpellConfig_p9}

\item 
{\bf QCheck\-Box} $\ast$ {\bf cb1}\label{classKSpellConfig_p10}

\item 
{\bf QCheck\-Box} $\ast$ {\bf cb2}\label{classKSpellConfig_p11}

\item 
{\bf QLabel} $\ast$ {\bf dictlist}\label{classKSpellConfig_p12}

\item 
{\bf QCombo\-Box} $\ast$ {\bf dictcombo}\label{classKSpellConfig_p13}

\item 
{\bf QCombo\-Box} $\ast$ {\bf encodingcombo}\label{classKSpellConfig_p14}

\item 
{\bf QCombo\-Box} $\ast$ {\bf clientcombo}\label{classKSpellConfig_p15}

\item 
{\bf QString\-List} {\bf langfnames}\label{classKSpellConfig_p16}

\end{CompactItemize}


\subsection{Detailed Description}
A configuration class/dialog for {\bf KSpell}{\rm (p.\,\pageref{classKSpell})}. 

It contains all of the options settings.The options are set to default values by the constructor and can be reset either by using the public interface or by using KSpell\-Config as a widget in a dialog (or, preferably a tabbed dialog using {\bf KDialog\-Base}) and letting the user change the settings. This way an application that uses {\bf KSpell}{\rm (p.\,\pageref{classKSpell})} can either rely on the default settings (in the simplest case), offer a dialog to configure {\bf KSpell}{\rm (p.\,\pageref{classKSpell})}, or offer a dialog to configure {\bf KSpell}{\rm (p.\,\pageref{classKSpell})} \_\-for\_\-this\_\-app\_\-only\_\- (in which case, the application should save the settings for use next time it is run). This last option might be useful in an email program, for example, where people may be writing in a language different from that used for writing papers in their word processor.

\begin{Desc}
\item[Author:]David Sweet $<${\tt dsweet@kde.org}$>$ \end{Desc}
\begin{Desc}
\item[Version:]\begin{Desc}
\item[Id]{\bf ksconfig.h}{\rm (p.\,\pageref{ksconfig_8h})},v 1.37.2.2 2003/09/05 10:46:36 livne Exp \end{Desc}
\end{Desc}
\begin{Desc}
\item[See also:]{\bf KSpell}{\rm (p.\,\pageref{classKSpell})} \end{Desc}




Definition at line 81 of file ksconfig.h.

\subsection{Constructor \& Destructor Documentation}
\index{KSpellConfig@{KSpell\-Config}!KSpellConfig@{KSpellConfig}}
\index{KSpellConfig@{KSpellConfig}!KSpellConfig@{KSpell\-Config}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}KSpell\-Config::KSpell\-Config ({\bf QWidget} $\ast$ {\em parent} = 0, const char $\ast$ {\em name} = 0, {\bf KSpell\-Config} $\ast$ {\em spell\-Config} = 0, bool {\em add\-Help\-Button} = true)}\label{classKSpellConfig_a0}


Constructs a KSpell\-Config with default or custom settings. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em parent}]Parent of the widget. \item[{\em name}]Widget name. \item[{\em spell\-Config}]Predefined configuration. If this parameter is 0, a default configuration will be used. \item[{\em add\-Help\-Button}]Enabled or hides a help button. See {\bf activate\-Help}{\rm (p.\,\pageref{classKSpellConfig_i0})} for more information. \end{description}
\end{Desc}


Definition at line 69 of file ksconfig.cpp.

References QGrid\-Layout::add\-Multi\-Cell\-Widget(), QGrid\-Layout::add\-Widget(), client(), KGlobal::config(), dict\-From\-List(), dictionary(), encoding(), ignore\-List(), QCombo\-Box::insert\-Item(), KStd\-Accel::name(), no\-Root\-Affix(), run\-Together(), set\-Dictionary(), set\-Ignore\-List(), QCombo\-Box::set\-Insertion\-Policy(), set\-No\-Root\-Affix(), set\-Run\-Together(), and KDialog::spacing\-Hint().

\subsection{Member Function Documentation}
\index{KSpellConfig@{KSpell\-Config}!setIgnoreList@{setIgnoreList}}
\index{setIgnoreList@{setIgnoreList}!KSpellConfig@{KSpell\-Config}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KSpell\-Config::set\-Ignore\-List ({\bf QString\-List} {\em \_\-ignorelist})}\label{classKSpellConfig_a4}


The {\tt \_\-ignorelist} contains words you'd like {\bf KSpell}{\rm (p.\,\pageref{classKSpell})} to ignore when it is spellchecking. 

When you get a KSpell\-Config object back from {\bf KSpell}{\rm (p.\,\pageref{classKSpell})} (using KSpell::kc\-Config()), the {\tt \_\-ignorelist} contains whatever was put in by you plus any words the user has chosen to ignore via the dialog box. It may be useful to save this list with the document being edited to facilitate quicker future spellchecking. 

Definition at line 793 of file ksconfig.cpp.

Referenced by KSpell::ks\-Config(), and KSpell\-Config().\index{KSpellConfig@{KSpell\-Config}!setReplaceAllList@{setReplaceAllList}}
\index{setReplaceAllList@{setReplaceAllList}!KSpellConfig@{KSpell\-Config}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KSpell\-Config::set\-Replace\-All\-List ({\bf QString\-List} {\em \_\-replace\-All\-List})}\label{classKSpellConfig_a5}


The {\tt \_\-replace\-All\-List} contains word you like that replace word. 

Becarefull this list contains word which is replaced and new word. 

Definition at line 805 of file ksconfig.cpp.

Referenced by KSpell::ks\-Config().\index{KSpellConfig@{KSpell\-Config}!setNoRootAffix@{setNoRootAffix}}
\index{setNoRootAffix@{setNoRootAffix}!KSpellConfig@{KSpell\-Config}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KSpell\-Config::set\-No\-Root\-Affix (bool)}\label{classKSpellConfig_a6}


Set an ISpell option. 

If {\tt true}, don't create root-affix combinations. 

Definition at line 557 of file ksconfig.cpp.

References QCheck\-Box::set\-Checked().

Referenced by KSpell\-Config().\index{KSpellConfig@{KSpell\-Config}!setRunTogether@{setRunTogether}}
\index{setRunTogether@{setRunTogether}!KSpellConfig@{KSpell\-Config}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KSpell\-Config::set\-Run\-Together (bool)}\label{classKSpellConfig_a7}


Set an ISpell option. 

If {\tt true}, treat run-together words a valid. 

Definition at line 566 of file ksconfig.cpp.

References QCheck\-Box::set\-Checked().

Referenced by KSpell\-Config().\index{KSpellConfig@{KSpell\-Config}!setDictionary@{setDictionary}}
\index{setDictionary@{setDictionary}!KSpellConfig@{KSpell\-Config}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KSpell\-Config::set\-Dictionary (const {\bf QString} {\em qs})}\label{classKSpellConfig_a8}


Set the name of the dictionary to use. 



Definition at line 575 of file ksconfig.cpp.

References QString::find(), QString::length(), QString::remove(), and QCombo\-Box::set\-Current\-Item().

Referenced by KSpell\-Config().\index{KSpellConfig@{KSpell\-Config}!noRootAffix@{noRootAffix}}
\index{noRootAffix@{noRootAffix}!KSpellConfig@{KSpell\-Config}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool KSpell\-Config::no\-Root\-Affix () const}\label{classKSpellConfig_a12}


Options reading routines. 



Definition at line 639 of file ksconfig.cpp.

Referenced by KSpell\-Config(), and write\-Global\-Settings().\index{KSpellConfig@{KSpell\-Config}!writeGlobalSettings@{writeGlobalSettings}}
\index{writeGlobalSettings@{writeGlobalSettings}!KSpellConfig@{KSpell\-Config}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool KSpell\-Config::write\-Global\-Settings ()}\label{classKSpellConfig_a20}


Call this method before this class is deleted if you want the settings you have (or the user has) chosen to become the global, default settings. 



Definition at line 193 of file ksconfig.cpp.

References no\-Root\-Affix(), KConfig\-Base::sync(), and KConfig\-Base::write\-Entry().\index{KSpellConfig@{KSpell\-Config}!interpret@{interpret}}
\index{interpret@{interpret}!KSpellConfig@{KSpell\-Config}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool KSpell\-Config::interpret ({\bf QString} \& {\em fname}, {\bf QString} \& {\em lname}, {\bf QString} \& {\em hname})\hspace{0.3cm}{\tt  [protected]}}\label{classKSpellConfig_b2}


This takes a dictionary file name (fname) and returns a language abbreviation (lname; like de for German), appropriate for the \$LANG variable, and a human-readble name (hname; like \char`\"{}Deutsch\char`\"{}). 

It also truncates \char`\"{}.aff\char`\"{} at the end of fname.

TRUE is returned if lname.data()==\$LANG 

Definition at line 239 of file ksconfig.cpp.

References QString::find(), QString::from\-Latin1(), QString::is\-Empty(), KLocale::language(), QString::left(), QString::length(), KGlobal::locale(), QString::mid(), QString::remove(), QString::right(), QString::truncate(), KLocale::two\-Alpha\-To\-Country\-Name(), and KLocale::two\-Alpha\-To\-Language\-Name().\index{KSpellConfig@{KSpell\-Config}!activateHelp@{activateHelp}}
\index{activateHelp@{activateHelp}!KSpellConfig@{KSpell\-Config}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KSpell\-Config::activate\-Help (void)\hspace{0.3cm}{\tt  [slot]}}\label{classKSpellConfig_i0}


Use this function to activate the help information for this widget. 

The function is particulary useful if the help button is not displayed as specified by the constructor. Normally you want to hide the help button if this widget is embedded into a larger dialog box that has its own help button. See kedit (optiondialog.cpp) for an example 

Definition at line 754 of file ksconfig.cpp.

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