#include <tdespell.h>

Inherits TQObject.

Public Types
enum	spellStatus { Starting = 0 , Running , Cleaning , Finished , Error , Crashed , FinishedNoMisspellingsEncountered }

enum	SpellerType { Text = 0 , HTML , TeX , Nroff }

Signals
void	misspelling (const TQString &originalword, const TQStringList &suggestions, unsigned int pos)

void	corrected (const TQString &originalword, const TQString &newword, unsigned int pos)

void	ignoreall (const TQString &originalword)

void	ignoreword (const TQString &originalword)

void	addword (const TQString &originalword)

void	replaceall (const TQString &origword, const TQString &replacement)

void	ready (KSpell *)

void	progress (unsigned int i)

void	done (const TQString &buffer)

void	done (bool)

void	death ()

void	dialog3 ()

Public Member Functions
	KSpell (TQWidget parent, const TQString &caption, TQObject receiver, const char slot, KSpellConfig kcs=0, bool progressbar=true, bool modal=false)

	KSpell (TQWidget parent, const TQString &caption, TQObject receiver, const char slot, KSpellConfig kcs, bool progressbar, bool modal, SpellerType type)

spellStatus	status () const

virtual void	cleanUp ()

void	setAutoDelete (bool _autoDelete)

virtual bool	check (const TQString &_buffer, bool usedialog=true)

int	lastPosition () const

virtual bool	checkList (TQStringList *_wordlist, bool usedialog=true)

virtual bool	checkWord (const TQString &_buffer, bool usedialog=false)

bool	checkWord (const TQString &buffer, bool _usedialog, bool suggest)

void	hide ()

TQStringList	suggestions () const

int	dlgResult () const

void	moveDlg (int x, int y)

int	heightDlg () const

int	widthDlg () const

TQString	intermediateBuffer () const

virtual bool	ignore (const TQString &word)

virtual bool	addPersonal (const TQString &word)

KSpellConfig	ksConfig () const

void	setProgressResolution (unsigned int res)

virtual	~KSpell ()

void	setIgnoreUpperWords (bool b)

void	setIgnoreTitleCase (bool b)

Static Public Member Functions
static int	modalCheck (TQString &text) TDE_DEPRECATED

static int	modalCheck (TQString &text, KSpellConfig *kcs)

Protected Slots
void	KSpell2 (KProcIO *)

void	checkWord2 (KProcIO *)

void	checkWord3 ()

void	check2 (KProcIO *)

void	checkList2 ()

void	checkList3a (KProcIO *)

void	checkListReplaceCurrent ()

void	checkList4 ()

void	dialog2 (int dlgresult)

void	check3 ()

void	suggestWord (KProcIO *)

void	slotStopCancel (int)

void	ispellExit (TDEProcess *)

void	emitDeath ()

void	ispellErrors (TDEProcess , char , int)

void	checkNext ()

Protected Member Functions
int	parseOneResponse (const TQString &_buffer, TQString &word, TQStringList &sugg)

TQString	funnyWord (const TQString &word)

void	dialog (const TQString &word, TQStringList &sugg, const char *_slot)

TQString	replacement () const

void	setUpDialog (bool reallyusedialogbox=true)

void	emitProgress ()

bool	cleanFputs (const TQString &s, bool appendCR=true)

bool	cleanFputsWord (const TQString &s, bool appendCR=true)

void	startIspell ()

bool	writePersonalDictionary ()

void	initialize (TQWidget _parent, const TQString &_caption, TQObject obj, const char slot, KSpellConfig _ksc, bool _progressbar, bool _modal, SpellerType type)

Protected Attributes
KProcIO *	proc

TQWidget *	parent

KSpellConfig *	ksconfig

KSpellDlg *	ksdlg

TQStringList *	wordlist

TQStringList::Iterator	wlIt

TQStringList	ignorelist

TQStringList	replacelist

TQStringList	sugg

TQTextCodec *	codec

spellStatus	m_status

bool	usedialog

bool	texmode

bool	dlgon

bool	personaldict

bool	dialogwillprocess

bool	progressbar

bool	dialogsetup

bool	autoDelete

TQString	caption

TQString	orig

TQString	origbuffer

TQString	newbuffer

TQString	cwword

TQString	dlgorigword

TQString	dlgreplacement

TQString	dialog3slot

int	dlgresult

int	trystart

int	maxtrystart

int	lastpos

unsigned int	totalpos

unsigned int	lastline

unsigned int	posinline

unsigned int	lastlastline

unsigned int	offset

unsigned int	progres

unsigned int	curprog

bool	modaldlg

Static Protected Attributes
static TQString	modaltext

static int	modalreturn = 0

static TQWidget *	modalWidgetHack = 0

Detailed Description

KDE Spellchecker

A KDE programmer's interface to International ISpell 3.1, ASpell, HSpell and ZPSpell.. A static method, modalCheck() is provided for convenient access to the spellchecker.

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

See also: KSpellConfig, KSyntaxHighlighter

Definition at line 46 of file tdespell.h.

Member Enumeration Documentation

◆ SpellerType

enum KSpell::SpellerType

These are possible types of documents which the spell checker can check.

Text - The default type, checks every word
HTML - For HTML/SGML/XML documents, will skip the tags,
TeX - For TeX/LaTeX documents, will skip commands,
Nroff - For nroff/troff documents.

Please note that not every option is supported on every type of checker (e.g. ASpell doesn't support Nroff). In case a type of a document is not supported the default Text option will be used.

Definition at line 80 of file tdespell.h.

◆ spellStatus

enum KSpell::spellStatus

Possible states of the spell checker.

Starting - After creation of KSpell.
Running - After the ready signal has been emitted.
Cleaning - After cleanUp() has been called.
Finished - After cleanUp() has been completed.

The following error states exist:

Error - An error occurred in the Starting state.
Crashed - An error occurred in the Running state.

Definition at line 65 of file tdespell.h.

Constructor & Destructor Documentation

◆ KSpell() [1/2]

KSpell::KSpell	(	TQWidget *	parent,
		const TQString &	caption,
		TQObject *	receiver,
		const char *	slot,
		KSpellConfig *	kcs = `0`,
		bool	progressbar = `true`,
		bool	modal = `false`
	)

Starts the spellchecker.

KSpell emits ready() when it has verified that ISpell/ASpell is working properly. Pass the name of a slot – do not pass zero! Be sure to call cleanUp() when you are done with KSpell.

If KSpell could not be started correctly, death() is emitted.

Parameters

parent	Parent of KSpellConfig dialog..
caption	Caption of KSpellConfig dialog.
receiver	Receiver object for the ready(KSpell *) signal.
slot	Receiver's slot, will be connected to the ready(KSpell *) signal.
kcs	Configuration for KSpell.
progressbar	Indicates if progress bar should be shown.
modal	Indicates modal or non-modal dialog.

Definition at line 107 of file tdespell.cpp.

◆ KSpell() [2/2]

KSpell::KSpell	(	TQWidget *	parent,
		const TQString &	caption,
		TQObject *	receiver,
		const char *	slot,
		KSpellConfig *	kcs,
		bool	progressbar,
		bool	modal,
		SpellerType	type
	)

Starts the spellchecker.

KSpell emits ready() when it has verified that ISpell/ASpell is working properly. Pass the name of a slot – do not pass zero! Be sure to call cleanUp() when you are done with KSpell.

If KSpell could not be started correctly, death() is emitted.

Parameters

parent	Parent of KSpellConfig dialog..
caption	Caption of KSpellConfig dialog.
receiver	Receiver object for the ready(KSpell *) signal.
slot	Receiver's slot, will be connected to the ready(KSpell *) signal.
kcs	Configuration for KSpell.
progressbar	Indicates if progress bar should be shown.
modal	Indicates modal or non-modal dialog.
type	Type of the document to check

Definition at line 115 of file tdespell.cpp.

◆ ~KSpell()

KSpell::~KSpell ( )

virtual

The destructor instructs ISpell/ASpell to write out the personal dictionary and then terminates ISpell/ASpell.

Definition at line 1285 of file tdespell.cpp.

Member Function Documentation

◆ addPersonal()

bool KSpell::addPersonal ( const TQString & word )

virtual

Adds a word to the user's personal dictionary.

Returns: false if word is not a word or there was an error communicating with ISpell/ASpell.

Definition at line 391 of file tdespell.cpp.

◆ addword

void KSpell::addword ( const TQString & originalword )

signal

Emitted when the user pressed "Add" in the dialog.

This could be used to make an external user dictionary independent of the ISpell personal dictionary.

◆ check()

bool KSpell::check	(	const TQString &	_buffer,
		bool	usedialog = `true`
	)

virtual

Spellchecks a buffer of many words in plain text format.

The _buffer is not modified. The signal done() will be sent when check() is finished and the argument will be a spell-corrected version of _buffer.

The spell check may be stopped by the user before the entire buffer has been checked. You can check lastPosition() to see how far in _buffer check() reached before stopping.

Definition at line 976 of file tdespell.cpp.

◆ checkList()

bool KSpell::checkList	(	TQStringList *	_wordlist,
		bool	usedialog = `true`
	)

virtual

Spellchecks a list of words.

checkList() is more flexible than check(). You could parse any type of document (HTML, TeX, etc.) into a list of spell-checkable words and send the list to checkList(). Sending a marked-up document to check() would result in the mark-up tags being spell checked.

Definition at line 782 of file tdespell.cpp.

◆ checkWord() [1/2]

bool KSpell::checkWord	(	const TQString &	_buffer,
		bool	usedialog = `false`
	)

virtual

Spellchecks a single word.

checkWord() is the most flexible function. Some applications might need this flexibility but will sacrifice speed when checking large numbers of words. Consider checkList() for checking many words.

Use this method for implementing "online" spellchecking (i.e., spellcheck as-you-type).

checkWord() returns false if buffer is not a single word (e.g. if it contains white space), otherwise it returns true;

If usedialog is set to true, KSpell will open the standard dialog if the word is not found. The dialog results can be queried by using dlgResult() and replacement().

The signal corrected() is emitted when the check is complete. You can look at suggestions() to see what the suggested replacements were.

set the dialog signal handler

Definition at line 473 of file tdespell.cpp.

◆ checkWord() [2/2]

bool KSpell::checkWord	(	const TQString &	buffer,
		bool	_usedialog,
		bool	suggest
	)

set the dialog signal handler

Definition at line 514 of file tdespell.cpp.

◆ cleanUp()

void KSpell::cleanUp ( )

virtual

Cleans up ISpell.

Write out the personal dictionary and close ISpell's stdin. A death() signal will be emitted when the cleanup is complete, but this method will return immediately.

Definition at line 1302 of file tdespell.cpp.

◆ corrected

void KSpell::corrected	(	const TQString &	originalword,
		const TQString &	newword,
		unsigned int	pos
	)

signal

Emitted after the "Replace" or "Replace All" buttons of the dialog was pressed, or if the word was corrected without calling the dialog (i.e., the user previously chose "Replace All" for this word).

Results from the dialog may be checked with dlgResult() and replacement().

Note, that when using checkList() this signal can occur more then once with same list position, when checking a word with hyphens. In this case originalword is the last replacement.

See also: check()

◆ death

void KSpell::death ( )

signal

Emitted on terminal errors and after clean up.

You can delete the KSpell object in this signal.

You can check status() to see what caused the death:

Error - KSpell could not start.
Crashed - KSpell encountered an unexpected error during execution.
Finished - Clean up finished.

◆ dlgResult()

int KSpell::dlgResult ( ) const

inline

Gets the result code of the dialog box.

After calling checkWord, you can use this to get the dialog box's result code. The possible values are (from tdespelldlg.h):

KS_CANCEL
KS_REPLACE
KS_REPLACEALL
KS_IGNORE
KS_IGNOREALL
KS_ADD
KS_STOP

Definition at line 240 of file tdespell.h.

◆ done [1/2]

void KSpell::done ( bool )

signal

Emitted when checkList() is done.

If the argument is true, then you should update your text from the wordlist, otherwise not.

◆ done [2/2]

void KSpell::done ( const TQString & buffer )

signal

Emitted when check() is done.

Be sure to copy the results of buffer if you need them. You can only rely on the contents of buffer for the life of the slot which was signaled by done().

◆ heightDlg()

int KSpell::heightDlg ( ) const

Returns the height of the dialog box.

Definition at line 125 of file tdespell.cpp.

◆ hide()

void KSpell::hide ( )

Hides the dialog box.

You'll need to do this when you are done with checkWord();

Definition at line 123 of file tdespell.cpp.

◆ ignore()

bool KSpell::ignore ( const TQString & word )

virtual

Tells ISpell/ASpell to ignore this word for the life of this KSpell instance.

Returns: false if word is not a word or there was an error communicating with ISpell/ASpell.

Definition at line 410 of file tdespell.cpp.

◆ ignoreall

void KSpell::ignoreall ( const TQString & originalword )

signal

Emitted when the user pressed "Ignore All" in the dialog.

This could be used to make an application or file specific user dictionary.

◆ ignoreword

void KSpell::ignoreword ( const TQString & originalword )

signal

Emitted when the user pressed "Ignore" in the dialog.

Don't know if this could be useful.

◆ intermediateBuffer()

TQString KSpell::intermediateBuffer ( ) const

inline

Returns the partially spellchecked buffer.

You might want the full buffer in its partially-checked state.

Definition at line 267 of file tdespell.h.

◆ ksConfig()

KSpellConfig KSpell::ksConfig ( ) const

Returns: the KSpellConfig object being used by this KSpell instance.

Definition at line 1295 of file tdespell.cpp.

◆ lastPosition()

int KSpell::lastPosition ( ) const

inline

Returns the position (when using check()) or word number (when using checkList()) of the last word checked.

Definition at line 167 of file tdespell.h.

◆ misspelling

void KSpell::misspelling	(	const TQString &	originalword,
		const TQStringList &	suggestions,
		unsigned int	pos
	)

signal

Emitted whenever a misspelled word is found by check() or by checkWord().

If it is emitted by checkWord(), pos=0. If it is emitted by check(), then pos indicates the position of the misspelled word in the (original) _buffer. (The first position is zero.) If it is emitted by checkList(), pos is the index to the misspelled word in the TQStringList passed to checkList(). Note, that originalword can be only a word part, if it's word with hyphens.

These are called before the dialog is opened, so that the calling program's GUI may be updated. (e.g. the misspelled word may be highlighted).

◆ modalCheck() [1/2]

int KSpell::modalCheck ( TQString & text )

static

Deprecated:: Performs a synchronous spellcheck.

This method does not return until spellchecking is done or canceled. Your application's GUI will still be updated, however.

Definition at line 1391 of file tdespell.cpp.

◆ modalCheck() [2/2]

int KSpell::modalCheck	(	TQString &	text,
		KSpellConfig *	kcs
	)

static

Performs a synchronous spellcheck.

This method does not return until spellchecking is done or canceled. Your application's GUI will still be updated, however.

This overloaded method uses the spell-check configuration passed as parameter.

Definition at line 1397 of file tdespell.cpp.

◆ moveDlg()

void KSpell::moveDlg	(	int	x,
		int	y
	)

Moves the dialog.

If the dialog is not currently visible, it will be placed at this position when it becomes visible. Use this to get the dialog out of the way of a highlighted misspelled word in a document.

Definition at line 1367 of file tdespell.cpp.

◆ progress

void KSpell::progress ( unsigned int i )

signal

Emitted during a check().

i is between 1 and 100.

◆ ready

void KSpell::ready ( KSpell * )

signal

Emitted after KSpell has verified that ISpell/ASpell is running and working properly.

◆ replaceall

void KSpell::replaceall	(	const TQString &	origword,
		const TQString &	replacement
	)

signal

Emitted when the user pressed "ReplaceAll" in the dialog.

◆ setAutoDelete()

void KSpell::setAutoDelete ( bool _autoDelete )

inline

Sets the auto-delete flag.

If this is set, the KSpell object is automatically deleted after emitting death().

Definition at line 145 of file tdespell.h.

◆ setIgnoreTitleCase()

void KSpell::setIgnoreTitleCase ( bool b )

Call setIgnoreTitleCase(true) to tell the spell-checker to ignore words with a 'title' case, i.e.

starting with an uppercase letter. They are spell-checked by default.

Definition at line 1379 of file tdespell.cpp.

◆ setIgnoreUpperWords()

void KSpell::setIgnoreUpperWords ( bool b )

Call setIgnoreUpperWords(true) to tell the spell-checker to ignore words that are completely uppercase.

They are spell-checked by default.

Definition at line 1374 of file tdespell.cpp.

◆ setProgressResolution()

void KSpell::setProgressResolution ( unsigned int res )

Sets the resolution (in percent) of the progress() signals.

E.g. setProgressResolution (10) instructs KSpell to send progress signals (at most) every 10% (10%, 20%, 30%...). The default is 10%.

Definition at line 1351 of file tdespell.cpp.

◆ status()

spellStatus KSpell::status ( ) const

inline

Returns the status of KSpell.

See also: spellStatus()

Definition at line 130 of file tdespell.h.

◆ suggestions()

TQStringList KSpell::suggestions ( ) const

inline

Returns list of suggested word replacements.

After calling checkWord() (an in response to a misspelled() signal you can use this to get the list of suggestions (if any were available).

Definition at line 222 of file tdespell.h.

◆ widthDlg()

int KSpell::widthDlg ( ) const

Returns the width of the dialog box.

Definition at line 126 of file tdespell.cpp.

Member Data Documentation

◆ modaldlg

bool KSpell::modaldlg

protected

Used for modalCheck.

Definition at line 541 of file tdespell.h.

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

tdeui

Public Types

Signals

Public Member Functions

Static Public Member Functions

Protected Slots

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ SpellerType

◆ spellStatus

Constructor & Destructor Documentation

◆ KSpell() [1/2]

◆ KSpell() [2/2]

◆ ~KSpell()

Member Function Documentation

◆ addPersonal()

◆ addword

◆ check()

◆ checkList()

◆ checkWord() [1/2]

◆ checkWord() [2/2]

◆ cleanUp()

◆ corrected

◆ death

◆ dlgResult()

◆ done [1/2]

◆ done [2/2]

◆ heightDlg()

◆ hide()

◆ ignore()

◆ ignoreall

◆ ignoreword

◆ intermediateBuffer()

◆ ksConfig()

◆ lastPosition()

◆ misspelling

◆ modalCheck() [1/2]

◆ modalCheck() [2/2]

◆ moveDlg()

◆ progress

◆ ready

◆ replaceall

◆ setAutoDelete()

◆ setIgnoreTitleCase()

◆ setIgnoreUpperWords()

◆ setProgressResolution()

◆ status()

◆ suggestions()

◆ widthDlg()

Member Data Documentation

◆ modaldlg

tdeui

tdeui