| Models the result of a spell check of a single word.
Features of a spell check result are:
- contains the result of checking one word
- has the original word
- has a type of result (i.e. OK, ERROR, NONE, SUGGESTION)
- has a list of suggested replacement words (if type is SUGGESTION)
- has an offset into the line where the original word was found
The possible result types are:
- OK
- the original word was found in the dictionary.
- ERROR
- Internal error (e.g. aspell process died, wrong version of aspell, phase
of moon wrong).
- NONE
- the original word was not found in the dictionary and no suggestions were
found.
- SUGGESTION
- the original word was not found in the dictionary and one or more
suggested replacements were found.
|