K3Spell Class Reference

#include <k3spell.h>

Inheritance diagram for K3Spell:

Public Types
enum	SpellerType { Text = 0, HTML, TeX, Nroff }
enum	spellStatus {   Starting = 0, Running, Cleaning, Finished,   Error, Crashed, FinishedNoMisspellingsEncountered }

Signals
void	addword (const QString &originalword)
void	corrected (const QString &originalword, const QString &newword, unsigned int pos)
void	death ()
void	dialog3 ()
void	done (const QString &buffer)
void	done (bool)
void	ignoreall (const QString &originalword)
void	ignoreword (const QString &originalword)
void	misspelling (const QString &originalword, const QStringList &suggestions, unsigned int pos)
void	progress (unsigned int i)
void	ready (K3Spell *)
void	replaceall (const QString &origword, const QString &replacement)

Public Member Functions
	K3Spell (QWidget *parent, const QString &caption, QObject *receiver, const char *slot, K3SpellConfig *kcs=0, bool progressbar=true, bool modal=false)
	K3Spell (QWidget *parent, const QString &caption, QObject *receiver, const char *slot, K3SpellConfig *kcs, bool progressbar, bool modal, SpellerType type)
virtual	~K3Spell ()
virtual bool	addPersonal (const QString &word)
virtual bool	check (const QString &_buffer, bool usedialog=true)
virtual bool	checkList (QStringList *_wordlist, bool usedialog=true)
virtual bool	checkWord (const QString &_buffer, bool usedialog=false)
bool	checkWord (const QString &buffer, bool _usedialog, bool suggest)
virtual void	cleanUp ()
int	dlgResult () const
int	heightDlg () const
void	hide ()
virtual bool	ignore (const QString &word)
QString	intermediateBuffer () const
K3SpellConfig	ksConfig () const
int	lastPosition () const
void	moveDlg (int x, int y)
void	setAutoDelete (bool _autoDelete)
void	setIgnoreTitleCase (bool b)
void	setIgnoreUpperWords (bool b)
void	setProgressResolution (unsigned int res)
spellStatus	status () const
QStringList	suggestions () const
int	widthDlg () const

Static Public Member Functions
static int	modalCheck (QString &text)
static int	modalCheck (QString &text, K3SpellConfig *kcs)

Protected Slots
void	check2 ()
void	check3 ()
void	checkList2 ()
void	checkList3a ()
void	checkList4 ()
void	checkListReplaceCurrent ()
void	checkNext ()
void	checkWord2 ()
void	checkWord3 ()
void	dialog2 (int dlgresult)
void	emitDeath ()
void	ispellErrors ()
void	ispellExit ()
void	K3Spell2 ()
void	slotStopCancel (int)
void	suggestWord ()

Protected Member Functions
bool	cleanFputs (const QString &s)
bool	cleanFputsWord (const QString &s)
void	dialog (const QString &word, QStringList &sugg, const char *_slot)
void	emitProgress ()
QString	funnyWord (const QString &word)
void	initialize (QWidget *_parent, const QString &_caption, QObject *obj, const char *slot, K3SpellConfig *_ksc, bool _progressbar, bool _modal, SpellerType type)
int	parseOneResponse (const QString &_buffer, QString &word, QStringList &sugg)
QString	replacement () const
void	setUpDialog (bool reallyusedialogbox=true)
void	startIspell ()
bool	writePersonalDictionary ()

Protected Attributes
bool	autoDelete
QString	caption
unsigned int	curprog
QString	cwword
QString	dialog3slot
bool	dialogsetup
bool	dialogwillprocess
bool	dlgon
QString	dlgorigword
QString	dlgreplacement
int	dlgresult
QStringList	ignorelist
K3SpellConfig *	ksconfig
K3SpellDlg *	ksdlg
unsigned int	lastlastline
int	lastline
int	lastpos
spellStatus	m_status
int	maxtrystart
bool	modaldlg
QString	newbuffer
unsigned int	offset
QString	orig
QString	origbuffer
QWidget *	parent
bool	personaldict
unsigned int	posinline
KProcess *	proc
unsigned int	progres
bool	progressbar
QStringList	replacelist
QStringList	sugg
bool	texmode
unsigned int	totalpos
int	trystart
bool	usedialog
QStringList::Iterator	wlIt
QStringList *	wordlist

Static Protected Attributes
static int	modalreturn = 0
static QString	modaltext
static QWidget *	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

K3SpellConfig, KSyntaxHighlighter

Deprecated:

, use sonnet instead

Definition at line 46 of file k3spell.h.

Member Enumeration Documentation

enum K3Spell::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.

Enumerator
Text
HTML
TeX
Nroff

Definition at line 80 of file k3spell.h.

enum K3Spell::spellStatus

Possible states of the spell checker.

• Starting - After creation of K3Spell.
• 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.

Enumerator
Starting
Running
Cleaning
Finished
Error
Crashed
FinishedNoMisspellingsEncountered

Definition at line 65 of file k3spell.h.

Constructor & Destructor Documentation

K3Spell::K3Spell	(	QWidget *	parent,
		const QString &	caption,
		QObject *	receiver,
		const char *	slot,
		K3SpellConfig *	kcs = 0,
		bool	progressbar = true,
		bool	modal = false
	)

Starts the spellchecker.

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

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

Parameters

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

Definition at line 125 of file k3spell.cpp.

K3Spell::K3Spell	(	QWidget *	parent,
		const QString &	caption,
		QObject *	receiver,
		const char *	slot,
		K3SpellConfig *	kcs,
		bool	progressbar,
		bool	modal,
		SpellerType	type
	)

Starts the spellchecker.

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

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

Parameters

parent	Parent of K3SpellConfig dialog..
caption	Caption of K3SpellConfig dialog.
receiver	Receiver object for the ready(K3Spell *) signal.
slot	Receiver's slot, will be connected to the ready(K3Spell *) signal.
kcs	Configuration for K3Spell.
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 133 of file k3spell.cpp.

K3Spell::~K3Spell ( )

virtual

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

Definition at line 1404 of file k3spell.cpp.

Member Function Documentation

bool K3Spell::addPersonal ( const QString &  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 489 of file k3spell.cpp.

void K3Spell::addword ( const QString &  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.

bool K3Spell::check ( const QString &  _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 1082 of file k3spell.cpp.

void K3Spell::check2 ( )

protectedslot

Definition at line 1147 of file k3spell.cpp.

void K3Spell::check3 ( )

protectedslot

Definition at line 1266 of file k3spell.cpp.

bool K3Spell::checkList ( QStringList *  _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 886 of file k3spell.cpp.

void K3Spell::checkList2 ( )

protectedslot

Definition at line 913 of file k3spell.cpp.

void K3Spell::checkList3a ( )

protectedslot

Definition at line 944 of file k3spell.cpp.

void K3Spell::checkList4 ( )

protectedslot

Definition at line 1033 of file k3spell.cpp.

void K3Spell::checkListReplaceCurrent ( )

protectedslot

Definition at line 1018 of file k3spell.cpp.

void K3Spell::checkNext ( )

protectedslot

Definition at line 703 of file k3spell.cpp.

bool K3Spell::checkWord ( const QString &  _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, K3Spell 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 571 of file k3spell.cpp.

bool K3Spell::checkWord	(	const QString &	buffer,
		bool	_usedialog,
		bool	suggest
	)

set the dialog signal handler

Definition at line 615 of file k3spell.cpp.

void K3Spell::checkWord2 ( )

protectedslot

Definition at line 661 of file k3spell.cpp.

void K3Spell::checkWord3 ( )

protectedslot

Definition at line 741 of file k3spell.cpp.

bool K3Spell::cleanFputs ( const QString &  s )

protected

Definition at line 549 of file k3spell.cpp.

bool K3Spell::cleanFputsWord ( const QString &  s )

protected

Definition at line 522 of file k3spell.cpp.

void K3Spell::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 1421 of file k3spell.cpp.

void K3Spell::corrected ( const QString &  originalword, const QString &  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 than once with same list position, when checking a word with hyphens. In this case originalword is the last replacement.

See also

check()

void K3Spell::death ( )

signal

Emitted on terminal errors and after clean up.

You can delete the K3Spell object in this signal.

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

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

void K3Spell::dialog ( const QString &  word, QStringList &  sugg, const char *  _slot  )

protected

Definition at line 1322 of file k3spell.cpp.

void K3Spell::dialog2 ( int  dlgresult )

protectedslot

Definition at line 1356 of file k3spell.cpp.

void K3Spell::dialog3 ( )

signal

int K3Spell::dlgResult

(

)

const

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 kspelldlg.h):

• KS_CANCEL
• KS_REPLACE
• KS_REPLACEALL
• KS_IGNORE
• KS_IGNOREALL
• KS_ADD
• KS_STOP

Definition at line 153 of file k3spell.cpp.

void K3Spell::done ( const QString &  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().

void K3Spell::done ( bool  )

signal

Emitted when checkList() is done.

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

void K3Spell::emitDeath ( )

protectedslot

Definition at line 1467 of file k3spell.cpp.

void K3Spell::emitProgress ( )

protected

Definition at line 1480 of file k3spell.cpp.

QString K3Spell::funnyWord ( const QString &  word )

protected

Definition at line 748 of file k3spell.cpp.

int K3Spell::heightDlg

(

)

const

Returns the height of the dialog box.

Definition at line 158 of file k3spell.cpp.

void K3Spell::hide

(

)

Hides the dialog box.

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

Definition at line 146 of file k3spell.cpp.

bool K3Spell::ignore ( const QString &  word )

virtual

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

Returns

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

Definition at line 508 of file k3spell.cpp.

void K3Spell::ignoreall ( const QString &  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.

void K3Spell::ignoreword ( const QString &  originalword )

signal

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

Don't know if this could be useful.

void K3Spell::initialize ( QWidget *  _parent, const QString &  _caption, QObject *  obj, const char *  slot, K3SpellConfig *  _ksc, bool  _progressbar, bool  _modal, SpellerType  type  )

protected

Definition at line 1577 of file k3spell.cpp.

QString K3Spell::intermediateBuffer

(

)

const

Returns the partially spellchecked buffer.

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

Definition at line 161 of file k3spell.cpp.

void K3Spell::ispellErrors ( )

protectedslot

Definition at line 416 of file k3spell.cpp.

void K3Spell::ispellExit ( )

protectedslot

Definition at line 1440 of file k3spell.cpp.

void K3Spell::K3Spell2 ( )

protectedslot

Definition at line 422 of file k3spell.cpp.

K3SpellConfig K3Spell::ksConfig

(

)

const

Returns

the K3SpellConfig object being used by this K3Spell instance.

Definition at line 1414 of file k3spell.cpp.

int K3Spell::lastPosition

(

)

const

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

Definition at line 1141 of file k3spell.cpp.

void K3Spell::misspelling ( const QString &  originalword, const QStringList &  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 QStringList passed to checkList(). Note, that originalword can be only a word part, if it's a 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).

int K3Spell::modalCheck ( QString &  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 1515 of file k3spell.cpp.

int K3Spell::modalCheck ( QString &  text, K3SpellConfig *  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 1521 of file k3spell.cpp.

void K3Spell::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 1491 of file k3spell.cpp.

int K3Spell::parseOneResponse ( const QString &  _buffer, QString &  word, QStringList &  sugg  )

protected

Definition at line 783 of file k3spell.cpp.

void K3Spell::progress ( unsigned int  i )

signal

Emitted during a check().

i is between 1 and 100.

void K3Spell::ready ( K3Spell *  )

signal

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

void K3Spell::replaceall ( const QString &  origword, const QString &  replacement  )

signal

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

QString K3Spell::replacement ( ) const

protected

Definition at line 1351 of file k3spell.cpp.

void K3Spell::setAutoDelete

(

bool

_autoDelete

)

Sets the auto-delete flag.

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

Definition at line 1435 of file k3spell.cpp.

void K3Spell::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 1503 of file k3spell.cpp.

void K3Spell::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 1498 of file k3spell.cpp.

void K3Spell::setProgressResolution

(

unsigned int

res

)

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

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

Definition at line 1475 of file k3spell.cpp.

void K3Spell::setUpDialog ( bool  reallyusedialogbox = true )

protected

Definition at line 470 of file k3spell.cpp.

void K3Spell::slotStopCancel ( int  result )

protectedslot

Definition at line 1305 of file k3spell.cpp.

void K3Spell::startIspell ( )

protected

Definition at line 192 of file k3spell.cpp.

K3Spell::spellStatus K3Spell::status

(

)

const

Returns the status of K3Spell.

See also

spellStatus()

Definition at line 141 of file k3spell.cpp.

QStringList K3Spell::suggestions

(

)

const

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 148 of file k3spell.cpp.

void K3Spell::suggestWord ( )

protectedslot

Definition at line 718 of file k3spell.cpp.

int K3Spell::widthDlg

(

)

const

Returns the width of the dialog box.

Definition at line 159 of file k3spell.cpp.

bool K3Spell::writePersonalDictionary ( )

protected

Definition at line 503 of file k3spell.cpp.

Member Data Documentation

bool K3Spell::autoDelete

protected

Definition at line 512 of file k3spell.h.

QString K3Spell::caption

protected

Definition at line 514 of file k3spell.h.

unsigned int K3Spell::curprog

protected

Definition at line 533 of file k3spell.h.

QString K3Spell::cwword

protected

Definition at line 518 of file k3spell.h.

QString K3Spell::dialog3slot

protected

Definition at line 521 of file k3spell.h.

bool K3Spell::dialogsetup

protected

Definition at line 511 of file k3spell.h.

bool K3Spell::dialogwillprocess

protected

Definition at line 509 of file k3spell.h.

bool K3Spell::dlgon

protected

Definition at line 507 of file k3spell.h.

QString K3Spell::dlgorigword

protected

Definition at line 519 of file k3spell.h.

QString K3Spell::dlgreplacement

protected

Definition at line 520 of file k3spell.h.

int K3Spell::dlgresult

protected

Definition at line 523 of file k3spell.h.

QStringList K3Spell::ignorelist

protected

Definition at line 499 of file k3spell.h.

K3SpellConfig* K3Spell::ksconfig

protected

Definition at line 495 of file k3spell.h.

K3SpellDlg* K3Spell::ksdlg

protected

Definition at line 496 of file k3spell.h.

unsigned int K3Spell::lastlastline

protected

Definition at line 530 of file k3spell.h.

int K3Spell::lastline

protected

Definition at line 528 of file k3spell.h.

int K3Spell::lastpos

protected

Definition at line 526 of file k3spell.h.

spellStatus K3Spell::m_status

protected

Definition at line 503 of file k3spell.h.

int K3Spell::maxtrystart

protected

Definition at line 525 of file k3spell.h.

bool K3Spell::modaldlg

protected

Used for modalCheck.

Definition at line 538 of file k3spell.h.

int K3Spell::modalreturn = 0

staticprotected

Definition at line 540 of file k3spell.h.

QString K3Spell::modaltext

staticprotected

Definition at line 539 of file k3spell.h.

QWidget * K3Spell::modalWidgetHack = 0

staticprotected

Definition at line 541 of file k3spell.h.

QString K3Spell::newbuffer

protected

Definition at line 517 of file k3spell.h.

unsigned int K3Spell::offset

protected

Definition at line 531 of file k3spell.h.

QString K3Spell::orig

protected

Definition at line 515 of file k3spell.h.

QString K3Spell::origbuffer

protected

Definition at line 516 of file k3spell.h.

QWidget* K3Spell::parent

protected

Definition at line 494 of file k3spell.h.

bool K3Spell::personaldict

protected

Definition at line 508 of file k3spell.h.

unsigned int K3Spell::posinline

protected

Definition at line 529 of file k3spell.h.

KProcess* K3Spell::proc

protected

Definition at line 493 of file k3spell.h.

unsigned int K3Spell::progres

protected

Definition at line 532 of file k3spell.h.

bool K3Spell::progressbar

protected

Definition at line 510 of file k3spell.h.

QStringList K3Spell::replacelist

protected

Definition at line 500 of file k3spell.h.

QStringList K3Spell::sugg

protected

Definition at line 501 of file k3spell.h.

bool K3Spell::texmode

protected

Definition at line 506 of file k3spell.h.

unsigned int K3Spell::totalpos

protected

Definition at line 527 of file k3spell.h.

int K3Spell::trystart

protected

Definition at line 524 of file k3spell.h.

bool K3Spell::usedialog

protected

Definition at line 505 of file k3spell.h.

QStringList::Iterator K3Spell::wlIt

protected

Definition at line 498 of file k3spell.h.

QStringList* K3Spell::wordlist

protected

Definition at line 497 of file k3spell.h.

---

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

• k3spell.h
• k3spell.cpp