KSpell Class Reference
#include <kspell.h>
Inheritance diagram for KSpell:

Detailed Description
KDE SpellcheckerA 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 <dsweet@kde.org>
- See also:
- KSpellConfig, KSyntaxHighlighter
Definition at line 46 of file kspell.h.
Public Types | |
enum | spellStatus { Starting = 0, Running, Cleaning, Finished, Error, Crashed, FinishedNoMisspellingsEncountered } |
enum | SpellerType { Text = 0, HTML, TeX, Nroff } |
Signals | |
void | misspelling (const QString &originalword, const QStringList &suggestions, unsigned int pos) |
void | corrected (const QString &originalword, const QString &newword, unsigned int pos) |
void | ignoreall (const QString &originalword) |
void | ignoreword (const QString &originalword) |
void | addword (const QString &originalword) |
void | replaceall (const QString &origword, const QString &replacement) |
void | ready (KSpell *) |
void | progress (unsigned int i) |
void | done (const QString &buffer) |
void | done (bool) |
void | death () |
void | dialog3 () |
Public Member Functions | |
KSpell (QWidget *parent, const QString &caption, QObject *receiver, const char *slot, KSpellConfig *kcs=0, bool progressbar=true, bool modal=false) | |
KSpell (QWidget *parent, const QString &caption, QObject *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 QString &_buffer, bool usedialog=true) |
int | lastPosition () const |
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) |
void | hide () |
QStringList | suggestions () const |
int | dlgResult () const |
void | moveDlg (int x, int y) |
int | heightDlg () const |
int | widthDlg () const |
QString | intermediateBuffer () const |
virtual bool | ignore (const QString &word) |
virtual bool | addPersonal (const QString &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 (QString &text) KDE_DEPRECATED |
static int | modalCheck (QString &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 (KProcess *) |
void | emitDeath () |
void | ispellErrors (KProcess *, char *, int) |
void | checkNext () |
Protected Member Functions | |
int | parseOneResponse (const QString &_buffer, QString &word, QStringList &sugg) |
QString | funnyWord (const QString &word) |
void | dialog (const QString &word, QStringList &sugg, const char *_slot) |
QString | replacement () const |
void | setUpDialog (bool reallyusedialogbox=true) |
void | emitProgress () |
bool | cleanFputs (const QString &s, bool appendCR=true) |
bool | cleanFputsWord (const QString &s, bool appendCR=true) |
void | startIspell () |
bool | writePersonalDictionary () |
void | initialize (QWidget *_parent, const QString &_caption, QObject *obj, const char *slot, KSpellConfig *_ksc, bool _progressbar, bool _modal, SpellerType type) |
Protected Attributes | |
KProcIO * | proc |
QWidget * | parent |
KSpellConfig * | ksconfig |
KSpellDlg * | ksdlg |
QStringList * | wordlist |
QStringList::Iterator | wlIt |
QStringList | ignorelist |
QStringList | replacelist |
QStringList | sugg |
QTextCodec * | codec |
spellStatus | m_status |
bool | usedialog |
bool | texmode |
bool | dlgon |
bool | personaldict |
bool | dialogwillprocess |
bool | progressbar |
bool | dialogsetup |
bool | autoDelete |
QString | caption |
QString | orig |
QString | origbuffer |
QString | newbuffer |
QString | cwword |
QString | dlgorigword |
QString | dlgreplacement |
QString | 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 QString | modaltext |
static int | modalreturn = 0 |
static QWidget * | modalWidgetHack = 0 |
Member Enumeration Documentation
|
These are possible types of documents which the spell checker can check.
|
|
Possible states of the spell checker.
|
Constructor & Destructor Documentation
|
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.
Definition at line 107 of file kspell.cpp. |
|
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.
Definition at line 115 of file kspell.cpp. |
|
The destructor instructs ISpell/ASpell to write out the personal dictionary and then terminates ISpell/ASpell.
Definition at line 1285 of file kspell.cpp. |
Member Function Documentation
|
Adds a word to the user's personal dictionary.
Definition at line 391 of file kspell.cpp. |
|
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. |
|
Spellchecks a buffer of many words in plain text format.
The
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 Definition at line 976 of file kspell.cpp. |
|
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 kspell.cpp. |
|
set the dialog signal handler Definition at line 514 of file kspell.cpp. |
|
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
If The signal corrected() is emitted when the check is complete. You can look at suggestions() to see what the suggested replacements were. Definition at line 473 of file kspell.cpp. |
|
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 kspell.cpp. |
|
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
|
|
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: |
|
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):
|
|
Emitted when checkList() is done.
If the argument is |
|
Emitted when check() is done.
Be sure to copy the results of |
|
Returns the height of the dialog box.
Definition at line 125 of file kspell.cpp. |
|
Hides the dialog box. You'll need to do this when you are done with checkWord(); Definition at line 123 of file kspell.cpp. |
|
Tells ISpell/ASpell to ignore this word for the life of this KSpell instance.
Definition at line 410 of file kspell.cpp. |
|
Emitted when the user pressed "Ignore All" in the dialog. This could be used to make an application or file specific user dictionary. |
|
Emitted when the user pressed "Ignore" in the dialog. Don't know if this could be useful. |
|
Returns the partially spellchecked buffer. You might want the full buffer in its partially-checked state. |
|
Definition at line 1295 of file kspell.cpp. |
|
Returns the position (when using check()) or word number (when using checkList()) of the last word checked.
|
|
Emitted whenever a misspelled word is found by check() or by checkWord().
If it is emitted by checkWord(), 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). |
|
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 kspell.cpp. |
|
Definition at line 1391 of file kspell.cpp. |
|
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 kspell.cpp. |
|
Emitted during a check().
|
|
Emitted after KSpell has verified that ISpell/ASpell is running and working properly.
|
|
Emitted when the user pressed "ReplaceAll" in the dialog.
|
|
Sets the auto-delete flag. If this is set, the KSpell object is automatically deleted after emitting death(). |
|
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 kspell.cpp. |
|
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 kspell.cpp. |
|
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 kspell.cpp. |
|
Returns the status of KSpell.
|
|
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). |
|
Returns the width of the dialog box.
Definition at line 126 of file kspell.cpp. |
Member Data Documentation
|
Used for modalCheck.
|
The documentation for this class was generated from the following files: