# class KSpellConfig | A configuration class/dialog for KSpell. More...
Definition | `#include <ksconfig.h>`
Inherits | QWidget (qt) [public ]
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

#### Public Methods

- KSpellConfig ( QWidget *parent=0, const char *name=0, KSpellConfig *spellConfig=0, bool addHelpButton = true )
- KSpellConfig (const KSpellConfig &)
- virtual ~KSpellConfig ()
- void operator= (const KSpellConfig &ksc)
- void setIgnoreList (QStringList _ignorelist)
- void setNoRootAffix (bool)
- void setRunTogether (bool)
- void setDictionary (const QString qs)
- void setDictFromList (bool dfl)
- void setEncoding (int enctype)
- void setClient (int client)
- bool noRootAffix () const
- bool runTogether () const
- const QString dictionary () const
- bool dictFromList () const
- int encoding () const
- QStringList ignoreList () const
- int client () const
- bool writeGlobalSettings ()

#### Public Slots

- void activateHelp ( void )

#### Protected Types

- enum {rdictlist=3, rencoding=4, rhelp=6}

#### Protected Methods

- void fillInDialog ()
- bool readGlobalSettings ()
- bool interpret ( QString &fname, QString &lname, QString &hname )

#### Protected Slots

- void sHelp ()
- void sNoAff (bool)
- void sRunTogether (bool)
- void sDictionary (bool)
- void sPathDictionary (bool)
- void sSetDictionary (int)
- void sChangeEncoding (int)
- void sChangeClient (int)

#### Protected Members

- int enc
- bool bnorootaffix
- bool bruntogether
- bool dictfromlist
- bool nodialog
- QString qsdict
- QString qspdict
- QStringList ignorelist
- KConfig *kc
- int iclient
- QCheckBox *cb1
- QCheckBox *cb2
- QLabel *dictlist
- QComboBox *dictcombo
- QComboBox *encodingcombo
- QComboBox *clientcombo
- QStringList langfnames

## Detailed Description

A configuration class/dialog for KSpell.

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 KSpellConfig as a widget in a dialog (or, preferably a tabbed dialog using KDialogBase) and letting the user change the settings. This way an application that uses KSpell can either rely on the default settings (in the simplest case), offer a dialog to configure KSpell, or offer a dialog to configure KSpell _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.

See also: KSpell

KSpellConfig ( QWidget *parent=0, const char *name=0, KSpellConfig *spellConfig=0, bool addHelpButton = true ) | ### KSpellConfig

Create a KSpellConfig with default or custom settings.

Parameters:

parent | Parent of the widget.
name | Widget name.
spellConfig | Predefined configuration. If this parameter is 0, a default configuration will be used.
addHelpButton | Enabled or hides a help button. See activateHelp for more information.

KSpellConfig (const KSpellConfig &) | ### KSpellConfig

~KSpellConfig () | ### ~KSpellConfig

[virtual]

void operator= (const KSpellConfig &ksc) | ### operator=

void setIgnoreList (QStringList _ignorelist) | ### setIgnoreList

The `ignorelist` contains words you'd like KSpell to ignore when it is spellchecking. When you get a KSpellConfig object back from KSpell (using KSpell::kcConfig()), the 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.

void setNoRootAffix (bool) | ### setNoRootAffix

Set an ISpell option.

If `true`, don't create root-affix combinations.

void setRunTogether (bool) | ### setRunTogether

Set an ISpell option.

If `true`, treat run-together words a valid.

void setDictionary (const QString qs) | ### setDictionary

Set the name of the dictionary to use.

void setDictFromList (bool dfl) | ### setDictFromList

void setEncoding (int enctype) | ### setEncoding

void setClient (int client) | ### setClient

bool noRootAffix () | ### noRootAffix

[const]

Options reading routines.

bool runTogether () | ### runTogether

[const]

const QString dictionary () | ### dictionary

[const]

bool dictFromList () | ### dictFromList

[const]

int encoding () | ### encoding

[const]

QStringList ignoreList () | ### ignoreList

[const]

int client () | ### client

[const]

bool writeGlobalSettings () | ### writeGlobalSettings

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.

void fillInDialog () | ### fillInDialog

[protected]

bool readGlobalSettings () | ### readGlobalSettings

[protected]

bool interpret ( QString &fname, QString &lname, QString &hname ) | ### interpret

[protected]

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 "Deutsch").

It also truncates ".aff" at the end of fname.

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

void activateHelp ( void ) | ### activateHelp

[slot]

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

void sHelp () | ### sHelp

[protected slots slot]

void sNoAff (bool) | ### sNoAff

[protected slots slot]

void sRunTogether (bool) | ### sRunTogether

[protected slots slot]

void sDictionary (bool) | ### sDictionary

[protected slots slot]

void sPathDictionary (bool) | ### sPathDictionary

[protected slots slot]

void sSetDictionary (int) | ### sSetDictionary

[protected slots slot]

void sChangeEncoding (int) | ### sChangeEncoding

[protected slots slot]

void sChangeClient (int) | ### sChangeClient

[protected slots slot]

int enc | ### enc

[protected]

bool bnorootaffix | ### bnorootaffix

[protected]

bool bruntogether | ### bruntogether

[protected]

bool dictfromlist | ### dictfromlist

[protected]

bool nodialog | ### nodialog

[protected]

QString qsdict | ### qsdict

[protected]

QString qspdict | ### qspdict

[protected]

QStringList ignorelist | ### ignorelist

[protected]

enum {rdictlist=3, rencoding=4, rhelp=6} | ###

[protected]

KConfig * kc | ### kc

[protected]

int iclient | ### iclient

[protected]

QCheckBox * cb1 | ### cb1

[protected]

QCheckBox * cb2 | ### cb2

[protected]

QLabel * dictlist | ### dictlist

[protected]

QComboBox * dictcombo | ### dictcombo

[protected]

QComboBox * encodingcombo | ### encodingcombo

[protected]

QComboBox * clientcombo | ### clientcombo

[protected]

QStringList langfnames | ### langfnames

[protected]

- Version: $Id: ksconfig.h,v 1.29 2001/01/30 19:31:34 wolfram Exp $
- Author: David Sweet <dsweet@kde.org>
- Generated: root@sparc.ports.openbsd.org on Wed May 2 09:46:40 2001, using kdoc 2.0a53.