KSpellConfig Class Reference

#include <ksconfig.h>

Inherits TQWidget.

Public Slots
void	activateHelp (void)

Signals
void	configChanged ()

Public Member Functions
	KSpellConfig (TQWidget *parent=0, const char *name=0, KSpellConfig *spellConfig=0, bool addHelpButton=true)
	KSpellConfig (const KSpellConfig &)
virtual	~KSpellConfig ()
void	operator= (const KSpellConfig &ksc)
void	fillDicts (TQComboBox *box, TQStringList *dictionaries=0)
void	setIgnoreList (TQStringList _ignorelist)
void	setReplaceAllList (TQStringList _replaceAllList)
void	setNoRootAffix (bool)
void	setRunTogether (bool)
void	setDictionary (const TQString qs)
void	setDictFromList (bool dfl)
void	setEncoding (int enctype)
void	setClient (int client)
bool	noRootAffix () const
bool	runTogether () const
const TQString	dictionary () const
bool	dictFromList () const
int	encoding () const
TQStringList	ignoreList () const
TQStringList	replaceAllList () const
int	client () const
bool	writeGlobalSettings ()
bool	readGlobalSettings ()

Protected Types
enum	{ rdictlist =3 , rencoding =4 , rhelp =6 }

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 Member Functions
void	fillInDialog ()
bool	interpret (TQString &fname, TQString &lname, TQString &hname)

Protected Attributes
int	enc
bool	bnorootaffix
bool	bruntogether
bool	dictfromlist
bool	nodialog
TQString	qsdict
TQString	qspdict
TQStringList	ignorelist
TDEConfig *	kc
int	iclient
TQCheckBox *	cb1
TQCheckBox *	cb2
TQLabel *	dictlist
TQComboBox *	dictcombo
TQComboBox *	encodingcombo
TQComboBox *	clientcombo
TQStringList	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.

Author

David Sweet dswee.nosp@m.t@kd.nosp@m.e.org

See also

KSpell

Definition at line 87 of file ksconfig.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

protected

Definition at line 266 of file ksconfig.h.

Constructor & Destructor Documentation

KSpellConfig() [1/2]

KSpellConfig::KSpellConfig	(	TQWidget *	parent = 0,
		const char *	name = 0,
		KSpellConfig *	spellConfig = 0,
		bool	addHelpButton = true
	)

Constructs 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.

Definition at line 71 of file ksconfig.cpp.

KSpellConfig() [2/2]

KSpellConfig::KSpellConfig

(

const KSpellConfig &

_ksc

)

Definition at line 48 of file ksconfig.cpp.

~KSpellConfig()

KSpellConfig::~KSpellConfig ( )

virtual

Deconstructor.

Deletes private class.

Definition at line 169 of file ksconfig.cpp.

Member Function Documentation

activateHelp

void KSpellConfig::activateHelp ( void  )

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

Definition at line 970 of file ksconfig.cpp.

client()

int KSpellConfig::client

(

)

const

Spell checker client, see KSpellClients.

Definition at line 848 of file ksconfig.cpp.

dictFromList()

bool KSpellConfig::dictFromList

(

)

const

Definition at line 176 of file ksconfig.cpp.

dictionary()

const TQString KSpellConfig::dictionary

(

)

const

Definition at line 867 of file ksconfig.cpp.

encoding()

int KSpellConfig::encoding

(

)

const

Definition at line 880 of file ksconfig.cpp.

fillDicts()

void KSpellConfig::fillDicts	(	TQComboBox *	box,
		TQStringList *	dictionaries = 0
	)

Get the translated dictionary names and, optionally, the corresponding internal dictionary names.

Fills box with the human readable, translated dictionary names and selects the currently used dictionary (this will be the global dictionary if you call fillDicts directly after the constructor). If dictionaries isn't 0 then dictionaries will be filled with the corresponding internal dictionary names that are necessary to set the dictionary with setDictionary.

Parameters

box	Will be filled with the translated dictionary names.
dictionaries	Will be filled with the internal dictionary names.

Since

3.2

Definition at line 592 of file ksconfig.cpp.

fillInDialog()

void KSpellConfig::fillInDialog ( )

protected

Definition at line 375 of file ksconfig.cpp.

ignoreList()

TQStringList KSpellConfig::ignoreList

(

)

const

Definition at line 1016 of file ksconfig.cpp.

interpret()

bool KSpellConfig::interpret ( TQString &  fname, TQString &  lname, TQString &  hname  )

protected

This takes a dictionary file name and provides both a language abbreviation appropriate for the $LANG variable, and a human-readable name.

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

Parameters

fname	the dictionary name file (input)
lname	the language abbreviation, such as de for German (output)
hname	the human-readable name, such as Deutsch (output)

Returns

true if

lname.data()==$LANG

Definition at line 251 of file ksconfig.cpp.

noRootAffix()

bool KSpellConfig::noRootAffix

(

)

const

Options reading routines.

Definition at line 855 of file ksconfig.cpp.

operator=()

void KSpellConfig::operator=

(

const KSpellConfig &

ksc

)

Definition at line 993 of file ksconfig.cpp.

readGlobalSettings()

bool KSpellConfig::readGlobalSettings

(

)

Definition at line 182 of file ksconfig.cpp.

replaceAllList()

TQStringList KSpellConfig::replaceAllList

(

)

const

Definition at line 1029 of file ksconfig.cpp.

runTogether()

bool KSpellConfig::runTogether

(

)

const

Definition at line 861 of file ksconfig.cpp.

sChangeClient

void KSpellConfig::sChangeClient ( int  i )

protectedslot

Definition at line 223 of file ksconfig.cpp.

sChangeEncoding

void KSpellConfig::sChangeEncoding ( int  i )

protectedslot

Definition at line 215 of file ksconfig.cpp.

sDictionary

void KSpellConfig::sDictionary ( bool  on )

protectedslot

Definition at line 933 of file ksconfig.cpp.

setClient()

void KSpellConfig::setClient

(

int

client

)

Definition at line 768 of file ksconfig.cpp.

setDictFromList()

void KSpellConfig::setDictFromList

(

bool

dfl

)

Definition at line 822 of file ksconfig.cpp.

setDictionary()

void KSpellConfig::setDictionary

(

const TQString

qs

)

Set the name of the dictionary to use.

Definition at line 795 of file ksconfig.cpp.

setEncoding()

void KSpellConfig::setEncoding

(

int

enctype

)

Definition at line 836 of file ksconfig.cpp.

setIgnoreList()

void KSpellConfig::setIgnoreList

(

TQStringList

_ignorelist

)

@sect Options setting routines.

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.

Definition at line 1010 of file ksconfig.cpp.

setNoRootAffix()

void KSpellConfig::setNoRootAffix

(

bool

b

)

Set an ISpell option.

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

Definition at line 777 of file ksconfig.cpp.

setReplaceAllList()

void KSpellConfig::setReplaceAllList

(

TQStringList

_replaceAllList

)

The _replaceAllList contains word you like that replace word.

Be careful that this list contains word which is replaced and new word.

Definition at line 1023 of file ksconfig.cpp.

setRunTogether()

void KSpellConfig::setRunTogether

(

bool

b

)

Set an ISpell option.

If true, treat run-together words a valid.

Definition at line 786 of file ksconfig.cpp.

sHelp

void KSpellConfig::sHelp ( void  )

protectedslot

Invokes the help documentation for tdespell.

Definition at line 975 of file ksconfig.cpp.

sNoAff

void KSpellConfig::sNoAff ( bool  )

protectedslot

Definition at line 893 of file ksconfig.cpp.

sPathDictionary

void KSpellConfig::sPathDictionary ( bool  on )

protectedslot

Definition at line 949 of file ksconfig.cpp.

sRunTogether

void KSpellConfig::sRunTogether ( bool  )

protectedslot

Definition at line 886 of file ksconfig.cpp.

sSetDictionary

void KSpellConfig::sSetDictionary ( int  i )

protectedslot

Definition at line 925 of file ksconfig.cpp.

writeGlobalSettings()

bool KSpellConfig::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.

Definition at line 197 of file ksconfig.cpp.

Member Data Documentation

bnorootaffix

bool KSpellConfig::bnorootaffix

protected

Definition at line 259 of file ksconfig.h.

bruntogether

bool KSpellConfig::bruntogether

protected

Definition at line 260 of file ksconfig.h.

cb1

TQCheckBox* KSpellConfig::cb1

protected

Definition at line 270 of file ksconfig.h.

cb2

TQCheckBox * KSpellConfig::cb2

protected

Definition at line 270 of file ksconfig.h.

clientcombo

TQComboBox * KSpellConfig::clientcombo

protected

Definition at line 275 of file ksconfig.h.

dictcombo

TQComboBox* KSpellConfig::dictcombo

protected

Definition at line 275 of file ksconfig.h.

dictfromlist

bool KSpellConfig::dictfromlist

protected

Definition at line 261 of file ksconfig.h.

dictlist

TQLabel* KSpellConfig::dictlist

protected

Definition at line 274 of file ksconfig.h.

enc

int KSpellConfig::enc

protected

Definition at line 258 of file ksconfig.h.

encodingcombo

TQComboBox * KSpellConfig::encodingcombo

protected

Definition at line 275 of file ksconfig.h.

iclient

int KSpellConfig::iclient

protected

Definition at line 268 of file ksconfig.h.

ignorelist

TQStringList KSpellConfig::ignorelist

protected

Definition at line 265 of file ksconfig.h.

kc

TDEConfig* KSpellConfig::kc

protected

Definition at line 267 of file ksconfig.h.

langfnames

TQStringList KSpellConfig::langfnames

protected

Definition at line 277 of file ksconfig.h.

nodialog

bool KSpellConfig::nodialog

protected

Definition at line 262 of file ksconfig.h.

qsdict

TQString KSpellConfig::qsdict

protected

Definition at line 263 of file ksconfig.h.

qspdict

TQString KSpellConfig::qspdict

protected

Definition at line 264 of file ksconfig.h.

---

The documentation for this class was generated from the following files:

• ksconfig.h
• ksconfig.cpp