|
|
enum spellStatus { Starting = 0, Running, Cleaning, Finished, Error, Crashed }; } | 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 occured in the Starting
state.
Crashed
- An error occured in the Running
state.
KSpell (QWidget *_parent, QString _caption, QObject *obj, const char *slot, KSpellConfig *_kcs=0, bool _progressbar = TRUE, bool _modal = FALSE )
| KSpell |
Start 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 dialg.. |
_caption | Caption of KSpellConfig dialog. |
_receiver | Receiver. |
_slot | Receivers SLOT. |
_kcs | Configuration for KSpell. |
_progressbar | Indicates if progress bar should be shown. |
_modal | Indicates modal or non-modal dialog. |
spellStatus status ()
| status |
Retrieve the status of KSpell.
See also: spellStatus()
void cleanUp ()
| cleanUp |
[virtual]
Clean 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.
void setAutoDelete (bool _autoDelete)
| setAutoDelete |
Auto-delete the KSpell object after emitting death().
bool check (const QString &_buffer)
| check |
[virtual]
Spellcheck 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 spel 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.
inline int lastPosition ()
| lastPosition |
Retrieve the position (when using check()) or word number (when using checkList()) of the last word checked.
bool checkList (QStringList *_wordlist)
| checkList |
[virtual]
Spellcheck 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.
bool checkWord (QString _buffer, bool usedialog=FALSE)
| checkWord |
[virtual]
Spellcheck 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 word, otherwise it
returns true
;
If usedialog
is set to true
, KSpell will put up 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.
void hide ()
| hide |
Hide the dialog box.
You'll need to do this when you are done with checkWord();
inline QStringList * suggestions ()
| suggestions |
Retrieve 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).
inline int dlgResult ()
| dlgResult |
Get 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):
void moveDlg (int x, int y)
| moveDlg |
Move 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.
inline int heightDlg ()
| heightDlg |
Retrieve the height of the dialog box.
inline int widthDlg ()
| widthDlg |
Retrieve the width of the dialog box.
const QString * intermediateBuffer ()
| intermediateBuffer |
Retrieve the partially spellchecked buffer.
You might want the full buffer in its partially-checked state.
bool ignore (QString word)
| ignore |
[virtual]
Tell ISpell/ASpell to ignore this word for the life of this KSpell instance.
ignore() returns false
if word is not a word or there was an error
communicating with ISpell/ASpell.
bool addPersonal (QString word)
| addPersonal |
[virtual]
Add 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.
KSpellConfig ksConfig ()
| ksConfig |
[const]
Retrieve the KSpellConfig object being used by this KSpell instance.
void setProgressResolution (unsigned res)
| setProgressResolution |
Set 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%.
~KSpell ()
| ~KSpell |
[virtual]
The destructor instructs ISpell/ASpell to write out the personal dictionary and then terminates ISpell/ASpell.
int modalCheck ( QString& text )
| modalCheck |
[static]
Perform a sychronous spellcheck.
This method does not return until spellchecking is done or canceled. Your application's GUI will still be updated, however.
void misspelling (QString originalword, QStringList *suggestions, unsigned pos)
| misspelling |
[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
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).
void corrected (QString originalword, QString newword, unsigned pos)
| corrected |
[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 cann occure
more then once with same list position, when checking a word with
hyphens. In this case orignalword
is the last replacement.
See also: check()
void ready (KSpell *)
| ready |
[signal]
Emitted after KSpell has verified that ISpell/ASpell is running and working properly.
void progress (unsigned int i)
| progress |
[signal]
Emitted during a check().
i
is between 1 and 100.
void done (const QString &buffer)
| done |
[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 done (bool)
| done |
[signal]
Emitted when checkList() is done.
If the argument is
true
, then you should update your text from the
wordlist, otherwise not.
void death ( )
| 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.
void KSpell2 (KProcIO *)
| KSpell2 |
[protected slots: slot]
void checkWord2 (KProcIO *)
| checkWord2 |
[protected slots: slot]
void checkWord3 ()
| checkWord3 |
[protected slots: slot]
void check2 (KProcIO *)
| check2 |
[protected slots: slot]
void checkList2 ()
| checkList2 |
[protected slots: slot]
void checkList3a (KProcIO *)
| checkList3a |
[protected slots: slot]
void checkList3 ()
| checkList3 |
[protected slots: slot]
void checkList4 ()
| checkList4 |
[protected slots: slot]
void dialog2 (int dlgresult)
| dialog2 |
[protected slots: slot]
void check3 ()
| check3 |
[protected slots: slot]
void slotStopCancel (int)
| slotStopCancel |
[protected slots: slot]
void ispellExit (KProcess *)
| ispellExit |
[protected slots: slot]
void emitDeath ()
| emitDeath |
[protected slots: slot]
void ispellErrors (KProcess *, char *, int)
| ispellErrors |
[protected slots: slot]
void dialog3 ()
| dialog3 |
[signal]
void ez ()
| ez |
[signal]
void eza ()
| eza |
[signal]
KProcIO * proc | proc |
[protected: ]
QWidget * parent | parent |
[protected: ]
KSpellConfig * ksconfig | ksconfig |
[protected: ]
KSpellDlg * ksdlg | ksdlg |
[protected: ]
QStringList * wordlist | wordlist |
[protected: ]
QStringList::Iterator wlIt | wlIt |
[protected: ]
QStringList ignorelist | ignorelist |
[protected: ]
QStringList replacelist | replacelist |
[protected: ]
QStringList sugg | sugg |
[protected: ]
QTextCodec* codec | codec |
[protected: ]
spellStatus m_status | m_status |
[protected: ]
bool usedialog | usedialog |
[protected: ]
bool texmode | texmode |
[protected: ]
bool dlgon | dlgon |
[protected: ]
bool personaldict | personaldict |
[protected: ]
bool dialogwillprocess | dialogwillprocess |
[protected: ]
bool progressbar | progressbar |
[protected: ]
bool dialogsetup | dialogsetup |
[protected: ]
bool autoDelete | autoDelete |
[protected: ]
QString caption | caption |
[protected: ]
QString orig | orig |
[protected: ]
QString origbuffer | origbuffer |
[protected: ]
QString newbuffer | newbuffer |
[protected: ]
QString cwword | cwword |
[protected: ]
QString dlgorigword | dlgorigword |
[protected: ]
QString dlgreplacement | dlgreplacement |
[protected: ]
QString dialog3slot | dialog3slot |
[protected: ]
int dlgresult | dlgresult |
[protected: ]
int trystart | trystart |
[protected: ]
int maxtrystart | maxtrystart |
[protected: ]
unsigned int lastpos | lastpos |
[protected: ]
unsigned int totalpos | totalpos |
[protected: ]
unsigned int lastline | lastline |
[protected: ]
unsigned int posinline | posinline |
[protected: ]
unsigned int lastlastline | lastlastline |
[protected: ]
unsigned int offset | offset |
[protected: ]
unsigned int progres | progres |
[protected: ]
unsigned int curprog | curprog |
[protected: ]
bool modaldlg | modaldlg |
[protected: ]
static QString modaltext | modaltext |
[protected: ]
static int modalreturn | modalreturn |
[protected: ]
static QWidget* modalWidgetHack | modalWidgetHack |
[protected: ]
int parseOneResponse (const QString &_buffer, QString &word, QStringList *sugg)
| parseOneResponse |
[protected: ]
Used for modalCheck.
QString funnyWord (QString word)
| funnyWord |
[protected: ]
void dialog (QString word, QStringList *sugg, const char* _slot)
| dialog |
[protected: ]
inline QString replacement ()
| replacement |
[protected: ]
void setUpDialog ( bool reallyusedialogbox = TRUE)
| setUpDialog |
[protected: ]
void emitProgress ()
| emitProgress |
[protected: ]
bool cleanFputs (QString s, bool appendCR=TRUE)
| cleanFputs |
[protected: ]
bool cleanFputsWord (QString s, bool appendCR=TRUE)
| cleanFputsWord |
[protected: ]
void startIspell ()
| startIspell |
[protected: ]
bool writePersonalDictionary ()
| writePersonalDictionary |
[protected: ]
Generated by: dfaure on Tue Feb 27 12:47:49 2001, using kdoc 2.0a50. |