void AddWordToDictionary ( PRUnichar* word )

Adds a word to the current personal dictionary.

Arguments:

word

PRBool canSpellCheck ( )

Returns true if we can enable spellchecking. If there are no available dictionaries, this will return false.

PRBool CheckCurrentWord ( PRUnichar* suggestedWord )

Check a given word. In spite of the name, this function checks the word you give it, returning true if the word is misspelled. If the word is misspelled, it will compute the suggestions which you can get from GetSuggestedWord().

Arguments:

suggestedWord

PRBool CheckCurrentWordNoSuggest ( PRUnichar* suggestedWord )

Like CheckCurrentWord, checks the word you give it, returning true if it's misspelled. This is faster than CheckCurrentWord because it does not compute any suggestions.

Watch out: this does not clear any suggestions left over from previous calls to CheckCurrentWord, so there may be suggestions, but they will be invalid.

Arguments:

suggestedWord

PRUnichar* GetCurrentDictionary ( )

void GetDictionaryList ( out arrayof PRUnichar* dictionaryList , out PRUint32 count )

Retrieves a list of the currently available dictionaries. The strings will typically be language IDs, like "en-US".

Arguments:

dictionaryList

count

PRUnichar* GetNextMisspelledWord ( )

When interactively spell checking the document, this will return the value of the next word that is misspelled. This also computes the suggestions which you can get by calling GetSuggestedWord.

void GetPersonalDictionary ( )

Fills an internal list of words added to the personal dictionary. These words can be retrieved using GetPersonalDictionaryWord()

PRUnichar* GetPersonalDictionaryWord ( )

Used after you call GetPersonalDictionary() to iterate through all the words added to the personal dictionary. Will return the empty string when there are no more words.

PRUnichar* GetSuggestedWord ( )

Used to get suggestions for the last word that was checked and found to be misspelled. The first call will give you the first (best) suggestion. Subsequent calls will iterate through all the suggestions, allowing you to build a list. When there are no more suggestions, an empty string (not a null pointer) will be returned.

void IgnoreWordAllOccurrences ( PRUnichar* word )

Arguments:

word

void InitSpellChecker ( nsIEditor editor , PRBool enableSelectionChecking )

Turns on the spell checker for the given editor. enableSelectionChecking set means that we only want to check the current selection in the editor, (this controls the behavior of GetNextMisspelledWord). For spellchecking clients with no modal UI (such as inline spellcheckers), this flag doesn't matter

Arguments:

editor

enableSelectionChecking

void RemoveWordFromDictionary ( PRUnichar* word )

Removes a word from the current personal dictionary.

Arguments:

word

void ReplaceWord ( PRUnichar* misspelledWord , PRUnichar* replaceWord , PRBool allOccurrences )

Use when modally checking the document to replace a word.

Arguments:

misspelledWord

replaceWord

allOccurrences

void saveDefaultDictionary ( )

Call to save the currently selected dictionary as the default. The function UninitSpellChecker will also do this, but that function may not be called in some situations. This function allows the caller to force the default right now.

void SetCurrentDictionary ( PRUnichar* dictionary )

Arguments:

dictionary

void setFilter ( nsITextServicesFilter filter )

Used to filter the content (for example, to skip blockquotes in email from spellchecking. Call this before calling InitSpellChecker; calling it after initialization will have no effect.

Arguments:

filter

void UninitSpellChecker ( )

Call this to free up the spell checking object. It will also save the current selected language as the default for future use.

If you have called CanSpellCheck but not InitSpellChecker, you can still call this function to clear the cached spell check object, and no preference saving will happen.