org.kde.koala

Interface KSpellSignals

public interface KSpellSignals

Method Summary
voidaddword(String originalword)
Emitted when the user pressed "Add" in the dialog.
voidcorrected(String originalword, String newword, int pos)
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).
voiddeath()
Emitted on terminal errors and after clean up.
voiddialog3()
voiddone(String buffer)
Emitted when check() is done.
voiddone(boolean arg1)
Emitted when checkList() is done.
voidignoreall(String originalword)
Emitted when the user pressed "Ignore All" in the dialog.
voidignoreword(String originalword)
Emitted when the user pressed "Ignore" in the dialog.
voidmisspelling(String originalword, String[] suggestions, int pos)
Emitted whenever a misspelled word is found by check() or by checkWord().
voidprogress(int i)
Emitted during a check().
voidready(KSpell arg1)
Emitted after KSpell has verified that ISpell/ASpell is running and working properly.
voidreplaceall(String origword, String replacement)
Emitted when the user pressed "ReplaceAll" in the dialog.

Method Detail

addword

public void addword(String originalword)
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.

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

corrected

public void corrected(String originalword, String newword, int pos)
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: KSpellSignals

UNKNOWN: Emitted after the "Replace" or "Replace All" buttons of the dialog was pressed, or if the word was corrected without calling the dialog (i.

death

public void death()
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.
  • @short Emitted on terminal errors and after clean up.

    dialog3

    public void dialog3()

    done

    public void done(String buffer)
    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().

    UNKNOWN: Emitted when check() is done.

    done

    public void done(boolean arg1)
    Emitted when checkList() is done. If the argument is true, then you should update your text from the wordlist, otherwise not.

    UNKNOWN: Emitted when checkList() is done.

    ignoreall

    public void ignoreall(String originalword)
    Emitted when the user pressed "Ignore All" in the dialog. This could be used to make an application or file specific user dictionary.

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

    ignoreword

    public void ignoreword(String originalword)
    Emitted when the user pressed "Ignore" in the dialog. Don't know if this could be useful.

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

    misspelling

    public void misspelling(String originalword, String[] suggestions, int pos)
    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 ArrayList 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).

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

    progress

    public void progress(int i)
    Emitted during a check(). i is between 1 and 100.

    UNKNOWN: Emitted during a check().

    ready

    public void ready(KSpell arg1)
    Emitted after KSpell has verified that ISpell/ASpell is running and working properly.

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

    replaceall

    public void replaceall(String origword, String replacement)
    Emitted when the user pressed "ReplaceAll" in the dialog.

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